使mybatis配置文件支持通配符，包括别名和mapper!

最新推荐文章于 2024-08-18 01:05:38 发布

好风软件工作日

最新推荐文章于 2024-08-18 01:05:38 发布

阅读量2.4w

点赞数

分类专栏： J2EE SPRING mybatis 文章标签： transactions string interceptor exception resources plugins

本文链接：https://blog.csdn.net/haofeng82/article/details/7861180

版权

J2EE 同时被 3 个专栏收录

25 篇文章 0 订阅

订阅专栏

SPRING

1 篇文章 0 订阅

订阅专栏

mybatis

1 篇文章 0 订阅

订阅专栏

mybatis的配置文件人口只有一个，而且别名必须写在这个文件里面，很难维护，要想实现web项目间的依赖，更是十分困难。所以重写了factoryBean（基于spring管理的方式），代码如下：

/*
*    Copyright 2010-2011 The myBatis Team
*
*    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.
*/
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

import javax.sql.DataSource;

import org.apache.ibatis.builder.xml.XMLConfigBuilder;
import org.apache.ibatis.builder.xml.XMLMapperBuilder;
import org.apache.ibatis.executor.ErrorContext;
import org.apache.ibatis.logging.Log;
import org.apache.ibatis.logging.LogFactory;
import org.apache.ibatis.mapping.Environment;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.apache.ibatis.transaction.TransactionFactory;
import org.apache.ibatis.type.TypeHandler;
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.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.jdbc.datasource.TransactionAwareDataSourceProxy;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;

/**
* {@code FactoryBean} that creates an MyBatis {@code SqlSessionFactory}.
* This is the usual way to set up a shared MyBatis {@code SqlSessionFactory} in a Spring application context;
* the SqlSessionFactory can then be passed to MyBatis-based DAOs via dependency injection.
*
* Either {@code DataSourceTransactionManager} or {@code JtaTransactionManager} can be used for transaction
* demarcation in combination with a {@code SqlSessionFactory}. JTA should be used for transactions
* which span multiple databases or when container managed transactions (CMT) are being used.
*
* @see #setConfigLocation
* @see #setDataSource
* @version $Id: SqlSessionFactoryBean.java 3767 2011-05-25 06:53:43Z eduardo.macarron@gmail.com $
*/
public class XLSqlSessionFactoryBeanV101 implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent> {

private final Log logger = LogFactory.getLog(getClass());

private Resource configLocation;

private Resource[] mapperLocations;

private DataSource dataSource;

private TransactionFactory transactionFactory;

private Properties configurationProperties;

private SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();

private SqlSessionFactory sqlSessionFactory;

private String environment = SqlSessionFactory.class.getSimpleName();

private boolean failFast;

private Interceptor[] plugins;

    private TypeHandler[] typeHandlers;

    private String typeHandlersPackage;

private Class<?>[] typeAliases;

    private String typeAliasesPackage;


/**
* 扩展别名位置，支持通配符、多个
*/
protected String extTypeAliasLocations;
/**
* 扩展mapper位置，支持通配符、多个
*/
protected String extMapperLocations;
/**
* 解析完毕后的mapper资源
*/
protected Resource[] extMappersResources;
/**
* 解析好的别名类数组
*/
protected TypeAliasObjectV3[] extTypeAlias;

    /**
     * Mybatis plugin list.
     *
     * @since 1.0.1
     *
     * @param plugins list of plugins
     *
     */
    public void setPlugins(Interceptor[] plugins) {
      this.plugins = plugins;
    }

/**
* Packages to search for type aliases.
*
* @since 1.0.1
*
* @param typeAliasesPackage package to scan for domain objects
*
*/
    public void setTypeAliasesPackage(String typeAliasesPackage) {
        this.typeAliasesPackage = typeAliasesPackage;
    }

/**
* Packages to search for type handlers.
*
* @since 1.0.1
*
* @param typeHandlersPackage package to scan for type handlers
*
*/
    public void setTypeHandlersPackage(String typeHandlersPackage) {
        this.typeHandlersPackage = typeHandlersPackage;
    }

/**
* Set type handlers. They must be annotated with {@code MappedTypes} and optionally with{@code MappedJdbcTypes}
*
* @since 1.0.1
*
* @param typeHandlers Type handler list
*/
    public void setTypeHandlers(TypeHandler[] typeHandlers) {
        this.typeHandlers = typeHandlers;
    }

/**
* List of type aliases to register. They can be annotated with {@code Alias}
*
* @since 1.0.1
*
* @param typeAliases Type aliases list
*/
 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.
*
* @since 1.0.1
*
* @param failFast enable failFast
*/
    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".
     */
    public void setConfigLocation(Resource configLocation) {
        this.configLocation = configLocation;
    }

/**
 * 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".
 */
 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.
 */
 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}.
     *
     */
    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;
        }
    }

    /**
     * Sets the {@code SqlSessionFactoryBuilder} to use when creating the{@code SqlSessionFactory}.
     *
     * This is mainly meant for testing so that mock SqlSessionFactory classes can be injected. By
     * default, {@code SqlSessionFactoryBuilder} creates{@code DefaultSqlSessionFactory} instances.
     *
     */
    public void setSqlSessionFactoryBuilder(SqlSessionFactoryBuilder sqlSessionFactoryBuilder) {
        this.sqlSessionFactoryBuilder = sqlSessionFactoryBuilder;
    }

