Spring学习及手写简易IOC容器

Spring 框架核心源码

1、使用 Spring 框架

2、反射机制

IoC 控制反转 Inverse of Control 创建对象的权限，Java 程序中需要用到的对象不再由程序员自己创建，而是交给 IoC 容器来创建。

IoC 核心思想

1、pom.xml

<dependencies>
    
    <dependency>
        <groupId>javax.servletgroupId>
        <artifactId>javax.servlet-apiartifactId>
        <version>4.0.1version>
    dependency>
dependencies>


<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.pluginsgroupId>
            <artifactId>maven-compiler-pluginartifactId>
            <version>3.8.1version>
            <configuration>
                <source>1.8source>
                <target>1.8target>
                <encoding>UTF-8encoding>
            configuration>
        plugin>
    plugins>
build>

<packaging>warpackaging>

2、创建 Servlet

@WebServlet("/hello")
public class HelloServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.getWriter().write(new HelloServiceImp().findAll().toString());
    }
}

3、部署到 Tomcat

4、Servlet、Service、Dao

当需求发生变更的时候，可能需要频繁修改 Java 代码，效率很低，如何解决？

静态工厂

package com.southwind.factory;

import com.southwind.dao.HelloDao;
import com.southwind.dao.impl.HelloDaoImpl;

public class BeanFactory {
    public static HelloDao getDao(){
        return new HelloDaoImpl();
    }
}

private HelloDao helloDao = BeanFactory.getDao();

上述的方式并不能解决我们的问题，需求发生改变的时候，仍然需要修改代码，怎么做到

不改 Java 代码，就可以实现实现类的切换呢？

外部配置文件的方式

将具体的实现类写到配置文件中，Java 程序只需要读取配置文件即可。

XML、YAML、Properties、JSON

1、定义外部配置文件

helloDao=com.southwind.dao.impl.HelloDaoImpl

2、Java 程序读取这个配置文件

public class BeanFactory {
    public static Properties properties;
    //缓存 确保单例
    public static Map<String,Object> cache=new HashMap<>();

