热门标签 | HotTags
当前位置:  开发笔记 > 前端 > 正文

创建动态代理对象bean,并动态注入到spring容器中的操作

这篇文章主要介绍了创建动态代理对象bean,并动态注入到spring容器中的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧

使用过Mybatis的同学,应该都知道,我们只需要编写mybatis对应的接口和mapper XML文件即可,并不需要手动编写mapper接口的实现。这里mybatis就用到了JDK动态代理,并且将生成的接口代理对象动态注入到Spring容器中。

这里涉及到几个问题。也许有同学会有疑问,我们直接编写好类,加入@Component等注解不是可以注入了吗?或者在配置类(@Configuration)中直接声明该Bean类型不也可以注入吗?

但具体到mybatis,这里我们用的是接口。由于spring实例化对象时,如果没有特殊情况,默认都是通过反射形式来实例化Bean。而接口是无法直接通过Class.newInstance()方式进行实例化的。

第二个问题,如果手动声明Bean,其实也可以。但是会比较麻烦。因为我们还要手动创建代理对象,可能还需要给该对象的属性,比如(sqlSessionFactory,dataSource)设置对应的Bean实例。这些都会比较麻烦。况且Mapper接口可能会有很多个。

下面,我也写一个简单例子。用于说明如何将动态代理生成的接口实例,动态的注入到Spring容器中,并且能正常调用这2个接口里面的方法,获取调用结果。

解释下这里为什么说是动态注入?因为我们事先并不知道会有多少个这样的Bean,可以通过指定包路径,来扫描特定路径下的Bean。

整个代码结构如下:

如图所示,我有2个接口CalculateService和TestService,这2个接口并没有对应的实现类。现在我们通过动态代理生成实例,然后注入到TestController中

首先是创建一个SpringBoot maven工程

TestController源码

package com.company.controller; 
import com.company.service.CalculateService;
import com.company.service.TestService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController; 
@RestController
public class TestController {
 
 @Autowired
 private TestService testService;
 
 @Autowired
 private CalculateService calculateService;
 
 @RequestMapping("/test")
 public String getHello() {
 String testList = testService.getList("code123","name456");
 String calculateResult = calculateService.getResult("测试");
 return (testList + "," +calculateResult);
 }
}

handler包下的ServiceBeanDefinitionRegistry源码:

package com.company.handler; 
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
import org.springframework.beans.factory.support.GenericBeanDefinition;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.ResourceLoaderAware;
import org.springframework.core.env.Environment;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternUtils;
import org.springframework.core.type.classreading.CachingMetadataReaderFactory;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import org.springframework.stereotype.Component;
import org.springframework.util.ClassUtils; 
import java.io.IOException;
import java.util.LinkedHashSet;
import java.util.Set;
 
/**
 * 用于Spring动态注入自定义接口
 * @author lichuang
 */
