SQL语句构建器类

2023年8月3日发(作者：)

SQL语句构建器类问题Java程序员⾯对的最痛苦的事情之⼀就是在Java代码中嵌⼊SQL语句。这么来做通常是由于SQL语句需要动态来⽣成-否则可以将它们放到外部⽂件或者存储过程中。正如你已经看到的那样，MyBatis在它的XML映射特性中有⼀个强⼤的动态SQL⽣成⽅案。但有时在Java代码内部创建SQL语句也是必要的。此时，MyBatis有另外⼀个特性可以帮到你，在减少典型的加号,引号,新⾏,格式化问题和嵌⼊条件来处理多余的逗号或 AND 连接词之前。事实上，在Java代码中来动态⽣成SQL代码就是⼀场噩梦。例如：String sql = "SELECT , ME, RD, _NAME, ""_NAME,D_ON, D_ON " +"FROM PERSON P, ACCOUNT A " +"INNER JOIN DEPARTMENT D on = MENT_ID " +"INNER JOIN COMPANY C on Y_ID = " +"WHERE ( = AND _NAME like ?) " +"OR (_NAME like ?) " +"GROUP BY " +"HAVING (_NAME like ?) " +"OR (_NAME like ?) " +"ORDER BY , _NAME";The SolutionMyBatis 3提供了⽅便的⼯具类来帮助解决该问题。使⽤SQL类，简单地创建⼀个实例来调⽤⽅法⽣成SQL语句。上⾯⽰例中的问题就像重写SQL类那样：private String selectPersonSql() { return new SQL() {{ SELECT(", ME, RD, _NAME"); SELECT("_NAME, D_ON, D_ON"); FROM("PERSON P"); FROM("ACCOUNT A"); INNER_JOIN("DEPARTMENT D on = MENT_ID"); INNER_JOIN("COMPANY C on Y_ID = "); WHERE(" = "); WHERE("_NAME like ?"); OR(); WHERE("_NAME like ?"); GROUP_BY(""); HAVING("_NAME like ?"); OR(); HAVING("_NAME like ?"); ORDER_BY(""); ORDER_BY("_NAME"); }}.toString();}该例中有什么特殊之处？当你仔细看时，那不⽤担⼼偶然间重复出现的"AND"关键字，或者在"WHERE"和"AND"之间的选择，抑或什么都不选。该SQL类⾮常注意"WHERE"应该出现在何处，哪⾥⼜应该使⽤"AND"，还有所有的字符串链接。SQL类这⾥给出⼀些⽰例：// Anonymous inner classpublic String deletePersonSql() { return new SQL() {{ DELETE_FROM("PERSON"); WHERE("ID = #{id}"); }}.toString();}// Builder / Fluent stylepublic String insertPersonSql() { String sql = new SQL() .INSERT_INTO("PERSON") .VALUES("ID, FIRST_NAME", "#{id}, #{firstName}") .VALUES("LAST_NAME", "#{lastName}") .toString(); return sql;}// With conditionals (note the final parameters, required for the anonymous inner class to access them)public String selectPersonLike(final String id, final String firstName, final String lastName) { return new SQL() {{ SELECT(", ME, RD, _NAME, _NAME"); FROM("PERSON P"); if (id != null) { WHERE(" like #{id}"); } if (firstName != null) { WHERE("_NAME like #{firstName}"); } if (lastName != null) { WHERE("_NAME like #{lastName}"); } ORDER_BY("_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();}⽅法SELECT(String))SELECT_DISTINCT(String)描述开始或插⼊到

SELECT⼦句。 可以被多次调⽤，参数也会添加到

SELECT⼦句。 参数通常使⽤逗号分隔的列名和别名列表，但也可以是数据库驱动程序接受的任意类型。开始或插⼊到

SELECT⼦句， 也可以插⼊

DISTINCT关键字到⽣成的查询语句中。 可以被多次调⽤，参数也SELECT_)会添加到

SELECT⼦句。 参数通常使⽤逗号分隔的列名和别名列表，但也可以是数据库驱动程序接受的任意类型。FROM(String))JOIN(String))INNER_JOIN(String)INNER_)LEFT_OUTER_JOIN(String)LEFT_OUTER_)RIGHT_OUTER_JOIN(String)RIGHT_OUTER_)开始或插⼊到

FROM⼦句。 可以被多次调⽤，参数也会添加到

FROM⼦句。 参数通常是表名或别名，也可以是数据库驱动程序接受的任意类型。基于调⽤的⽅法，添加新的合适类型的

JOIN⼦句。 参数可以包含由列命和join on条件组合成标准的join。⽅法WHERE(String))OR()AND()GROUP_BY(String)GROUP_)HAVING(String))ORDER_BY(String)ORDER_)DELETE_FROM(String)INSERT_INTO(String)SET(String))描述插⼊新的

