原文鏈接：https://www.dubby.cn/detail.html?id=9094

1湾盒、mybatis-config.xml

這個(gè)配置文件的結(jié)構(gòu)如下：

• properties
• settings
• typeAliases
• typeHandlers
• objectFactory
• plugins
• environments
  • environment
    • transactionManager
    • dataSource
• databaseIdProvider
• mappers

這里我簡(jiǎn)單說(shuō)一說(shuō)這些配置的意義饵撑，當(dāng)然不可能每個(gè)都介紹的非常詳細(xì)坐慰，我說(shuō)說(shuō)一些比較實(shí)用和比較常用的吧冈绊。

properties

這個(gè)其實(shí)是很多組件都會(huì)提供的一個(gè)配置功能，在這里可以可以定義一些屬性凿滤，那么在這個(gè)文件的后面都可以使用${propertyName}來(lái)引用這個(gè)屬性拔创，而且這里還可以引用外部文件，比如數(shù)據(jù)庫(kù)連接信息，一般屬于高密配置胖缤，不能直接寫(xiě)在配置文件里尚镰，那么可以單獨(dú)寫(xiě)個(gè)配置文件config.properties:

username=test
password=123456
url=jdbc:mysql://localhost:3306/mybatis_study?useUnicode=true&characterEncoding=UTF-8&useLegacyDatetimeCode=false&serverTimezone=UTC&useSSL=false

然后在mybatis-config.xml里配置：

<properties resource="config.properties">
    <!--默認(rèn)不開(kāi)啟-->
    <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
    <!--默認(rèn)就是:-->
    <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="#|#"/>
    <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
</properties>

那么，在后續(xù)的配置中可以引用這些屬性：

<dataSource type="cn.dubby.mybatis.configuration.datasource.HikariCPDataSourceFactory">
    <!--since MyBatis 3.4.2 如果driver沒(méi)有找到哪廓，會(huì)使用冒號(hào)后的值作為默認(rèn)值狗唉。此功能默認(rèn)不開(kāi)啟，開(kāi)啟需指定org.apache.ibatis.parsing.PropertyParser.enable-default-value-->
    <property name="driverClassName" value="${driver#|#com.mysql.cj.jdbc.Driver}"/>
    <property name="jdbcUrl" value="${url}"/>
    <property name="username" value="${username}"/>
    <property name="password" value="${password}"/>
</dataSource>

注意看涡真，org.apache.ibatis.parsing.PropertyParser.enable-default-value和org.apache.ibatis.parsing.PropertyParser.default-value-separator這兩個(gè)需要配合起來(lái)工作分俯。作用是在使用${}引用屬性時(shí)，如果沒(méi)有找到這個(gè)屬性哆料，可以使用一個(gè)默認(rèn)值來(lái)代替缸剪，而屬性名和默認(rèn)值中間的分隔符就是這里配置的#|#，默認(rèn)是:东亦，使用時(shí)是${driver#|#com.mysql.cj.jdbc.Driver}杏节，意思就是沒(méi)有沒(méi)有配置driver，那就使用com.mysql.cj.jdbc.Driver典阵。

如果即使用<property name="propertyName" value="propertyValue"/>奋渔，又在config.properties配置了propertyName，那么該以哪個(gè)為準(zhǔn)呢壮啊？

以config.properties里配置的為準(zhǔn)嫉鲸！

settings

先給出一個(gè)setting的配置選項(xiàng)吧，我們來(lái)感受一下：

<settings>
  <!--開(kāi)啟或禁用緩存-->
  <setting name="cacheEnabled" value="true"/>
  <setting name="lazyLoadingEnabled" value="true"/>
  <setting name="multipleResultSetsEnabled" value="true"/>
  <setting name="useColumnLabel" value="true"/>
  <setting name="useGeneratedKeys" value="false"/>
  <setting name="autoMappingBehavior" value="PARTIAL"/>
  <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
  <setting name="defaultExecutorType" value="SIMPLE"/>
  <setting name="defaultStatementTimeout" value="25"/>
  <setting name="defaultFetchSize" value="100"/>
  <setting name="safeRowBoundsEnabled" value="false"/>
  <!--數(shù)據(jù)庫(kù)里下劃線自動(dòng)匹配成Java中駝峰命名的屬性-->
  <setting name="mapUnderscoreToCamelCase" value="true"/>
  <setting name="localCacheScope" value="SESSION"/>
  <setting name="jdbcTypeForNull" value="OTHER"/>
  <setting name="lazyLoadTriggerMethods"
    value="equals,clone,hashCode,toString"/>