@Component
public class ServiceBeanDefinitionRegistry implements BeanDefinitionRegistryPostProcessor,ResourceLoaderAware,ApplicationContextAware { 
 @Override
 public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
 //这里一般我们是通过反射获取需要代理的接口的clazz列表
 //比如判断包下面的类,或者通过某注解标注的类等等
 Set> beanClazzs = scannerPackages("com.company.service");
 for (Class beanClazz : beanClazzs) {
  BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(beanClazz);
  GenericBeanDefinition definition = (GenericBeanDefinition) builder.getRawBeanDefinition();
 
  //在这里,我们可以给该对象的属性注入对应的实例。
  //比如mybatis,就在这里注入了dataSource和sqlSessionFactory,
  // 注意,如果采用definition.getPropertyValues()方式的话,
  // 类似definition.getPropertyValues().add("interfaceType", beanClazz);
  // 则要求在FactoryBean(本应用中即ServiceFactory)提供setter方法,否则会注入失败
  // 如果采用definition.getConstructorArgumentValues(),
  // 则FactoryBean中需要提供包含该属性的构造方法,否则会注入失败
  definition.getConstructorArgumentValues().addGenericArgumentValue(beanClazz);
 
  //注意,这里的BeanClass是生成Bean实例的工厂,不是Bean本身。
  // FactoryBean是一种特殊的Bean,其返回的对象不是指定类的一个实例,
  // 其返回的是该工厂Bean的getObject方法所返回的对象。
  definition.setBeanClass(ServiceFactory.class);
 
  //这里采用的是byType方式注入,类似的还有byName等
  definition.setAutowireMode(GenericBeanDefinition.AUTOWIRE_BY_TYPE);
  registry.registerBeanDefinition(beanClazz.getSimpleName(), definition);
 }
 }
 
 private static final String DEFAULT_RESOURCE_PATTERN = "**/*.class"; 
 private MetadataReaderFactory metadataReaderFactory;
 
 /**
 * 根据包路径获取包及子包下的所有类
 * @param basePackage basePackage
 * @return Set> Set>
 */
 private Set> scannerPackages(String basePackage) {
 Set> set = new LinkedHashSet<>();
 String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX +
  resolveBasePackage(basePackage) + '/' + DEFAULT_RESOURCE_PATTERN;
 try {
  Resource[] resources = this.resourcePatternResolver.getResources(packageSearchPath);
  for (Resource resource : resources) {
  if (resource.isReadable()) {
   MetadataReader metadataReader = this.metadataReaderFactory.getMetadataReader(resource);
   String className = metadataReader.getClassMetadata().getClassName();
   Class<&#63;> clazz;
   try {
   clazz = Class.forName(className);
   set.add(clazz);
   } catch (ClassNotFoundException e) {
   e.printStackTrace();
   }
  }
  }
 } catch (IOException e) {
  e.printStackTrace();
 }
 return set;
 }
 
 protected String resolveBasePackage(String basePackage) {
 return ClassUtils.convertClassNameToResourcePath(this.getEnvironment().resolveRequiredPlaceholders(basePackage));
 }
 
 @Override
 public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
 
 }
 
 private ResourcePatternResolver resourcePatternResolver; 
 private ApplicationContext applicationContext;
 
 @Override
 public void setResourceLoader(ResourceLoader resourceLoader) {
 this.resourcePatternResolver = ResourcePatternUtils.getResourcePatternResolver(resourceLoader);
 this.metadataReaderFactory = new CachingMetadataReaderFactory(resourceLoader);
 }
 
 @Override
 public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
 this.applicatiOnContext= applicationContext;
 }
 
 private Environment getEnvironment() {
 return applicationContext.getEnvironment();
 }
}

ServiceFactory源码:

package com.company.handler; 
import org.springframework.beans.factory.FactoryBean; 
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Proxy;
 
/**
 * 接口实例工厂,这里主要是用于提供接口的实例对象
 * @author lichuang
 * @param 
 */
public class ServiceFactory implements FactoryBean { 
 private Class interfaceType; 
 public ServiceFactory(Class interfaceType) {
 this.interfaceType = interfaceType;
 }
 
 @Override
 public T getObject() throws Exception {
 //这里主要是创建接口对应的实例,便于注入到spring容器中
 InvocationHandler handler = new ServiceProxy<>(interfaceType);
 return (T) Proxy.newProxyInstance(interfaceType.getClassLoader(),
  new Class[] {interfaceType},handler);
 }
 
 @Override
 public Class getObjectType() {
 return interfaceType;
 }
 
 @Override
 public boolean isSingleton() {
 return true;
 }
}

ServiceProxy源码

package com.company.handler; 
import com.alibaba.fastjson.JSON; 
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.util.Arrays;
 
/**
 * 动态代理,需要注意的是,这里用到的是JDK自带的动态代理,代理对象只能是接口,不能是类
 * @author lichuang
 */
 
public class ServiceProxy implements InvocationHandler { 
 private Class interfaceType; 
 public ServiceProxy(Class intefaceType) {
 this.interfaceType = interfaceType;
 }
 
 @Override
 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
 if (Object.class.equals(method.getDeclaringClass())) {
  return method.invoke(this,args);
 }
 System.out.println("调用前,参数:{}" + args);
 //这里可以得到参数数组和方法等,可以通过反射,注解等,进行结果集的处理
 //mybatis就是在这里获取参数和相关注解,然后根据返回值类型,进行结果集的转换
 Object result = JSON.toJSONString(args);
 System.out.println("调用后,结果:{}" + result);
 return result;
 }
}

另外2个接口源码:

package com.company.service; 
public interface CalculateService { 
 String getResult(String name);
}

TestService接口

package com.company.service; 
public interface TestService { 
 String getList(String code, String name);
}

我们DEBUG运行,可以看到程序正常运行,两个Service接口都已正常的注入到控制器中了,程序也能正常返回接口。

补充:Spring动态 注入/删除 Bean

我们通过getBean来获得对象,但这些对象都是事先定义好的,我们有时候要在程序中动态的加入对象.因为如果采用配置文件或者注解,我们要加入对象的话,还要重启服务,如果我们想要避免这一情况就得采用动态处理bean,包括:动态注入,动态删除。

