|
@@ -0,0 +1,232 @@
|
|
|
+package com.baomidou.mybatisplus.spring.boot.starter;
|
|
|
+
|
|
|
+import java.util.List;
|
|
|
+
|
|
|
+import javax.annotation.PostConstruct;
|
|
|
+import javax.sql.DataSource;
|
|
|
+
|
|
|
+import org.apache.ibatis.annotations.Mapper;
|
|
|
+import org.apache.ibatis.logging.Log;
|
|
|
+import org.apache.ibatis.logging.LogFactory;
|
|
|
+import org.apache.ibatis.mapping.DatabaseIdProvider;
|
|
|
+import org.apache.ibatis.plugin.Interceptor;
|
|
|
+import org.apache.ibatis.session.ExecutorType;
|
|
|
+import org.apache.ibatis.session.SqlSessionFactory;
|
|
|
+import org.mybatis.spring.SqlSessionTemplate;
|
|
|
+import org.mybatis.spring.mapper.ClassPathMapperScanner;
|
|
|
+import org.mybatis.spring.mapper.MapperFactoryBean;
|
|
|
+import org.springframework.beans.BeansException;
|
|
|
+import org.springframework.beans.factory.BeanFactory;
|
|
|
+import org.springframework.beans.factory.BeanFactoryAware;
|
|
|
+import org.springframework.beans.factory.ObjectProvider;
|
|
|
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
|
|
|
+import org.springframework.boot.autoconfigure.AutoConfigurationPackages;
|
|
|
+import org.springframework.boot.autoconfigure.AutoConfigureAfter;
|
|
|
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
|
|
|
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
|
|
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
|
|
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
|
|
+import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
|
|
|
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
|
|
+import org.springframework.context.ResourceLoaderAware;
|
|
|
+import org.springframework.context.annotation.Bean;
|
|
|
+import org.springframework.context.annotation.Import;
|
|
|
+import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
|
|
|
+import org.springframework.core.io.Resource;
|
|
|
+import org.springframework.core.io.ResourceLoader;
|
|
|
+import org.springframework.core.type.AnnotationMetadata;
|
|
|
+import org.springframework.util.Assert;
|
|
|
+import org.springframework.util.CollectionUtils;
|
|
|
+import org.springframework.util.ObjectUtils;
|
|
|
+import org.springframework.util.StringUtils;
|
|
|
+
|
|
|
+import com.baomidou.mybatisplus.MybatisConfiguration;
|
|
|
+import com.baomidou.mybatisplus.MybatisXMLLanguageDriver;
|
|
|
+import com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean;
|
|
|
+
|
|
|
+/**
|
|
|
+ * {@link EnableAutoConfiguration Auto-Configuration} for Mybatis. Contributes a
|
|
|
+ * {@link SqlSessionFactory} and a {@link SqlSessionTemplate}.
|
|
|
+ * <p>
|
|
|
+ * If {@link org.mybatis.spring.annotation.MapperScan} is used, or a
|
|
|
+ * configuration file is specified as a property, those will be considered,
|
|
|
+ * otherwise this auto-configuration will attempt to register mappers based on
|
|
|
+ * the interface definitions in or under the root auto-configuration package.
|
|
|
+ *
|
|
|
+ * @author Eddú Meléndez
|
|
|
+ * @author Josh Long
|
|
|
+ * @author Kazuki Shimizu
|
|
|
+ * @author Eduardo Macarrón
|
|
|
+ */
|
|
|
+@SuppressWarnings("ConstantConditions")
|
|
|
+@org.springframework.context.annotation.Configuration
|
|
|
+@ConditionalOnClass({SqlSessionFactory.class, MybatisSqlSessionFactoryBean.class})
|
|
|
+@ConditionalOnBean(DataSource.class)
|
|
|
+@EnableConfigurationProperties(MybatisPlusProperties.class)
|
|
|
+@AutoConfigureAfter(DataSourceAutoConfiguration.class)
|
|
|
+public class MybatisPlusAutoConfiguration {
|
|
|
+
|
|
|
+ private static final Log logger = LogFactory.getLog(MybatisPlusAutoConfiguration.class);
|
|
|
+
|
|
|
+ private final MybatisPlusProperties properties;
|
|
|
+
|
|
|
+ private final Interceptor[] interceptors;
|
|
|
+
|
|
|
+ private final ResourceLoader resourceLoader;
|
|
|
+
|
|
|
+ private final DatabaseIdProvider databaseIdProvider;
|
|
|
+
|
|
|
+ private final List<ConfigurationCustomizer> configurationCustomizers;
|
|
|
+
|
|
|
+ public MybatisPlusAutoConfiguration(MybatisPlusProperties properties,
|
|
|
+ ObjectProvider<Interceptor[]> interceptorsProvider,
|
|
|
+ ResourceLoader resourceLoader,
|
|
|
+ ObjectProvider<DatabaseIdProvider> databaseIdProvider,
|
|
|
+ ObjectProvider<List<ConfigurationCustomizer>> configurationCustomizersProvider) {
|
|
|
+ this.properties = properties;
|
|
|
+ this.interceptors = interceptorsProvider.getIfAvailable();
|
|
|
+ this.resourceLoader = resourceLoader;
|
|
|
+ this.databaseIdProvider = databaseIdProvider.getIfAvailable();
|
|
|
+ this.configurationCustomizers = configurationCustomizersProvider.getIfAvailable();
|
|
|
+ }
|
|
|
+
|
|
|
+ @PostConstruct
|
|
|
+ public void checkConfigFileExists() {
|
|
|
+ if (this.properties.isCheckConfigLocation() && StringUtils.hasText(this.properties.getConfigLocation())) {
|
|
|
+ Resource resource = this.resourceLoader.getResource(this.properties.getConfigLocation());
|
|
|
+ Assert.state(resource.exists(), "Cannot find config location: " + resource
|
|
|
+ + " (please add config file or check your Mybatis configuration)");
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ @Bean
|
|
|
+ @ConditionalOnMissingBean
|
|
|
+ public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
|
|
|
+ MybatisSqlSessionFactoryBean factory = new MybatisSqlSessionFactoryBean();
|
|
|
+ factory.setDataSource(dataSource);
|
|
|
+ factory.setVfs(SpringBootVFS.class);
|
|
|
+ if (StringUtils.hasText(this.properties.getConfigLocation())) {
|
|
|
+ factory.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation()));
|
|
|
+ }
|
|
|
+ MybatisConfiguration configuration = this.properties.getConfiguration();
|
|
|
+ if (configuration == null && !StringUtils.hasText(this.properties.getConfigLocation())) {
|
|
|
+ configuration = new MybatisConfiguration();
|
|
|
+ }
|
|
|
+ if (configuration != null && !CollectionUtils.isEmpty(this.configurationCustomizers)) {
|
|
|
+ for (ConfigurationCustomizer customizer : this.configurationCustomizers) {
|
|
|
+ customizer.customize(configuration);
|
|
|
+ }
|
|
|
+ }
|
|
|
+ configuration.setDefaultScriptingLanguage(MybatisXMLLanguageDriver.class);
|
|
|
+ factory.setConfiguration(configuration);
|
|
|
+ if (this.properties.getConfigurationProperties() != null) {
|
|
|
+ factory.setConfigurationProperties(this.properties.getConfigurationProperties());
|
|
|
+ }
|
|
|
+ if (!ObjectUtils.isEmpty(this.interceptors)) {
|
|
|
+ factory.setPlugins(this.interceptors);
|
|
|
+ }
|
|
|
+ if (this.databaseIdProvider != null) {
|
|
|
+ factory.setDatabaseIdProvider(this.databaseIdProvider);
|
|
|
+ }
|
|
|
+ if (StringUtils.hasLength(this.properties.getTypeAliasesPackage())) {
|
|
|
+ factory.setTypeAliasesPackage(this.properties.getTypeAliasesPackage());
|
|
|
+ }
|
|
|
+ // TODO 自定义枚举包
|
|
|
+ if (StringUtils.hasLength(this.properties.getTypeEnumsPackage())) {
|
|
|
+ factory.setTypeEnumsPackage(this.properties.getTypeEnumsPackage());
|
|
|
+ }
|
|
|
+ if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) {
|
|
|
+ factory.setTypeHandlersPackage(this.properties.getTypeHandlersPackage());
|
|
|
+ }
|
|
|
+ if (!ObjectUtils.isEmpty(this.properties.resolveMapperLocations())) {
|
|
|
+ factory.setMapperLocations(this.properties.resolveMapperLocations());
|
|
|
+ }
|
|
|
+ if (!ObjectUtils.isEmpty(this.properties.getGlobalConfig())) {
|
|
|
+ factory.setGlobalConfig(this.properties.getGlobalConfig().convertGlobalConfiguration());
|
|
|
+ }
|
|
|
+ return factory.getObject();
|
|
|
+ }
|
|
|
+
|
|
|
+ @Bean
|
|
|
+ @ConditionalOnMissingBean
|
|
|
+ public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
|
|
|
+ ExecutorType executorType = this.properties.getExecutorType();
|
|
|
+ if (executorType != null) {
|
|
|
+ return new SqlSessionTemplate(sqlSessionFactory, executorType);
|
|
|
+ } else {
|
|
|
+ return new SqlSessionTemplate(sqlSessionFactory);
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * This will just scan the same base package as Spring Boot does. If you want
|
|
|
+ * more power, you can explicitly use
|
|
|
+ * {@link org.mybatis.spring.annotation.MapperScan} but this will get typed
|
|
|
+ * mappers working correctly, out-of-the-box, similar to using Spring Data JPA
|
|
|
+ * repositories.
|
|
|
+ */
|
|
|
+ public static class AutoConfiguredMapperScannerRegistrar
|
|
|
+ implements BeanFactoryAware, ImportBeanDefinitionRegistrar, ResourceLoaderAware {
|
|
|
+
|
|
|
+ private BeanFactory beanFactory;
|
|
|
+
|
|
|
+ private ResourceLoader resourceLoader;
|
|
|
+
|
|
|
+ @Override
|
|
|
+ public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
|
|
|
+
|
|
|
+ logger.debug("Searching for mappers annotated with @Mapper");
|
|
|
+
|
|
|
+ ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
|
|
|
+
|
|
|
+ try {
|
|
|
+ if (this.resourceLoader != null) {
|
|
|
+ scanner.setResourceLoader(this.resourceLoader);
|
|
|
+ }
|
|
|
+
|
|
|
+ List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
|
|
|
+ if (logger.isDebugEnabled()) {
|
|
|
+ for (String pkg : packages) {
|
|
|
+ logger.debug("Using auto-configuration base package '" + pkg + "'");
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ scanner.setAnnotationClass(Mapper.class);
|
|
|
+ scanner.registerFilters();
|
|
|
+ scanner.doScan(StringUtils.toStringArray(packages));
|
|
|
+ } catch (IllegalStateException ex) {
|
|
|
+ logger.debug("Could not determine auto-configuration package, automatic mapper scanning disabled." + ex);
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ @Override
|
|
|
+ public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
|
|
|
+ this.beanFactory = beanFactory;
|
|
|
+ }
|
|
|
+
|
|
|
+ @Override
|
|
|
+ public void setResourceLoader(ResourceLoader resourceLoader) {
|
|
|
+ this.resourceLoader = resourceLoader;
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * {@link org.mybatis.spring.annotation.MapperScan} ultimately ends up
|
|
|
+ * creating instances of {@link MapperFactoryBean}. If
|
|
|
+ * {@link org.mybatis.spring.annotation.MapperScan} is used then this
|
|
|
+ * auto-configuration is not needed. If it is _not_ used, however, then this
|
|
|
+ * will bring in a bean registrar and automatically register components based
|
|
|
+ * on the same component-scanning path as Spring Boot itself.
|
|
|
+ */
|
|
|
+ @org.springframework.context.annotation.Configuration
|
|
|
+ @Import({AutoConfiguredMapperScannerRegistrar.class})
|
|
|
+ @ConditionalOnMissingBean(MapperFactoryBean.class)
|
|
|
+ public static class MapperScannerRegistrarNotFoundConfiguration {
|
|
|
+
|
|
|
+ @PostConstruct
|
|
|
+ public void afterPropertiesSet() {
|
|
|
+ logger.debug("No " + MapperFactoryBean.class.getName() + " found.");
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+}
|