WHERE⼦句条件， 由AND链接。可以多次被调⽤，每次都由AND来链接新条件。使⽤

OR() 来分隔OR。使⽤OR来分隔当前的

WHERE⼦句条件。 可以被多次调⽤，但在⼀⾏中多次调⽤或⽣成不稳定的SQL。使⽤AND来分隔当前的

WHERE⼦句条件。 可以被多次调⽤，但在⼀⾏中多次调⽤或⽣成不稳定的SQL。因为

WHERE 和

HAVING ⼆者都会⾃动链接

AND, 这是⾮常罕见的⽅法，只是为了完整性才被使⽤。插⼊新的

GROUP BY⼦句元素，由逗号连接。 可以被多次调⽤，每次都由逗号连接新的条件。插⼊新的

HAVING⼦句条件。 由AND连接。可以被多次调⽤，每次都由AND来连接新的条件。使⽤

OR() 来分隔OR.插⼊新的

ORDER BY⼦句元素， 由逗号连接。可以多次被调⽤，每次由逗号连接新的条件。开始⼀个delete语句并指定需要从哪个表删除的表名。通常它后⾯都会跟着WHERE语句！开始⼀个insert语句并指定需要插⼊数据的表名。后⾯都会跟着⼀个或者多个VALUES() orINTO_COLUMNS() and INTO_VALUES()。针对update语句，插⼊到"set"列表中开始⼀个update语句并指定需要更新的表明。后⾯都会跟着⼀个或者多个SET()，通常也会有⼀个WHERE()。插⼊到insert语句中。第⼀个参数是要插⼊的列名，第⼆个参数则是该列的值。Appends columns phrase to an insert statement. This should be call INTO_VALUES() with s values phrase to an insert statement. This should be call INTO_COLUMNS() with (String)VALUES(String, String)INTO_)INTO_)Since version 3.4.2, you can use variable-length arguments as follows:public String selectPersonSql() { return new SQL() .SELECT("", "ME", "RD", "_NAME", "MENT_NAME", "Y_NAME") .FROM("PERSON P", "ACCOUNT A") .INNER_JOIN("DEPARTMENT D on = MENT_ID", "COMPANY C on Y_ID = ") .WHERE(" = ", "_NAME like #{name}") .ORDER_BY("", "_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();}SqlBuilder 和 SelectBuilder (已经废弃)在3.2版本之前，我们使⽤了⼀点不同的做法，通过实现ThreadLocal变量来掩盖⼀些导致Java DSL⿇烦的语⾔限制。但这种⽅式已经废弃了，现代的框架都欢迎⼈们使⽤构建器类型和匿名内部类的想法。因此，SelectBuilder 和 SqlBuilder 类都被废弃了。下⾯的⽅法仅仅适⽤于废弃的SqlBuilder 和 SelectBuilder 类。⽅法BEGIN() /RESET()描述这些⽅法清空SelectBuilder类的ThreadLocal状态，并且准备⼀个新的构建语句。开始新的语句时，

BEGIN()读取得最好。由于⼀些原因（在某些条件下，也许是逻辑需要⼀个完全不同的语句），在执⾏中清理语句

RESET()读取得最好。SQL()⽅法返回⽣成的

SQL() 并重置

SelectBuilder 状态 (好像

BEGIN() 或

RESET()描述 被调⽤了). 因此，该⽅法只能被调⽤⼀次！SelectBuilder 和 SqlBuilder 类并不神奇，但是知道它们如何⼯作也是很重要的。 SelectBuilder 使⽤ SqlBuilder 使⽤了静态导⼊和ThreadLocal变量的组合来开启整洁语法，可以很容易地和条件交错。使⽤它们，静态导⼊类的⽅法即可，就像这样(⼀个或其它，并⾮两者):import static Builder.*;import static lder.*;这就允许像下⾯这样来创建⽅法：/* DEPRECATED */public String selectBlogsSql() { BEGIN(); // Clears ThreadLocal variable SELECT("*"); FROM("BLOG"); return SQL();}/* DEPRECATED */private String selectPersonSql() { BEGIN(); // Clears ThreadLocal variable SELECT(", ME, RD, _NAME"); SELECT("_NAME, D_ON, D_ON"); FROM("PERSON P"); FROM("ACCOUNT A"); INNER_JOIN("DEPARTMENT D on = MENT_ID"); INNER_JOIN("COMPANY C on Y_ID = "); WHERE(" = "); WHERE("_NAME like ?"); OR(); WHERE("_NAME like ?"); GROUP_BY(""); HAVING("_NAME like ?"); OR(); HAVING("_NAME like ?"); ORDER_BY(""); ORDER_BY("_NAME"); return SQL();}

2023年8月3日发(作者：)

SQL语句构建器类问题Java程序员⾯对的最痛苦的事情之⼀就是在Java代码中嵌⼊SQL语句。这么来做通常是由于SQL语句需要动态来⽣成-否则可以将它们放到外部⽂件或者存储过程中。正如你已经看到的那样，MyBatis在它的XML映射特性中有⼀个强⼤的动态SQL⽣成⽅案。但有时在Java代码内部创建SQL语句也是必要的。此时，MyBatis有另外⼀个特性可以帮到你，在减少典型的加号,引号,新⾏,格式化问题和嵌⼊条件来处理多余的逗号或 AND 连接词之前。事实上，在Java代码中来动态⽣成SQL代码就是⼀场噩梦。例如：String sql = "SELECT , ME, RD, _NAME, ""_NAME,D_ON, D_ON " +"FROM PERSON P, ACCOUNT A " +"INNER JOIN DEPARTMENT D on = MENT_ID " +"INNER JOIN COMPANY C on Y_ID = " +"WHERE ( = AND _NAME like ?) " +"OR (_NAME like ?) " +"GROUP BY " +"HAVING (_NAME like ?) " +"OR (_NAME like ?) " +"ORDER BY , _NAME";The SolutionMyBatis 3提供了⽅便的⼯具类来帮助解决该问题。使⽤SQL类，简单地创建⼀个实例来调⽤⽅法⽣成SQL语句。上⾯⽰例中的问题就像重写SQL类那样：private String selectPersonSql() { return new SQL() {{ SELECT(", ME, RD, _NAME"); SELECT("_NAME, D_ON, D_ON"); FROM("PERSON P"); FROM("ACCOUNT A"); INNER_JOIN("DEPARTMENT D on = MENT_ID"); INNER_JOIN("COMPANY C on Y_ID = "); WHERE(" = "); WHERE("_NAME like ?"); OR(); WHERE("_NAME like ?"); GROUP_BY(""); HAVING("_NAME like ?"); OR(); HAVING("_NAME like ?"); ORDER_BY(""); ORDER_BY("_NAME"); }}.toString();}该例中有什么特殊之处？当你仔细看时，那不⽤担⼼偶然间重复出现的"AND"关键字，或者在"WHERE"和"AND"之间的选择，抑或什么都不选。该SQL类⾮常注意"WHERE"应该出现在何处，哪⾥⼜应该使⽤"AND"，还有所有的字符串链接。SQL类这⾥给出⼀些⽰例：// Anonymous inner classpublic String deletePersonSql() { return new SQL() {{ DELETE_FROM("PERSON"); WHERE("ID = #{id}"); }}.toString();}// Builder / Fluent stylepublic String insertPersonSql() { String sql = new SQL() .INSERT_INTO("PERSON") .VALUES("ID, FIRST_NAME", "#{id}, #{firstName}") .VALUES("LAST_NAME", "#{lastName}") .toString(); return sql;}// With conditionals (note the final parameters, required for the anonymous inner class to access them)public String selectPersonLike(final String id, final String firstName, final String lastName) { return new SQL() {{ SELECT(", ME, RD, _NAME, _NAME"); FROM("PERSON P"); if (id != null) { WHERE(" like #{id}"); } if (firstName != null) { WHERE("_NAME like #{firstName}"); } if (lastName != null) { WHERE("_NAME like #{lastName}"); } ORDER_BY("_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();}⽅法SELECT(String))SELECT_DISTINCT(String)描述开始或插⼊到

SELECT⼦句。 可以被多次调⽤，参数也会添加到

SELECT⼦句。 参数通常使⽤逗号分隔的列名和别名列表，但也可以是数据库驱动程序接受的任意类型。开始或插⼊到

SELECT⼦句， 也可以插⼊

DISTINCT关键字到⽣成的查询语句中。 可以被多次调⽤，参数也SELECT_)会添加到

SELECT⼦句。 参数通常使⽤逗号分隔的列名和别名列表，但也可以是数据库驱动程序接受的任意类型。FROM(String))JOIN(String))INNER_JOIN(String)INNER_)LEFT_OUTER_JOIN(String)LEFT_OUTER_)RIGHT_OUTER_JOIN(String)RIGHT_OUTER_)开始或插⼊到