1 动态注入bean思路

在具体进行代码实现的时候,我们要知道,Spring管理bean的对象是BeanFactory,具体的是DefaultListableBeanFactory,在这个类当中有一个注入bean的方法:registerBeanDefinition,在调用registerBeanDefinition方法时,需要BeanDefinition参数,那么这个参数怎么获取呢?

Spring提供了BeanDefinitionBuilder可以构建一个BeanDefinition,那么我们的问题就是如何获取BeanFactory了,这个就很简单了,只要获取到ApplicationContext对象即可获取到BeanFacory了。

2. 动态注入实现代码

综上所述,如果我们要编写一个简单里的例子的话,那么分以个几个步骤进行编码即可进行动态注入了:

1、获取ApplicationContext;

2、通过ApplicationContext获取到BeanFacotory;

3、通过BeanDefinitionBuilder构建BeanDefiniton;

4、调用beanFactory的registerBeanDefinition注入beanDefinition;

5、使用ApplicationContext.getBean获取bean进行测试;

我们需要先定义个类进行测试,比如TestService代码如下:

package com.kfit.demo.service;
public class TestService {
 private String name;
 public String getName() {
 return name;
 }
 public void setName(String name) {
 this.name = name;
 }
 public void print(){
 System.out.println("动态载入bean,name="+name);
 }
}

那么下面我们的目标就是动态注入TestService了,根据以上的分析,我们进行编码,具体代码如下:

//获取context. 
ApplicationContext ctx = (ApplicationContext) SpringApplication.run(App.class, args);
 
//获取BeanFactory
DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory)ctx.getAutowireCapableBeanFactory();
 
//创建bean信息
BeanDefinitiOnBuilderbeanDefinitionBuilder=BeanDefinitionBuilder.genericBeanDefinition(TestService.class);
beanDefinitionBuilder.addPropertyValue("name","张三");
 
//动态注册bean
defaultListableBeanFactory.registerBeanDefinition("testService",beanDefinitionBuilder.getBeanDefinition());
 
//获取动态注册的bean
TestService testService =ctx.getBean(TestService.class);
testService.print();

执行代码

动态载入bean,name=张三

到这里,就证明我们的代码很成功了。

3 多次注入同一个bean的情况

多次注入同一个bean的,如果beanName不一样的话,那么会产生两个Bean;如果beanName一样的话,后面注入的会覆盖前面的。

第一种情况:beanName一样的代码:

beanDefinitiOnBuilder= BeanDefinitionBuilder.genericBeanDefinition(TestService.class);
beanDefinitionBuilder.addPropertyValue("name","李四");
defaultListableBeanFactory.registerBeanDefinition("testService", beanDefinitionBuilder.getBeanDefinition());

运行看控制台:

动态载入bean,name=李四

第二种情况:beanName不一样的代码:

beanDefinitiOnBuilder= BeanDefinitionBuilder.genericBeanDefinition(TestService.class);
beanDefinitionBuilder.addPropertyValue("name","李四");
defaultListableBeanFactory.registerBeanDefinition("testService1",beanDefinitionBuilder.getBeanDefinition());
TestService testService =ctx.getBean(TestService.class);
testService.print();

此时如果没有更改别的代码直接运行的话,是会报如下错误的:

Caused by: org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifying bean of type [com.kfit.demo.service.TestService] is defined: expected single matching bean but found 2: testService1,testService

大体意思就是在按照 byType getBean的时候,找到了两个bean,这时候就不知道要获取哪个了,所以在获取的时候,我们就要使用byName指定我们是要获取的testService还是testService1,只需要修改一句代码:

TestService testService =ctx.getBean("testService");

一般重复注入一个新Bean的情况较少,多数情况都是讲已有的Bean注入到容器中,

applicationContext.getAutowireCapableBeanFactory().applyBeanPostProcessorsAfterInitialization(obj, obj.getClass().getName());
beanFactory.registerSingleton(obj.getClass().getName(), obj);

第一行:让obj完成Spring初始化过程中所有增强器检验,只是不重新创建obj,

第二行:将obj以单例的形式入驻到容器中,此时通过obj.getClass().getName()或obj.getClass()都可以拿到放入Spring容器的Bean。

4 动态删除

相对于动态注入,动态删除就很简单了,直接奉上代码:

 //删除bean.
defaultListableBeanFactory.removeBeanDefinition("testService");

以上为个人经验,希望能给大家一个参考,也希望大家多多支持。如有错误或未考虑完全的地方,望不吝赐教。


