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",还有所有的字符串链接。

    • SELECT(String)
    • SELECT(String…)|开始或插入到 SELECT子句。 可以被多次调用,参数也会添加到 SELECT子句。 参数通常使用逗号分隔的列名和别名列表,但也可以是数据库驱动程序接受的任意类型。
      |
    • SELECT_DISTINCT(String)
    • SELECT_DISTINCT(String…)|开始或插入到 SELECT子句, 也可以插入 DISTINCT关键字到生成的查询语句中。 可以被多次调用,参数也会添加到 SELECT子句。 参数通常使用逗号分隔的列名和别名列表,但也可以是数据库驱动程序接受的任意类型。
      |
    • FROM(String)
    • FROM(String…)|开始或插入到 FROM子句。 可以被多次调用,参数也会添加到 FROM子句。 参数通常是表名或别名,也可以是数据库驱动程序接受的任意类型。
      |
    • 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子句。参数可以包含由列命和join on条件组合成标准的join。
      |
    • WHERE(String)
    • WHERE(String…)|插入新的 WHERE子句条件, 由AND链接。可以多次被调用,每次都由AND来链接新条件。使用 OR() 来分隔OR
      |OR()|使用OR来分隔当前的 WHERE子句条件。可以被多次调用,但在一行中多次调用或生成不稳定的SQL
      |AND()|使用AND来分隔当前的 WHERE子句条件。可以被多次调用,但在一行中多次调用或生成不稳定的SQL。因为 WHEREHAVING 二者都会自动链接 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子句元素, 由逗号连接。可以多次被调用,每次由逗号连接新的条件。
      |DELETE_FROM(String)|开始一个delete语句并指定需要从哪个表删除的表名。通常它后面都会跟着WHERE语句!
      |INSERT_INTO(String)|开始一个insert语句并指定需要插入数据的表名。后面都会跟着一个或者多个VALUES() or INTO_COLUMNS() and INTO_VALUES()。
      |
    • SET(String)
    • SET(String…)|针对update语句,插入到"set"列表中
      |UPDATE(String)|开始一个update语句并指定需要更新的表明。后面都会跟着一个或者多个SET(),通常也会有一个WHERE()。
      |VALUES(String, String)|插入到insert语句中。第一个参数是要插入的列名,第二个参数则是该列的值。
      |INTO_COLUMNS(String…)| Appends columns phrase to an insert statement. This should be call INTO_VALUES() with together.
      |INTO_VALUES(String…)| Appends values phrase to an insert statement. This should be call INTO_COLUMNS() with together.

    Since version 3.4.2, you can use variable-length arguments as follows:

    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. }
    10.  
    11. public String insertPersonSql() {
    12. return new SQL()
    13. .INSERT_INTO("PERSON")
    14. .INTO_COLUMNS("ID", "FULL_NAME")
    15. .INTO_VALUES("#{id}", "#{fullName}")
    16. }
    17.  
    18. public String updatePersonSql() {
    19. return new SQL()
    20. .UPDATE("PERSON")
    21. .SET("FULL_NAME = #{fullName}", "DATE_OF_BIRTH = #{dateOfBirth}")
    22. .WHERE("ID = #{id}")
    23. .toString();
    24. }

    在3.2版本之前,我们使用了一点不同的做法,通过实现ThreadLocal变量来掩盖一些导致Java DSL麻烦的语言限制。但这种方式已经废弃了,现代的框架都欢迎人们使用构建器类型和匿名内部类的想法。因此,SelectBuilder 和 SqlBuilder 类都被废弃了。

    方法 描述
    BEGIN() / RESET() 这些方法清空SelectBuilder类的ThreadLocal状态,并且准备一个新的构建语句。开始新的语句时, BEGIN()读取得最好。由于一些原因(在某些条件下,也许是逻辑需要一个完全不同的语句),在执行中清理语句 RESET()读取得最好。
    SQL() 返回生成的 SQL() 并重置 SelectBuilder 状态 (好像 BEGIN()RESET() 被调用了). 因此,该方法只能被调用一次!

    SelectBuilder 和 SqlBuilder 类并不神奇,但是知道它们如何工作也是很重要的。 SelectBuilder 使用 SqlBuilder 使用了静态导入和ThreadLocal变量的组合来开启整洁语法,可以很容易地和条件交错。使用它们,静态导入类的方法即可,就像这样(一个或其它,并非两者):

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

    这就允许像下面这样来创建方法:

    1. /* DEPRECATED */
    2. private String selectPersonSql() {
    3. BEGIN(); // Clears ThreadLocal variable
    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. }