FROM⼦句。 可以被多次调⽤，参数也会添加到

FROM⼦句。 参数通常是表名或别名，也可以是数据库驱动程序接受的任意类型。基于调⽤的⽅法，添加新的合适类型的

JOIN⼦句。 参数可以包含由列命和join on条件组合成标准的join。⽅法WHERE(String))OR()AND()GROUP_BY(String)GROUP_)HAVING(String))ORDER_BY(String)ORDER_)DELETE_FROM(String)INSERT_INTO(String)SET(String))描述插⼊新的

WHERE⼦句条件， 由AND链接。可以多次被调⽤，每次都由AND来链接新条件。使⽤

OR() 来分隔OR。使⽤OR来分隔当前的

WHERE⼦句条件。 可以被多次调⽤，但在⼀⾏中多次调⽤或⽣成不稳定的SQL。使⽤AND来分隔当前的

WHERE⼦句条件。 可以被多次调⽤，但在⼀⾏中多次调⽤或⽣成不稳定的SQL。因为

WHERE 和

HAVING ⼆者都会⾃动链接

AND, 这是⾮常罕见的⽅法，只是为了完整性才被使⽤。插⼊新的

GROUP BY⼦句元素，由逗号连接。 可以被多次调⽤，每次都由逗号连接新的条件。插⼊新的

