MyBatis 3 SQL 語(yǔ)句構(gòu)建器

問(wèn)題

Java 程序員面對(duì)的最痛苦的事情之一就是在 Java 代碼中嵌入 SQL 語(yǔ)句。這通常是因?yàn)樾枰獎(jiǎng)討B(tài)生成 SQL 語(yǔ)句，不然我們可以將它們放到外部文件或者存儲(chǔ)過(guò)程中。如你所見(jiàn)，MyBatis 在 XML 映射中具備強(qiáng)大的 SQL 動(dòng)態(tài)生成能力。但有時(shí)，我們還是需要在 Java 代碼里構(gòu)建 SQL 語(yǔ)句。此時(shí)，MyBatis 有另外一個(gè)特性可以幫到你，讓你從處理典型問(wèn)題中解放出來(lái)，比如加號(hào)、引號(hào)、換行、格式化問(wèn)題、嵌入條件的逗號(hào)管理及 AND 連接。確實(shí)，在 Java 代碼中動(dòng)態(tài)生成 SQL 代碼真的就是一場(chǎng)噩夢(mèng)。例如：

String sql = "SELECT P.ID, P.USERNAME, P.PASSWORD, P.FULL_NAME, "
"P.LAST_NAME,P.CREATED_ON, P.UPDATED_ON " +
"FROM PERSON P, ACCOUNT A " +
"INNER JOIN DEPARTMENT D on D.ID = P.DEPARTMENT_ID " +
"INNER JOIN COMPANY C on D.COMPANY_ID = C.ID " +
"WHERE (P.ID = A.ID AND P.FIRST_NAME like ?) " +
"OR (P.LAST_NAME like ?) " +
"GROUP BY P.ID " +
"HAVING (P.LAST_NAME like ?) " +
"OR (P.FIRST_NAME like ?) " +
"ORDER BY P.ID, P.FULL_NAME";

    

解決方案

MyBatis 3 提供了方便的工具類來(lái)幫助解決此問(wèn)題。借助 SQL 類，我們只需要簡(jiǎn)單地創(chuàng)建一個(gè)實(shí)例，并調(diào)用它的方法即可生成 SQL 語(yǔ)句。讓我們來(lái)用 SQL 類重寫上面的例子：

private String selectPersonSql() {
  return new SQL() {{
    SELECT("P.ID, P.USERNAME, P.PASSWORD, P.FULL_NAME");
    SELECT("P.LAST_NAME, P.CREATED_ON, P.UPDATED_ON");
    FROM("PERSON P");
    FROM("ACCOUNT A");
    INNER_JOIN("DEPARTMENT D on D.ID = P.DEPARTMENT_ID");
    INNER_JOIN("COMPANY C on D.COMPANY_ID = C.ID");
    WHERE("P.ID = A.ID");
    WHERE("P.FIRST_NAME like ?");
    OR();
    WHERE("P.LAST_NAME like ?");
    GROUP_BY("P.ID");
    HAVING("P.LAST_NAME like ?");
    OR();
    HAVING("P.FIRST_NAME like ?");
    ORDER_BY("P.ID");
    ORDER_BY("P.FULL_NAME");
  }}.toString();
}

這個(gè)例子有什么特別之處嗎？仔細(xì)看一下你會(huì)發(fā)現(xiàn)，你不用擔(dān)心可能會(huì)重復(fù)出現(xiàn)的 "AND" 關(guān)鍵字，或者要做出用 "WHERE" 拼接還是 "AND" 拼接還是不用拼接的選擇。SQL 類已經(jīng)為你處理了哪里應(yīng)該插入 "WHERE"、哪里應(yīng)該使用 "AND" 的問(wèn)題，并幫你完成所有的字符串拼接工作。

SQL 類

這里有一些示例：

// 匿名內(nèi)部類風(fēng)格
public String deletePersonSql() {
  return new SQL() {{
    DELETE_FROM("PERSON");
    WHERE("ID = #{id}");
  }}.toString();
}

