Springboot之把外部依賴包納入Spring容器管理的兩種方式
前言
在Spring boot項目中,凡是標記有@Component、@Controller、@Service、@Configuration、@Bean等注解的類,Spring boot都會在容器啟動的時候,自動創(chuàng)建bean并納入到Spring容器中進行管理,這樣就可以使用@Autowired等注解,在需要使用bean的業(yè)務類中進行注入。這里起到關鍵作用的就是@ComponentScan,這是一個bean掃描注解,默認掃描的目錄是啟動類所在包下的所有包及子包,也就是說凡是標記了@Componetn等注解類,Spring boot都會自動創(chuàng)建bean納入Spring容器管理。
問題
一個問題來了,是什么呢?如果我封裝了一套公共的業(yè)務組件,也想把些組件類放到Spring容器里,方便在業(yè)務里注入使用,這時候應該怎么辦呢?
解決方法
最先想到的就是,應該就是更新@ComponentScan的掃描路徑了吧,除了這個還有沒有更好方法呢?答案是有的,且聽我細細道來的。
主要是兩種方式:
第一種:Spring.factories
如果了解過Spring boot的自動裝配的原理以及如何自定義自己的starter,對這個配置文件應該會很熟悉,Spring boot能夠實現(xiàn)開箱即用,省去了許多繁瑣的配置,spring-boot-autoconfigure.jar下的/META-INF/spring.factories配置文件起了關鍵作用。那個類里有什么呢?仔細會發(fā)現(xiàn)spring.factories中配置信息是key-value的形式,key是spring中預留的擴展點配置接口的全限定類名,vlue則是具體的配置類的全限定類名,如果有多個配置類,則以英文逗號隔開;
如果公共的業(yè)務組件封裝好了,就可以在resources目錄下,創(chuàng)建/META-INF/spring.factories配置文件,并實現(xiàn)Spring預留的擴展點配置接口,使用的時候引入到項目中,然后在Spring容器啟動的時候,會讀取classpath下所有的spring.factories中的配置類,然后納入到Spring容器中。當然這個處理過程是很復雜的,這里不過多展開,我在網上找到了一張圖,可以幫助你很好的理解整個過程,有興趣的小伙們,不妨根據(jù)圖上內容,再結合spring源碼再深入研究一下。
圖片
第二種:org.springframework.boot.autoconfigure.AutoConfiguration.imports
其實org.springframework.boot.autoconfigure.AutoConfiguration.imports文件功能和Sping.factories的作用是一樣的,這個用法是Spring boot2.7以后出現(xiàn)的,目的也是為引入外部的jar,把外部bean納入到Spring容器,實現(xiàn)外部組件與Spring的集成,主要的區(qū)別在于引入的方式有些不同,spring.factories這種方式是在resources下創(chuàng)建/META-INF/spring.factories配置文件,內部是key-value的形式,這種則是創(chuàng)建/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports,內部是具體的要導入到Spring環(huán)境的中的配置類。
兩種方式有一些區(qū)別,不過都是用來實現(xiàn)自動裝配的。
mybatis與Springboot
SpringBoot和MyBatis的集成主要也是利用了SpringBoot的自動配置特性和MyBatis的映射特性。
在SpringBoot中,通過開啟自動配置,系統(tǒng)會在ConfigurationClassPostProcessor這個BeanFactory的后置處理器中,讀取spring.factories配置文件中的org.springframework.boot.autoconfigure.EnableAutoConfiguration,讀取到所有的自動配置類進行注冊。
而對于MyBatis,我們主要是通過MapperScan這個注解來注冊Mapper。在SpringBoot中,如果某個類使用了@MapperScan注解,那么Spring會自動掃描該類所在的包,并將掃描到的Mapper接口注冊到Spring容器中。這樣,我們就可以在Service中使用@Autowired將Mapper注入,從而使用Mapper提供的方法對數(shù)據(jù)庫進行操作。
此外,SpringBoot還集成了MyBatis的別名和類型處理器。這是通過掃描@Alias和@TypeAlias注解來實現(xiàn)的,它們可以幫助我們將類型進行轉換,使得我們可以在MyBatis中使用更方便的類型,比如使用String代替硬編碼的SQL語句。
示例
項目里也經常會用到reids,這里舉一個實例,以把redis與Springboot的集成,封裝成一個starter。
Redis在Springboot中的配置類
/**
* Redis 配置類
*/
@AutoConfiguration
public class RedisAutoConfiguration {
/**
* 創(chuàng)建 RedisTemplate Bean,使用 JSON 序列化方式
*/
@Bean
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
// 創(chuàng)建 RedisTemplate 對象
RedisTemplate<String, Object> template = new RedisTemplate<>();
// 設置 RedisConnection 工廠。?? 它就是實現(xiàn)多種 Java Redis 客戶端接入的秘密工廠。感興趣的胖友,可以自己去擼下。
template.setConnectionFactory(factory);
// 使用 String 序列化方式,序列化 KEY 。
template.setKeySerializer(RedisSerializer.string());
template.setHashKeySerializer(RedisSerializer.string());
// 使用 JSON 序列化方式(庫是 Jackson ),序列化 VALUE 。
template.setValueSerializer(buildRedisSerializer());
template.setHashValueSerializer(buildRedisSerializer());
return template;
}
public static RedisSerializer<?> buildRedisSerializer() {
RedisSerializer<Object> json = RedisSerializer.json();
// 解決 LocalDateTime 的序列化
ObjectMapper objectMapper = (ObjectMapper) ReflectUtil.getFieldValue(json, "mapper");
objectMapper.registerModules(new JavaTimeModule());
return json;
}
}
resources目錄下創(chuàng)建/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件,并填寫配置類的全限定名稱
com.example.redis.config.RedisAutoConfiguration