SQL 语句构建器

问题

Java 程序员面对的最痛苦的事情之一就是在 Java 代码中嵌入 SQL 语句。这通常是因为需要动态生成 SQL 语句，不然我们可以将它们放到外部文件或者存储过程中。如你所见，MyBatis 在 XML 映射中具备强大的 SQL 动态生成能力。但有时，我们还是需要在 Java 代码里构建 SQL 语句。此时，MyBatis 有另外一个特性可以帮到你，让你从处理典型问题中解放出来，比如加号、引号、换行、格式化问题、嵌入条件的逗号管理及 AND 连接。确实，在 Java 代码中动态生成 SQL 代码真的就是一场噩梦。例如：

  1. String sql = "SELECT P.ID, P.USERNAME, P.PASSWORD, P.FULL_NAME, "
  2. "P.LAST_NAME,P.CREATED_ON, P.UPDATED_ON " +
  3. "FROM PERSON P, ACCOUNT A " +
  4. "INNER JOIN DEPARTMENT D on D.ID = P.DEPARTMENT_ID " +
  5. "INNER JOIN COMPANY C on D.COMPANY_ID = C.ID " +
  6. "WHERE (P.ID = A.ID AND P.FIRST_NAME like ?) " +
  7. "OR (P.LAST_NAME like ?) " +
  8. "GROUP BY P.ID " +
  9. "HAVING (P.LAST_NAME like ?) " +
  10. "OR (P.FIRST_NAME like ?) " +
  11. "ORDER BY P.ID, P.FULL_NAME";

解决方案

MyBatis 3 提供了方便的工具类来帮助解决此问题。借助 SQL 类，我们只需要简单地创建一个实例，并调用它的方法即可生成 SQL 语句。让我们来用 SQL 类重写上面的例子：

  1. private String selectPersonSql() {
  2.   return new SQL() {{
  3.     SELECT("P.ID, P.USERNAME, P.PASSWORD, P.FULL_NAME");
  4.     SELECT("P.LAST_NAME, P.CREATED_ON, P.UPDATED_ON");
  5.     FROM("PERSON P");
  6.     FROM("ACCOUNT A");
  7.     INNER_JOIN("DEPARTMENT D on D.ID = P.DEPARTMENT_ID");
  8.     INNER_JOIN("COMPANY C on D.COMPANY_ID = C.ID");
  9.     WHERE("P.ID = A.ID");
  10.     WHERE("P.FIRST_NAME like ?");
  11.     OR();
  12.     WHERE("P.LAST_NAME like ?");
  13.     GROUP_BY("P.ID");
  14.     HAVING("P.LAST_NAME like ?");
  15.     OR();
  16.     HAVING("P.FIRST_NAME like ?");
  17.     ORDER_BY("P.ID");
  18.     ORDER_BY("P.FULL_NAME");
  19.   }}.toString();
  20. }

这个例子有什么特别之处吗？仔细看一下你会发现，你不用担心可能会重复出现的 “AND” 关键字，或者要做出用 “WHERE” 拼接还是 “AND” 拼接还是不用拼接的选择。SQL 类已经为你处理了哪里应该插入 “WHERE”、哪里应该使用 “AND” 的问题，并帮你完成所有的字符串拼接工作。

SQL 类