HAVING⼦句条件。 由AND连接。可以被多次调⽤，每次都由AND来连接新的条件。使⽤

OR() 来分隔OR.插⼊新的

ORDER BY⼦句元素， 由逗号连接。可以多次被调⽤，每次由逗号连接新的条件。开始⼀个delete语句并指定需要从哪个表删除的表名。通常它后⾯都会跟着WHERE语句！开始⼀个insert语句并指定需要插⼊数据的表名。后⾯都会跟着⼀个或者多个VALUES() orINTO_COLUMNS() and INTO_VALUES()。针对update语句，插⼊到"set"列表中开始⼀个update语句并指定需要更新的表明。后⾯都会跟着⼀个或者多个SET()，通常也会有⼀个WHERE()。插⼊到insert语句中。第⼀个参数是要插⼊的列名，第⼆个参数则是该列的值。Appends columns phrase to an insert statement. This should be call INTO_VALUES() with s values phrase to an insert statement. This should be call INTO_COLUMNS() with (String)VALUES(String, String)INTO_)INTO_)Since version 3.4.2, you can use variable-length arguments as follows:public String selectPersonSql() { return new SQL() .SELECT("", "ME", "RD", "_NAME", "MENT_NAME", "Y_NAME") .FROM("PERSON P", "ACCOUNT A") .INNER_JOIN("DEPARTMENT D on = MENT_ID", "COMPANY C on Y_ID = ") .WHERE(" = ", "_NAME like #{name}") .ORDER_BY("", "_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();}SqlBuilder 和 SelectBuilder (已经废弃)在3.2版本之前，我们使⽤了⼀点不同的做法，通过实现ThreadLocal变量来掩盖⼀些导致Java DSL⿇烦的语⾔限制。但这种⽅式已经废弃了，现代的框架都欢迎⼈们使⽤构建器类型和匿名内部类的想法。因此，SelectBuilder 和 SqlBuilder 类都被废弃了。下⾯的⽅法仅仅适⽤于废弃的SqlBuilder 和 SelectBuilder 类。⽅法BEGIN() /RESET()描述这些⽅法清空SelectBuilder类的ThreadLocal状态，并且准备⼀个新的构建语句。开始新的语句时，

BEGIN()读取得最好。由于⼀些原因（在某些条件下，也许是逻辑需要⼀个完全不同的语句），在执⾏中清理语句

RESET()读取得最好。SQL()⽅法返回⽣成的

SQL() 并重置

SelectBuilder 状态 (好像

BEGIN() 或

RESET()描述 被调⽤了). 因此，该⽅法只能被调⽤⼀次！SelectBuilder 和 SqlBuilder 类并不神奇，但是知道它们如何⼯作也是很重要的。 SelectBuilder 使⽤ SqlBuilder 使⽤了静态导⼊和ThreadLocal变量的组合来开启整洁语法，可以很容易地和条件交错。使⽤它们，静态导⼊类的⽅法即可，就像这样(⼀个或其它，并⾮两者):import static Builder.*;import static lder.*;这就允许像下⾯这样来创建⽅法：/* DEPRECATED */public String selectBlogsSql() { BEGIN(); // Clears ThreadLocal variable SELECT("*"); FROM("BLOG"); return SQL();}/* DEPRECATED */private String selectPersonSql() { BEGIN(); // Clears ThreadLocal variable SELECT(", ME, RD, _NAME"); SELECT("_NAME, D_ON, D_ON"); FROM("PERSON P"); FROM("ACCOUNT A"); INNER_JOIN("DEPARTMENT D on = MENT_ID"); INNER_JOIN("COMPANY C on Y_ID = "); WHERE(" = "); WHERE("_NAME like ?"); OR(); WHERE("_NAME like ?"); GROUP_BY(""); HAVING("_NAME like ?"); OR(); HAVING("_NAME like ?"); ORDER_BY(""); ORDER_BY("_NAME"); return SQL();}