Spring学习-手写IOC(注解版)

一，内容说明

1.实现@Service注解和@Autowired（其他@controller @compent等等注解原理一样,只是将类注入到spring容器）

2.问题：如何创建自定义注解

3.问题：如何在框架启动时加载标有注解的类和属性(@Autowired标注在类的属性上)

二，原理说明

1.jdk1.4之后新增注解功能关键字@interface

2.在spring框架启动时，扫(项目路径下)所有的包，循环遍历所有类，使用反射获取类是否有注解@Service，如果有，则使用反射newInstance该类的实例，并将类名和类的实例存放在全局变量Map集合中

3.如果类的属性上有@Autowired，从全局变量Map获取该属性对应的实例，使用反射技术给类的该属性赋值field.set(object, newBean);

三，源码

1.自定义注解，名称可以自定义，一般为ExtAutowired 表示自己扩展的注解

package com.huajie.spring.annotation;

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.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD })
public @interface XwfAutowired {

}

package com.huajie.spring.annotation;

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 XwfService {
	 String value() default "";

}

2.ExtClassPathXmlApplicationContext 为了方便这里不模拟spring启动过程,这是核心类

package com.huajie.spring.ext;

import java.lang.reflect.Field;
import java.util.List;
import com.huajie.spring.annotation.XwfAutowired;
import com.huajie.spring.annotation.XwfService;
import com.huajie.utils.ClassUtil;
import java.util.concurrent.ConcurrentHashMap;
import org.apache.commons.lang.StringUtils;

public class ExtClassPathXmlApplicationContext {
	// 扫包范围
	private String packageName;
	private ConcurrentHashMap<String, Object> beans = null;

	public ExtClassPathXmlApplicationContext(String packageName) throws Exception {
		this.packageName = packageName;
		beans = new ConcurrentHashMap<String, Object>();
		// 初始化beans Service注解
		initBeans();
		// 初始化属性 及 Autowired注解
		initAttris();
	}

	private void initAttris() throws Exception {
		for (Object o : beans.keySet()) {
			System.out.println("key=" + o + " value=" + beans.get(o));
			// 依赖注入
			attriAssign(beans.get(o));
		}
	}

	// 初始化对象
	public void initBeans() throws IllegalArgumentException, IllegalAccessException {
		// 1.扫包
		List<Class<?>> classes = ClassUtil.getClasses(packageName);
		// 2.判断是否有注解
		ConcurrentHashMap<String, Object> findClassExisAnnotation = findClassExisAnnotation(classes);
		if (findClassExisAnnotation == null || findClassExisAnnotation.isEmpty()) {
			throw new RuntimeException("该包下没有这个注解");
		}
	}

	public Object getBean(String beanId) throws Exception {
		if (beanId == null || StringUtils.isEmpty(beanId)) {
			throw new RuntimeException("beanId不能为空");
		}
		Object class1 = beans.get(beanId);
		if (class1 == null) {
			throw new RuntimeException("该包下没有BeanId为" + beanId + "的类");
		}
		return class1;
	}

	// 是否有注解
	public ConcurrentHashMap<String, Object> findClassExisAnnotation(List<Class<?>> classes)
			throws IllegalArgumentException, IllegalAccessException {
		for (Class<?> class1 : classes) {
			XwfService annotation = class1.getAnnotation(XwfService.class);
			if (annotation != null) {
				// beanId 类名小写
				String beanId = annotation.value();
				if (StringUtils.isEmpty(beanId)) {
					// 获取当前类名
					beanId = toLowerCaseFirstOne(class1.getSimpleName());
				}
				Object newInstance = newInstance(class1);
				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();
	}

	// 通过反射生成对象
	public Object newInstance(Class<?> classInfo) {
		try {
			return classInfo.newInstance();
		} catch (Exception e) {
			throw new RuntimeException("反射生成对象失败" + e.getMessage());
		}
	}

	// 依赖注入实现原理
	public void attriAssign(Object object) throws Exception {
		// 1.使用反射机制获取当前类的所有属性
		Field[] declaredFields = object.getClass().getDeclaredFields();
		// 2.判断当前类是否存在注解
		for (Field field : declaredFields) {
			XwfAutowired annotation = field.getAnnotation(XwfAutowired.class);
			if (annotation != null) {
				// 获取属性名称
				String name = field.getName();
				// 根据beanName查找对象
				Object newBean = getBean(name);
				// 3.默认使用属性名称,查找bean容器对象
				if (object != null) {
					field.setAccessible(true);
					// 给属性赋值 将对象注入到 属性中
					field.set(object, newBean);
				}
			}
		}
	}
}

3.扫包工具类 ClassUtil.java 此为网上搜索版本

package com.huajie.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.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

public class ClassUtil {

	/**
	 * 取得某个接口下所有实现这个接口的类
	 */
	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 pack
	 * @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();
				}
			}
		}
	}
}

四，测试效果

客户端测试类

package com.huajie;

import com.huajie.service.UserService;
import com.huajie.spring.ext.ExtClassPathXmlApplicationContext;

public class TestApp {
	
	public static void main(String[] args) throws Exception {
		ExtClassPathXmlApplicationContext app = new ExtClassPathXmlApplicationContext("com.huajie.service");
		UserService userService = (UserService) app.getBean("userService");
		userService.add("test");
	}
	
}

impl实现类

package com.huajie.service.impl;

import com.huajie.service.OrderService;
import com.huajie.service.UserService;
import com.huajie.spring.annotation.XwfAutowired;
import com.huajie.spring.annotation.XwfService;

@XwfService(value = "userService")
public class UserServiceImpl implements UserService {
	@XwfAutowired
	private OrderService orderService;
	public int add(String a) {
		System.out.println("####UserServiceImpl====添加" + a);
		orderService.add();
		return 0;
	}

}

package com.huajie.service.impl;

import com.huajie.service.OrderService;
import com.huajie.spring.annotation.XwfService;

@XwfService(value = "orderService")
public class OrderServiceImpl implements OrderService {

	public void add() {
		System.out.println("####OrderServiceImpl====依赖注入添加");
	}

}

接口

package com.huajie.service;

import org.springframework.stereotype.Service;

@Service
public interface UserService {
    int add(String a);
}

package com.huajie.service;

public interface OrderService {
	void add();
}

测试结果截图

Spring学习-手写IOC(注解版)

猜你喜欢