HasorDB 映射文件

使用 Mapper 文件的好處是便于維護和管理 SQL，這在團隊協(xié)作時 review sql 代碼比起在程序中用代碼來拼接要好。

文檔結(jié)構(gòu)?

下面是 HasorDB Mapper 文件基本結(jié)構(gòu)：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//hasor.net//DTD Mapper 1.0//EN" 
                        "https://www.hasor.net/schema/hasordb-mapper.dtd">
<mapper namespace="...">
    ...
</mapper>

提示
?namespace ?通常是配置一個接口類名，這個接口下的每個方法會對應到 mapper 文件中一個具體的 sql 操作上。

在 ?mapper ?根元素下可以使用的頂層 XML 元素有如下幾個：

• resultMap 用于描述如何從查詢結(jié)果集中加載數(shù)據(jù)。
• sql 用于定義一小段可以復用的 SQL 片段。
• insert 映射 INSERT 語句。
• update 映射 UPDATE 語句。
• delete 映射 DELETE 語句。
• select 映射 SELECT 語句。

select 操作?

select 標簽是 HasorDB 中最常用的元素之一。對于簡單的情況 select 元素非常簡單。例如:

<select id="queryListByAge">
    select * from `test_user` where age = #{age}
</select>

select 標簽有很多屬性下面列出的是每個屬性和含義。

insert, update 和 delete 操作?

?insert?、?update?、?delete ?標簽本質(zhì)上是同一個標簽，只是通過專門的名字來區(qū)分會讓人更為容易理解。

一個簡單的例子如下：

<insert id="insertUser">
    insert into `test_user` (
        `id`, `name`, `age`, `create_time`
    ) values (
        #{id}, #{name}, #{age}, #{createTime}
    )
</insert>

<update id="updateAge">
    update `test_user` set age = #{age} where id = #{id}
</update>

<delete id="deleteById">
    delete from `test_user` where id = #{id}
</delete>

?insert?、?update?、?delete ?標簽都有如下共同的屬性。

selectKey?

對于不支持自增列的數(shù)據(jù)庫，HasorDB 可以使用 ?selectKey ?標簽來通過 SQL 方式生成它，比較常見用處是使用數(shù)據(jù)庫的 ?sequence?。 例如：下面 Mapper 配置，在執(zhí)行 ?insert ?之前會先使用數(shù)據(jù)庫函數(shù)生成一個隨機數(shù)作為主鍵。

<insert id="insertUser">
    <selectKey keyProperty="id" resultType="int" order="BEFORE">
        SELECT CONCAT('1', CEILING(RAND() * 1000 + 1000))
    </selectKey>
    insert into `test_user` (
        `id`, `name`, `age`, `create_time`
    ) values (
        #{id}, #{name}, #{age}, #{createTime}
    )
</insert>

?selectKey ?標簽有如下屬性。

sql 代碼片段?

此標簽可用于定義一段在其它語句中被包含的重用代碼片段。例如定義列名。

<sql id="testuser_columns">
    name,age,create_time
</sql>

<insert id="insertUser">
    insert into `test_user` (
        <include refid="testuser_columns"/>
    ) values (
        #{name}, #{age}, now()
    )
</insert>

結(jié)果集映射?

并不是每一個 ?select ?都必須要求配置 ?resultMap ?默認情況下會使用 Map 來承裝返回的數(shù)據(jù)。

<select id="queryListByAge">
    select * from `test_user` where age = #{age}
</select>

但通常 Map 并不是一個很好的模型設(shè)計，應該使用一些有意義的 pojo 充當數(shù)據(jù)對象。HasorDB 支持將一個普通的 pojo 映射到一個結(jié)果集上。例如下面這個 Bean：

?class net.hasor.db.example.mapper.TestUser?

public class TestUser {
    private Integer id;
    private String  name;
    private Integer age;
    private Date    createTime;

    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public Date getCreateTime() {
        return createTime;
    }
    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }
}

