[Spring] 如何实现一个低配版`Spring BeanFactory`？

2023-12-22 01:38
文章标签 java 实现 spring beanfactory 低配

本文主要是介绍[Spring] 如何实现一个低配版`Spring BeanFactory`？，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

如何实现一个低配版Spring BeanFactory？

目录

  • 如何实现一个低配版`Spring BeanFactory`？
    • 准备工作
    • 核心源码
    • 效果
    • 总结
    • 更多

手机用户请横屏获取最佳阅读体验，REFERENCES中是本文参考的链接，如需要链接和更多资源，可以关注其他博客发布地址。

平台地址
CSDNhttps://blog.csdn.net/sinat_28690417
简书https://www.jianshu.com/u/3032cc862300
个人博客https://yiyuery.club

结合Spring BeanFactory实例扫描和注入思想进行深入编码实战：工厂化管理运行中实例对象

准备工作

  • 包扫描工具类定义
/** @ProjectName: 编程学习* @Copyright:   2019 HangZhou xiazhaoyang Dev, Ltd. All Right Reserved.* @address:     http://xiazhaoyang.tech* @date:        2019/5/20 20:57* @email:       https:yiyuery.github.io/NoteBooks* @description: 本内容仅限于编程技术学习使用，转发请注明出处.*/
package com.example.swagger.common.component;import lombok.extern.slf4j.Slf4j;import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.jar.JarEntry;
import java.util.jar.JarInputStream;/*** <p>*	扫描指定路径下class* </p>** @author xiazhaoyang* @version v1.0.0* @date 2019-06-05 22:46* @modificationHistory=========================逻辑或功能性重大变更记录* @modify By: {修改人} 2019-06-05* @modify reason: {方法名}:{原因}* ...*/
@Slf4j
public class ClasspathPackageScanner {private String basePackage;private ClassLoader cl;/*** Construct an instance and specify the base package it should scan.* @param basePackage The base package to scan.*/public ClasspathPackageScanner(String basePackage) {this.basePackage = basePackage;this.cl = getClass().getClassLoader();}/*** Construct an instance with base package and class loader.* @param basePackage The base package to scan.* @param cl Use this class load to locate the package.*/public ClasspathPackageScanner(String basePackage, ClassLoader cl) {this.basePackage = basePackage;this.cl = cl;}/*** Get all fully qualified names located in the specified package* and its sub-package.** @return A list of fully qualified names.* @throws IOException*/public List<String> getFullyQualifiedClassNameList() throws IOException {log.info("Start Scan...", basePackage);return doScan(basePackage, new ArrayList<>());}/*** Actually perform the scanning procedure.** @param basePackage* @param nameList A list to contain the result.* @return A list of fully qualified names.** @throws IOException*/private List<String> doScan(String basePackage, List<String> nameList) throws IOException {// replace dots with splashesString splashPath = StringUtil.dotToSplash(basePackage);// get file pathURL url = cl.getResource(splashPath);String filePath = StringUtil.getRootPath(url);// Get classes in that package.// If the web server unzips the jar file, then the classes will exist in the form of// normal file in the directory.// If the web server does not unzip the jar file, then classes will exist in jar file.// contains the name of the class file. e.g., Apple.class will be stored as "Apple"List<String> names = null;if (isJarFile(filePath)) {// jar fileif (log.isDebugEnabled()) {log.debug("{} fina a jar file", filePath);}names = readFromJarFile(filePath, splashPath);} else {// directoryif (log.isDebugEnabled()) {log.debug("{} find a directory", filePath);}names = readFromDirectory(filePath);}for (String name : names) {if (isClassFile(name)) {nameList.add(toFullyQualifiedName(name, basePackage));} else {// this is a directory// check this directory for more classes// do recursive invocationdoScan(basePackage + "." + name, nameList);}}if (log.isDebugEnabled()) {for (String n : nameList) {log.debug("load {}", n);}}return nameList;}/*** Convert short class name to fully qualified name.* e.g., String -> java.lang.String*/private String toFullyQualifiedName(String shortName, String basePackage) {StringBuilder sb = new StringBuilder(basePackage);sb.append('.');sb.append(StringUtil.trimExtension(shortName));return sb.toString();}private List<String> readFromJarFile(String jarPath, String splashedPackageName) throws IOException {if (log.isDebugEnabled()) {log.debug("从JAR包中读取类: {}", jarPath);}JarInputStream jarIn = new JarInputStream(new FileInputStream(jarPath));JarEntry entry = jarIn.getNextJarEntry();List<String> nameList = new ArrayList<>();while (null != entry) {String name = entry.getName();if (name.startsWith(splashedPackageName) && isClassFile(name)) {nameList.add(name);}entry = jarIn.getNextJarEntry();}return nameList;}private List<String> readFromDirectory(String path) {File file = new File(path);String[] names = file.list();if (null == names) {return null;}return Arrays.asList(names);}private boolean isClassFile(String name) {return name.endsWith(".class");}private boolean isJarFile(String name) {return name.endsWith(".jar");}/*** For test purpose.*/public static void main(String[] args) throws Exception {ClasspathPackageScanner scan = new ClasspathPackageScanner("com.example.swagger");scan.getFullyQualifiedClassNameList();}
}class StringUtil{private StringUtil() {}/*** "file:/home/whf/cn/fh" -> "/home/whf/cn/fh"* "jar:file:/home/whf/foo.jar!cn/fh" -> "/home/whf/foo.jar"*/public static String getRootPath(URL url) {String fileUrl = url.getFile();int pos = fileUrl.indexOf('!');if (-1 == pos) {return fileUrl;}return fileUrl.substring(5, pos);}/*** "cn.fh.lightning" -> "cn/fh/lightning"* @param name* @return*/public static String dotToSplash(String name) {return name.replaceAll("\\.", "/");}/*** "Apple.class" -> "Apple"*/public static String trimExtension(String name) {int pos = name.indexOf('.');if (-1 != pos) {return name.substring(0, pos);}return name;}/*** /application/home -> /home* @param uri* @return*/public static String trimURI(String uri) {String trimmed = uri.substring(1);int splashIndex = trimmed.indexOf('/');return trimmed.substring(splashIndex);}
}
  • 自动注入注解定义AutoRegister： 类似于Spring的@Component注解
/** @ProjectName: 编程学习* @Copyright:   2019 HangZhou xiazhaoyang Dev, Ltd. All Right Reserved.* @address:     http://xiazhaoyang.tech* @date:        2019/5/20 20:57* @email:       https:yiyuery.github.io/NoteBooks* @description: 本内容仅限于编程技术学习使用，转发请注明出处.*/
package com.example.swagger.api;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;/*** <p>*	自动注入注解定义`AutoRegister`： 类似于`Spring`的`@Component`注解* </p>** @author xiazhaoyang* @version v1.0.0* @date 2019-06-05 21:46* @modificationHistory=========================逻辑或功能性重大变更记录* @modify By: {修改人} 2019-06-05* @modify reason: {方法名}:{原因}* ...*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface AutoRegister {String name() default "";
}
  • 配置类属性填充注解定义PropNameSpace ，读取Properties前缀自动注入
/** @ProjectName: 编程学习* @Copyright:   2019 HangZhou xiazhaoyang Dev, Ltd. All Right Reserved.* @address:     http://xiazhaoyang.tech* @date:        2019/5/20 20:57* @email:       https:yiyuery.github.io/NoteBooks* @description: 本内容仅限于编程技术学习使用，转发请注明出处.*/
package com.example.swagger.api;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;/*** <p>*	配置类属性填充注解定义`PropNameSpace` ，读取`Properties`前缀自动注入* </p>** @author xiazhaoyang* @version v1.0.0* @date 2019-06-05 21:43* @modificationHistory=========================逻辑或功能性重大变更记录* @modify By: {修改人} 2019-06-05* @modify reason: {方法名}:{原因}* ...*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface PropNameSpace {/*** 入参前缀* @return*/String prefix() default "";
}
  • 实例工厂定义
