創(chuàng)建動(dòng)態(tài)代理對(duì)象bean,并動(dòng)態(tài)注入到spring容器中的操作

更新時(shí)間：2021年02月19日 10:23:36 作者：lichuangcsdn

這篇文章主要介紹了創(chuàng)建動(dòng)態(tài)代理對(duì)象bean,并動(dòng)態(tài)注入到spring容器中的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧

使用過(guò)Mybatis的同學(xué)，應(yīng)該都知道，我們只需要編寫mybatis對(duì)應(yīng)的接口和mapper XML文件即可，并不需要手動(dòng)編寫mapper接口的實(shí)現(xiàn)。這里mybatis就用到了JDK動(dòng)態(tài)代理，并且將生成的接口代理對(duì)象動(dòng)態(tài)注入到Spring容器中。

這里涉及到幾個(gè)問(wèn)題。也許有同學(xué)會(huì)有疑問(wèn)，我們直接編寫好類，加入@Component等注解不是可以注入了嗎？或者在配置類（@Configuration）中直接聲明該Bean類型不也可以注入嗎？

但具體到mybatis，這里我們用的是接口。由于spring實(shí)例化對(duì)象時(shí)，如果沒(méi)有特殊情況，默認(rèn)都是通過(guò)反射形式來(lái)實(shí)例化Bean。而接口是無(wú)法直接通過(guò)Class.newInstance()方式進(jìn)行實(shí)例化的。

第二個(gè)問(wèn)題，如果手動(dòng)聲明Bean，其實(shí)也可以。但是會(huì)比較麻煩。因?yàn)槲覀冞€要手動(dòng)創(chuàng)建代理對(duì)象，可能還需要給該對(duì)象的屬性，比如（sqlSessionFactory，dataSource）設(shè)置對(duì)應(yīng)的Bean實(shí)例。這些都會(huì)比較麻煩。況且Mapper接口可能會(huì)有很多個(gè)。

下面，我也寫一個(gè)簡(jiǎn)單例子。用于說(shuō)明如何將動(dòng)態(tài)代理生成的接口實(shí)例，動(dòng)態(tài)的注入到Spring容器中，并且能正常調(diào)用這2個(gè)接口里面的方法，獲取調(diào)用結(jié)果。

解釋下這里為什么說(shuō)是動(dòng)態(tài)注入？因?yàn)槲覀兪孪炔⒉恢罆?huì)有多少個(gè)這樣的Bean，可以通過(guò)指定包路徑，來(lái)掃描特定路徑下的Bean。

整個(gè)代碼結(jié)構(gòu)如下：

如圖所示，我有2個(gè)接口CalculateService和TestService，這2個(gè)接口并沒(méi)有對(duì)應(yīng)的實(shí)現(xiàn)類?，F(xiàn)在我們通過(guò)動(dòng)態(tài)代理生成實(shí)例，然后注入到TestController中

首先是創(chuàng)建一個(gè)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("測(cè)試");
 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動(dòng)態(tài)注入自定義接口
 * @author lichuang
 */