推荐阅读
  • Web开发框架概览:Java与JavaScript技术及框架综述
    Web开发涉及服务器端和客户端的协同工作。在服务器端,Java是一种优秀的编程语言,适用于构建各种功能模块,如通过Servlet实现特定服务。客户端则主要依赖HTML进行内容展示,同时借助JavaScript增强交互性和动态效果。此外,现代Web开发还广泛使用各种框架和库,如Spring Boot、React和Vue.js,以提高开发效率和应用性能。 ... [详细]
  • Spring框架的核心组件与架构解析 ... [详细]
  • 深入解析Struts、Spring与Hibernate三大框架的面试要点与技巧 ... [详细]
  • 本文详细探讨了几种常用的Java后端开发框架组合及其具体应用场景。通过对比分析Spring Boot、MyBatis、Hibernate等框架的特点和优势,结合实际项目需求,为开发者提供了选择合适框架组合的参考依据。同时,文章还介绍了这些框架在微服务架构中的应用,帮助读者更好地理解和运用这些技术。 ... [详细]
  • 在 Axublog 1.1.0 版本的 `c_login.php` 文件中发现了一个严重的 SQL 注入漏洞。该漏洞允许攻击者通过操纵登录请求中的参数,注入恶意 SQL 代码,从而可能获取敏感信息或对数据库进行未授权操作。建议用户尽快更新到最新版本并采取相应的安全措施以防止潜在的风险。 ... [详细]
  • 《Spring in Action 第4版:全面解析与实战指南》
    《Spring in Action 第4版:全面解析与实战指南》不仅详细介绍了Spring框架的核心优势,如简洁易测试、低耦合特性,还深入探讨了其轻量级和最小侵入性的设计原则。书中强调了声明式编程的优势,并通过基于约定的方法简化开发流程。此外,Spring的模板机制有效减少了重复代码,而依赖注入功能则由容器自动管理,确保了应用的灵活性和可维护性。 ... [详细]
  • 在使用SSH框架进行项目开发时,经常会遇到一些常见的问题。例如,在Spring配置文件中配置AOP事务声明后,进行单元测试时可能会出现“No Hibernate Session bound to thread”的错误。本文将详细探讨这一问题的原因,并提供有效的解决方案,帮助开发者顺利解决此类问题。 ... [详细]
  • 在基于.NET框架的分层架构实践中,为了实现各层之间的松散耦合,本文详细探讨了依赖注入(DI)和控制反转(IoC)容器的设计与实现。通过合理的依赖管理和对象创建,确保了各层之间的单向调用关系,从而提高了系统的可维护性和扩展性。此外,文章还介绍了几种常见的IoC容器实现方式及其应用场景,为开发者提供了实用的参考。 ... [详细]
  • com.sun.javadoc.PackageDoc.exceptions()方法的使用及代码示例 ... [详细]
  • 使用虚拟机配置服务器
    本文详细介绍了如何使用虚拟机配置服务器,包括购买云服务器的操作步骤、系统默认配置以及相关注意事项。通过这些步骤,您可以高效地配置和管理您的服务器。 ... [详细]
  • Python 3 Scrapy 框架执行流程详解
    本文详细介绍了如何在 Python 3 环境下安装和使用 Scrapy 框架,包括常用命令和执行流程。Scrapy 是一个强大的 Web 抓取框架,适用于数据挖掘、监控和自动化测试等多种场景。 ... [详细]
  • MySQL Decimal 类型的最大值解析及其在数据处理中的应用艺术
    在关系型数据库中,表的设计与SQL语句的编写对性能的影响至关重要,甚至可占到90%以上。本文将重点探讨MySQL中Decimal类型的最大值及其在数据处理中的应用技巧,通过实例分析和优化建议,帮助读者深入理解并掌握这一重要知识点。 ... [详细]
  • 在本文中,我们将探讨如何在Docker环境中高效地管理和利用数据库。首先,需要安装Docker Desktop以确保本地环境准备就绪。接下来,可以从Docker Hub中选择合适的数据库镜像,并通过简单的命令将其拉取到本地。此外,我们还将介绍如何配置和优化这些数据库容器,以实现最佳性能和安全性。 ... [详细]
  • SQL注入防御:深入解析绕过addslashes技术的方法与策略 ... [详细]
  • 本文作为探讨PHP依赖注入容器系列文章的开篇,将首先通过具体示例详细阐述依赖注入的基本概念及其重要性,为后续深入解析容器的实现奠定基础。 ... [详细]
author-avatar
施工的公司_534
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有