MyBatis——SQL语句构建器类

最新推荐文章于 2025-01-13 04:01:31 发布

原创最新推荐文章于 2025-01-13 04:01:31 发布 · 1.4k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#java #MyBatis #SQL语句构建器 #SQL #database

JAVA 专栏收录该内容

80 篇文章

订阅专栏

本文介绍如何利用MyBatis3的SQL类避免在Java代码中处理SQL的繁琐问题，通过@InsertProvider、@DeleteProvider、@UpdateProvider和@SelectProvider注解，演示如何轻松构造插入、删除、更新和查询操作。适合动态SQL场景下的代码优化。

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

解决方案

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

官方文档：mybatis – MyBatis 3 | SQL 语句构建器https://mybatis.org/mybatis-3/zh/statement-builders.html

具体使用

插入：

注解：@InsertProvider

@InsertProvider(type = CommonDao.SqlProvider.class, method = "insertByCondition")
int insert(PersonDTO param);

class SqlProvider {
            public String insertByCondition(PersonDTO param) {
            SQL sql = new SQL();
            sql.INSERT_INTO("Person");
            if (param.getId() != null) {
                sql.VALUES("ID", "#{id}");
            }
            if (!StringUtils.isEmpty(param.getAge())) {
                sql.VALUES("AGE", "#{age}");
            }
            if (!StringUtils.isEmpty(param.getName())) {
                sql.VALUES("NAME", "#{name}");
            }
            return sql.toString();
        }
}

删除：

注解:@DeleteProvider

@DeleteProvider(type = CommonDao.SqlProvider.class, method = "removeByCondition")
int remove(PersonDTO param);

class SqlProvider {
            public String removeByCondition(PersonDTO param) {
            SQL sql = new SQL();
            sql.DELETE_FROM("Person");
            if (param.getId() != null) {
                sql.WHERE("id = #{id}");
            }
            if (!StringUtils.isEmpty(param.getAge())) {
                sql.WHERE("AGE= #{age}");
            }
            if (!StringUtils.isEmpty(param.getName())) {
                sql.WHERE("NAME= #{name}");
            }
            return sql.toString();
        }
}

修改：

注解：@UpdateProvider

@UpdateProvider(type = CommonDao.SqlProvider.class, method = "updateByCondition")
public int update(PersonDTO param);


class SqlProvider {
    public String updateByCondition(PersonDTO param) {
        SQL sql = new SQL();
        sql.UPDATE("Person");

        if (!StringUtils.isEmpty(param.getAge())) {
                sql.SET("AGE = #{age}");
        }
        if (!StringUtils.isEmpty(param.getName())) {
                sql.SET("NAME = #{name}");
        }
        sql.WHERE("ID = #{id}");
        return sql.toString();
   }
}

查询：

注解：@SelectProvider

@SelectProvider(type = CommonDao.SqlProvider.class, method = "selectByCondition")
List<PersonDTO> personList(PersonDTO param);

class SqlProvider {
    public String selectByCondition(PersonDTO param) {
         SQL sql = new SQL();
         sql.SELECT("*");
         sql.FROM("Person");
         if (param.getId() != null) {
             sql.WHERE("ID = #{id}");
         }
         if (!StringUtils.isEmpty(param.getAge())) {
            sql.WHERE("AGE = #{age}");
         }
         if (!StringUtils.isEmpty(param.getName())) {
            sql.WHERE("NAME = #{name}");
         }
         if (!StringUtils.isEmpty(param.getOrder())) {
            sql.ORDER_BY("ORDER ASC");
         }
         return sql.toString();
  }
}

当类名与表字段名字不对应时

如类的字段有personAge、personName与表字段AGE、NAME不对应

    @Results({@Result(column = "AGE", property = "personAge"), @Result(column = "NAME", property = "personName")})
    @SelectProvider(type = CommonDao.SqlProvider.class, method = "selectByCondition")
    List<PersonDTO> personList(PersonDTO param);

批量插入

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

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();
}

public class SqlProvider {
    public String batchInsertInfoSQL(@Param("param") List<PersonDTO> param){
        return new SQL(){{
            INSERT_INTO("Person").
            INTO_COLUMNS("ID","AGE","NAME");
            for (int i = 0; i < param.size(); i++) {
                INTO_VALUES(UUID.randomUUID().toString(),
                        Convert.toStr(param.get(i).getAge()),
                        param.get(i).getName())
                    	.ADD_ROW();
            }
        }}.toString();
    }