MyBatis 如何配置多個別名 typeAliasesPackage

Posted on by

配置多個別名 typeAliasesPackage

<property name="typeAliasesPackage" value="com.ivan.edu.model,com.ivan.edu.vo"></property>

隻需要用逗號“,”隔開就行，當然上面是以 XML 為例，YML 或 Properties 文件配置同理可得~

設置typeAliasesPackage支持**通配符匹配

mybatis的typeAliasesPackage屬性的作用是，搜索指定包別名。

配置瞭以後xml文件中的resultType和parameterType就不需要指定全類名com.example.system.domain.SysUser，我們隻需要寫SysUser，會到我們配置的typeAliasesPackage包下搜索。

轉到MybatisProperties文件中，發現typeAliasesPackage是String類型。

@ConfigurationProperties(prefix = MybatisProperties.MYBATIS_PREFIX)
public class MybatisProperties {  
  /**
   * Packages to search type aliases. (Package delimiters are ",; \t\n")
   */
  private String typeAliasesPackage;

如果有多個包的話，隻能以逗號分隔的形式賦值，如下：

mybatis:
    typeAliasesPackage: com.example.system.domain,com.example.common.domain

秉著“不想多敲一點代碼”的做法，

我不想每次多一個包，就在typeAliasesPackage後面多加一個包名，

我想要的是可不可以配置一個通配符，就算加再多的包，也不用重新給typeAliasesPackage賦值。

mybatis:
    # 規則是，新加的包的名字必須是 com.example.xxx.domain
    typeAliasesPackage: com.example.**.domain

如果想要實現上述想法，我們需要自定義SqlSessionFactory，以代碼的方式找到匹配com.example.**.domain的所有包名，然後賦值給typeAliasesPackage。

代碼實現方式如下：

import java.io.IOException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import javax.sql.DataSource;
import org.apache.ibatis.io.VFS;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.boot.autoconfigure.SpringBootVFS;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.io.DefaultResourceLoader;
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.classreading.CachingMetadataReaderFactory;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import org.springframework.util.ClassUtils;
/**
 * Mybatis支持*匹配掃描包
 *
 * @author ruoyi
 */
@Configuration
public class MyBatisConfig {
    @Autowired
    private Environment env;
    static final String DEFAULT_RESOURCE_PATTERN = "**/*.class";
    /**
     * 自定義typeAliasesPackage
     * 在application.yml中typeAliasesPackage的值等於com.ruoyi.**.domain
     * 但是mybatis是無法識別**通配符的
     * 需要我們自己實現通過**通配符匹配到所有的domain包
     *
     * @param typeAliasesPackage
     * @return
     */
    public static String setTypeAliasesPackage(String typeAliasesPackage) {
        ResourcePatternResolver resolver = (ResourcePatternResolver) new PathMatchingResourcePatternResolver();
        MetadataReaderFactory metadataReaderFactory = new CachingMetadataReaderFactory(resolver);
        List<String> allResult = new ArrayList<String>();
        try {
            for (String aliasesPackage : typeAliasesPackage.split(",")) {
                List<String> result = new ArrayList<String>();
                aliasesPackage = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX
                        + ClassUtils.convertClassNameToResourcePath(aliasesPackage.trim()) + "/" + DEFAULT_RESOURCE_PATTERN;
                Resource[] resources = resolver.getResources(aliasesPackage);
                if (resources != null && resources.length > 0) {
                    MetadataReader metadataReader = null;
                    for (Resource resource : resources) {
                        if (resource.isReadable()) {
                            metadataReader = metadataReaderFactory.getMetadataReader(resource);
                            try {
                                result.add(Class.forName(metadataReader.getClassMetadata().getClassName()).getPackage().getName());
                            } catch (ClassNotFoundException e) {
                                e.printStackTrace();
                            }
                        }
                    }
                }
                if (result.size() > 0) {
                    HashSet<String> hashResult = new HashSet<String>(result);
                    allResult.addAll(hashResult);
                }
            }
            if (allResult.size() > 0) {
                typeAliasesPackage = String.join(",", (String[]) allResult.toArray(new String[0]));
            } else {
                throw new RuntimeException("mybatis typeAliasesPackage 路徑掃描錯誤,參數typeAliasesPackage:" + typeAliasesPackage + "未找到任何包");
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        return typeAliasesPackage;
    }
    @Bean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        // 獲取配置文件中定義的 mybatis.typeAliasesPackage 的值
        String typeAliasesPackage = env.getProperty("mybatis.typeAliasesPackage");
        // 獲取配置文件中定義的 mybatis.mapperLocations 的值
        String mapperLocations = env.getProperty("mybatis.mapperLocations");
        // 獲取配置文件中定義的 mybatis.configLocation 的值
        String configLocation = env.getProperty("mybatis.configLocation");
        typeAliasesPackage = setTypeAliasesPackage(typeAliasesPackage);
        VFS.addImplClass(SpringBootVFS.class);
        final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource);
        sessionFactory.setTypeAliasesPackage(typeAliasesPackage);
        // 在所有jar包的classpath下查找所有以Mapper.xml結尾的xml文件
        sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(mapperLocations));
        sessionFactory.setConfigLocation(new DefaultResourceLoader().getResource(configLocation));
        return sessionFactory.getObject();
    }
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：