尝试手写一个框架（一）手写一个Spring IOC框架

置顶歪桃

已于 2023-08-30 12:04:25 修改

阅读量9.4k

点赞数 20

分类专栏： Spring 手写框架文章标签： spring ioc

于 2020-06-10 11:37:08 首次发布

本文链接：https://blog.csdn.net/m0_37892044/article/details/106643842

版权

Spring 同时被 2 个专栏收录

16 篇文章 1 订阅

订阅专栏

手写框架

6 篇文章 2 订阅

订阅专栏

这里写目录标题

1、Spring容器

首选先介绍一个概念，叫做Spring容器，
Spring的核心容器：BeanFactory。
简单来说,BeanFactory就是一个管理Bean的工厂,主要负责初始化各种Bean,并调用它们的生命周期方法。
Spring的应用上下文：ApplicationContext
是BeanFactory的子接口,也被称为应用上下文,不仅包含了BeanFactory的所有功能,还添加了对国际化、资源访问、事件传播等方面的支持。
创建Spring上下文：
ClassPathXmlApplicationContext：从类路径创建；
FileSystemXmlApplicationContext：从文件真实地址路径创建（C:\Users\hutao）

ApplicationContext applicationContext = new ClassPathXmlApplicationContext(String configLocation);

在这里插入图片描述

2、Spring IOC实现原理

反射+XML+容器。首先先上一张图。
在这里插入图片描述
1、当web容器启动的时候，Spring的全局bean的管理器会去xml配置文件中扫描的包下面获取到所有的类；
2、根据你使用的注解，进行对应的封装，封装到全局的bean容器中进行管理，一旦容器初始化完毕，beanID以及bean实例化的类对象信息就全部存在了；
3、现在我们需要在某个service里面调用另一个bean的某个方法的时候，我们只需要依赖注入进来另一个bean的Id即可；
4、调用的时候，spring会去初始化完成的bean容器中获取即可，如果存在就把依赖的bean的类的实例化对象返回给你，你就可以调用依赖的bean的相关方法或属性等。

3、手写Spring IOC

3.1回顾我们平时使用的Spring

在spring项目中，我们会在web.XML中配置我们的Spring容器
如下
在这里插入图片描述
在Spring容器中指定我们需要扫描class类文件的路径

在接口实现类上添加Service注解

在我们需要用到的地方，注入Spring给我们创建好的对象。

有了以上知识点，现在我们就可以来手动写我们自己的Spring IOC了，在开始手写之前，先想一想，我们需要有哪些工作需要做？
1、需要去构造一个Spring容器：ClassPathXmlApplicationContext；
2、需要注解定义两个注解：@Service、@Resource；
3、使用反射的手段读取指定目录下的class信息，解析Class信息；
4、对Class信息的注解做处理；
5、以键值对的方式创建beanID，bean对象，并且放到容器中；
6、使用的时候通过beanID获取Bean对象。

3.2手写Spring IOC

代码空间目录如下
在这里插入图片描述

3.2.1模拟Spring容器

我们使用一个Map来模拟bean的容器
String就是这个bean对象的ID；
Object就是这个SpringIOC给我们创建的对象

public class ClassPathXmlApplicationContext {
	/**
	 * Spring扫描包的范围
	 */
	private String packageName;

	/**
	 *  Spring存放bean对象的容器，使用并发的hashMap来模拟
	 */
	private ConcurrentHashMap<String, Object> beanContainer = null;

	public ClassPathXmlApplicationContext(String packageName) throws Exception {
		beanContainer = new ConcurrentHashMap<String, Object>();
		this.packageName = packageName;
		}
}

3.2.2模拟@Service、@Resource注解

@Resource
@Target({ TYPE, FIELD, METHOD })
@Retention(RUNTIME)
public @interface Resource 
}
@Service
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface Service {
}

3.2.3模拟Spring容器启动

下面这个写法，相信很熟悉吧，是不是单独学习Spring的时候，老师使用的方式？实际项目中的话，我们一般会配置为随着服务器启动，配置到web.xml中

public class TestSpring {
	
	public static void main(String[] args) throws Exception {
		ClassPathXmlApplicationContext app = new ClassPathXmlApplicationContext("com.sunwise.alm.springIOC.springIOC.service.impl");
		HuTaoTaoService huTaoTaoService = (HuTaoTaoService) app.getBean("huTaoTaoServiceImpl");
		huTaoTaoService.helloHutao();
	}
}

3.2.4编写pring容器代码

/**
 * @Description Spring容器注解版本
 * @author hutao
 * @mail hutao_2017@aliyun.com
 * @date 2020年6月9日
 */
public ClassPathXmlApplicationContext(String packageName) throws Exception {
		beanContainer = new ConcurrentHashMap<String, Object>();
		this.packageName = packageName;
		/*
		 * 1.使用java的反射机制扫包,获取当前包下所有的类(工具类，无需多花精力)
		 */
		List<Class<?>> listClass = ClassUtil.getClasses(packageName);
		/*
		 * 2.获取所有Class上面存在我们定义的 @Service 注解类,
		 *   以@Service修饰的类名（首字母小写）作为beanID,
		 *   并且以这个类创建一个对象作为bean对象
		 *   把创建的这些对象放到我们定义的 beanContainer(存放bean对象的容器)
		 */
		findClassExisAnnotationService(listClass);
		/*
		 * 3.扫描所有@Service修饰的类，看是否存在有@Resource修饰的属性
		 *   如果有，就从beanContainer容器中取出@Resource所修饰类的对象作为自己的变量。
		 */
		initEntryField();
	}