</settings>

typeAliases

這是類(lèi)型別名歹啼，因?yàn)镴ava中類(lèi)的全限定名是包名+類(lèi)名玄渗，太長(zhǎng)啦，所以這里允許我們給他起個(gè)別名狸眼，這樣在后面使用的時(shí)候捻爷，可以簡(jiǎn)短一點(diǎn)。

<typeAliases>
    <!--可以單獨(dú)指定別名-->
    <typeAlias type="cn.dubby.mybatis.configuration.entity.Blog" alias="Blog"/>
    <!--也可以直接指定包下所有類(lèi)的別名份企，此時(shí)還可以使用@Alias("blog")來(lái)修改他的別名-->
    <package name="cn.dubby.mybatis.configuration.entity"/>
</typeAliases>

可以一個(gè)類(lèi)一個(gè)類(lèi)的指定也榄；也可以直接指定一個(gè)package，這樣這個(gè)package下的所有的類(lèi)都有別名了司志，此時(shí)你可以使用@Alias("blog")來(lái)修改他的別名甜紫，默認(rèn)就是類(lèi)名。

typeHandlers

在MyBatis中骂远，數(shù)據(jù)庫(kù)中列轉(zhuǎn)化成Object中的變量囚霸，都是TypeHandler的轉(zhuǎn)換成果。他是一個(gè)接口：

public interface TypeHandler<T> {

  void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;

  T getResult(ResultSet rs, String columnName) throws SQLException;

  T getResult(ResultSet rs, int columnIndex) throws SQLException;

  T getResult(CallableStatement cs, int columnIndex) throws SQLException;

}

MyBatis內(nèi)置了很多TypeHandler激才，如果我們需要自定義呢拓型？這里給個(gè)簡(jiǎn)單的例子额嘿，如果在數(shù)據(jù)庫(kù)中手機(jī)號(hào)存儲(chǔ)格式如下：

image

但是在Java中，mobile是由countryCode和mobile共同決定的：

public class MobilePhone {

    private static final String DEFAULT_COUNTRY_CODE = "86";

    private String countryCode;

    private String mobile;

    public MobilePhone(String mobile) {
        this(DEFAULT_COUNTRY_CODE, mobile);
    }

    public MobilePhone(String countryCode, String mobile) {
        this.countryCode = countryCode;
        this.mobile = mobile;
    }

    @Override
    public String toString() {
        return "'" + countryCode + "_" + mobile + "'";
    }
}

那么劣挫，我們可以自定義一個(gè)MobilePhoneHandler:

@MappedJdbcTypes(JdbcType.VARCHAR)
public class MobilePhoneHandler extends BaseTypeHandler<MobilePhone> {

    public void setNonNullParameter(PreparedStatement ps, int i, MobilePhone parameter, JdbcType jdbcType) throws SQLException {
        ps.setString(i, parameter.toString());
    }

    public MobilePhone getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return convert(rs.getString(columnName));
    }

    public MobilePhone getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        return convert(rs.getString(columnIndex));
    }

    public MobilePhone getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        return convert(cs.getString(columnIndex));
    }

    private MobilePhone convert(String mobileInDB) {
        if (mobileInDB == null || mobileInDB.trim().length() == 0)
            return null;

        String[] mobilePair = mobileInDB.split("_");
        if (mobilePair.length != 2) {
            throw new IllegalArgumentException("mobile phone must be consist of countryCode and mobileNo.");
        }
        return new MobilePhone(mobilePair[0], mobilePair[1]);
    }
}