@Component
public class ServiceBeanDefinitionRegistry implements BeanDefinitionRegistryPostProcessor,ResourceLoaderAware,ApplicationContextAware { 
 @Override
 public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
 //這里一般我們是通過(guò)反射獲取需要代理的接口的clazz列表
 //比如判斷包下面的類，或者通過(guò)某注解標(biāo)注的類等等
 Set<Class<?>> beanClazzs = scannerPackages("com.company.service");
 for (Class beanClazz : beanClazzs) {
  BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(beanClazz);
  GenericBeanDefinition definition = (GenericBeanDefinition) builder.getRawBeanDefinition();
 
  //在這里，我們可以給該對(duì)象的屬性注入對(duì)應(yīng)的實(shí)例。
  //比如mybatis，就在這里注入了dataSource和sqlSessionFactory，
  // 注意，如果采用definition.getPropertyValues()方式的話，
  // 類似definition.getPropertyValues().add("interfaceType", beanClazz);
  // 則要求在FactoryBean（本應(yīng)用中即ServiceFactory）提供setter方法，否則會(huì)注入失敗
  // 如果采用definition.getConstructorArgumentValues()，
  // 則FactoryBean中需要提供包含該屬性的構(gòu)造方法，否則會(huì)注入失敗
  definition.getConstructorArgumentValues().addGenericArgumentValue(beanClazz);
 
  //注意，這里的BeanClass是生成Bean實(shí)例的工廠，不是Bean本身。
  // FactoryBean是一種特殊的Bean，其返回的對(duì)象不是指定類的一個(gè)實(shí)例，
  // 其返回的是該工廠Bean的getObject方法所返回的對(duì)象。
  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;
 
 /**
 * 根據(jù)包路徑獲取包及子包下的所有類
 * @param basePackage basePackage
 * @return Set<Class<?>> Set<Class<?>>
 */
 private Set<Class<?>> scannerPackages(String basePackage) {
 Set<Class<?>> 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<?> 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;
 
/**
 * 接口實(shí)例工廠，這里主要是用于提供接口的實(shí)例對(duì)象
 * @author lichuang
 * @param <T>
 */
public class ServiceFactory<T> implements FactoryBean<T> { 
 private Class<T> interfaceType; 
 public ServiceFactory(Class<T> interfaceType) {
 this.interfaceType = interfaceType;
 }
 
 @Override
 public T getObject() throws Exception {
 //這里主要是創(chuàng)建接口對(duì)應(yīng)的實(shí)例，便于注入到spring容器中
 InvocationHandler handler = new ServiceProxy<>(interfaceType);
 return (T) Proxy.newProxyInstance(interfaceType.getClassLoader(),
  new Class[] {interfaceType},handler);
 }
 
 @Override
 public Class<T> 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;
 
/**
 * 動(dòng)態(tài)代理，需要注意的是，這里用到的是JDK自帶的動(dòng)態(tài)代理，代理對(duì)象只能是接口，不能是類
 * @author lichuang
 */
 
public class ServiceProxy<T> implements InvocationHandler { 
 private Class<T> interfaceType; 
 public ServiceProxy(Class<T> 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("調(diào)用前，參數(shù)：{}" + args);
 //這里可以得到參數(shù)數(shù)組和方法等，可以通過(guò)反射，注解等，進(jìn)行結(jié)果集的處理
 //mybatis就是在這里獲取參數(shù)和相關(guān)注解，然后根據(jù)返回值類型，進(jìn)行結(jié)果集的轉(zhuǎn)換
 Object result = JSON.toJSONString(args);
 System.out.println("調(diào)用后，結(jié)果：{}" + result);
 return result;
 }
}

另外2個(gè)接口源碼：

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運(yùn)行，可以看到程序正常運(yùn)行，兩個(gè)Service接口都已正常的注入到控制器中了，程序也能正常返回接口。

補(bǔ)充：Spring動(dòng)態(tài) 注入/刪除 Bean

我們通過(guò)getBean來(lái)獲得對(duì)象,但這些對(duì)象都是事先定義好的,我們有時(shí)候要在程序中動(dòng)態(tài)的加入對(duì)象.因?yàn)槿绻捎门渲梦募蛘咦⒔?，我們要加入?duì)象的話,還要重啟服務(wù),如果我們想要避免這一情況就得采用動(dòng)態(tài)處理bean,包括：動(dòng)態(tài)注入,動(dòng)態(tài)刪除。

1 動(dòng)態(tài)注入bean思路

在具體進(jìn)行代碼實(shí)現(xiàn)的時(shí)候，我們要知道，Spring管理bean的對(duì)象是BeanFactory，具體的是DefaultListableBeanFactory，在這個(gè)類當(dāng)中有一個(gè)注入bean的方法：registerBeanDefinition，在調(diào)用registerBeanDefinition方法時(shí)，需要BeanDefinition參數(shù)，那么這個(gè)參數(shù)怎么獲取呢？

Spring提供了BeanDefinitionBuilder可以構(gòu)建一個(gè)BeanDefinition，那么我們的問(wèn)題就是如何獲取BeanFactory了，這個(gè)就很簡(jiǎn)單了，只要獲取到ApplicationContext對(duì)象即可獲取到BeanFacory了。

2. 動(dòng)態(tài)注入實(shí)現(xiàn)代碼

綜上所述，如果我們要編寫一個(gè)簡(jiǎn)單里的例子的話，那么分以個(gè)幾個(gè)步驟進(jìn)行編碼即可進(jìn)行動(dòng)態(tài)注入了：

1、獲取ApplicationContext;

2、通過(guò)ApplicationContext獲取到BeanFacotory;

3、通過(guò)BeanDefinitionBuilder構(gòu)建BeanDefiniton;

4、調(diào)用beanFactory的registerBeanDefinition注入beanDefinition；

5、使用ApplicationContext.getBean獲取bean進(jìn)行測(cè)試；

我們需要先定義個(gè)類進(jìn)行測(cè)試，比如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("動(dòng)態(tài)載入bean,name="+name);
 }
}

