All Downloads are FREE. Search and download functionalities are using the official Maven repository.

yui.comn.mybatisx.extension.spring.MybatisSqlSessionFactoryBean Maven / Gradle / Ivy

package yui.comn.mybatisx.extension.spring;

import static org.springframework.util.Assert.notNull;
import static org.springframework.util.Assert.state;
import static org.springframework.util.ObjectUtils.isEmpty;
import static org.springframework.util.StringUtils.hasLength;
import static org.springframework.util.StringUtils.tokenizeToStringArray;

import java.io.IOException;
import java.lang.reflect.Modifier;
import java.sql.SQLException;
import java.util.HashSet;
import java.util.Optional;
import java.util.Properties;
import java.util.Set;
import java.util.stream.Stream;

import javax.sql.DataSource;

import org.apache.ibatis.builder.xml.XMLMapperBuilder;
import org.apache.ibatis.cache.Cache;
import org.apache.ibatis.executor.ErrorContext;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.io.VFS;
import org.apache.ibatis.mapping.DatabaseIdProvider;
import org.apache.ibatis.mapping.Environment;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.reflection.factory.ObjectFactory;
import org.apache.ibatis.reflection.wrapper.ObjectWrapperFactory;
import org.apache.ibatis.scripting.LanguageDriver;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.transaction.TransactionFactory;
import org.apache.ibatis.type.TypeHandler;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.mybatis.logging.Logger;
import org.mybatis.logging.LoggerFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.transaction.SpringManagedTransactionFactory;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.core.NestedIOException;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.core.type.ClassMetadata;
import org.springframework.core.type.classreading.CachingMetadataReaderFactory;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import org.springframework.jdbc.datasource.TransactionAwareDataSourceProxy;
import org.springframework.util.ClassUtils;

import com.baomidou.mybatisplus.core.MybatisConfiguration;
import com.baomidou.mybatisplus.core.MybatisPlusVersion;
import com.baomidou.mybatisplus.core.MybatisSqlSessionFactoryBuilder;
import com.baomidou.mybatisplus.core.config.GlobalConfig;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler;
import com.baomidou.mybatisplus.core.toolkit.Assert;
import com.baomidou.mybatisplus.core.toolkit.GlobalConfigUtils;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.extension.toolkit.SqlHelper;

import lombok.Setter;
import yui.comn.mybatisx.core.InjectorMapperBuilder;
import yui.comn.mybatisx.core.MybatisLinkConfiguration;
import yui.comn.mybatisx.core.MybatisLinkXMLConfigBuilder;