这里有一些示例：

  1. // 匿名内部类风格
  2. public String deletePersonSql() {
  3.   return new SQL() {{
  4.     DELETE_FROM("PERSON");
  5.     WHERE("ID = #{id}");
  6.   }}.toString();
  7. }
  9. // Builder / Fluent 风格
  10. public String insertPersonSql() {
  11.   String sql = new SQL()
  12.     .INSERT_INTO("PERSON")
  13.     .VALUES("ID, FIRST_NAME", "#{id}, #{firstName}")
  14.     .VALUES("LAST_NAME", "#{lastName}")
  15.     .toString();
  16.   return sql;
  17. }
  19. // 动态条件（注意参数需要使用 final 修饰，以便匿名内部类对它们进行访问）
  20. public String selectPersonLike(final String id, final String firstName, final String lastName) {
  21.   return new SQL() {{
  22.     SELECT("P.ID, P.USERNAME, P.PASSWORD, P.FIRST_NAME, P.LAST_NAME");
  23.     FROM("PERSON P");
  24.     if (id != null) {
  25.       WHERE("P.ID like #{id}");
  26.     }
  27.     if (firstName != null) {
  28.       WHERE("P.FIRST_NAME like #{firstName}");
  29.     }
  30.     if (lastName != null) {
  31.       WHERE("P.LAST_NAME like #{lastName}");
  32.     }
  33.     ORDER_BY("P.LAST_NAME");
  34.   }}.toString();
  35. }
  37. public String deletePersonSql() {
  38.   return new SQL() {{
  39.     DELETE_FROM("PERSON");
  40.     WHERE("ID = #{id}");
  41.   }}.toString();
  42. }
  44. public String insertPersonSql() {
  45.   return new SQL() {{
  46.     INSERT_INTO("PERSON");
  47.     VALUES("ID, FIRST_NAME", "#{id}, #{firstName}");
  48.     VALUES("LAST_NAME", "#{lastName}");
  49.   }}.toString();
  50. }
  52. public String updatePersonSql() {
  53.   return new SQL() {{
  54.     UPDATE("PERSON");
  55.     SET("FIRST_NAME = #{firstName}");
  56.     WHERE("ID = #{id}");
  57.   }}.toString();
  58. }
方法描述
  • SELECT(String)
  • SELECT(String…)
开始新的或追加到已有的 SELECT子句。可以被多次调用，参数会被追加到 SELECT 子句。 参数通常使用逗号分隔的列名和别名列表，但也可以是数据库驱动程序接受的任意参数。
  • SELECT_DISTINCT(String)
  • SELECT_DISTINCT(String…)
开始新的或追加到已有的 SELECT子句，并添加 DISTINCT 关键字到生成的查询中。可以被多次调用，参数会被追加到 SELECT 子句。 参数通常使用逗号分隔的列名和别名列表，但也可以是数据库驱动程序接受的任意参数。
  • FROM(String)
  • FROM(String…)
开始新的或追加到已有的 FROM子句。可以被多次调用，参数会被追加到 FROM子句。 参数通常是一个表名或别名，也可以是数据库驱动程序接受的任意参数。
  • JOIN(String)
  • JOIN(String…)
  • INNER_JOIN(String)
  • INNER_JOIN(String…)
  • LEFT_OUTER_JOIN(String)
  • LEFT_OUTER_JOIN(String…)
  • RIGHT_OUTER_JOIN(String)
  • RIGHT_OUTER_JOIN(String…)
基于调用的方法，添加新的合适类型的 JOIN 子句。 参数可以包含一个由列和连接条件构成的标准连接。
  • WHERE(String)
  • WHERE(String…)
插入新的 WHERE 子句条件，并使用 AND 拼接。可以被多次调用，对于每一次调用产生的新条件，会使用 AND 拼接起来。要使用 OR 分隔，请使用 OR()。
OR()使用 OR 来分隔当前的 WHERE 子句条件。 可以被多次调用，但在一行中多次调用会生成错误的 SQL。
AND()使用 AND 来分隔当前的 WHERE子句条件。 可以被多次调用，但在一行中多次调用会生成错误的 SQL。由于 WHERE 和 HAVING都会自动使用 AND 拼接, 因此这个方法并不常用，只是为了完整性才被定义出来。
  • GROUP_BY(String)
  • GROUP_BY(String…)
追加新的 GROUP BY 子句，使用逗号拼接。可以被多次调用，每次调用都会使用逗号将新的条件拼接起来。
  • HAVING(String)
  • HAVING(String…)
追加新的 HAVING 子句。使用 AND 拼接。可以被多次调用，每次调用都使用AND来拼接新的条件。要使用 OR 分隔，请使用 OR()。
  • ORDER_BY(String)
  • ORDER_BY(String…)
追加新的 ORDER BY 子句，使用逗号拼接。可以多次被调用，每次调用会使用逗号拼接新的条件。
  • LIMIT(String)
  • LIMIT(int)
追加新的 LIMIT 子句。 仅在 SELECT()、UPDATE()、DELETE() 时有效。 当在 SELECT() 中使用时，应该配合 OFFSET() 使用。（于 3.5.2 引入）
  • OFFSET(String)
  • OFFSET(long)