// Builder / Fluent 風(fēng)格
public String insertPersonSql() {
  String sql = new SQL()
    .INSERT_INTO("PERSON")
    .VALUES("ID, FIRST_NAME", "#{id}, #{firstName}")
    .VALUES("LAST_NAME", "#{lastName}")
    .toString();
  return sql;
}

// 動(dòng)態(tài)條件（注意參數(shù)需要使用 final 修飾，以便匿名內(nèi)部類對(duì)它們進(jìn)行訪問(wèn)）
public String selectPersonLike(final String id, final String firstName, final String lastName) {
  return new SQL() {{
    SELECT("P.ID, P.USERNAME, P.PASSWORD, P.FIRST_NAME, P.LAST_NAME");
    FROM("PERSON P");
    if (id != null) {
      WHERE("P.ID like #{id}");
    }
    if (firstName != null) {
      WHERE("P.FIRST_NAME like #{firstName}");
    }
    if (lastName != null) {
      WHERE("P.LAST_NAME like #{lastName}");
    }
    ORDER_BY("P.LAST_NAME");
  }}.toString();
}

public String deletePersonSql() {
  return new SQL() {{
    DELETE_FROM("PERSON");
    WHERE("ID = #{id}");
  }}.toString();
}

public String insertPersonSql() {
  return new SQL() {{
    INSERT_INTO("PERSON");
    VALUES("ID, FIRST_NAME", "#{id}, #{firstName}");
    VALUES("LAST_NAME", "#{lastName}");
  }}.toString();
}

public String updatePersonSql() {
  return new SQL() {{
    UPDATE("PERSON");
    SET("FIRST_NAME = #{firstName}");
    WHERE("ID = #{id}");
  }}.toString();
}

注意，SQL 類將原樣插入 ?LIMIT?、?OFFSET?、?OFFSET n ROWS? 以及 ?FETCH FIRST n ROWS ONLY? 子句。換句話說(shuō)，類庫(kù)不會(huì)為不支持這些子句的數(shù)據(jù)庫(kù)執(zhí)行任何轉(zhuǎn)換。 因此，用戶應(yīng)該要了解目標(biāo)數(shù)據(jù)庫(kù)是否支持這些子句。如果目標(biāo)數(shù)據(jù)庫(kù)不支持這些子句，產(chǎn)生的 SQL 可能會(huì)引起運(yùn)行錯(cuò)誤。

從版本 3.4.2 開(kāi)始，你可以像下面這樣使用可變長(zhǎng)度參數(shù)：

public String selectPersonSql() {
  return new SQL()
    .SELECT("P.ID", "A.USERNAME", "A.PASSWORD", "P.FULL_NAME", "D.DEPARTMENT_NAME", "C.COMPANY_NAME")
    .FROM("PERSON P", "ACCOUNT A")
    .INNER_JOIN("DEPARTMENT D on D.ID = P.DEPARTMENT_ID", "COMPANY C on D.COMPANY_ID = C.ID")
    .WHERE("P.ID = A.ID", "P.FULL_NAME like #{name}")
    .ORDER_BY("P.ID", "P.FULL_NAME")
    .toString();
}

public String insertPersonSql() {
  return new SQL()
    .INSERT_INTO("PERSON")
    .INTO_COLUMNS("ID", "FULL_NAME")
    .INTO_VALUES("#{id}", "#{fullName}")
    .toString();
}

public String updatePersonSql() {
  return new SQL()
    .UPDATE("PERSON")
    .SET("FULL_NAME = #{fullName}", "DATE_OF_BIRTH = #{dateOfBirth}")
    .WHERE("ID = #{id}")
    .toString();
}

從版本 3.5.2 開(kāi)始，你可以像下面這樣構(gòu)建批量插入語(yǔ)句：