然后別忘了需要配置這個(gè)TypeHandler：

<typeHandlers>
    <!--可以單獨(dú)指定別名-->
    <typeHandler handler="cn.dubby.mybatis.configuration.handler.MobilePhoneHandler"/>
    <!--也可以直接指定包下所有類(lèi)的別名-->
    <package name="cn.dubby.mybatis.configuration.handler"/>
</typeHandlers>

那如果是枚舉呢册养？

MyBatis給我們提供了兩種枚舉相關(guān)的TypeHandler：EnumTypeHandler和 EnumOrdinalTypeHandler。一看就知道压固，一個(gè)是根據(jù)名字轉(zhuǎn)換（String）球拦，一個(gè)是根據(jù)順序轉(zhuǎn)換(int)。

默認(rèn)MyBatis是使用名字轉(zhuǎn)化的帐我，也就是如果你的枚舉是這樣的：

public enum CategoryEnum {
    A, B;
}

那么數(shù)據(jù)庫(kù)中就存著A坎炼，B這樣的字符串。但是很多DBA會(huì)建議我們使用Int來(lái)存儲(chǔ)（性能拦键，空間等各方面考慮）谣光，那么我們就需要使用EnumOrdinalTypeHandler了。

<typeHandler handler="org.apache.ibatis.type.EnumOrdinalTypeHandler" javaType="cn.dubby.mybatis.configuration.enums.CategoryEnum"/>

可是芬为，如果還想用String轉(zhuǎn)換的方式呢萄金，比如這種場(chǎng)景：

public class Category {
    private Integer id;
    private CategoryEnum category1;
    private CategoryEnum category2;
}

那可以在ResultMap在具體指定使用哪個(gè)來(lái)轉(zhuǎn)換：

<resultMap id="CategoryResult" type="Category">
    <result column="id" property="id"/>
    <result column="category1" property="category1"/>
    <result column="category2" property="category2" typeHandler="org.apache.ibatis.type.EnumTypeHandler"/>
</resultMap>

Enum順序是從0開(kāi)始的

objectFactory

MyBatis每次創(chuàng)建一個(gè)對(duì)象來(lái)承載查詢(xún)結(jié)果時(shí)，都會(huì)使用ObjectFactory來(lái)創(chuàng)建碳柱。我們可以重寫(xiě)這個(gè)類(lèi)，來(lái)實(shí)現(xiàn)我們的目的：

public class ExampleObjectFactory extends DefaultObjectFactory {

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

    public <T> T create(Class<T> type) {
        logger.info("ExampleObjectFactory create a object, type is {}", type.getName());
        return super.create(type);
    }

    public <T> T create(Class<T> type, List<Class<?>> constructorArgTypes, List<Object> constructorArgs) {
        logger.info("ExampleObjectFactory create a object, type is {}", type.getName());
        return super.create(type, constructorArgTypes, constructorArgs);
    }

    public void setProperties(Properties properties) {
        super.setProperties(properties);
    }

    public <T> boolean isCollection(Class<T> type) {
        return Collection.class.isAssignableFrom(type);
    }

}

plugins

插件是MyBatis給我們開(kāi)放的一個(gè)秘密通道熬芜，我們可以通過(guò)各個(gè)插件來(lái)攔截MyBatis生命周期里比較重要的一些方法調(diào)用：

• Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
• ParameterHandler (getParameterObject, setParameters)
• ResultSetHandler (handleResultSets, handleOutputParameters)
• StatementHandler (prepare, parameterize, batch, update, query)

這里給個(gè)例子吧：

@Intercepts({@Signature(
        type = Executor.class,
        method = "query",
        args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})})
public class ExamplePlugin implements Interceptor {

    private Logger logger = LoggerFactory.getLogger(ExamplePlugin.class);

    public Object intercept(Invocation invocation) throws Throwable {
        logger.info("====intercept start====");
        logger.info("參數(shù):{}", invocation.getArgs());
        Object result = invocation.proceed();
        logger.info("結(jié)果:{}", result);
        logger.info("====intercept complete====");
        return result;
    }

    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    public void setProperties(Properties properties) {
    }
}

