使用過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<Class<?>> 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<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;
- /**
- * 接口實例工廠,這里主要是用于提供接口的實例對象
- * @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 {
- //這里主要是創建接口對應的實例,便于注入到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;
- /**
- * 動態代理,需要注意的是,這里用到的是JDK自帶的動態代理,代理對象只能是接口,不能是類
- * @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("調用前,參數:{}" + 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");
以上為個人經驗,希望能給大家一個參考,也希望大家多多支持我們。如有錯誤或未考慮完全的地方,望不吝賜教。
原文鏈接:https://blog.csdn.net/lichuangcsdn/article/details/89694363