MybatisPlusAutoConfiguration.java 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406
  1. /*
  2. * Copyright (c) 2011-2022, baomidou (jobob@qq.com).
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. package com.baomidou.mybatisplus.autoconfigure;
  17. import com.baomidou.mybatisplus.core.MybatisConfiguration;
  18. import com.baomidou.mybatisplus.core.config.GlobalConfig;
  19. import com.baomidou.mybatisplus.core.handlers.AnnotationHandler;
  20. import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
  21. import com.baomidou.mybatisplus.core.handlers.PostInitTableInfoHandler;
  22. import com.baomidou.mybatisplus.core.incrementer.IKeyGenerator;
  23. import com.baomidou.mybatisplus.core.incrementer.IdentifierGenerator;
  24. import com.baomidou.mybatisplus.core.injector.ISqlInjector;
  25. import com.baomidou.mybatisplus.extension.ddl.IDdl;
  26. import com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean;
  27. import org.apache.ibatis.annotations.Mapper;
  28. import org.apache.ibatis.mapping.DatabaseIdProvider;
  29. import org.apache.ibatis.plugin.Interceptor;
  30. import org.apache.ibatis.scripting.LanguageDriver;
  31. import org.apache.ibatis.session.ExecutorType;
  32. import org.apache.ibatis.session.SqlSessionFactory;
  33. import org.apache.ibatis.transaction.TransactionFactory;
  34. import org.apache.ibatis.type.TypeHandler;
  35. import org.mybatis.spring.SqlSessionFactoryBean;
  36. import org.mybatis.spring.SqlSessionTemplate;
  37. import org.mybatis.spring.mapper.MapperFactoryBean;
  38. import org.mybatis.spring.mapper.MapperScannerConfigurer;
  39. import org.slf4j.Logger;
  40. import org.slf4j.LoggerFactory;
  41. import org.springframework.beans.BeanWrapper;
  42. import org.springframework.beans.BeanWrapperImpl;
  43. import org.springframework.beans.factory.BeanFactory;
  44. import org.springframework.beans.factory.BeanFactoryAware;
  45. import org.springframework.beans.factory.InitializingBean;
  46. import org.springframework.beans.factory.ListableBeanFactory;
  47. import org.springframework.beans.factory.ObjectProvider;
  48. import org.springframework.beans.factory.annotation.Autowired;
  49. import org.springframework.beans.factory.config.BeanDefinition;
  50. import org.springframework.beans.factory.support.BeanDefinitionBuilder;
  51. import org.springframework.beans.factory.support.BeanDefinitionRegistry;
  52. import org.springframework.boot.autoconfigure.AutoConfigurationPackages;
  53. import org.springframework.boot.autoconfigure.AutoConfigureAfter;
  54. import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
  55. import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
  56. import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
  57. import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
  58. import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
  59. import org.springframework.boot.context.properties.EnableConfigurationProperties;
  60. import org.springframework.context.ApplicationContext;
  61. import org.springframework.context.EnvironmentAware;
  62. import org.springframework.context.annotation.Bean;
  63. import org.springframework.context.annotation.Configuration;
  64. import org.springframework.context.annotation.Import;
  65. import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
  66. import org.springframework.core.annotation.Order;
  67. import org.springframework.core.env.Environment;
  68. import org.springframework.core.io.Resource;
  69. import org.springframework.core.io.ResourceLoader;
  70. import org.springframework.core.type.AnnotationMetadata;
  71. import org.springframework.util.Assert;
  72. import org.springframework.util.CollectionUtils;
  73. import org.springframework.util.ObjectUtils;
  74. import org.springframework.util.StringUtils;
  75. import javax.sql.DataSource;
  76. import java.beans.PropertyDescriptor;
  77. import java.util.ArrayList;
  78. import java.util.List;
  79. import java.util.Map;
  80. import java.util.Optional;
  81. import java.util.Set;
  82. import java.util.function.Consumer;
  83. import java.util.stream.Collectors;
  84. import java.util.stream.Stream;
  85. /**
  86. * {@link EnableAutoConfiguration Auto-Configuration} for Mybatis. Contributes a
  87. * {@link SqlSessionFactory} and a {@link SqlSessionTemplate}.
  88. * <p>
  89. * If {@link org.mybatis.spring.annotation.MapperScan} is used, or a
  90. * configuration file is specified as a property, those will be considered,
  91. * otherwise this auto-configuration will attempt to register mappers based on
  92. * the interface definitions in or under the root auto-configuration package.
  93. * </p>
  94. * <p> copy from {@link org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration}</p>
  95. *
  96. * @author Eddú Meléndez
  97. * @author Josh Long
  98. * @author Kazuki Shimizu
  99. * @author Eduardo Macarrón
  100. */
  101. @Configuration(proxyBeanMethods = false)
  102. @ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
  103. @ConditionalOnSingleCandidate(DataSource.class)
  104. @EnableConfigurationProperties(MybatisPlusProperties.class)
  105. @AutoConfigureAfter({DataSourceAutoConfiguration.class, MybatisPlusLanguageDriverAutoConfiguration.class})
  106. public class MybatisPlusAutoConfiguration implements InitializingBean {
  107. private static final Logger logger = LoggerFactory.getLogger(MybatisPlusAutoConfiguration.class);
  108. private final MybatisPlusProperties properties;
  109. private final Interceptor[] interceptors;
  110. private final TypeHandler[] typeHandlers;
  111. private final LanguageDriver[] languageDrivers;
  112. private final ResourceLoader resourceLoader;
  113. private final DatabaseIdProvider databaseIdProvider;
  114. private final List<ConfigurationCustomizer> configurationCustomizers;
  115. private final List<SqlSessionFactoryBeanCustomizer> sqlSessionFactoryBeanCustomizers;
  116. private final List<MybatisPlusPropertiesCustomizer> mybatisPlusPropertiesCustomizers;
  117. private final ApplicationContext applicationContext;
  118. public MybatisPlusAutoConfiguration(MybatisPlusProperties properties,
  119. ObjectProvider<Interceptor[]> interceptorsProvider,
  120. ObjectProvider<TypeHandler[]> typeHandlersProvider,
  121. ObjectProvider<LanguageDriver[]> languageDriversProvider,
  122. ResourceLoader resourceLoader,
  123. ObjectProvider<DatabaseIdProvider> databaseIdProvider,
  124. ObjectProvider<List<ConfigurationCustomizer>> configurationCustomizersProvider,
  125. ObjectProvider<List<SqlSessionFactoryBeanCustomizer>> sqlSessionFactoryBeanCustomizers,
  126. ObjectProvider<List<MybatisPlusPropertiesCustomizer>> mybatisPlusPropertiesCustomizerProvider,
  127. ApplicationContext applicationContext) {
  128. this.properties = properties;
  129. this.interceptors = interceptorsProvider.getIfAvailable();
  130. this.typeHandlers = typeHandlersProvider.getIfAvailable();
  131. this.languageDrivers = languageDriversProvider.getIfAvailable();
  132. this.resourceLoader = resourceLoader;
  133. this.databaseIdProvider = databaseIdProvider.getIfAvailable();
  134. this.configurationCustomizers = configurationCustomizersProvider.getIfAvailable();
  135. this.sqlSessionFactoryBeanCustomizers = sqlSessionFactoryBeanCustomizers.getIfAvailable();
  136. this.mybatisPlusPropertiesCustomizers = mybatisPlusPropertiesCustomizerProvider.getIfAvailable();
  137. this.applicationContext = applicationContext;
  138. }
  139. @Override
  140. public void afterPropertiesSet() {
  141. if (!CollectionUtils.isEmpty(mybatisPlusPropertiesCustomizers)) {
  142. mybatisPlusPropertiesCustomizers.forEach(i -> i.customize(properties));
  143. }
  144. checkConfigFileExists();
  145. }
  146. private void checkConfigFileExists() {
  147. if (this.properties.isCheckConfigLocation() && StringUtils.hasText(this.properties.getConfigLocation())) {
  148. Resource resource = this.resourceLoader.getResource(this.properties.getConfigLocation());
  149. Assert.state(resource.exists(),
  150. "Cannot find config location: " + resource + " (please add config file or check your Mybatis configuration)");
  151. }
  152. }
  153. @Bean
  154. @ConditionalOnMissingBean
  155. public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
  156. // TODO 使用 MybatisSqlSessionFactoryBean 而不是 SqlSessionFactoryBean
  157. MybatisSqlSessionFactoryBean factory = new MybatisSqlSessionFactoryBean();
  158. factory.setDataSource(dataSource);
  159. factory.setVfs(SpringBootVFS.class);
  160. if (StringUtils.hasText(this.properties.getConfigLocation())) {
  161. factory.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation()));
  162. }
  163. applyConfiguration(factory);
  164. if (this.properties.getConfigurationProperties() != null) {
  165. factory.setConfigurationProperties(this.properties.getConfigurationProperties());
  166. }
  167. if (!ObjectUtils.isEmpty(this.interceptors)) {
  168. factory.setPlugins(this.interceptors);
  169. }
  170. if (this.databaseIdProvider != null) {
  171. factory.setDatabaseIdProvider(this.databaseIdProvider);
  172. }
  173. if (StringUtils.hasLength(this.properties.getTypeAliasesPackage())) {
  174. factory.setTypeAliasesPackage(this.properties.getTypeAliasesPackage());
  175. }
  176. if (this.properties.getTypeAliasesSuperType() != null) {
  177. factory.setTypeAliasesSuperType(this.properties.getTypeAliasesSuperType());
  178. }
  179. if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) {
  180. factory.setTypeHandlersPackage(this.properties.getTypeHandlersPackage());
  181. }
  182. if (!ObjectUtils.isEmpty(this.typeHandlers)) {
  183. factory.setTypeHandlers(this.typeHandlers);
  184. }
  185. if (!ObjectUtils.isEmpty(this.properties.resolveMapperLocations())) {
  186. factory.setMapperLocations(this.properties.resolveMapperLocations());
  187. }
  188. // TODO 修改源码支持定义 TransactionFactory
  189. this.getBeanThen(TransactionFactory.class, factory::setTransactionFactory);
  190. // TODO 对源码做了一定的修改(因为源码适配了老旧的mybatis版本,但我们不需要适配)
  191. Class<? extends LanguageDriver> defaultLanguageDriver = this.properties.getDefaultScriptingLanguageDriver();
  192. if (!ObjectUtils.isEmpty(this.languageDrivers)) {
  193. factory.setScriptingLanguageDrivers(this.languageDrivers);
  194. }
  195. Optional.ofNullable(defaultLanguageDriver).ifPresent(factory::setDefaultScriptingLanguageDriver);
  196. applySqlSessionFactoryBeanCustomizers(factory);
  197. // TODO 此处必为非 NULL
  198. GlobalConfig globalConfig = this.properties.getGlobalConfig();
  199. // TODO 注入填充器
  200. this.getBeanThen(MetaObjectHandler.class, globalConfig::setMetaObjectHandler);
  201. // TODO 注入注解控制器
  202. this.getBeanThen(AnnotationHandler.class, globalConfig::setAnnotationHandler);
  203. // TODO 注入参与器
  204. this.getBeanThen(PostInitTableInfoHandler.class, globalConfig::setPostInitTableInfoHandler);
  205. // TODO 注入主键生成器
  206. this.getBeansThen(IKeyGenerator.class, i -> globalConfig.getDbConfig().setKeyGenerators(i));
  207. // TODO 注入sql注入器
  208. this.getBeanThen(ISqlInjector.class, globalConfig::setSqlInjector);
  209. // TODO 注入ID生成器
  210. this.getBeanThen(IdentifierGenerator.class, globalConfig::setIdentifierGenerator);
  211. // TODO 设置 GlobalConfig 到 MybatisSqlSessionFactoryBean
  212. factory.setGlobalConfig(globalConfig);
  213. return factory.getObject();
  214. }
  215. /**
  216. * 检查spring容器里是否有对应的bean,有则进行消费
  217. *
  218. * @param clazz class
  219. * @param consumer 消费
  220. * @param <T> 泛型
  221. */
  222. private <T> void getBeanThen(Class<T> clazz, Consumer<T> consumer) {
  223. if (this.applicationContext.getBeanNamesForType(clazz, false, false).length > 0) {
  224. consumer.accept(this.applicationContext.getBean(clazz));
  225. }
  226. }
  227. /**
  228. * 检查spring容器里是否有对应的bean,有则进行消费
  229. *
  230. * @param clazz class
  231. * @param consumer 消费
  232. * @param <T> 泛型
  233. */
  234. private <T> void getBeansThen(Class<T> clazz, Consumer<List<T>> consumer) {
  235. if (this.applicationContext.getBeanNamesForType(clazz, false, false).length > 0) {
  236. final Map<String, T> beansOfType = this.applicationContext.getBeansOfType(clazz);
  237. List<T> clazzList = new ArrayList<>();
  238. beansOfType.forEach((k, v) -> clazzList.add(v));
  239. consumer.accept(clazzList);
  240. }
  241. }
  242. // TODO 入参使用 MybatisSqlSessionFactoryBean
  243. private void applyConfiguration(MybatisSqlSessionFactoryBean factory) {
  244. // TODO 使用 MybatisConfiguration
  245. MybatisConfiguration configuration = this.properties.getConfiguration();
  246. if (configuration == null && !StringUtils.hasText(this.properties.getConfigLocation())) {
  247. configuration = new MybatisConfiguration();
  248. }
  249. if (configuration != null && !CollectionUtils.isEmpty(this.configurationCustomizers)) {
  250. for (ConfigurationCustomizer customizer : this.configurationCustomizers) {
  251. customizer.customize(configuration);
  252. }
  253. }
  254. factory.setConfiguration(configuration);
  255. }
  256. private void applySqlSessionFactoryBeanCustomizers(MybatisSqlSessionFactoryBean factory) {
  257. if (!CollectionUtils.isEmpty(this.sqlSessionFactoryBeanCustomizers)) {
  258. for (SqlSessionFactoryBeanCustomizer customizer : this.sqlSessionFactoryBeanCustomizers) {
  259. customizer.customize(factory);
  260. }
  261. }
  262. }
  263. @Bean
  264. @ConditionalOnMissingBean
  265. public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
  266. ExecutorType executorType = this.properties.getExecutorType();
  267. if (executorType != null) {
  268. return new SqlSessionTemplate(sqlSessionFactory, executorType);
  269. } else {
  270. return new SqlSessionTemplate(sqlSessionFactory);
  271. }
  272. }
  273. /**
  274. * This will just scan the same base package as Spring Boot does. If you want more power, you can explicitly use
  275. * {@link org.mybatis.spring.annotation.MapperScan} but this will get typed mappers working correctly, out-of-the-box,
  276. * similar to using Spring Data JPA repositories.
  277. */
  278. public static class AutoConfiguredMapperScannerRegistrar
  279. implements BeanFactoryAware, EnvironmentAware, ImportBeanDefinitionRegistrar {
  280. private BeanFactory beanFactory;
  281. private Environment environment;
  282. @Override
  283. public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
  284. if (!AutoConfigurationPackages.has(this.beanFactory)) {
  285. logger.debug("Could not determine auto-configuration package, automatic mapper scanning disabled.");
  286. return;
  287. }
  288. logger.debug("Searching for mappers annotated with @Mapper");
  289. List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
  290. if (logger.isDebugEnabled()) {
  291. packages.forEach(pkg -> logger.debug("Using auto-configuration base package '{}'", pkg));
  292. }
  293. BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class);
  294. builder.addPropertyValue("processPropertyPlaceHolders", true);
  295. builder.addPropertyValue("annotationClass", Mapper.class);
  296. builder.addPropertyValue("basePackage", StringUtils.collectionToCommaDelimitedString(packages));
  297. BeanWrapper beanWrapper = new BeanWrapperImpl(MapperScannerConfigurer.class);
  298. Set<String> propertyNames = Stream.of(beanWrapper.getPropertyDescriptors()).map(PropertyDescriptor::getName)
  299. .collect(Collectors.toSet());
  300. if (propertyNames.contains("lazyInitialization")) {
  301. // Need to mybatis-spring 2.0.2+
  302. // TODO 兼容了mybatis.lazy-initialization配置
  303. builder.addPropertyValue("lazyInitialization", "${mybatis-plus.lazy-initialization:${mybatis.lazy-initialization:false}}");
  304. }
  305. if (propertyNames.contains("defaultScope")) {
  306. // Need to mybatis-spring 2.0.6+
  307. builder.addPropertyValue("defaultScope", "${mybatis-plus.mapper-default-scope:}");
  308. }
  309. // for spring-native
  310. boolean injectSqlSession = environment.getProperty("mybatis.inject-sql-session-on-mapper-scan", Boolean.class,
  311. Boolean.TRUE);
  312. if (injectSqlSession && this.beanFactory instanceof ListableBeanFactory) {
  313. ListableBeanFactory listableBeanFactory = (ListableBeanFactory) this.beanFactory;
  314. Optional<String> sqlSessionTemplateBeanName = Optional
  315. .ofNullable(getBeanNameForType(SqlSessionTemplate.class, listableBeanFactory));
  316. Optional<String> sqlSessionFactoryBeanName = Optional
  317. .ofNullable(getBeanNameForType(SqlSessionFactory.class, listableBeanFactory));
  318. if (sqlSessionTemplateBeanName.isPresent() || !sqlSessionFactoryBeanName.isPresent()) {
  319. builder.addPropertyValue("sqlSessionTemplateBeanName",
  320. sqlSessionTemplateBeanName.orElse("sqlSessionTemplate"));
  321. } else {
  322. builder.addPropertyValue("sqlSessionFactoryBeanName", sqlSessionFactoryBeanName.get());
  323. }
  324. }
  325. builder.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
  326. registry.registerBeanDefinition(MapperScannerConfigurer.class.getName(), builder.getBeanDefinition());
  327. }
  328. @Override
  329. public void setBeanFactory(BeanFactory beanFactory) {
  330. this.beanFactory = beanFactory;
  331. }
  332. @Override
  333. public void setEnvironment(Environment environment) {
  334. this.environment = environment;
  335. }
  336. private String getBeanNameForType(Class<?> type, ListableBeanFactory factory) {
  337. String[] beanNames = factory.getBeanNamesForType(type);
  338. return beanNames.length > 0 ? beanNames[0] : null;
  339. }
  340. }
  341. /**
  342. * If mapper registering configuration or mapper scanning configuration not present, this configuration allow to scan
  343. * mappers based on the same component-scanning path as Spring Boot itself.
  344. */
  345. @org.springframework.context.annotation.Configuration
  346. @Import(AutoConfiguredMapperScannerRegistrar.class)
  347. @ConditionalOnMissingBean({MapperFactoryBean.class, MapperScannerConfigurer.class})
  348. public static class MapperScannerRegistrarNotFoundConfiguration implements InitializingBean {
  349. @Override
  350. public void afterPropertiesSet() {
  351. logger.debug(
  352. "Not found configuration for registering mapper bean using @MapperScan, MapperFactoryBean and MapperScannerConfigurer.");
  353. }
  354. }
  355. @Order
  356. @Bean
  357. @ConditionalOnMissingBean
  358. public DdlApplicationRunner ddlApplicationRunner(@Autowired(required = false) List<IDdl> ddlList) {
  359. if (ObjectUtils.isEmpty(ddlList)) {
  360. return null;
  361. }
  362. return new DdlApplicationRunner(ddlList);
  363. }
  364. }