public String insertPersonsSql() {
  // INSERT INTO PERSON (ID, FULL_NAME)
  //     VALUES (#{mainPerson.id}, #{mainPerson.fullName}) , (#{subPerson.id}, #{subPerson.fullName})
  return new SQL()
    .INSERT_INTO("PERSON")
    .INTO_COLUMNS("ID", "FULL_NAME")
    .INTO_VALUES("#{mainPerson.id}", "#{mainPerson.fullName}")
    .ADD_ROW()
    .INTO_VALUES("#{subPerson.id}", "#{subPerson.fullName}")
    .toString();
}

從版本 3.5.2 開(kāi)始，你可以像下面這樣構(gòu)建限制返回結(jié)果數(shù)的 SELECT 語(yǔ)句,：

public String selectPersonsWithOffsetLimitSql() {
  // SELECT id, name FROM PERSON
  //     LIMIT #{limit} OFFSET #{offset}
  return new SQL()
    .SELECT("id", "name")
    .FROM("PERSON")
    .LIMIT("#{limit}")
    .OFFSET("#{offset}")
    .toString();
}

public String selectPersonsWithFetchFirstSql() {
  // SELECT id, name FROM PERSON
  //     OFFSET #{offset} ROWS FETCH FIRST #{limit} ROWS ONLY
  return new SQL()
    .SELECT("id", "name")
    .FROM("PERSON")
    .OFFSET_ROWS("#{offset}")
    .FETCH_FIRST_ROWS_ONLY("#{limit}")
    .toString();
}

SqlBuilder 和 SelectBuilder (已經(jīng)廢棄)

在版本 3.2 之前，我們的實(shí)現(xiàn)方式不太一樣，我們利用 ?ThreadLocal ?變量來(lái)掩蓋一些對(duì) Java DSL 不太友好的語(yǔ)言限制。現(xiàn)在，現(xiàn)代 SQL 構(gòu)建框架使用的構(gòu)建器和匿名內(nèi)部類思想已被人們所熟知。因此，我們廢棄了基于這種實(shí)現(xiàn)方式的 ?SelectBuilder ?和 ?SqlBuilder ?類。

下面的方法僅僅適用于廢棄的 ?SqlBuilder ?和 ?SelectBuilder ?類。

?SelectBuilder ?和 ?SqlBuilder ?類并不神奇，但最好還是知道它們的工作原理。 ?SelectBuilder ?以及 ?SqlBuilder ?借助靜態(tài)導(dǎo)入和 ?ThreadLocal ?變量實(shí)現(xiàn)了對(duì)插入條件友好的簡(jiǎn)潔語(yǔ)法。要使用它們，只需要靜態(tài)導(dǎo)入這個(gè)類的方法即可，就像這樣（只能使用其中的一條，不能同時(shí)使用）:

import static org.apache.ibatis.jdbc.SelectBuilder.*;

import static org.apache.ibatis.jdbc.SqlBuilder.*;

然后就可以像下面這樣創(chuàng)建一些方法：

/* 已被廢棄 */
public String selectBlogsSql() {
  BEGIN(); // 重置 ThreadLocal 狀態(tài)變量
  SELECT("*");
  FROM("BLOG");
  return SQL();
}

/* 已被廢棄 */
private String selectPersonSql() {
  BEGIN(); // 重置 ThreadLocal 狀態(tài)變量
  SELECT("P.ID, P.USERNAME, P.PASSWORD, P.FULL_NAME");
  SELECT("P.LAST_NAME, P.CREATED_ON, P.UPDATED_ON");
  FROM("PERSON P");
  FROM("ACCOUNT A");
  INNER_JOIN("DEPARTMENT D on D.ID = P.DEPARTMENT_ID");
  INNER_JOIN("COMPANY C on D.COMPANY_ID = C.ID");
  WHERE("P.ID = A.ID");
  WHERE("P.FIRST_NAME like ?");
  OR();
  WHERE("P.LAST_NAME like ?");
  GROUP_BY("P.ID");
  HAVING("P.LAST_NAME like ?");
  OR();
  HAVING("P.FIRST_NAME like ?");
  ORDER_BY("P.ID");
  ORDER_BY("P.FULL_NAME");
  return SQL();
}