    static {
        properties=new Properties();
        try {
            properties.load(BeanFactory.class.getClassLoader().getResourceAsStream("factory.properties"));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    public static Object getDao(String beanName){
        if(!cache.containsKey(beanName)) {
        //锁住保证线程安全
            synchronized (BeanFactory.class) {
                try {
                    if (!cache.containsKey(beanName)) {
                        String value = properties.getProperty(beanName);
                        Class clazz = Class.forName(value);
                        Object instance = clazz.getConstructor().newInstance();
                        cache.put(beanName, instance);
                    }
                } catch (ClassNotFoundException e) {
                    e.printStackTrace();
                } catch (InstantiationException e) {
                    e.printStackTrace();
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                } catch (InvocationTargetException e) {
                    e.printStackTrace();
                } catch (NoSuchMethodException e) {
                    e.printStackTrace();
                }
            }
        }
        return cache.get(beanName);
    }
}

3、修改 Service

private HelloDao helloDao = (HelloDao) BeanFactory.getDao();

1、private HelloDao helloDao = new HelloDaoImpl();

2、private HelloDao helloDao = （HelloDao）BeanFactory.getDao("helloDao");

1、强依赖/紧耦合，编译之后无法修改，没有扩展性。

2、弱依赖/松耦合，编译之后仍然可以修改，让程序具有更好的扩展性。

自己放弃了创建对象的权限，将创建对象的权限交给了 BeanFactory，这种将控制权交给别人的思想，就是控制反转 IoC。

Spring IoC 的使用

XML 和注解，XML 已经被淘汰了，目前主流的是基于注解的方式，Spring Boot 就是基于注解的方式。

@Data
@Component("myOrder")
public class Order {
    @Value("xxx123")
    private String orderId;
    @Value("1000.0")
    private Float price;
}

@Data
@Component
public class Account {
    @Value("1")
    private Integer id;
    @Value("张三")
    private String name;
    @Value("22")
    private Integer age;
    @Autowired
    @Qualifier("order")
    private Order myOrder;
}

package com.southwind.spring.test;

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Test {
    public static void main(String[] args) {
        //加载IoC容器
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext("com.southwind.spring.entity");
        String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
        System.out.println(applicationContext.getBeanDefinitionCount());
        for (String beanDefinitionName : beanDefinitionNames) {
            System.out.println(beanDefinitionName);
            System.out.println(applicationContext.getBean(beanDefinitionName));
        }
    }
}

IoC 基于注解的执行原理

手写代码的思路：

1、自定义一个 MyAnnotationConfigApplicationContext，构造器中传入要扫描的包。

2、获取这个包下的所有类。

3、遍历这些类，找出添加了 @Component 注解的类，获取它的 Class 和对应的 beanName，封装成一个 BeanDefinition，存入集合 Set，这个机会就是 IoC 自动装载的原材料。

4、遍历 Set 集合，通过反射机制创建对象，同时检测属性有没有添加 @Value 注解，如果有还需要给属性赋值，再将这些动态创建的对象以 k-v 的形式存入缓存区。

5、提供 getBean 等方法，通过 beanName 取出对应的 bean 即可。

代码实现

定义四个自定义注解

package com.wjs.myspring.carolspring.Annoation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface WjsAutowired {
}

package com.wjs.myspring.carolspring.Annoation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface WjsComponent {
    String value() default "";
}

package com.wjs.myspring.carolspring.Annoation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface WjsQualifier {
    String value();
}

package com.wjs.myspring.carolspring.Annoation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface WjsValue {
    String value();
}

自定义一个MyAnnotationConfigApplicationContext类

package com.wjs.myspring.carolspring;

import com.wjs.myspring.carolspring.Annoation.WjsAutowired;
import com.wjs.myspring.carolspring.Annoation.WjsComponent;
import com.wjs.myspring.carolspring.Annoation.WjsQualifier;
import com.wjs.myspring.carolspring.Annoation.WjsValue;

import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.*;

public class MyAnnotationConfigApplicationContext {
    private Map<String,Object> ioc=new HashMap<>();
    public MyAnnotationConfigApplicationContext(String pack){
        //遍历包，找到目标类(原材料)
        Set<BeanDefinition> beanDefinitions = getBeanDefinitions(pack);
        //根据原材料创建bean
        createObject(beanDefinitions);
        //自动装载
        autowireObject(beanDefinitions);
    }
    public Object getBean(String beanName){
        return ioc.get(beanName);
    }
 }

getBeanDefinitions方法

此方法用到了MyTools工具类,此类代码会放在文章结尾,此方法用来将指定包下的添加@WjsComponent 注解的类封装成一个BeanDefinition集合。

public Set<BeanDefinition> getBeanDefinitions(String pack){
        //获取包下所有类
        Set<Class<?>> classes = MyTools.getClasses(pack);
        Set<BeanDefinition> result=new HashSet<>();
        for (Class<?> clazz : classes) {
            //遍历这些类找到添加了注解的类
            WjsComponent wjsComponent = clazz.getAnnotation(WjsComponent.class);
            if(wjsComponent!=null){
                //获取wjsComponent注解的值
                String beanName = wjsComponent.value();
                if("".equals(beanName)){
                    //没有设置beanName时,获取类名首字母小写
                    String name = clazz.getName().replaceAll(clazz.getPackage().getName() + ".", "");
                    beanName=name.substring(0,1).toLowerCase()+name.substring(1);
                }
                //3、将这些类封装成BeanDefinition，装载到集合中
                result.add(new BeanDefinition(beanName,clazz));
            }
        }
        return result;
    }

BeanDefinition类代码如下

package com.wjs.myspring.carolspring;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.ToString;

@Data
@AllArgsConstructor
@ToString
public class BeanDefinition {
    private String beanName;//bean的名称
    private Class beanClass;//bean的Class
}

createObject方法

此方法根据上一步生成的BeanDefinition集合创建对象放入ioc容器中,以及对标注了@WjsValue注解的属性进行赋值,类型转换做了一部分,比较简陋。

private void createObject(Set<BeanDefinition> beanDefinitions) {
        for (BeanDefinition definition : beanDefinitions) {
            Class clazz = definition.getBeanClass();
            String beanName=definition.getBeanName();
            try {
                //创建的对象
                Object object = clazz.getConstructor().newInstance();
                //完成属性的赋值
                Field[] fields = clazz.getDeclaredFields();
                for (Field field : fields) {
                    WjsValue annotation = field.getAnnotation(WjsValue.class);
                    if(annotation!=null){
                        //如果属性上添加了此注解
                        String value=annotation.value();
                        String fieldName = field.getName();
                        //设置方法名
                        String methodName="set"+fieldName.substring(0,1).toUpperCase()+fieldName.substring(1);
                        Method method = clazz.getMethod(methodName, field.getType());
                        //完成数据类型转换
                        Object val=null;
                        switch (field.getType().getName()){
                            case "java.lang.Integer":
                                val = Integer.parseInt(value);
                                break;
                            case "java.lang.String":
                                val = value;
                                break;
                            case "java.lang.Float":
                                val = Float.parseFloat(value);
                                break;
                        }
                        method.invoke(object,val);
                    }
                }
                ioc.put(beanName,object);
            } catch (InstantiationException e) {
                e.printStackTrace();
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            } catch (InvocationTargetException e) {
                e.printStackTrace();
            } catch (NoSuchMethodException e) {
                e.printStackTrace();
            }
        }
    }

autowireObject方法

此方法将类中被@WjsAutowired注解及@WjsQualifier注解的属性进行自动注入,两个都标注的会按照@WjsQualifier注解定义名称进行注入,只标注了@WjsAutowired注解会按照类型进行注入。

private void autowireObject(Set<BeanDefinition> beanDefinitions) {
        for (BeanDefinition definition : beanDefinitions) {
            Class clazz = definition.getBeanClass();
            //拿到所有属性的集合
            Field[] fields = clazz.getDeclaredFields();
            for (Field field : fields) {
                WjsAutowired autowired = field.getAnnotation(WjsAutowired.class);
                if(autowired!=null){
                    WjsQualifier qualifier = field.getAnnotation(WjsQualifier.class);
                    if(qualifier!=null){
                       //按照name进行注入
                        try {
                            //拿到注解的值
                            String value = qualifier.value();
                            //拿到注入进属性的值
                            Object bean =getBean(value);
                            //拿到属性名
                            String fieldName = field.getName();
                            //凭借对应属性set方法名
                            String methodName="set"+fieldName.substring(0,1).toUpperCase()+fieldName.substring(1);
                            //通过反射拿到方法
                            Method method = clazz.getMethod(methodName, field.getType());
                            //获取主对象
                            Object object = getBean(definition.getBeanName());
                            //调用方法
                            method.invoke(object,bean);
                        } catch (NoSuchMethodException e) {
                            e.printStackTrace();
                        } catch (IllegalAccessException e) {
                            e.printStackTrace();
                        } catch (InvocationTargetException e) {
                            e.printStackTrace();
                        }
                    }else {
                        //按照类型进行注入

                        //拿到属性类型名称
                        String name = field.getType().getName();
                        //创建ioc容器里符合条件类型的key集合
                        List<String> keyList=new ArrayList<>();
                        for (String key : ioc.keySet()) {
                            String typeName = ioc.get(key).getClass().getTypeName();
                            if(name.equals(typeName)){
                                keyList.add(key);
                            }
                        }
                        if(keyList.size()==1){
                            //当找到一个时
                            try {
                                String key = keyList.get(0);
                                Object bean = getBean(key);
                                //拿到属性名
                                String fieldName = field.getName();
                                //凭借对应属性set方法名
                                String methodName="set"+fieldName.substring(0,1).toUpperCase()+fieldName.substring(1);
                                //通过反射拿到方法
                                Method method = clazz.getMethod(methodName, field.getType());
                                //获取主对象
                                Object object = getBean(definition.getBeanName());
                                //调用方法
                                method.invoke(object,bean);
                            } catch (NoSuchMethodException e) {
                                e.printStackTrace();
                            } catch (IllegalAccessException e) {
                                e.printStackTrace();
                            } catch (InvocationTargetException e) {
                                e.printStackTrace();
                            }
                        }

                    }
                }
            }
        }
    }

测试

package com.wjs.myspring.carolspring;

public class MyTest {
    public static void main(String[] args) {
        MyAnnotationConfigApplicationContext context = new MyAnnotationConfigApplicationContext("com.wjs.myspring");
        Object user = context.getBean("user");
        System.out.println(user);
    }
}

package com.wjs.myspring.carolspring.enity;

import com.wjs.myspring.carolspring.Annoation.WjsAutowired;
import com.wjs.myspring.carolspring.Annoation.WjsComponent;
import com.wjs.myspring.carolspring.Annoation.WjsQualifier;
import com.wjs.myspring.carolspring.Annoation.WjsValue;
import lombok.Data;
import lombok.ToString;

@WjsComponent
@ToString
@Data
public class User {
    @WjsValue("测试名字")
    public String name;
    @WjsValue("12")
    private Integer age;

    @WjsAutowired
    private Account account;
}

package com.wjs.myspring.carolspring.enity;

import com.wjs.myspring.carolspring.Annoation.WjsComponent;
import com.wjs.myspring.carolspring.Annoation.WjsValue;
import lombok.Data;
import lombok.ToString;

@Data
@ToString
@WjsComponent("wjsAccount")
public class Account {
    @WjsValue("567234569")
    public String accountNumber;
    @WjsValue("1000")
    private Integer money;
}

结果 所有属性都注入成功,ioc容器里有两个bean

工具类代码

package com.wjs.myspring.carolspring;

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.Enumeration;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

public class MyTools {

    public static Set<Class<?>> getClasses(String pack) {

        // 第一个class类的集合
        Set<Class<?>> classes = new LinkedHashSet<Class<?>>();
        // 是否循环迭代
        boolean recursive = true;
        // 获取包的名字 并进行替换
        String packageName = pack;
        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");
                    // 以文件的方式扫描整个包下的文件 并添加到集合中
                    findClassesInPackageByFile(packageName, filePath, recursive, classes);
                } else if ("jar".equals(protocol)) {
                    // 如果是jar包文件
                    // 定义一个JarFile
                    System.out.println("jar类型的扫描");
                    JarFile jar;
                    try {
                        // 获取jar
                        jar = ((JarURLConnection) url.openConnection()).getJarFile();
                        // 从此jar包 得到一个枚举类
                        Enumeration<JarEntry> entries = jar.entries();
                        findClassesInPackageByJar(packageName, entries, packageDirName, recursive, classes);
                    } catch (IOException e) {
                        // log.error("在扫描用户定义视图时从jar包获取文件出错");
                        e.printStackTrace();
                    }
                }
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        return classes;
    }

    private static void findClassesInPackageByJar(String packageName, Enumeration<JarEntry> entries, String packageDirName, final boolean recursive, Set<Class<?>> classes) {
        // 同样的进行循环迭代
        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) {
                            // .error("添加用户自定义视图类错误 找不到此类的.class文件");
                            e.printStackTrace();
                        }
                    }
                }
            }
        }
    }

    private static void findClassesInPackageByFile(String packageName, String packagePath, final boolean recursive, Set<Class<?>> classes) {
        // 获取此包的目录 建立一个File
        File dir = new File(packagePath);
        // 如果不存在或者 也不是目录就直接返回
        if (!dir.exists() || !dir.isDirectory()) {
            // log.warn("用户定义包名 " + packageName + " 下没有任何文件");
            return;
        }
        // 如果存在 就获取包下的所有文件 包括目录
        File[] dirfiles = dir.listFiles(new FileFilter() {
            // 自定义过滤规则 如果可以循环(包含子目录) 或则是以.class结尾的文件(编译好的java类文件)
            @Override
            public boolean accept(File file) {
                return (recursive && file.isDirectory()) || (file.getName().endsWith(".class"));
            }
        });
        // 循环所有文件
        for (File file : dirfiles) {
            // 如果是目录 则继续扫描
            if (file.isDirectory()) {
                findClassesInPackageByFile(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));
                    // 经过回复同学的提醒，这里用forName有一些不好，会触发static方法，没有使用classLoader的load干净
                    classes.add(Thread.currentThread().getContextClassLoader().loadClass(packageName + '.' + className));
                } catch (ClassNotFoundException e) {
                    // log.error("添加用户自定义视图类错误 找不到此类的.class文件");
                    e.printStackTrace();
                }
            }
        }
    }

}