com.lightning.testplatform.configure.mybatis.MybatisAutoConfiguration.java Source code

Java tutorial

Introduction

Here is the source code for com.lightning.testplatform.configure.mybatis.MybatisAutoConfiguration.java

Source

/**
 *    Copyright 2015-2016 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package com.lightning.testplatform.configure.mybatis;

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.SqlSessionFactoryBean;
import org.mybatis.spring.SqlSessionTemplate;
import org.mybatis.spring.annotation.MapperScan;
import org.mybatis.spring.mapper.MapperFactoryBean;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.DefaultResourceLoader;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;

import javax.annotation.PostConstruct;
import javax.sql.DataSource;

/**
 * {@link EnableAutoConfiguration Auto-Configuration} for Mybatis. Contributes a
 * {@link SqlSessionFactory} and a {@link SqlSessionTemplate}.
 *
 * 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 Melndez
 * @author Josh Long
 * @author Kazuki Shimizu
 * @author Eduardo Macarrn
 */
@Configuration
//@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class })
//@ConditionalOnBean(DataSource.class)
@EnableConfigurationProperties(MybatisProperties.class)
//@AutoConfigureAfter(DataSourceAutoConfiguration.class)
@MapperScan(basePackages = "com.lightning.testplatform.mapper")
public class MybatisAutoConfiguration {

    private static Logger logger = LoggerFactory.getLogger(MybatisAutoConfiguration.class);

    @Autowired
    private MybatisProperties properties;

    @Autowired(required = false)
    private Interceptor[] interceptors;

    @Autowired
    private ResourceLoader resourceLoader = new DefaultResourceLoader();

    @Autowired(required = false)
    private DatabaseIdProvider databaseIdProvider;

    @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 {
        SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
        factory.setDataSource(dataSource);
        //    factory.setVfs(SpringBootVFS.class);
        if (StringUtils.hasText(this.properties.getConfigLocation())) {
            factory.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation()));

            //      ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
            //      factory.setConfigLocation(resolver.getResource(this.properties.getConfigLocation()));
        }
        factory.setConfiguration(properties.getConfiguration());
        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());
        }
        if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) {
            factory.setTypeHandlersPackage(this.properties.getTypeHandlersPackage());
        }
        if (!ObjectUtils.isEmpty(this.properties.resolveMapperLocations())) {
            factory.setMapperLocations(this.properties.resolveMapperLocations());
        }

        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.");
    ////      }
    //    }
    //
    //    @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.
     */
    //  @Configuration
    //  @Import({ AutoConfiguredMapperScannerRegistrar.class })
    //  @ConditionalOnMissingBean(MapperFactoryBean.class)
    //  public static class MapperScannerRegistrarNotFoundConfiguration {
    //
    //    @PostConstruct
    //    public void afterPropertiesSet() {
    //      logger.debug("No {} found.", MapperFactoryBean.class.getName());
    //    }
    //  }

}