可以使用 ?resultType ?屬性將查詢結(jié)果映射到這個 Bean 上。

<select id="queryById" resultType="net.hasor.db.example.mapper.TestUser">
    select 
        id, name, age, create_time
    from
        test_user
    where
        id = #{id}
</select>

使用這種方式，HasorDB 會在加載配置文件的時候自動創(chuàng)建一個 ?resultMap?，根據(jù)名稱將列自動映射到 pojo 的屬性上。如果列名不完全匹配，可以在列名上使用 ?as ?子句來匹配映射。例如:

<select id="queryById" resultType="net.hasor.db.example.mapper.TestUser">
    select 
        id, name, age, create_time as createTime
    from
        test_user
    where
        id = #{id}
</select>

直接使用 ?resultMap ?的好處是可以更加精細化的控制每一個屬性映射，以剛才的映射為例。在不通過 ?as ?改變列名的情況下映射這個 pojo：

<resultMap id="testuser_resultMap" type="net.hasor.db.example.mapper.TestUser">
    <id column="id" property="id"/>
    <result column="name" property="name"/>
    <result column="age" property="age"/>
    <result column="create_time" property="createTime"/>
</resultMap>

<select id="queryById" resultMap="testuser_resultMap">
    select
        id, name, age, create_time
    from
        test_user
    where
        id = #{id}
</select>

?resultMap ?標簽有如下屬性。

id &

?id ?和 ?result ?都是用于映射列和屬性之間的映射關(guān)系。不同的是 id 可以方便的指出列在數(shù)據(jù)中是否為主鍵。

在使用通用 Mapper 時，CURD 操作將會依賴 ?id?、?table?、?schema ?這些屬性用以生成 SQL。

它們每個標簽都有下面這些屬性

多結(jié)果映射?

例如，一個 ?select ?配置了兩個 查詢語句?；蛘哒{(diào)用的存儲過程中執(zhí)行了兩條 查詢 SQL。?resultType ?中以逗號作為分割將兩個結(jié)果分別映射到兩個類型上。

提示
使用 ?resultMap ?同樣也可以通過逗號作為分割，映射多個結(jié)果。

<select id="multipleListByAge" multipleResult="ALL"
        resultType="net.hasor.db.example.mapper.TestUserPojo,net.hasor.db.example.mapper.TestUser">
    select id, name, age, create_time as createTime from `test_user` where age = #{age};
    select * from `test_user`;
</select>

自動映射?

上面已經(jīng)介紹過 ?resultMap ?和 ?resultType ?的能力，在本節(jié)可以了解通過自動映射機制來混合兩種操作。

HasorDB 會嘗試將結(jié)果集中的列名作為屬性名進行寫入，匹配的時會忽略大小寫。 這意味著，如果找到名為 ?ID ?的列和名為 ?ID ?的屬性，HasorDB 將使用 ?ID ?列值設(shè)置 ?ID ?屬性。

<resultMap id="testuser_resultMap" type="net.hasor.db.example.mapper.TestUser">
    <result property="createTime" column="create_time"/>
</resultMap>

<select id="queryById" resultMap="testuser_resultMap">
    select
        id, name, age, create_time
    from
        test_user
    where
        id = #{id}
</select>

通常數(shù)據(jù)庫列的命名使用大寫字母和下劃線，這與 java 通常遵循駝峰命名約定有一定的差異。 若想使它們之間自定映射需要設(shè)置 ?mapUnderscoreToCamelCase ?為 ?true?

<resultMap id="testuser_resultMap" type="net.hasor.db.example.mapper.TestUser" 
           mapUnderscoreToCamelCase="true"/>

<select id="queryById" resultMap="testuser_resultMap">
    select
        id, name, age, create_time
    from
        test_user
    where
        id = #{id}
</select>

提示
默認情況下 HasorDB 是啟用自動映射的，如果你不像使用這一特性。則可以通過設(shè)置 ?autoMapping ?為 ?false ?來關(guān)閉它。