那么下面我們的目標(biāo)就是動(dòng)態(tài)注入TestService了，根據(jù)以上的分析，我們進(jìn)行編碼，具體代碼如下：

//獲取context. 
ApplicationContext ctx = (ApplicationContext) SpringApplication.run(App.class, args);
 
//獲取BeanFactory
DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory)ctx.getAutowireCapableBeanFactory();
 
//創(chuàng)建bean信息
BeanDefinitionBuilderbeanDefinitionBuilder =BeanDefinitionBuilder.genericBeanDefinition(TestService.class);
beanDefinitionBuilder.addPropertyValue("name","張三");
 
//動(dòng)態(tài)注冊(cè)bean
defaultListableBeanFactory.registerBeanDefinition("testService",beanDefinitionBuilder.getBeanDefinition());
 
//獲取動(dòng)態(tài)注冊(cè)的bean
TestService testService =ctx.getBean(TestService.class);
testService.print();

執(zhí)行代碼

動(dòng)態(tài)載入bean,name=張三

到這里，就證明我們的代碼很成功了。

3 多次注入同一個(gè)bean的情況

多次注入同一個(gè)bean的，如果beanName不一樣的話，那么會(huì)產(chǎn)生兩個(gè)Bean；如果beanName一樣的話，后面注入的會(huì)覆蓋前面的。

第一種情況：beanName一樣的代碼：

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

運(yùn)行看控制臺(tái)：

動(dòng)態(tài)載入bean,name=李四

第二種情況：beanName不一樣的代碼：

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

此時(shí)如果沒(méi)有更改別的代碼直接運(yùn)行的話，是會(huì)報(bào)如下錯(cuò)誤的：

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的時(shí)候，找到了兩個(gè)bean，這時(shí)候就不知道要獲取哪個(gè)了，所以在獲取的時(shí)候，我們就要使用byName指定我們是要獲取的testService還是testService1，只需要修改一句代碼：

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

一般重復(fù)注入一個(gè)新Bean的情況較少，多數(shù)情況都是講已有的Bean注入到容器中，

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

第一行：讓obj完成Spring初始化過(guò)程中所有增強(qiáng)器檢驗(yàn)，只是不重新創(chuàng)建obj，

第二行：將obj以單例的形式入駐到容器中，此時(shí)通過(guò)obj.getClass().getName()或obj.getClass()都可以拿到放入Spring容器的Bean。

4 動(dòng)態(tài)刪除

相對(duì)于動(dòng)態(tài)注入，動(dòng)態(tài)刪除就很簡(jiǎn)單了，直接奉上代碼：

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

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教。

您可能感興趣的文章:

欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片