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

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
hdu1043（八数码问题，广搜 + hash（实现状态压缩） ）

hdu1043（八数码问题，广搜 + hash（实现状态压缩） ）

利用康拓展开将一个排列映射成一个自然数，然后就变成了普通的广搜题。 #include<iostream>#include<algorithm>#include<string>#include<stack>#include<queue>#include<map>#include<stdio.h>#include<stdlib.h>#include<ctype.h>#inclu
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2