代码实现SpringIOC与@Resource功能
本文中将通过自定义的代码实现SpringIOC的XML与注解版本，并且实现@Resource的倚赖注入功能，通过该代码的实现能够更好的理解Spring在该内容的思想原理。
1. 什么是SpringIOC
spring ioc指的是控制反转，IOC容器负责实例化、定位、配置应用程序中的对象及建立这些对象间的依赖。交由Spring来管理这些，实现解耦
2. 手写SpringIOCXML版本
实现思路：
- 读取配置文件 spring.xml
- 使用beanId查找对应的class地址
- 使用反射机制初始化对象
由于需要解析xml文件，所以添加dom4j倚赖
<!-- https://mvnrepository.com/artifact/dom4j/dom4j -->
<dependency>
<groupId>dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>1.6.1</version>
</dependency>
<!-- https://mvnrepository.com/artifact/commons-lang/commons-lang -->
<dependency>
<groupId>commons-lang</groupId>
<artifactId>commons-lang</artifactId>
<version>2.6</version>
</dependency>
/**
* XML方式注入bean*
*/
public class MyClassPathXmlApplicationContext {
// xml路径地址
private String xmlPath;
public MyClassPathXmlApplicationContext(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;
}
}
spring.xml
<beans>
<bean id="user" class="org.example.entity.User">bean>
beans>
实体类可自行定义
自定义完成后进行测试：
public static void main(String[] args) throws Exception {
MyClassPathXmlApplicationContext applicationContext = new MyClassPathXmlApplicationContext("spring.xml");
User user = (User) applicationContext.getBean("user");
System.out.println(user);//org.example.entity.User@7699a589
}
总结：xml版本逻辑较为简单，仅需传入配置文件路径和beanId即可，使用xml解析技术找到对应的类路径再通过反射进行实例化，而下面的注解版本将会相较复杂些。
3. 手写SpringIOC注解版本与@Resource
实现思路：首先根据包的路径把添加了注解的bean扫描出来，使用反射进行初始化，再将bean存储于容器中。
然后倚赖注入时，遍历所有bean，并判断该bean中的字段是否有添加了@Resource注解，如果有将利用反射机制对该字段进行赋值。
定义注解：
// 自定义注解 注入到Spring容器
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface ExtService {
}
//自定义注解 从Spring容器获取bean
@Target({ ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface ExtResource {
}
可以看出我们要实现的其实就是这两个注解的功能，前者是Spring提供的@service注解，添加该注解能被扫描到Spring的容器中，后者是jdk提供的@resource注解，该注解能以名称注入。
// 手写SpringIOC 注解版本
public class MyClassPathXmlApplicationContext {
// 扫包的范围
private String packageName;
// springbean容器
private ConcurrentHashMap<String, Object> beans = null;
public MyClassPathXmlApplicationContext(String packageName) throws Exception {
beans = new ConcurrentHashMap<>();
this.packageName = packageName;
initBeans();
initEntryField();
}
// 初始化属性
private void initEntryField() throws Exception {
// 1.遍历所有的bean容器对象
for (Map.Entry<String, Object> entry : beans.entrySet()) {
Object bean = entry.getValue();
// 2.判断属性上面是否有加注解
attriAssign(bean);
}
}
public Object getBean(String beanId) throws Exception {
if (StringUtils.isEmpty(beanId)) {
throw new Exception("beanId参数不能为空");
}
// 1.从spring容器获取bean
Object object = beans.get(beanId);
// attriAssign(object);
return object;
}
// 初始化对象
public Object newInstance(Class<?> classInfo)
throws ClassNotFoundException, InstantiationException, IllegalAccessException {
return classInfo.newInstance();
}
// 初始化对象
public void initBeans() throws Exception {
// 1.使用java的反射机制扫包,获取当前包下所有的类
List<Class<?>> classes = ClassUtil.getClasses(packageName);
// 2.判断类上是否存在注入bean的注解
ConcurrentHashMap<String, Object> classExisAnnotation = findClassExisAnnotation(classes);
if (classExisAnnotation == null || classExisAnnotation.isEmpty()) {
throw new Exception("该包下没有任何类加上注解");
}
}
// 判断类上是否存在注入bean的注解
public ConcurrentHashMap<String, Object> findClassExisAnnotation(List<Class<?>> classes) throws Exception {
for (Class<?> classInfo : classes) {
// 判断类上是否有注解
ExtService annotation = classInfo.getAnnotation(ExtService.class);
if (annotation != null) {
// 获取当前类名
String className = classInfo.getSimpleName();
// 获得beanId，首字母变小写
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();
}
// 依赖注入注解
public void attriAssign(Object object) throws Exception {
// 1.使用反射机制,获取当前类的所有属性
Class<? extends Object> classInfo = object.getClass();
Field[] declaredFields = classInfo.getDeclaredFields();
// 2.判断当前类属性是否存在注解
for (Field field : declaredFields) {
ExtResource extResource = field.getAnnotation(ExtResource.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);
}
}
}
}
}
其中使用了一个反射工具类，类中的getClasses（）方法可以仅传入包名便能遍历出所有的class,如下：
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 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();
}
}
}
}
}
创建好service层：
public interface UserService {
public void add();
}
//将该类注入到spring容器里面
@ExtService
public class UserServiceImpl implements UserService {
// 从Spring容器中读取bean
@ExtResource
private OrderService orderServiceImpl;
public void add() {
orderServiceImpl.addOrder();
System.out.println("我是使用反射机制运行的方法");
}
}
public interface OrderService {
public void addOrder();
}
@ExtService
public class OrderServiceImpl implements OrderService {
@Override
public void addOrder() {
System.out.println("addOrder");
}
}
进行测试：
public static void main(String[] args) throws Exception {
ClassPathXmlApplicationContext app = new ClassPathXmlApplicationContext("org.example.service.impl");
UserService userService = (UserService) app.getBean("userServiceImpl");
userService.add();
System.out.println(userService);
}
成功注入，大功告成