3.2.5找到存在@Service注解的类

	/**
	 * @Description 找到类上面存在注入bean的注解的class
	 * @author hutao
	 * @mail hutao_2017@aliyun.com
	 * @date 2020年6月9日
	 */ 
	public ConcurrentHashMap<String, Object> findClassExisAnnotationService(List<Class<?>> classes) throws Exception {
		for (Class<?> classInfo : classes) {
			// 判断类上是否有注解
			Service annotation = classInfo.getAnnotation(Service.class);
			if (annotation != null) {
				// 获取当前类名
				String className = classInfo.getSimpleName();
				// 将当前类名变为小写
				String beanId = toLowerCaseFirstOne(className);
				Object newInstance = newInstance(classInfo);
				beanContainer.put(beanId, newInstance);
			}
		}
		return beanContainer;
	}

3.2.6找到存在@Resource注解的属性

	private void initEntryField() throws Exception {
		// 1.遍历所有的bean容器对象
		for (Entry<String, Object> entry : beanContainer.entrySet()) {
			Object bean = entry.getValue();
			// 2.判断属性上面是否有加Resource注解
			attriAssign(bean);
		}
	}
	
	/**
	 * @Description Dependency injection依赖注入 注解原理
	 * @author hutao
	 * @mail hutao_2017@aliyun.com
	 * @date 2020年6月9日
	 */ 
	public void attriAssign(Object object) throws Exception {
		// 1.使用反射机制,获取当前类的所有属性
		Class<? extends Object> classInfo = object.getClass();
		Field[] declaredFields = classInfo.getDeclaredFields();

		// 2.判断当前类的属性是否存在注解
		for (Field field : declaredFields) {
			Resource extResource = field.getAnnotation(Resource.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);
				}
			}
		}
	}
	/**
	 * @Description Dependency injection依赖注入 注解原理
	 * @author hutao
	 * @mail hutao_2017@aliyun.com
	 * @date 2020年6月9日
	 */ 
	public void attriAssign(Object object) throws Exception {
		// 1.使用反射机制,获取当前类的所有属性
		Class<? extends Object> classInfo = object.getClass();
		Field[] declaredFields = classInfo.getDeclaredFields();

		// 2.判断当前类的属性是否存在注解
		for (Field field : declaredFields) {
			Resource extResource = field.getAnnotation(Resource.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);
				}
			}
		}
	}
		/**
	 * @Description 首字母转小写
	 * @author hutao
	 * @mail hutao_2017@aliyun.com
	 * @date 2020年6月9日
	 */ 
	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();
	}
		/**
	 * @Description 创建对象
	 * @author hutao
	 * @mail hutao_2017@aliyun.com
	 * @date 2020年6月9日
	 */ 
	public Object newInstance(Class<?> classInfo) throws ClassNotFoundException, InstantiationException, IllegalAccessException {
		return classInfo.newInstance();
	}
		/**
	 * @Description 根据beanID获取bean对象
	 * @author hutao
	 * @mail hutao_2017@aliyun.com
	 * @date 2020年6月9日
	 */
	public Object getBean(String beanId) throws Exception {
		if (StringUtils.isEmpty(beanId)) {
			throw new Exception("beanId参数不能为空");
		}
		//spring容器获取bean
		return beanContainer.get(beanId);
	}

3.2.7工具类

public class ClassUtil {


	/**
	 * @Description 根据文件名获取class文件
	 * @author hutao
	 * @date 2019年10月25日
	 */
	public static List<Class<?>> getClasses(List<String> list) {

		// 第一个class类的集合
		List<Class<?>> classes = new ArrayList<Class<?>>();
		try {
			for(String controllerName : list) {
				Class<?> controllerClass = Class.forName(controllerName);
				classes.add(controllerClass);
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
		return classes;
	}

	/**
	 * @Description 首字母变小写
	 * @author hutao
	 * @date 2019年10月25日
	 */
	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();
	}

	/**
	 * @Description 初始化对象
	 * @author hutao
	 * @date 2019年10月25日
	 */
	public static Object newInstance(Class<?> classInfo)
			throws ClassNotFoundException, InstantiationException, IllegalAccessException {
		return classInfo.newInstance();
	}
	
	/**
	 * @Description 根据包名获取包路径下的class
	 * @author hutao
	 * @date 2019年10月27日
	 */
	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();
				}
			}
		}
	}

}

3.2.8演示

public interface HuTaoTaoService {
	
	public void helloHutao();
	
}

public interface ZhangHuanHuanService {
	
	public void helloZhangHuan();
	
}

@Service
public class ZhangHuanHuanServiceImpl implements ZhangHuanHuanService{

	@Override
	public void helloZhangHuan() {
		
		System.out.println("hello 张欢");
		
	}
	
}

@Service
public class HuTaoTaoServiceImpl implements HuTaoTaoService{
	
	@Resource
	private ZhangHuanHuanService zhangHuanHuanServiceImpl;

	@Override
	public void helloHutao() {
		
		System.out.println("hello 胡涛");
		
		zhangHuanHuanServiceImpl.helloZhangHuan();
	}

}