MyBatis 配置優化實戰：屬性文件外部化與類型別名簡化

MyBatis 配置優化實戰：外部化屬性文件與類型別名最佳實踐

本文詳細講解 MyBatis 核心配置文件優化的兩大關鍵技巧：將資料庫連線資訊外部化至 properties 文件，以及為實體類定義類型別名簡化映射文件引用。

優化一：資料庫配置外部化至 properties 文件

問題背景

傳統做法將資料庫連線資訊直接寫在 conf.xml 中：

<dataSource type="POOLED">
    <property name="driver" value="com.mysql.jdbc.Driver"/>
    <property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
    <property name="username" value="root"/>
    <property name="password" value="XDP"/>
</dataSource>

缺點：環境切換需修改 XML、敏感資訊洩露風險、版本控制困擾。

解決方案：引入 db.properties

1. 建立 src/db.properties

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis
name=root
password=XDP

2. conf.xml 引用 properties

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 
  "https://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>
    <!-- 引入外部屬性文件 -->
    <properties resource="db.properties"/>
    
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${name}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

進階：多環境配置切換

<properties resource="db.properties"/>
<properties resource="db-${env}.properties"/> <!-- 覆蓋預設值 -->

<environments default="${env}">
    <environment id="development">...</environment>
    <environment id="production">...</environment>
    <environment id="test">...</environment>
</environments>

啟動時指定 JVM 參數：-Denv=production 即可切換環境。

優化二：類型別名簡化實體類引用

問題背景

映射文件中頻繁寫入完整類名：

<insert id="addUser" parameterType="me.gacl.domain.User">...</insert>
<select id="getUser" resultType="me.gacl.domain.User">...</select>

冗長且易拼錯，重構時需批量修改。

方案一：單個類別定義別名

<configuration>
    <typeAliases>
        <typeAlias type="me.gacl.domain.User" alias="_User"/>
    </typeAliases>
</configuration>

映射文件簡化為：

<insert id="addUser" parameterType="_User">...</insert>
<select id="getUser" resultType="_User">...</select>

方案二：批量掃描包定義別名 (推薦)

<configuration>
    <typeAliases>
        <!-- 掃描包下所有類，別名預設為簡類名 (User) -->
        <package name="me.gacl.domain"/>
    </typeAliases>
</configuration>

效果：me.gacl.domain.User → 別名 User
me.gacl.domain.Order → 別名 Order

方案三：註解方式定義別名 (MyBatis 3.2+)

@Alias("User")
public class User { ... }

需在配置中開啟掃描：<package name="me.gacl.domain"/>

別名命名最佳實踐

綜合優化後的 conf.xml 範例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 
  "https://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>
    <properties resource="db.properties"/>
    
    <typeAliases>
        <package name="me.gacl.domain"/>
        <package name="me.gacl.dto"/>
    </typeAliases>
    
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${name}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>
    
    <mappers>
        <mapper resource="me/gacl/mapping/userMapper.xml"/>
        <mapper resource="me/gacl/mapping/orderMapper.xml"/>
    </mappers>
</configuration>

驗證優化效果

<!-- 優化前 -->
<select id="getUser" parameterType="me.gacl.domain.User" resultType="me.gacl.domain.User">...</select>

<!-- 優化後 -->
<select id="getUser" parameterType="User" resultType="User">...</select>

映射文件行數減少 ~30%，可讀性顯著提升，重構時僅需修改實體類包路徑。

總結

MyBatis 配置優化兩大核心：外部化屬性文件實現環境隔離與安全管理，類型別名消除冗長類名提升可維護性。建議專案伊始即確立：db-${env}.properties 多環境配置 + <package name="..."/> 批量別名掃描，配合註解 @Alias 處理特殊命名衝突，構建清晰、安全、易維護的配置體系。