手写SpringIOC容器框架[email protected]和@Resource实现
微信公众号：用心程序员
简介
Spring框架 作为一个轻量级的开源框架不仅给我们的开发工作带来了许多便利，同时也为众多开源框架的研究提供了不可或缺的指导思想。Spring最为核心的两大功能特性就是IOC和AOP.下面主要介绍SpringIOC及自己实现SpringIOC
一、SpringIOC
SpringIOC 指的是控制反转，就是把原先我们代码里面需要实现的对象创建、依赖的代码，反转给容器来帮忙实现。那么必然的我们需要创建一个容器，同时需要一种描述来让容器知道需要创建的对象与对象的关系。这个描述最具体表现就是我们可配置的文件。
IOC容器 负责实例化、定位、配置应用程序中的对象及建立这些对象间的依赖。交由Spring来管理这些，实现解耦
二、手写SpringIOC容器框架（XML版本）
实现原理：使用dom4j解析配置文件+反射机制实现
XML方式注入对象思路
- 解析XML配置文件
- 使用方法参数beanid查找配置文件中bean节点的id一致的
- 获取class信息地址，使用反射机制初始化，实现注入
具体实现过程
- 第一步 编写ExtClassPathXmlApplicationContext，实现注入
/**
* XML方式注入bean
*/
public class ExtClassPathXmlApplicationContext {
// xml路径地址
private String xmlPath;
public ExtClassPathXmlApplicationContext(String xmlPath) {
this.xmlPath = xmlPath;
}
public Object getBean(String beanId) throws Exception {
// 1. 读取配置文件
List<Element> elements = readerXml();
if (elements == null) {
throw new Exception("该配置文件没有子元素");
}
// 2. 使用beanId查找对应的class地址
String beanClass = findXmlByIDClass(elements, beanId);
if (StringUtils.isEmpty(beanClass)) {
throw new Exception("未找到对应的class地址");
}
// 3. 使用反射机制初始化，对象
Class<?> forName = Class.forName(beanClass);
return forName.newInstance();
}
// 读取配置文件信息
public List<Element> readerXml() throws DocumentException {
SAXReader saxReader = new SAXReader();
if (StringUtils.isEmpty(xmlPath)) {
new Exception("xml路径为空...");
}
Document read = saxReader.read(getClassXmlInputStream(xmlPath));
// 获取根节点信息
Element rootElement = read.getRootElement();
// 获取子节点
List<Element> elements = rootElement.elements();
if (elements == null || elements.isEmpty()) {
return null;
}
return elements;
}
// 使用beanid查找该Class地址
public String findXmlByIDClass(List<Element> elements, String beanId) throws Exception {
for (Element element : elements) {
// 读取节点上是否有value
String beanIdValue = element.attributeValue("id");
if (beanIdValue == null) {
throw new Exception("使用该beanId为查找到元素");
}
if (!beanIdValue.equals(beanId)) {
continue;
}
// 获取Class地址属性
String classPath = element.attributeValue("class");
if (!StringUtils.isEmpty(classPath)) {
return classPath;
}
}
return null;
}
// 读取xml配置文件
public InputStream getClassXmlInputStream(String xmlPath) {
InputStream resourceAsStream = getClass().getClassLoader().getResourceAsStream(xmlPath);
return resourceAsStream;
}
}
- 第二步 测试
1. 编写测试类User
public class User {
private String name;
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
2. 编写测试文件spring.xml
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
xsi:schemaLocation="http://www.springframework.org/schema/beans">
<bean id="user" class="com.ljx.entity.User"></bean>
</beans>
3. 编写测试类Test01
public class Test01 {
public static void main(String[] args) throws Exception{
ExtClassPathXmlApplicationContext applicationContext = new ExtClassPathXmlApplicationContext("spring.xml");
User user = (User) applicationContext.getBean("user");
System.out.println(user);
}
}
三、手写SpringIOC容器框架（注解版本）
注解方式注入对象思路
- 使用java反射机制扫包，获取当前包下所有类
- 判断类上是否存在注入bean的注解
- 使用java反射机制进行初始化，实现注入
依赖注入基本思路
- 使用java反射机制，获取当前类下的所有属性
- 判断当前类属性是否存在注解
- 查找bean容器对象（默认使用属性名称查找）
具体实现过程
- 第一步 编写对象注入注解@ExtService
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ExtService {
}
- 第二步 编写依赖注入注解@ExtResource
@Target({ ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface ExtResource {
}
- 第三步 反射类工具
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();
}
}
}
}
}
- 第四步 编写ExtClassPathXmlApplicationContext，实现对象注入和依赖注入
public class ExtClassPathXmlApplicationContext {
// 扫包范围
private String packageName;
ConcurrentHashMap<String, Object> initBean = null;
public ExtClassPathXmlApplicationContext(String packageName) {
this.packageName = packageName;
}
// 使用beanID查找对象
public Object getBean(String beanId) throws Exception {
// 1.使用反射机制获取该包下所有的类已经存在bean的注解类
List<Class> listClassesAnnotation = findClassExisService();
if (listClassesAnnotation == null || listClassesAnnotation.isEmpty()) {
throw new Exception("没有需要初始化的bean");
}
// 2.使用Java反射机制初始化对象
initBean = initBean(listClassesAnnotation);
if (initBean == null || initBean.isEmpty()) {
throw new Exception("初始化bean为空!");
}
// 3.使用beanID查找查找对应bean对象
Object object = initBean.get(beanId);
// 4.使用反射读取类的属性,赋值信息
attriAssign(object);
return object;
}
// 使用反射读取类的属性,赋值信息
public void attriAssign(Object object) throws IllegalArgumentException, IllegalAccessException {
// 1.获取类的属性是否存在 获取bean注解
Class<? extends Object> classInfo = object.getClass();
Field[] declaredFields = classInfo.getDeclaredFields();
for (Field field : declaredFields) {
// 属性名称
String name = field.getName();
// 2.使用属性名称查找bean容器赋值
Object bean = initBean.get(name);
if (bean != null) {
// 私有访问允许访问
field.setAccessible(true);
// 给属性赋值
field.set(object, bean);
continue;
}
}
}
// 使用反射机制获取该包下所有的类已经存在bean的注解类
public List<Class> findClassExisService() throws Exception {
// 1.使用反射机制获取该包下所有的类
if (StringUtils.isEmpty(packageName)) {
throw new Exception("扫包地址不能为空!");
}
// 2.使用反射技术获取当前包下所有的类
List<Class<?>> classesByPackageName = ClassUtil.getClasses(packageName);
// 3.存放类上有bean注入注解
List<Class> exisClassesAnnotation = new ArrayList<Class>();
// 4.判断该类上属否存在注解
for (Class classInfo : classesByPackageName) {
ExtService extService = (ExtService) classInfo.getDeclaredAnnotation(ExtService.class);
if (extService != null) {
exisClassesAnnotation.add(classInfo);
continue;
}
}
return exisClassesAnnotation;
}
// 初始化bean对象
public ConcurrentHashMap<String, Object> initBean(List<Class> listClassesAnnotation)
throws InstantiationException, IllegalAccessException {
ConcurrentHashMap concurrentHashMap = new ConcurrentHashMap<String, Object>();
for (Class classInfo : listClassesAnnotation) {
// 初始化对象
Object newInstance = classInfo.newInstance();
// 获取父类名称
String beanId = toLowerCaseFirstOne(classInfo.getSimpleName());
concurrentHashMap.put(beanId, newInstance);
}
return concurrentHashMap;
}
// 首字母转小写
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();
}
}
- 第五步 测试
1. 编写service层
@ExtService
public class UserService {
@ExtResource
private OrderService orderServiceImpl; //不能用orderService只能用orderServiceImpl，需改进
public void addUser(){
orderServiceImpl.addOrder();
System.out.println("使用反射机制初始化对象");
}
}
@ExtService
public class OrderServiceImpl implements OrderService {
@Override
public void addOrder() {
System.out.println("addOrder");
}
}
2. 编写测试类Test03
public class Test03 {
public static void main(String[] args) throws Exception{
ExtClassPathXmlApplicationContext applicationContext = new ExtClassPathXmlApplicationContext("com.ljx.service");
UserService userService = (UserService) applicationContext.getBean("userService");
userService.addUser();
System.out.println(userService);
}
}
项目源码： https://github.com/ljx95/SpringIOCDemo