[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。

相关文章

Python实现精确小数计算的完全指南

Python实现精确小数计算的完全指南

《Python实现精确小数计算的完全指南》在金融计算、科学实验和工程领域,浮点数精度问题一直是开发者面临的重大挑战,本文将深入解析Python精确小数计算技术体系,感兴趣的小伙伴可以了解一下... 目录引言：小数精度问题的核心挑战一、浮点数精度问题分析1.1 浮点数精度陷阱1.2 浮点数误差来源二、基础解决
阅读更多...
Java实现在Word文档中添加文本水印和图片水印的操作指南

Java实现在Word文档中添加文本水印和图片水印的操作指南

《Java实现在Word文档中添加文本水印和图片水印的操作指南》在当今数字时代,文档的自动化处理与安全防护变得尤为重要,无论是为了保护版权、推广品牌,还是为了在文档中加入特定的标识,为Word文档添加... 目录引言Spire.Doc for Java：高效Word文档处理的利器代码实战：使用Java为Wo
阅读更多...
SpringBoot日志级别与日志分组详解

SpringBoot日志级别与日志分组详解

《SpringBoot日志级别与日志分组详解》文章介绍了日志级别（ALL至OFF）及其作用,说明SpringBoot默认日志级别为INFO,可通过application.properties调整全局或... 目录日志级别1、级别内容2、调整日志级别调整默认日志级别调整指定类的日志级别项目开发过程中，利用日志
阅读更多...
Java中的抽象类与abstract 关键字使用详解

Java中的抽象类与abstract 关键字使用详解

《Java中的抽象类与abstract关键字使用详解》：本文主要介绍Java中的抽象类与abstract关键字使用详解,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧... 目录一、抽象类的概念二、使用 abstract2.1 修饰类 => 抽象类2.2 修饰方法 => 抽象方法，没有
阅读更多...
SpringBoot 多环境开发实战(从配置、管理与控制)

SpringBoot 多环境开发实战(从配置、管理与控制)

《SpringBoot多环境开发实战(从配置、管理与控制)》本文详解SpringBoot多环境配置,涵盖单文件YAML、多文件模式、MavenProfile分组及激活策略,通过优先级控制灵活切换环境... 目录一、多环境开发基础（单文件 YAML 版）（一）配置原理与优势（二）实操示例二、多环境开发多文件版
阅读更多...
Spring 中的切面与事务结合使用完整示例

Spring 中的切面与事务结合使用完整示例

《Spring中的切面与事务结合使用完整示例》本文给大家介绍Spring中的切面与事务结合使用完整示例,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考... 目录 一、前置知识：Spring AOP 与 事务的关系 事务本质上就是一个“切面”二、核心组件三、完
阅读更多...
Java实现远程执行Shell指令

Java实现远程执行Shell指令

《Java实现远程执行Shell指令》文章介绍使用JSch在SpringBoot项目中实现远程Shell操作,涵盖环境配置、依赖引入及工具类编写,详解分号和双与号执行多指令的区别... 目录软硬件环境说明编写执行Shell指令的工具类总结jsch(Java Secure Channel)是SSH2的一个纯J
阅读更多...
使用Python实现Word文档的自动化对比方案

使用Python实现Word文档的自动化对比方案

《使用Python实现Word文档的自动化对比方案》我们经常需要比较两个Word文档的版本差异,无论是合同修订、论文修改还是代码文档更新,人工比对不仅效率低下,还容易遗漏关键改动,下面通过一个实际案例... 目录引言一、使用python-docx库解析文档结构二、使用difflib进行差异比对三、高级对比方
阅读更多...
深度解析Python中递归下降解析器的原理与实现

深度解析Python中递归下降解析器的原理与实现

《深度解析Python中递归下降解析器的原理与实现》在编译器设计、配置文件处理和数据转换领域,递归下降解析器是最常用且最直观的解析技术,本文将详细介绍递归下降解析器的原理与实现,感兴趣的小伙伴可以跟随... 目录引言：解析器的核心价值一、递归下降解析器基础1.1 核心概念解析1.2 基本架构二、简单算术表达
阅读更多...
JavaScript中比较两个数组是否有相同元素(交集)的三种常用方法

JavaScript中比较两个数组是否有相同元素(交集)的三种常用方法

《JavaScript中比较两个数组是否有相同元素(交集)的三种常用方法》：本文主要介绍JavaScript中比较两个数组是否有相同元素(交集)的三种常用方法,每种方法结合实例代码给大家介绍的非常... 目录引言：为什么"相等"判断如此重要？方法1：使用some()+includes()（适合小数组）方法2
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2