追加新的 OFFSET 子句。 仅在 SELECT() 时有效。 当在 SELECT() 时使用时，应该配合 LIMIT() 使用。（于 3.5.2 引入）
  • OFFSET_ROWS(String)
  • OFFSET_ROWS(long)
追加新的 OFFSET n ROWS 子句。 仅在 SELECT() 时有效。 该方法应该配合 FETCH_FIRST_ROWS_ONLY() 使用。（于 3.5.2 加入）
  • FETCH_FIRST_ROWS_ONLY(String)
  • FETCH_FIRST_ROWS_ONLY(int)
追加新的 FETCH FIRST n ROWS ONLY 子句。 仅在 SELECT() 时有效。 该方法应该配合 OFFSET_ROWS() 使用。（于 3.5.2 加入）
DELETE_FROM(String)开始新的 delete 语句，并指定删除表的表名。通常它后面都会跟着一个 WHERE 子句！
INSERT_INTO(String)开始新的 insert 语句，并指定插入数据表的表名。后面应该会跟着一个或多个 VALUES() 调用，或 INTO_COLUMNS() 和 INTO_VALUES() 调用。
  • SET(String)
  • SET(String…)
对 update 语句追加 “set” 属性的列表
UPDATE(String)开始新的 update 语句，并指定更新表的表名。后面都会跟着一个或多个 SET() 调用，通常也会有一个 WHERE() 调用。
VALUES(String, String)追加数据值到 insert 语句中。第一个参数是数据插入的列名，第二个参数则是数据值。
INTO_COLUMNS(String…)追加插入列子句到 insert 语句中。应与 INTO_VALUES() 一同使用。
INTO_VALUES(String…)追加插入值子句到 insert 语句中。应与 INTO_COLUMNS() 一同使用。
ADD_ROW()添加新的一行数据，以便执行批量插入。（于 3.5.2 引入）

提示 注意，SQL 类将原样插入 LIMIT、OFFSET、OFFSET n ROWS 以及 FETCH FIRST n ROWS ONLY 子句。换句话说，类库不会为不支持这些子句的数据库执行任何转换。 因此，用户应该要了解目标数据库是否支持这些子句。如果目标数据库不支持这些子句，产生的 SQL 可能会引起运行错误。

从版本 3.4.2 开始，你可以像下面这样使用可变长度参数：

  1. public String selectPersonSql() {
  2.   return new SQL()
  3.     .SELECT("P.ID", "A.USERNAME", "A.PASSWORD", "P.FULL_NAME", "D.DEPARTMENT_NAME", "C.COMPANY_NAME")
  4.     .FROM("PERSON P", "ACCOUNT A")
  5.     .INNER_JOIN("DEPARTMENT D on D.ID = P.DEPARTMENT_ID", "COMPANY C on D.COMPANY_ID = C.ID")
  6.     .WHERE("P.ID = A.ID", "P.FULL_NAME like #{name}")
  7.     .ORDER_BY("P.ID", "P.FULL_NAME")
  8.     .toString();
  9. }
  11. public String insertPersonSql() {
  12.   return new SQL()
  13.     .INSERT_INTO("PERSON")
  14.     .INTO_COLUMNS("ID", "FULL_NAME")
  15.     .INTO_VALUES("#{id}", "#{fullName}")
  16.     .toString();
  17. }
  19. public String updatePersonSql() {
  20.   return new SQL()
  21.     .UPDATE("PERSON")
  22.     .SET("FULL_NAME = #{fullName}", "DATE_OF_BIRTH = #{dateOfBirth}")
  23.     .WHERE("ID = #{id}")
  24.     .toString();
  25. }

从版本 3.5.2 开始，你可以像下面这样构建批量插入语句：

  1. public String insertPersonsSql() {
  2.   // INSERT INTO PERSON (ID, FULL_NAME)
  3.   //     VALUES (#{mainPerson.id}, #{mainPerson.fullName}) , (#{subPerson.id}, #{subPerson.fullName})
  4.   return new SQL()
  5.     .INSERT_INTO("PERSON")
  6.     .INTO_COLUMNS("ID", "FULL_NAME")
  7.     .INTO_VALUES("#{mainPerson.id}", "#{mainPerson.fullName}")
  8.     .ADD_ROW()
  9.     .INTO_VALUES("#{subPerson.id}", "#{subPerson.fullName}")
  10.     .toString();
  11. }