/**
 * 拷贝类 {@link SqlSessionFactoryBean} 修改方法 buildSqlSessionFactory() 加载自定义
 * 

MybatisXmlConfigBuilder

*

移除 sqlSessionFactoryBuilder 属性,强制使用 `new MybatisSqlSessionFactoryBuilder()`

*

移除 environment 属性,强制使用 `MybatisSqlSessionFactoryBean.class.getSimpleName()`

* * @author hubin * @since 2017-01-04 */ public class MybatisSqlSessionFactoryBean implements FactoryBean, InitializingBean, ApplicationListener { private static final Logger LOGGER = LoggerFactory.getLogger(MybatisSqlSessionFactoryBean.class); private static final ResourcePatternResolver RESOURCE_PATTERN_RESOLVER = new PathMatchingResourcePatternResolver(); private static final MetadataReaderFactory METADATA_READER_FACTORY = new CachingMetadataReaderFactory(); private Resource configLocation; // TODO 使用 MybatisConfiguration private MybatisLinkConfiguration configuration; private Resource[] mapperLocations; private DataSource dataSource; private TransactionFactory transactionFactory; private Properties configurationProperties; private SqlSessionFactory sqlSessionFactory; private boolean failFast; private Interceptor[] plugins; private TypeHandler[] typeHandlers; private String typeHandlersPackage; private Class[] typeAliases; private String typeAliasesPackage; private Class typeAliasesSuperType; private LanguageDriver[] scriptingLanguageDrivers; private Class defaultScriptingLanguageDriver; // issue #19. No default provider. private DatabaseIdProvider databaseIdProvider; private Class vfs; private Cache cache; private ObjectFactory objectFactory; private ObjectWrapperFactory objectWrapperFactory; /** * TODO 自定义枚举包 */ @Setter private String typeEnumsPackage; // TODO 自定义全局配置 @Setter private GlobalConfig globalConfig; /** * Sets the ObjectFactory. * * @param objectFactory a custom ObjectFactory * @since 1.1.2 */ public void setObjectFactory(ObjectFactory objectFactory) { this.objectFactory = objectFactory; } /** * Sets the ObjectWrapperFactory. * * @param objectWrapperFactory a specified ObjectWrapperFactory * @since 1.1.2 */ public void setObjectWrapperFactory(ObjectWrapperFactory objectWrapperFactory) { this.objectWrapperFactory = objectWrapperFactory; } /** * Gets the DatabaseIdProvider * * @return a specified DatabaseIdProvider * @since 1.1.0 */ public DatabaseIdProvider getDatabaseIdProvider() { return databaseIdProvider; } /** * Sets the DatabaseIdProvider. As of version 1.2.2 this variable is not initialized by default. * * @param databaseIdProvider a DatabaseIdProvider * @since 1.1.0 */ public void setDatabaseIdProvider(DatabaseIdProvider databaseIdProvider) { this.databaseIdProvider = databaseIdProvider; } /** * Gets the VFS. * * @return a specified VFS */ public Class getVfs() { return this.vfs; } /** * Sets the VFS. * * @param vfs a VFS */ public void setVfs(Class vfs) { this.vfs = vfs; } /** * Gets the Cache. * * @return a specified Cache */ public Cache getCache() { return this.cache; } /** * Sets the Cache. * * @param cache a Cache */ public void setCache(Cache cache) { this.cache = cache; } /** * Mybatis plugin list. * * @param plugins list of plugins * @since 1.0.1 */ public void setPlugins(Interceptor... plugins) { this.plugins = plugins; } /** * Packages to search for type aliases. * *

* Since 2.0.1, allow to specify a wildcard such as {@code com.example.*.model}. * * @param typeAliasesPackage package to scan for domain objects * @since 1.0.1 */ public void setTypeAliasesPackage(String typeAliasesPackage) { this.typeAliasesPackage = typeAliasesPackage; } /** * Super class which domain objects have to extend to have a type alias created. No effect if there is no package to * scan configured. * * @param typeAliasesSuperType super class for domain objects * @since 1.1.2 */ public void setTypeAliasesSuperType(Class typeAliasesSuperType) { this.typeAliasesSuperType = typeAliasesSuperType; } /** * Packages to search for type handlers. * *

* Since 2.0.1, allow to specify a wildcard such as {@code com.example.*.typehandler}. * * @param typeHandlersPackage package to scan for type handlers * @since 1.0.1 */ public void setTypeHandlersPackage(String typeHandlersPackage) { this.typeHandlersPackage = typeHandlersPackage; } /** * Set type handlers. They must be annotated with {@code MappedTypes} and optionally with {@code MappedJdbcTypes} * * @param typeHandlers Type handler list * @since 1.0.1 */ public void setTypeHandlers(TypeHandler... typeHandlers) { this.typeHandlers = typeHandlers; } /** * List of type aliases to register. They can be annotated with {@code Alias} * * @param typeAliases Type aliases list * @since 1.0.1 */ public void setTypeAliases(Class... typeAliases) { this.typeAliases = typeAliases; } /** * If true, a final check is done on Configuration to assure that all mapped statements are fully loaded and there is * no one still pending to resolve includes. Defaults to false. * * @param failFast enable failFast * @since 1.0.1 */ public void setFailFast(boolean failFast) { this.failFast = failFast; } /** * Set the location of the MyBatis {@code SqlSessionFactory} config file. A typical value is * "WEB-INF/mybatis-configuration.xml". * * @param configLocation a location the MyBatis config file */ public void setConfigLocation(Resource configLocation) { this.configLocation = configLocation; } /** * Set a customized MyBatis configuration. * TODO 这里的入参使用 MybatisConfiguration 而不是 Configuration * * @param configuration MyBatis configuration * @since 1.3.0 */ public void setConfiguration(MybatisLinkConfiguration configuration) { this.configuration = configuration; } public MybatisConfiguration getConfiguration() { return this.configuration; } /** * Set locations of MyBatis mapper files that are going to be merged into the {@code SqlSessionFactory} configuration * at runtime. *

* This is an alternative to specifying "<sqlmapper>" entries in an MyBatis config file. This property being * based on Spring's resource abstraction also allows for specifying resource patterns here: e.g. * "classpath*:sqlmap/*-mapper.xml". * * @param mapperLocations location of MyBatis mapper files */ public void setMapperLocations(Resource... mapperLocations) { this.mapperLocations = mapperLocations; } /** * Set optional properties to be passed into the SqlSession configuration, as alternative to a * {@code <properties>} tag in the configuration xml file. This will be used to resolve placeholders in the * config file. * * @param sqlSessionFactoryProperties optional properties for the SqlSessionFactory */ public void setConfigurationProperties(Properties sqlSessionFactoryProperties) { this.configurationProperties = sqlSessionFactoryProperties; } /** * Set the JDBC {@code DataSource} that this instance should manage transactions for. The {@code DataSource} should * match the one used by the {@code SqlSessionFactory}: for example, you could specify the same JNDI DataSource for * both. *

* A transactional JDBC {@code Connection} for this {@code DataSource} will be provided to application code accessing * this {@code DataSource} directly via {@code DataSourceUtils} or {@code DataSourceTransactionManager}. *

* The {@code DataSource} specified here should be the target {@code DataSource} to manage transactions for, not a * {@code TransactionAwareDataSourceProxy}. Only data access code may work with * {@code TransactionAwareDataSourceProxy}, while the transaction manager needs to work on the underlying target * {@code DataSource}. If there's nevertheless a {@code TransactionAwareDataSourceProxy} passed in, it will be * unwrapped to extract its target {@code DataSource}. * * @param dataSource a JDBC {@code DataSource} */ public void setDataSource(DataSource dataSource) { if (dataSource instanceof TransactionAwareDataSourceProxy) { // If we got a TransactionAwareDataSourceProxy, we need to perform // transactions for its underlying target DataSource, else data // access code won't see properly exposed transactions (i.e. // transactions for the target DataSource). this.dataSource = ((TransactionAwareDataSourceProxy) dataSource).getTargetDataSource(); } else { this.dataSource = dataSource; } } /** * Set the MyBatis TransactionFactory to use. Default is {@code SpringManagedTransactionFactory} *

* The default {@code SpringManagedTransactionFactory} should be appropriate for all cases: * be it Spring transaction management, EJB CMT or plain JTA. If there is no active transaction, * SqlSession operations will execute SQL statements non-transactionally. * * It is strongly recommended to use the default {@code TransactionFactory}. If not used, any * attempt at getting an SqlSession through Spring's MyBatis framework will throw an exception if * a transaction is active. * * @param transactionFactory the MyBatis TransactionFactory * @see SpringManagedTransactionFactory */ public void setTransactionFactory(TransactionFactory transactionFactory) { this.transactionFactory = transactionFactory; } /** * Set scripting language drivers. * * @param scriptingLanguageDrivers scripting language drivers * @since 2.0.2 */ public void setScriptingLanguageDrivers(LanguageDriver... scriptingLanguageDrivers) { this.scriptingLanguageDrivers = scriptingLanguageDrivers; } /** * Set a default scripting language driver class. * * @param defaultScriptingLanguageDriver A default scripting language driver class * @since 2.0.2 */ public void setDefaultScriptingLanguageDriver(Class defaultScriptingLanguageDriver) { this.defaultScriptingLanguageDriver = defaultScriptingLanguageDriver; } /** * {@inheritDoc} */ @Override public void afterPropertiesSet() throws Exception { notNull(dataSource, "Property 'dataSource' is required"); state((configuration == null && configLocation == null) || !(configuration != null && configLocation != null), "Property 'configuration' and 'configLocation' can not specified with together"); this.sqlSessionFactory = buildSqlSessionFactory(); } /** * Build a {@code SqlSessionFactory} instance. *

* The default implementation uses the standard MyBatis {@code XMLConfigBuilder} API to build a * {@code SqlSessionFactory} instance based on an Reader. Since 1.3.0, it can be specified a * {@link Configuration} instance directly(without config file). *

* * @return SqlSessionFactory * @throws IOException if loading the config file failed */ protected SqlSessionFactory buildSqlSessionFactory() throws Exception { final Configuration targetConfiguration; // TODO 使用 MybatisXmlConfigBuilder 而不是 XMLConfigBuilder // MybatisXMLConfigBuilder xmlConfigBuilder = null; MybatisLinkXMLConfigBuilder xmlConfigBuilder = null; if (this.configuration != null) { targetConfiguration = this.configuration; if (targetConfiguration.getVariables() == null) { targetConfiguration.setVariables(this.configurationProperties); } else if (this.configurationProperties != null) { targetConfiguration.getVariables().putAll(this.configurationProperties); } } else if (this.configLocation != null) { // TODO 使用 MybatisXMLConfigBuilder // xmlConfigBuilder = new MybatisXMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties); xmlConfigBuilder = new MybatisLinkXMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties); targetConfiguration = xmlConfigBuilder.getConfiguration(); } else { LOGGER.debug(() -> "Property 'configuration' or 'configLocation' not specified, using default MyBatis Configuration"); // TODO 使用 MybatisConfiguration targetConfiguration = new MybatisLinkConfiguration(); Optional.ofNullable(this.configurationProperties).ifPresent(targetConfiguration::setVariables); } // TODO 无配置启动所必须的 this.globalConfig = Optional.ofNullable(this.globalConfig).orElseGet(GlobalConfigUtils::defaults); this.globalConfig.setDbConfig(Optional.ofNullable(this.globalConfig.getDbConfig()).orElseGet(GlobalConfig.DbConfig::new)); // TODO 初始化 id-work 以及 打印骚东西 GlobalConfigUtils.setGlobalConfig(targetConfiguration, this.globalConfig); // TODO 自定义枚举类扫描处理 if (hasLength(this.typeEnumsPackage)) { Set> classes; if (typeEnumsPackage.contains(StringPool.STAR) && !typeEnumsPackage.contains(StringPool.COMMA) && !typeEnumsPackage.contains(StringPool.SEMICOLON)) { classes = scanClasses(typeEnumsPackage, null); if (classes.isEmpty()) { LOGGER.warn(() -> "Can't find class in '[" + typeEnumsPackage + "]' package. Please check your configuration."); } } else { classes = new HashSet<>(); String[] typeEnumsPackageArray = tokenizeToStringArray(this.typeEnumsPackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS); Assert.notNull(typeEnumsPackageArray, "not find typeEnumsPackage:" + typeEnumsPackage); Stream.of(typeEnumsPackageArray).forEach(typePackage -> { try { Set> scanTypePackage = scanClasses(typePackage, null); if (scanTypePackage.isEmpty()) { LOGGER.warn(() -> "Can't find class in '[" + typePackage + "]' package. Please check your configuration."); } else { classes.addAll(scanTypePackage); } } catch (IOException e) { throw new MybatisPlusException("Cannot scan class in '[" + typePackage + "]' package", e); } }); } // 取得类型转换注册器 TypeHandlerRegistry typeHandlerRegistry = targetConfiguration.getTypeHandlerRegistry(); classes.stream() .filter(Class::isEnum) .filter(MybatisEnumTypeHandler::isMpEnums) .forEach(cls -> typeHandlerRegistry.register(cls, MybatisEnumTypeHandler.class)); } Optional.ofNullable(this.objectFactory).ifPresent(targetConfiguration::setObjectFactory); Optional.ofNullable(this.objectWrapperFactory).ifPresent(targetConfiguration::setObjectWrapperFactory); Optional.ofNullable(this.vfs).ifPresent(targetConfiguration::setVfsImpl); if (hasLength(this.typeAliasesPackage)) { scanClasses(this.typeAliasesPackage, this.typeAliasesSuperType).stream() .filter(clazz -> !clazz.isAnonymousClass()).filter(clazz -> !clazz.isInterface()) .filter(clazz -> !clazz.isMemberClass()).forEach(targetConfiguration.getTypeAliasRegistry()::registerAlias); } if (!isEmpty(this.typeAliases)) { Stream.of(this.typeAliases).forEach(typeAlias -> { targetConfiguration.getTypeAliasRegistry().registerAlias(typeAlias); LOGGER.debug(() -> "Registered type alias: '" + typeAlias + "'"); }); } if (!isEmpty(this.plugins)) { Stream.of(this.plugins).forEach(plugin -> { targetConfiguration.addInterceptor(plugin); LOGGER.debug(() -> "Registered plugin: '" + plugin + "'"); }); } if (hasLength(this.typeHandlersPackage)) { scanClasses(this.typeHandlersPackage, TypeHandler.class).stream().filter(clazz -> !clazz.isAnonymousClass()) .filter(clazz -> !clazz.isInterface()).filter(clazz -> !Modifier.isAbstract(clazz.getModifiers())) .forEach(targetConfiguration.getTypeHandlerRegistry()::register); } if (!isEmpty(this.typeHandlers)) { Stream.of(this.typeHandlers).forEach(typeHandler -> { targetConfiguration.getTypeHandlerRegistry().register(typeHandler); LOGGER.debug(() -> "Registered type handler: '" + typeHandler + "'"); }); } if (!isEmpty(this.scriptingLanguageDrivers)) { Stream.of(this.scriptingLanguageDrivers).forEach(languageDriver -> { targetConfiguration.getLanguageRegistry().register(languageDriver); LOGGER.debug(() -> "Registered scripting language driver: '" + languageDriver + "'"); }); } Optional.ofNullable(this.defaultScriptingLanguageDriver).ifPresent(targetConfiguration::setDefaultScriptingLanguage); if (this.databaseIdProvider != null) {// fix #64 set databaseId before parse mapper xmls try { targetConfiguration.setDatabaseId(this.databaseIdProvider.getDatabaseId(this.dataSource)); } catch (SQLException e) { throw new NestedIOException("Failed getting a databaseId", e); } } Optional.ofNullable(this.cache).ifPresent(targetConfiguration::addCache); if (xmlConfigBuilder != null) { try { xmlConfigBuilder.parse(); LOGGER.debug(() -> "Parsed configuration file: '" + this.configLocation + "'"); } catch (Exception ex) { throw new NestedIOException("Failed to parse config resource: " + this.configLocation, ex); } finally { ErrorContext.instance().reset(); } } targetConfiguration.setEnvironment(new Environment(MybatisSqlSessionFactoryBean.class.getSimpleName(), this.transactionFactory == null ? new SpringManagedTransactionFactory() : this.transactionFactory, this.dataSource)); if (this.mapperLocations != null) { if (this.mapperLocations.length == 0) { LOGGER.warn(() -> "Property 'mapperLocations' was specified but matching resources are not found."); } else { for (Resource mapperLocation : this.mapperLocations) { if (mapperLocation == null) { continue; } try { XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(), targetConfiguration, mapperLocation.toString(), targetConfiguration.getSqlFragments()); xmlMapperBuilder.parse(); } catch (Exception e) { throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e); } finally { ErrorContext.instance().reset(); } LOGGER.debug(() -> "Parsed mapper file: '" + mapperLocation + "'"); } LOGGER.debug(() ->"********** Resource to link begin**********"); // 执行一对一,一对多查询 for (Resource mapperLocation : this.mapperLocations) { if (mapperLocation == null) { continue; } try { // TODO 这里也换了噢噢噢噢 InjectorMapperBuilder xmlMapperBuilder = new InjectorMapperBuilder(mapperLocation.getInputStream(), targetConfiguration, mapperLocation.toString(), targetConfiguration.getSqlFragments()); xmlMapperBuilder.parse(); } catch (Exception e) { throw new NestedIOException("Failed to parse mapping resource2: '" + mapperLocation + "'", e); } finally { ErrorContext.instance().reset(); } LOGGER.debug(() ->"Parsed mapper file2: '" + mapperLocation + "'"); } LOGGER.debug(() ->"********** Resource to link end**********"); } } else { LOGGER.debug(() -> "Property 'mapperLocations' was not specified."); } final SqlSessionFactory sqlSessionFactory = new MybatisSqlSessionFactoryBuilder().build(targetConfiguration); // TODO SqlRunner SqlHelper.FACTORY = sqlSessionFactory; // TODO 打印骚东西 Banner if (globalConfig.isBanner()) { System.out.println(" _ _ |_ _ _|_. ___ _ | _ "); System.out.println("| zhe| |\\/|_)(_| | |_\\ |_)||_|_\\ "); System.out.println(" / | "); System.out.println(" " + MybatisPlusVersion.getVersion() + " "); } return sqlSessionFactory; } /** * {@inheritDoc} */ @Override public SqlSessionFactory getObject() throws Exception { if (this.sqlSessionFactory == null) { afterPropertiesSet(); } return this.sqlSessionFactory; } /** * {@inheritDoc} */ @Override public Class getObjectType() { return this.sqlSessionFactory == null ? SqlSessionFactory.class : this.sqlSessionFactory.getClass(); } /** * {@inheritDoc} */ @Override public boolean isSingleton() { return true; } /** * {@inheritDoc} */ @Override public void onApplicationEvent(ApplicationEvent event) { if (failFast && event instanceof ContextRefreshedEvent) { // fail-fast -> check all statements are completed this.sqlSessionFactory.getConfiguration().getMappedStatementNames(); } } private Set> scanClasses(String packagePatterns, Class assignableType) throws IOException { Set> classes = new HashSet<>(); String[] packagePatternArray = tokenizeToStringArray(packagePatterns, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS); for (String packagePattern : packagePatternArray) { Resource[] resources = RESOURCE_PATTERN_RESOLVER.getResources(ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + ClassUtils.convertClassNameToResourcePath(packagePattern) + "/**/*.class"); for (Resource resource : resources) { try { ClassMetadata classMetadata = METADATA_READER_FACTORY.getMetadataReader(resource).getClassMetadata(); Class clazz = Resources.classForName(classMetadata.getClassName()); if (assignableType == null || assignableType.isAssignableFrom(clazz)) { classes.add(clazz); } } catch (Throwable e) { LOGGER.warn(() -> "Cannot load the '" + resource + "'. Cause by " + e.toString()); } } } return classes; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy