coding++:Spring IOC/DI 实现原理
什么是 SpringIOC:
spring ioc 指的是控制反转,IOC容器负责实例化、定位、配置应用程序中的对象及建立这些对象间的依赖。交由Spring容器统一进行管理,从而实现松耦合。
“控制反转”,不是什么技术,而是一种设计思想。
IOC 实现原理:
使用反射机制+XML技术
理解了这些基本概念后,我们通过一个简单的示意图来简单描述一下整个流程,
从示意图可以看出,当web容器启动的时候,spring的全局bean的管理器会去xml配置文件中扫描的包下面获取到所有的类。
并根据你使用的注解,进行对应的封装,封装到全局的bean容器中进行管理,一旦容器初始化完毕,beanID以及bean实例化的类对象信息就全部存在了。
现在我们需要在某个service里面调用另一个bean的某个方法的时候,我们只需要依赖注入进来另一个bean的Id即可。
调用的时候,spring会去初始化完成的bean容器中获取即可,如果存在就把依赖的bean的类的实例化对象返回给你,你就可以调用依赖的bean的相关方法或属性等
下面通过实例代码来模拟一下整个IOC的原理和执行流程:
demo 结构如下:
首先我们自定义两个注解,我们知道在业务类中经常使用 @Service来标记这个类是bean管理的类,而@Autowired或者@Resource用于bean之间相互依赖使用,
package mlq.spring.annotation; import java.lang.annotation.Retention; import java.lang.annotation.Target; import static java.lang.annotation.ElementType.FIELD; import static java.lang.annotation.ElementType.METHOD; import static java.lang.annotation.ElementType.TYPE; import static java.lang.annotation.RetentionPolicy.RUNTIME; /** * 模拟@Autowired注解 */ @Target({ TYPE, FIELD, METHOD }) @Retention(RUNTIME) public @interface SelfAutowired { }
import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 自定义注解 service 注入bean容器 */ @Target({ ElementType.TYPE }) @Retention(RetentionPolicy.RUNTIME) public @interface SelfService { }
模拟spring的bean容器类,想必使用过spring框架在进行整合测试的时候,都使用到下面这段代码,这段代码的作用其实就是模拟在spring启动加载的时候,
通过这个类去初始化一个bean 的容器管理类,所有的bean的信息解析和保存都会在这个类里面进行,下面我们写一个这样的类来还原一下这个过程。
SelfPathXmlApplicationContext app = new SelfPathXmlApplicationContext("mlq.spring.service.impl");
自定义spring的bean容器类。
import mlq.spring.annotation.SelfAutowired; import mlq.spring.annotation.SelfService; import mlq.spring.utils.ClassParseUtil; import org.springframework.util.StringUtils; import java.lang.reflect.Field; import java.util.List; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; /** * 自定义bean管理器 */ public class SelfPathXmlApplicationContext { // 封装所有的bean容器 private ConcurrentHashMap<String, Object> beans = null; private String packageName; /** * 该类被创建出来的时候加载 * * @param packageName * @throws Exception */ public SelfPathXmlApplicationContext(String packageName) throws Exception { beans = new ConcurrentHashMap<String, Object>(); this.packageName = packageName; initBeans(); initEntryField(); } /** * 获取扫描包下面的所有bean */ private void initBeans() throws Exception { // 1.使用java的反射机制扫包,[获取当前包下所有的类] List<Class<?>> classes = ClassParseUtil.getClasses(packageName); // 2、判断类上面是否存在注入的bean的注解 ConcurrentHashMap<String, Object> classExisAnnotation = findClassExisAnnotation(classes); if (classExisAnnotation == null || classExisAnnotation.isEmpty()) { throw new Exception("该包下没有任何类加上注解"); } } /** * 判断类上是否存在注入自定义的bean的注解 * * @param classes * @return * @throws Exception */ public ConcurrentHashMap<String, Object> findClassExisAnnotation(List<Class<?>> classes) throws Exception { for (Class<?> classInfo : classes) { // 判断类上是否有注解 [获取自定义的service注解] SelfService annotation = classInfo.getAnnotation(SelfService.class); if (annotation != null) { // 获取当前类的类名 String className = classInfo.getSimpleName(); String beanId = toLowerCaseFirstOne(className); Object newInstance = newInstance(classInfo); beans.put(beanId, newInstance); } } return beans; } // 首字母转小写 public static String toLowerCaseFirstOne(String s) { if (Character.isLowerCase(s.charAt(0))) return s; else return (new StringBuilder()).append(Character.toLowerCase(s.charAt(0))).append(s.substring(1)).toString(); } /** * 通过class名称获取类的实例化对象 * * @param classInfo * @return * @throws ClassNotFoundException * @throws InstantiationException * @throws IllegalAccessException */ public Object newInstance(Class<?> classInfo) throws ClassNotFoundException, InstantiationException, IllegalAccessException { return classInfo.newInstance(); } /** * 初始化bean的实例对象的所有属性 * * @throws Exception */ private void initEntryField() throws Exception { // 1.遍历所有的bean容器对象 for (Map.Entry<String, Object> entry : beans.entrySet()) { // 2.判断属性上面是否有加注解 Object bean = entry.getValue(); attriAssign(bean); } } /** * 依赖注入注解原理 * * @param object * @throws Exception */ public void attriAssign(Object object) throws Exception { // 1.使用反射机制,获取当前类的所有属性 Class<? extends Object> classInfo = object.getClass(); Field[] declaredFields = classInfo.getDeclaredFields(); // 2.判断当前类属性是否存在注解 for (Field field : declaredFields) { SelfAutowired extResource = field.getAnnotation(SelfAutowired.class); if (extResource != null) { // 获取属性名称 String beanId = field.getName(); Object bean = getBean(beanId); if (bean != null) { // 3.默认使用属性名称,查找bean容器对象 1参数 当前对象 2参数给属性赋值 field.setAccessible(true); // 允许访问私有属性 field.set(object, bean); } } } } /** * 根据beanId获取bean名称 * * @param beanId * @return * @throws Exception */ public Object getBean(String beanId) throws Exception { if (StringUtils.isEmpty(beanId)) { throw new Exception("beanId参数不能为空"); } // 1.从spring容器获取bean Object object = beans.get(beanId); return object; } public ConcurrentHashMap<String, Object> getBeans() { return beans; } public void setBeans(ConcurrentHashMap<String, Object> beans) { this.beans = beans; } public String getPackageName() { return packageName; } public void setPackageName(String packageName) { this.packageName = packageName; } }
ClassParseUtil :工具类
package mlq.spring.utils; import java.io.File; import java.io.FileFilter; import java.io.IOException; import java.net.JarURLConnection; import java.net.URL; import java.net.URLDecoder; import java.util.ArrayList; import java.util.Enumeration; import java.util.List; import java.util.jar.JarEntry; import java.util.jar.JarFile; public class ClassParseUtil { /** * 取得某个接口下所有实现这个接口的类 */ public static List<Class> getAllClassByInterface(Class c) { List<Class> returnClassList = null; if (c.isInterface()) { // 获取当前的包名 String packageName = c.getPackage().getName(); // 获取当前包下以及子包下所以的类 List<Class<?>> allClass = getClasses(packageName); if (allClass != null) { returnClassList = new ArrayList<Class>(); for (Class classes : allClass) { // 判断是否是同一个接口 if (c.isAssignableFrom(classes)) { // 本身不加入进去 if (!c.equals(classes)) { returnClassList.add(classes); } } } } } return returnClassList; } /* * 取得某一类所在包的所有类名 不含迭代 */ public static String[] getPackageAllClassName(String classLocation, String packageName) { // 将packageName分解 String[] packagePathSplit = packageName.split("[.]"); String realClassLocation = classLocation; int packageLength = packagePathSplit.length; for (int i = 0; i < packageLength; i++) { realClassLocation = realClassLocation + File.separator + packagePathSplit[i]; } File packeageDir = new File(realClassLocation); if (packeageDir.isDirectory()) { String[] allClassName = packeageDir.list(); return allClassName; } return null; } /** * 从包package中获取所有的Class * * @param packageName * @return */ public static List<Class<?>> getClasses(String packageName) { // 第一个class类的集合 List<Class<?>> classes = new ArrayList<Class<?>>(); // 是否循环迭代 boolean recursive = true; // 获取包的名字 并进行替换 String packageDirName = packageName.replace('.', '/'); // 定义一个枚举的集合 并进行循环来处理这个目录下的things Enumeration<URL> dirs; try { dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName); // 循环迭代下去 while (dirs.hasMoreElements()) { // 获取下一个元素 URL url = dirs.nextElement(); // 得到协议的名称 String protocol = url.getProtocol(); // 如果是以文件的形式保存在服务器上 if ("file".equals(protocol)) { // 获取包的物理路径 String filePath = URLDecoder.decode(url.getFile(), "UTF-8"); // 以文件的方式扫描整个包下的文件 并添加到集合中 findAndAddClassesInPackageByFile(packageName, filePath, recursive, classes); } else if ("jar".equals(protocol)) { // 如果是jar包文件 // 定义一个JarFile JarFile jar; try { // 获取jar jar = ((JarURLConnection) url.openConnection()).getJarFile(); // 从此jar包 得到一个枚举类 Enumeration<JarEntry> entries = jar.entries(); // 同样的进行循环迭代 while (entries.hasMoreElements()) { // 获取jar里的一个实体 可以是目录 和一些jar包里的其他文件 如META-INF等文件 JarEntry entry = entries.nextElement(); String name = entry.getName(); // 如果是以/开头的 if (name.charAt(0) == '/') { // 获取后面的字符串 name = name.substring(1); } // 如果前半部分和定义的包名相同 if (name.startsWith(packageDirName)) { int idx = name.lastIndexOf('/'); // 如果以"/"结尾 是一个包 if (idx != -1) { // 获取包名 把"/"替换成"." packageName = name.substring(0, idx).replace('/', '.'); } // 如果可以迭代下去 并且是一个包 if ((idx != -1) || recursive) { // 如果是一个.class文件 而且不是目录 if (name.endsWith(".class") && !entry.isDirectory()) { // 去掉后面的".class" 获取真正的类名 String className = name.substring(packageName.length() + 1, name.length() - 6); try { // 添加到classes classes.add(Class.forName(packageName + '.' + className)); } catch (ClassNotFoundException e) { e.printStackTrace(); } } } } } } catch (IOException e) { e.printStackTrace(); } } } } catch (IOException e) { e.printStackTrace(); } return classes; } /** * 以文件的形式来获取包下的所有Class * * @param packageName * @param packagePath * @param recursive * @param classes */ public static void findAndAddClassesInPackageByFile(String packageName, String packagePath, final boolean recursive, List<Class<?>> classes) { // 获取此包的目录 建立一个File File dir = new File(packagePath); // 如果不存在或者 也不是目录就直接返回 if (!dir.exists() || !dir.isDirectory()) { return; } // 如果存在 就获取包下的所有文件 包括目录 File[] dirfiles = dir.listFiles(new FileFilter() { // 自定义过滤规则 如果可以循环(包含子目录) 或则是以.class结尾的文件(编译好的java类文件) public boolean accept(File file) { return (recursive && file.isDirectory()) || (file.getName().endsWith(".class")); } }); // 循环所有文件 for (File file : dirfiles) { // 如果是目录 则继续扫描 if (file.isDirectory()) { findAndAddClassesInPackageByFile(packageName + "." + file.getName(), file.getAbsolutePath(), recursive, classes); } else { // 如果是java类文件 去掉后面的.class 只留下类名 String className = file.getName().substring(0, file.getName().length() - 6); try { // 添加到集合中去 classes.add(Class.forName(packageName + '.' + className)); } catch (ClassNotFoundException e) { e.printStackTrace(); } } } } }
当这个类被初始化的时候,通过构造函数里面的两个方法,通过外部传入指定的包名,解析该包下面的所有类和相关注解,其实现原理主要是使用了反射。
通过一个工具类获取到了所有的类的实例化集合后,我们对这个集合进行遍历,具体的执行方法可以看findClassExisAnnotation 这个方法。
在findClassExisAnnotation这个方法里面,可以看到,我们使用自定义的注解去到这个实例类对象去匹配,如果匹配到了相应的注解,就把这个bean封装到全局的集合中,这里使用了concurrentHashMap进行封装。
这一步完成之后,包含了自定义注解[@Service]的相关类对象就存在了内存集合中了,如果在web容器启动完毕之后。
使用自己的bean的时候就可以直接通过getBean这个方法去容器里面直接获取就可以了。
通过这个方法就可以拿到当前beanId对应的类的实例化对象,可以使用里面的相关方法,
但是到这里并没有完事啊,假如在我们某个标注了@Service的类里面有下面这样的注解,即依赖了其他的某个bean。
比如,在我们的userService类里面依赖了orderService,就形成了所谓的依赖注入。
同样,依赖注入也是通过上面相同的方式,在initBean()方法结束之后立即执行,我们来看看这个方法。
在initEntryField()这个方法里,要做的事情就是遍历上述初始化好的所有bean,然后再去每个bean的实例对象中解析并封装属性相关的对应信息,下面看一下initEntryField()这个方法。
通过这个方法,就可以将某个bean中依赖的其他bean信息进行封装。
最后我们写一个测试类来验证一下,直接运行下面的main函数。
public class TestMain { public static void main(String[] args) throws Exception { SelfPathXmlApplicationContext app = new SelfPathXmlApplicationContext("mlq.spring.service.impl"); UserServiceImpl userServiceImpl = (UserServiceImpl) app.getBean("userServiceImpl"); String result = userServiceImpl.add(); System.out.println("获取到了orderService的执行结果是 : " + result); System.out.println("当前的bean的实例对象是: " + userServiceImpl); } }
源码下载: Download 提取码:ls59