/** @ProjectName: 编程学习* @Copyright:   2019 HangZhou xiazhaoyang Dev, Ltd. All Right Reserved.* @address:     http://xiazhaoyang.tech* @date:        2019/5/20 20:57* @email:       https:yiyuery.github.io/NoteBooks* @description: 本内容仅限于编程技术学习使用，转发请注明出处.*/
package com.example.swagger.common.context;import java.util.HashMap;
import java.util.Map;/*** <p>** </p>** @author xiazhaoyang* @version v1.0.0* @date 2019-06-05 22:45* @modificationHistory=========================逻辑或功能性重大变更记录* @modify By: {修改人} 2019-06-05* @modify reason: {方法名}:{原因}* ...*/
public class AppBeanContext {private static class SingletonHolder {private static final AppBeanContext INSTANCE = new AppBeanContext();}public static final AppBeanContext getInstance() {return SingletonHolder.INSTANCE;}private static final Map<String, Object> HOLDER = new HashMap<>();/*** 注册实例* @param name* @param bean*/public void registerBean(String name, Object bean) {if (HOLDER.containsKey(name)) {throw new IllegalStateException("bean repetition register!");}HOLDER.putIfAbsent(name, bean);}/*** 获取实例* @param name* @param clazz* @param <T>* @return*/public <T> T getBean(String name, Class<T> clazz) {if (!HOLDER.containsKey(name)) {throw new IllegalArgumentException("bean repetition register!");}return clazz.cast(HOLDER.get(name));}
}