配置插件：

<plugins>
    <plugin interceptor="cn.dubby.mybatis.configuration.plugin.ExamplePlugin">
        <property name="someProperty" value="100"/>
    </plugin>
</plugins>

environments

先預(yù)覽一下：

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    <dataSource type="POOLED">
      <property name="driver" value="${driver}"/>
      <property name="url" value="${url}"/>
      <property name="username" value="${username}"/>
      <property name="password" value="${password}"/>
    </dataSource>
  </environment>
</environments>

首先我們看到一個(gè)environment莲镣，還有一個(gè)default="development"。這個(gè)作用是可以配置多個(gè)環(huán)境的數(shù)據(jù)源涎拉，每個(gè)envonment有個(gè)名字瑞侮，還可以設(shè)置一個(gè)默認(rèn)的environment，在構(gòu)建SqlSessionFactory的時(shí)候鼓拧，可以指定envonment：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, properties);

如果不指定的話半火，就會(huì)使用默認(rèn)的：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, properties);

注意：一個(gè)SqlSessionFactory只能選擇一個(gè)environment

然后我們看到transactionManager，這個(gè)MyBatis提供了兩種內(nèi)置的事務(wù)管理器季俩，JDBC和MANAGED钮糖。這里不展開(kāi)說(shuō)，一般用JDBC就可以了酌住，而且如果使用Spring集成的話店归，Spring會(huì)使用自己的transactionManager來(lái)替換MyBatis的transactionManager。

然后就是DataSource了酪我，MyBatis內(nèi)置了三種：UNPOOLED消痛，POOLED和JNDI。這三個(gè)名字已經(jīng)很明顯了都哭，我就不解釋了秩伞，那如果想使用第三方的數(shù)據(jù)庫(kù)連接池呢逞带，該如何處理，簡(jiǎn)單的來(lái)說(shuō)纱新，可以自己實(shí)現(xiàn)DataSourceFactory展氓，我這里選擇了據(jù)說(shuō)是最快的HikariCP：

public class HikariCPDataSourceFactory implements DataSourceFactory {

    private HikariConfig config;

    @Override
    public void setProperties(Properties props) {
        config = new HikariConfig(props);
    }

    @Override
    public DataSource getDataSource() {
        return new HikariDataSource(config);
    }
}

然后修改DataSource配置：

<dataSource type="cn.dubby.mybatis.configuration.datasource.HikariCPDataSourceFactory">
    <property name="driverClassName" value="${driver#|#com.mysql.cj.jdbc.Driver}"/>
    <property name="jdbcUrl" value="${url}"/>
    <property name="username" value="${username}"/>
    <property name="password" value="${password}"/>
</dataSource>

mappers

就是在這里配置所有的mapper，有這么幾種選擇：

<!-- 使用相對(duì)路徑 -->
<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
  <mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>

<!-- 使用絕對(duì)路徑 -->
<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
  <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>

<!-- 使用接口全限定名 -->
<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
  <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>

<!-- 使用包名 -->
<mappers>
  <package name="org.mybatis.builder"/>
</mappers>

2怒炸、XxxMapper.xml

mapper是MyBatis真正神奇的地方带饱，這里讓我們可以使用幾乎原生的sql，但卻又可以擺脫重復(fù)枯燥的jdbc拼接代碼阅羹，讓我們開(kāi)始了解他吧勺疼，他的可以配置項(xiàng)分為：

• cache – 在當(dāng)前namespcae配置一個(gè)緩存
• cache-ref – 從其他namespace引用一個(gè)緩存.
• resultMap – 定義了如何把從數(shù)據(jù)庫(kù)中查詢(xún)出來(lái)的數(shù)據(jù)封裝成Java的Object
• parameterMap – Deprecated! 后續(xù)可能會(huì)刪除，這里不解釋
• sql – 可重復(fù)使用的一段SQL
• insert – 插入
• update – 更新
• delete – 刪除
• select – 選擇