/**
 * 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.
 *
 * @see SpringManagedTransactionFactory
 * @param transactionFactory the MyBatis TransactionFactory
 */
 public void setTransactionFactory(TransactionFactory transactionFactory) {
 this.transactionFactory = transactionFactory;
 }

/**
 * NOTE: This class overrides any {@code Environment} you have set in the MyBatis
 * config file. This is used only as a placeholder name. The default value is
 * {@code SqlSessionFactoryBean.class.getSimpleName()}.
 *
 * @param environment the environment name
 */
 public void setEnvironment(String environment) {
 this.environment = environment;
 }

    /**
     * {@inheritDoc}
     */
    public void afterPropertiesSet() throws Exception {
        Assert.notNull(dataSource, "Property 'dataSource' is required");
        Assert.notNull(sqlSessionFactoryBuilder, "Property 'sqlSessionFactoryBuilder' is required");

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.
     *
     * @return SqlSessionFactory
     * @throws IOException if loading the config file failed
     */
    protected SqlSessionFactory buildSqlSessionFactory() throws IOException {

        Configuration configuration;

        XMLConfigBuilder xmlConfigBuilder = null;
        if (this.configLocation != null) {
            xmlConfigBuilder = new XMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);
            configuration = xmlConfigBuilder.getConfiguration();
        } else {
            if (this.logger.isDebugEnabled()) {
                this.logger.debug("Property 'configLocation' not specified, using default MyBatis Configuration");
            }
            configuration = new Configuration();
        }
        extAlias(configuration);
        if (StringUtils.hasLength(this.typeAliasesPackage)) {
            String[] typeAliasPackageArray = StringUtils.tokenizeToStringArray(this.typeAliasesPackage,
                ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
            for (String packageToScan : typeAliasPackageArray) {
                configuration.getTypeAliasRegistry().registerAliases(packageToScan);
                if (this.logger.isDebugEnabled()) {
                    this.logger.debug("Scanned package: '" + packageToScan + "' for aliases");
                }
            }
        }

if (!ObjectUtils.isEmpty(this.typeAliases)) {
 for (Class<?> typeAlias : this.typeAliases) {
 configuration.getTypeAliasRegistry().registerAlias(typeAlias);
 if (this.logger.isDebugEnabled()) {
 this.logger.debug("Registered type alias: '" + typeAlias + "'");
 }
 }
 }

        if (!ObjectUtils.isEmpty(this.plugins)) {
            for (Interceptor plugin : this.plugins) {
                configuration.addInterceptor(plugin);
                if (this.logger.isDebugEnabled()) {
                    this.logger.debug("Registered plugin: '" + plugin + "'");
                }
            }
        }

        if (StringUtils.hasLength(this.typeHandlersPackage)) {
            String[] typeHandlersPackageArray = StringUtils.tokenizeToStringArray(this.typeHandlersPackage,
                ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
            for (String packageToScan : typeHandlersPackageArray ) {
                configuration.getTypeHandlerRegistry().register(packageToScan);
                if (this.logger.isDebugEnabled()) {
                    this.logger.debug("Scanned package: '" + packageToScan + "' for type handlers");
                }
            }
        }

        if (!ObjectUtils.isEmpty(this.typeHandlers)) {
            for (TypeHandler typeHandler : this.typeHandlers) {
                configuration.getTypeHandlerRegistry().register(typeHandler);
                if (this.logger.isDebugEnabled()) {
                    this.logger.debug("Registered type handler: '" + typeHandler + "'");
                }
            }
        }

        if (xmlConfigBuilder != null) {
            try {
                xmlConfigBuilder.parse();

                if (this.logger.isDebugEnabled()) {
                    this.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();
            }
        }

        if (this.transactionFactory == null) {
            this.transactionFactory = new SpringManagedTransactionFactory(this.dataSource);
        }

        Environment environment = new Environment(this.environment, this.transactionFactory, this.dataSource);
        configuration.setEnvironment(environment);

        if (!ObjectUtils.isEmpty(this.mapperLocations)) {
            for (Resource mapperLocation : this.mapperLocations) {
                if (mapperLocation == null) {
                    continue;
                }

                // this block is a workaround for issue http://code.google.com/p/mybatis/issues/detail?id=235
                // when running MyBatis 3.0.4. But not always works.
                // Not needed in 3.0.5 and above.
                String path;
                if (mapperLocation instanceof ClassPathResource) {
                    path = ((ClassPathResource) mapperLocation).getPath();
                } else {
                    path = mapperLocation.toString();
                }

                try {
                    XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(),
                            configuration, path, configuration.getSqlFragments());
                    xmlMapperBuilder.parse();
                } catch (Exception e) {
                    throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);
                } finally {
                    ErrorContext.instance().reset();
                }

/**
 * 初始化的时候进行的扩展
 * @throws NestedIOException
 */
 private void extInit(Configuration configuration) throws NestedIOException{
 /*扩展typeAlias*/
 extAlias(configuration);
 /*扩展mapper*/
 extMpper(configuration);
 }

 private void extMpper(Configuration configuration) throws NestedIOException{

 ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
 List <Resource> extMapperResourceList =new ArrayList<Resource>();
 if(extMapperLocations!=null){
 String[] locations = extMapperLocations.split(",");
 for(int i=0;i<locations.length;i++){
 String location = locations[i];
 location =location.trim();
 if(location!=null&&location.length()>0){
 try {
 Resource[] resources = resolver.getResources(location);
 for(int j=0;j<resources.length;j++){
 extMapperResourceList.add(resources[j]);
 }

 } catch (IOException e) {
 // TODO Auto-generated catch block
 e.printStackTrace();
 }
 }
 }

 }
 System.out.println("extMapperResourceList个数为："+extMapperResourceList.size());
 if (extMapperResourceList.size()>0) {

 for (int i=0;i<extMapperResourceList.size();i++) {
 Resource mapperLocation = extMapperResourceList.get(i);
 if (mapperLocation == null) {
 continue;
 }

if (this.logger.isDebugEnabled()) {
 this.logger.debug("Parsed mapper file: '" + mapperLocation + "'");
 }
 }
 } else {
 if (this.logger.isDebugEnabled()) {
 this.logger.debug("Property 'mapperLocations' was not specified or no matching resources found");
 }
 }
 }

 private void extAlias(Configuration configuration){
 ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();

 if(extTypeAliasLocations!=null){
 String[] locations = extTypeAliasLocations.split(",");
 for(int i=0;i<locations.length;i++){
 String location = locations[i];
 System.out.println("extTypeAliasLocation:"+location);
 location =location.trim();
 if(location!=null&&location.length()>0){
 try {
 Resource[] resources = resolver.getResources(location);

 for(int j=0;j<resources.length;j++){
 Resource resource =resources[j];
 System.out.println("resource:"+resource.getFilename());
 ExtTypeAliasBuilder xmlMapperBuilder = new ExtTypeAliasBuilder(resource.getInputStream(),
 null,this.configurationProperties,configuration);

 xmlMapperBuilder.parse();

 }

 } catch (IOException e) {
 // TODO Auto-generated catch block
 e.printStackTrace();
 }
 }
 }

 }
 }
 /**
 * {@inheritDoc}
 */
 public SqlSessionFactory getObject() throws Exception {
 if (this.sqlSessionFactory == null) {
 afterPropertiesSet();
 }

return this.sqlSessionFactory;
}

/**
 * {@inheritDoc}
 */
 public Class<? extends SqlSessionFactory> getObjectType() {
 return this.sqlSessionFactory == null ? SqlSessionFactory.class : this.sqlSessionFactory.getClass();
 }

    /**
     * {@inheritDoc}
     */
    public boolean isSingleton() {
        return true;
    }

    /**
     * {@inheritDoc}
     */
    public void onApplicationEvent(ApplicationEvent event) {
        if (failFast && event instanceof ContextRefreshedEvent) {
            // fail-fast -> check all statements are completed
            this.sqlSessionFactory.getConfiguration().getMappedStatementNames();
        }
    }

public String getExtTypeAliasLocations() {
return extTypeAliasLocations;
}

public void setExtTypeAliasLocations(String extTypeAliasLocations) {
this.extTypeAliasLocations = extTypeAliasLocations;
}

public String getExtMapperLocations() {
return extMapperLocations;
}

public void setExtMapperLocations(String extMapperLocations) {
this.extMapperLocations = extMapperLocations;
}

public Resource[] getExtMappersResources() {
return extMappersResources;
}

public void setExtMappersResources(Resource[] extMappersResources) {
this.extMappersResources = extMappersResources;
}

public TypeAliasObjectV3[] getExtTypeAlias() {
return extTypeAlias;
}

public void setExtTypeAlias(TypeAliasObjectV3[] extTypeAlias) {
this.extTypeAlias = extTypeAlias;
}

}