思路

  • 首先通过指定package路径下的class文件扫描
  • 然后通过自定义注解完成，判断是否需要自动注入。
  • 如果含有AutoRegister注解，则通过反射生成实例并存放到实例工厂中
  • 如果含有PropNameSpace注解，则自动读取yaml文件中的属性来进行填充

核心源码

  • 启动初始化类
/** @ProjectName: 编程学习* @Copyright:   2019 HangZhou xiazhaoyang Dev, Ltd. All Right Reserved.* @address:     https:yiyuery.club* @date:        2019/5/20 20:57* @email:       xiazhaoyang@live.com* @description: 本内容仅限于编程技术学习使用，转发请注明出处.*/
package com.example.swagger.common.component;import com.example.swagger.api.AutoRegister;
import com.example.swagger.api.ITransformPlugin;
import com.example.swagger.api.PropNameSpace;
import com.example.swagger.common.base.AbstractOfficeTransformPlugin;
import com.example.swagger.common.base.AbstractSwaggerTransformPlugin;
import com.example.swagger.common.configuration.ApplicationYamlLoader;
import com.example.swagger.common.configuration.OfficeTransformConfig;
import com.example.swagger.common.context.AppBeanContext;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;import java.lang.reflect.Field;
import java.util.List;/*** <p>*  启动初始化类* </p>** @author xiazhaoyang* @version v1.0.0* @date 2019-06-07 05:33* @modificationHistory=========================逻辑或功能性重大变更记录* @modify By: {修改人} 2019-06-07* @modify reason: {方法名}:{原因}* ...*/
@Slf4j
public class AppStarterInitial {static {log.info("start init...");beforeStart();log.info("end init...");}private static void beforeStart() {try {ClasspathPackageScanner scan = new ClasspathPackageScanner("com.example.swagger");List<String> classNames = scan.getFullyQualifiedClassNameList();for (String clazz : classNames) {Class<?> c = Thread.currentThread().getContextClassLoader().loadClass(clazz);if (c.getAnnotations().length > 0) {//获取自动注入对象if (c.getAnnotationsByType(AutoRegister.class).length > 0) {Object bean = c.newInstance();//遍历属性中所有FieldString prefixKey = "";if (c.getAnnotationsByType(PropNameSpace.class).length > 0) {PropNameSpace[] annotationsByType = c.getAnnotationsByType(PropNameSpace.class);prefixKey = annotationsByType[0].prefix();}Field[] declaredFields = c.getDeclaredFields();for (Field field : declaredFields) {field.setAccessible(Boolean.TRUE);String filedKey = field.getAnnotationsByType(JsonProperty.class).length > 0 ? field.getAnnotationsByType(JsonProperty.class)[0].value() : field.getName();String propKey = prefixKey + "." + filedKey;field.set(bean, ApplicationYamlLoader.getPropsByKey(propKey,field.getType()));}String beanName = c.getAnnotationsByType(AutoRegister.class)[0].name();AppBeanContext.getInstance().registerBean(StringUtils.isNotBlank(beanName)?beanName: StringUtils.lowerCase(c.getSimpleName()).substring(0,1)+c.getSimpleName().substring(1),bean);}}}} catch (Throwable e) {log.error("init error", e);}}
}

这个主要为了完成实例自动扫描和注入、参数配置类自动扫描填充参数的功能。

项目启动类集成这个类即可在实例化之前触发对应实例并注入到实例工厂中以备使用。

/** @ProjectName: 编程学习* @Copyright:   2019 HangZhou xiazhaoyang Dev, Ltd. All Right Reserved.* @address:     http://xiazhaoyang.tech* @date:        2019/5/20 20:57* @email:       https:yiyuery.github.io/NoteBooks* @description: 本内容仅限于编程技术学习使用，转发请注明出处.*/
package com.example.swagger;import com.example.swagger.common.component.AppStarterInitial;
import com.example.swagger.common.enums.FileTransformEnum;
import com.example.swagger.common.enums.SwaggerGenEnum;/*** <p>*  启动类* </p>** @author xiazhaoyang* @version v1.0.0* @date 2019-06-05 22:57* @modificationHistory=========================逻辑或功能性重大变更记录* @modify By: {修改人} 2019-06-05* @modify reason: {方法名}:{原因}* ...*/
public class SwaggerTransformApplication extends AppStarterInitial {public static void main(String[] args){//TODO ...}}

效果

如此一来，我们的低配版Spring BeanFactory就可以看到如下的效果了。

在这里插入图片描述

图片中打印的这个配置类：

/** @ProjectName: 编程学习* @Copyright:   2019 HangZhou xiazhaoyang Dev, Ltd. All Right Reserved.* @address:     http://xiazhaoyang.tech* @date:        2019/5/20 20:57* @email:       https:yiyuery.github.io/NoteBooks* @description: 本内容仅限于编程技术学习使用，转发请注明出处.*/
package com.example.swagger.common.configuration;import com.example.swagger.api.AutoRegister;
import com.example.swagger.api.PropNameSpace;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;/*** <p>** </p>** @author xiazhaoyang* @version v1.0.0* @date 2019-06-05 21:50* @modificationHistory=========================逻辑或功能性重大变更记录* @modify By: {修改人} 2019-06-05* @modify reason: {方法名}:{原因}* ...*/
@Data
@AllArgsConstructor
@NoArgsConstructor
@AutoRegister
@PropNameSpace(prefix = "enhance.config")
public class SwaggerEnhanceConfig {@JsonProperty("api-docs-url")private String apiDocsUrl;
}

yaml：

enhance:config:api-docs-url: http://localhost:9000/swagger-resources/v2/api-docs?group=UI

通过图片我们可以看到，已经成功实现了配置类实例的内部参数填充了。

总结

本文通过自定义注解和反射模拟了Spring BeanFactory的一个简单的实例动态注入和管理功能。有兴趣的小伙伴可以深入了解下Spring的三大核心思想：IOC(控制反转)，DI(依赖注入)，AOP（面向切面编程）。

更多

扫码关注“架构探险之道”，获取更多源码和文章资源

在这里插入图片描述

知识星球(扫码加入获取源码和文章资源链接)

在这里插入图片描述

这篇关于[Spring] 如何实现一个低配版`Spring BeanFactory`？的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/522194。

相关文章

Spring Boot整合Redis注解实现增删改查功能(Redis注解使用)

Spring Boot整合Redis注解实现增删改查功能(Redis注解使用)

《SpringBoot整合Redis注解实现增删改查功能(Redis注解使用)》文章介绍了如何使用SpringBoot整合Redis注解实现增删改查功能,包括配置、实体类、Repository、Se... 目录配置Redis连接定义实体类创建Repository接口增删改查操作示例插入数据查询数据删除数据更
阅读更多...
Java Lettuce 客户端入门到生产的实现步骤

Java Lettuce 客户端入门到生产的实现步骤

《JavaLettuce客户端入门到生产的实现步骤》本文主要介绍了JavaLettuce客户端入门到生产的实现步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要... 目录1 安装依赖MavenGradle2 最小化连接示例3 核心特性速览4 生产环境配置建议5 常见问题
阅读更多...
Java使用Swing生成一个最大公约数计算器

Java使用Swing生成一个最大公约数计算器

《Java使用Swing生成一个最大公约数计算器》这篇文章主要为大家详细介绍了Java使用Swing生成一个最大公约数计算器的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以了解一下... 目录第一步：利用欧几里得算法计算最大公约数欧几里得算法的证明情形 1：b=0情形 2：b>0完成相关代码第二步：加
阅读更多...
linux ssh如何实现增加访问端口

linux ssh如何实现增加访问端口

《linuxssh如何实现增加访问端口》Linux中SSH默认使用22端口,为了增强安全性或满足特定需求,可以通过修改SSH配置来增加或更改SSH访问端口,具体步骤包括修改SSH配置文件、增加或修改... 目录1. 修改 SSH 配置文件2. 增加或修改端口3. 保存并退出编辑器4. 更新防火墙规则使用uf
阅读更多...
Java 的ArrayList集合底层实现与最佳实践

Java 的ArrayList集合底层实现与最佳实践

《Java的ArrayList集合底层实现与最佳实践》本文主要介绍了Java的ArrayList集合类的核心概念、底层实现、关键成员变量、初始化机制、容量演变、扩容机制、性能分析、核心方法源码解析、... 目录1. 核心概念与底层实现1.1 ArrayList 的本质1.1.1 底层数据结构JDK 1.7
阅读更多...
Java Map排序如何按照值按照键排序

Java Map排序如何按照值按照键排序

《JavaMap排序如何按照值按照键排序》该文章主要介绍Java中三种Map（HashMap、LinkedHashMap、TreeMap）的默认排序行为及实现按键排序和按值排序的方法,每种方法结合实... 目录一、先理清 3 种 Map 的默认排序行为二、按「键」排序的实现方式1. 方式 1：用 TreeM
阅读更多...
Java中流式并行操作parallelStream的原理和使用方法

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流（parallelStream）的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS
阅读更多...
C++中unordered_set哈希集合的实现

C++中unordered_set哈希集合的实现

《C++中unordered_set哈希集合的实现》std::unordered_set是C++标准库中的无序关联容器,基于哈希表实现,具有元素唯一性和无序性特点,本文就来详细的介绍一下unorder... 目录一、概述二、头文件与命名空间三、常用方法与示例1. 构造与析构2. 迭代器与遍历3. 容量相关4
阅读更多...
Java中Redisson 的原理深度解析

Java中Redisson 的原理深度解析

《Java中Redisson的原理深度解析》Redisson是一个高性能的Redis客户端,它通过将Redis数据结构映射为Java对象和分布式对象,实现了在Java应用中方便地使用Redis,本文... 目录前言一、核心设计理念二、核心架构与通信层1. 基于 Netty 的异步非阻塞通信2. 编解码器三、
阅读更多...
C++中悬垂引用(Dangling Reference) 的实现

C++中悬垂引用(Dangling Reference) 的实现

《C++中悬垂引用(DanglingReference)的实现》C++中的悬垂引用指引用绑定的对象被销毁后引用仍存在的情况,会导致访问无效内存,下面就来详细的介绍一下产生的原因以及如何避免,感兴趣... 目录悬垂引用的产生原因1. 引用绑定到局部变量，变量超出作用域后销毁2. 引用绑定到动态分配的对象，对象
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2