从版本 3.5.2 开始，你可以像下面这样构建限制返回结果数的 SELECT 语句,：

  1. public String selectPersonsWithOffsetLimitSql() {
  2.   // SELECT id, name FROM PERSON
  3.   //     LIMIT #{limit} OFFSET #{offset}
  4.   return new SQL()
  5.     .SELECT("id", "name")
  6.     .FROM("PERSON")
  7.     .LIMIT("#{limit}")
  8.     .OFFSET("#{offset}")
  9.     .toString();
  10. }
  12. public String selectPersonsWithFetchFirstSql() {
  13.   // SELECT id, name FROM PERSON
  14.   //     OFFSET #{offset} ROWS FETCH FIRST #{limit} ROWS ONLY
  15.   return new SQL()
  16.     .SELECT("id", "name")
  17.     .FROM("PERSON")
  18.     .OFFSET_ROWS("#{offset}")
  19.     .FETCH_FIRST_ROWS_ONLY("#{limit}")
  20.     .toString();
  21. }

SqlBuilder 和 SelectBuilder (已经废弃)

在版本 3.2 之前，我们的实现方式不太一样，我们利用 ThreadLocal 变量来掩盖一些对 Java DSL 不太友好的语言限制。现在，现代 SQL 构建框架使用的构建器和匿名内部类思想已被人们所熟知。因此，我们废弃了基于这种实现方式的 SelectBuilder 和 SqlBuilder 类。

下面的方法仅仅适用于废弃的 SqlBuilder 和 SelectBuilder 类。

方法描述
BEGIN() / RESET()这些方法清空 SelectBuilder 类的 ThreadLocal 状态，并准备好构建一个新的语句。开始新的语句时，BEGIN() 是最名副其实的（可读性最好的）。但如果由于一些原因（比如程序逻辑在某些条件下需要一个完全不同的语句），在执行过程中要重置语句构建状态，就很适合使用 RESET()。
SQL()该方法返回生成的 SQL() 并重置 SelectBuilder 状态（等价于调用了 BEGIN() 或 RESET()）。因此，该方法只能被调用一次！

SelectBuilder 和 SqlBuilder 类并不神奇，但最好还是知道它们的工作原理。 SelectBuilder 以及 SqlBuilder 借助静态导入和 ThreadLocal 变量实现了对插入条件友好的简洁语法。要使用它们，只需要静态导入这个类的方法即可，就像这样（只能使用其中的一条，不能同时使用）:

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

然后就可以像下面这样创建一些方法：

  1. /* 已被废弃 */
  2. public String selectBlogsSql() {
  3.   BEGIN(); // 重置 ThreadLocal 状态变量
  4.   SELECT("*");
  5.   FROM("BLOG");
  6.   return SQL();
  7. }
  1. /* 已被废弃 */
  2. private String selectPersonSql() {
  3.   BEGIN(); // 重置 ThreadLocal 状态变量
  4.   SELECT("P.ID, P.USERNAME, P.PASSWORD, P.FULL_NAME");
  5.   SELECT("P.LAST_NAME, P.CREATED_ON, P.UPDATED_ON");
  6.   FROM("PERSON P");
  7.   FROM("ACCOUNT A");
  8.   INNER_JOIN("DEPARTMENT D on D.ID = P.DEPARTMENT_ID");
  9.   INNER_JOIN("COMPANY C on D.COMPANY_ID = C.ID");
  10.   WHERE("P.ID = A.ID");
  11.   WHERE("P.FIRST_NAME like ?");
  12.   OR();
  13.   WHERE("P.LAST_NAME like ?");
  14.   GROUP_BY("P.ID");
  15.   HAVING("P.LAST_NAME like ?");
  16.   OR();
  17.   HAVING("P.FIRST_NAME like ?");
  18.   ORDER_BY("P.ID");
  19.   ORDER_BY("P.FULL_NAME");
  20.   return SQL();
  21. }