MyBatis Plus之注解实现动态SQL

[TOC]

使用MyBatis，所有的Dao层方法继承基类BaseMapper<T>

一、使用<script></script>脚本包裹

第一种方式：使用<script></script>进行包裹，像在xml中写sql语句一样实现动态SQL

1、使用<if></if>标签，实现关键词模糊查找

@Mapper
public interface CompanyMapper extends BaseMapper<CompanyEntity> {

    // 分页查询
    @Select("<script>" +
            " select t.*,a.name_cn as company_name" +
            " from t_company t " +
            " join t_customer_company a on t.company_id=a.id" +
            " where <![CDATA[t.status <> 2]]>" +
            " <if test='nameCn != null and nameCn.trim() != &quot;&quot;'>" +
            " AND t.name_cn like CONCAT('%',#{nameCn},'%')" +
            " </if>" +
            " </script>")
    IPage<CompanyEntity> selectCompanybyPage(Page<CompanyEntity> page,
                                       @Param("nameCn") String nameCn);
}
  • 1、如果涉及不等于等操作，可以使用<![CDATA[要包裹的内容]]>将其包裹。
  • 2、对字符串进行null判断与空串的判断可参照<if test='nameCn != null and nameCn.trim() != &quot;&quot;'>方式，具体可参考动态SQL之、条件判断。

1.1、使用<where></where>标签，实现关键词模糊查询进阶

由<where></where>包裹的<if></if>标签中的SQl语句，除第一个and可省略不写外，其他均需要写。

@Select("<script>" +
            " select t.* from t_log t" +
            " <where>" +
            " <if test='typeName!= null'>" +
            " and t.type_name like CONCAT('%',#{typeName},'%')" +
            " </if>" +
            " <if test='typeCode!= null'>" +
            " and t.type_code like CONCAT('%',#{typeCode},'%')" +
            " </if>" +
            " </where>" +
            " </script>")
    IPage<LogEntity> selectLogByPage(Page<LogEntity> page,
                                           @Param("typeName") String typeName,
                                           @Param("typeCode") String typeCode);

1.2、查询语句中出现大于小于的另一种方式写法

当注解SQL语句中出现日期的大于等于和小于等于判断时，如果未使用<![CDATA[内容]]>进行包裹，则将小于等于转译为lt;=（或者将大于等于转义为：&gt;=）
原则是：SQL注解语句中只能出现同方向的大于或者我小于。

@Select("<script>" +
            " select t.* from t_user_plan t" +
            " where t.type=0" +
            " <if test='startTime != null'>" +
            " AND t.effective_date >= #{startTime} " +
            " </if>" +
            " <if test='endTime != null'>" +
            " AND t.effective_date &lt;= #{endTime} " +
            " </if>" +
            " </script>"
    )
    IPage<UserPlanEntity> selectUserPlanByPage(Page<UserPlanEntity> page,
                                               @Param("startTime") LocalDate startTime,
                                               @Param("endTime") LocalDate endTime);

2、使用<foreach></foreach>标签，实现id列表查询

// 根据id集合查询所有对象
@Select("<script>" +
        " select t.* from t_user t " +
        " where t.id in" +
        " <foreach collection='ids' item='id' open='(' separator=',' close=')'>" +
        " #{id}" +
        " </foreach>" +
        " </script>")
List<UserEntity> selectAllUserbyIds(@Param("ids") List<String> ids);

3、使用<foreach></foreach>标签，实现批量插入

    /**
     * 批量插入
     * @param list
     * @return
     */
    @Insert("<script>" +
            " INSERT INTO t_position(sate,type,zone_id,time,lon,lat,height)VALUES" +
            " <foreach collection='list' item='entity' separator=','> " +
            " (#{entity.sate},#{entity.type},#{entity.zoneId},#{entity.time},#{entity.lon},#{entity.lat},#{entity.height})" +
            " </foreach> " +
            " </script>")
    boolean insertBatch(@Param("list") List<PositionEntity> list);

附上yml中需要配置项特别说明：需要在url中添加rewriteBatchedStatements=true，否则批量插入不生效！

spring:
  config:
    activate:
      on-profile: dev
  datasource:
    driverClassName: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mysql_name?zeroDateTimeBehavior=convertToNull&autoReconnect=true&tinyInt1isBit=false&useSSL=false&allowMultiQueries=true&useUnicode=true&characterEncoding=utf8&allowPublicKeyRetrieval=true&rewriteBatchedStatements=true
    username: root
    password: 123456

以上on-profile写法，使用MP版本为：3.4.3.4

4、使用<set></set>标签，实现字段更新

    @Update("<script>" +
            " update radius.t_user_plan" +
            " <set>" +
            " <if test='plan.state != null'>" +
            "  state = #{plan.state}," +
            " </if>" +
            " <if test='plan.effectiveDate != null'>" +
            "  effective_date=#{plan.effectiveDate}," +
            " </if>" +
            " <if test='plan.expireDate != null'>" +
            "  expire_date=#{plan.expireDate}," +
            " </if>" +
            " <if test='plan.dataLimit != null'>" +
            "  data_limit=#{plan.dataLimit}," +
            " </if>" +
            " </set>" +
            " where user_plan_id in" +
            " <foreach collection='ids' item='id' open='(' separator=',' close=')'>" +
            " #{id}" +
            " </foreach>" +
            " and state = 0" +
            " and (YEAR(effective_date)=YEAR(CURTIME()) and MONTH(effective_date)=MONTH(CURTIME()))" +
            " </script>")
    int updateUserByIds(@Param("ids") List<Long> ids,
                        @Param("plan") Plan plan);

5、使用对象集合来进行更新

@Update("<script>" +
            " update t_user" +
            " set balance = #{balance}" +
            " where id in" +
            " <foreach collection='list' item='one' open='(' separator=',' close=')'>" +
            " #{one.id}" +
            " </foreach>" +
            " </script>"
    )
    int updateBillPubAccountByIds(@Param("list") List<User> list,
                                  @Param("balance") Integer balance);

6、插入或更新(单条记录)

由于MyBatis Plus升级到3.5.7后，继承自BaseMapper后，其父类中存在insertOrUpdate更新单条或多条记录的重载方法，经测试，其更新或插入依赖的是主键id，不能很好的符合要求，以下重写了insertOrUpdate实现根据自定义唯一性索引进行更新

SQL详情

/**
     * 插入或更新数据信息
     * key值：user_id(需要在数据库中将这字段标注为唯一索引)
     *
     * @param entity 待插入或更新的实体对象
     */
    @Override
    @Insert("<script>" +
            " INSERT INTO t_user_task(user_id,user_type,priority,slice_id,task_type,des_user_id,res_req,state,sid,bid,flag,sid2,bid2) VALUES " +
            " (#{entity.userId},#{entity.userType},#{entity.priority},#{entity.sliceId},#{entity.taskType},#{entity.desUserId},#{entity.resReq},#{entity.state},#{entity.sid},#{entity.bid},#{entity.flag},#{entity.sid2},#{entity.bid2})" +
            " on duplicate key update" +
            " user_id=values(user_id)," +
            " user_type=values(user_type)," +
            " priority=values(priority)," +
            " slice_id=values(slice_id)," +
            " task_type=values(task_type)," +
            " des_user_id=values(des_user_id)," +
            " res_req=values(res_req)," +
            " state=values(state)," +
            " sid=values(sid)," +
            " bid=values(bid)," +
            " flag=values(flag)," +
            " sid2=values(sid2)," +
            " bid2=values(bid2)" +
            " </script>")
    boolean insertOrUpdate(@Param("entity") UserTask entity);

设置该表中user_id为唯一索引


设置user_id为唯一索引

7、插入或更新(多条记录)

/**
     * 批量插入或更新数据信息
     * key值：user_id(需要在数据库中将这字段标注为唯一索引)
     *
     * @param list 待插入或更新的实体集合
     * @return 返回影响的记录数
     */
    @Insert("<script>" +
            " <foreach collection='list' item='entity' separator=';'>" +
            " INSERT INTO t_user_task(user_id,user_type,priority,slice_id,task_type,des_user_id,res_req,state,sid,bid,flag,sid2,bid2) VALUES " +
            " (#{entity.userId},#{entity.userType},#{entity.priority},#{entity.sliceId},#{entity.taskType},#{entity.desUserId},#{entity.resReq},#{entity.state},#{entity.sid},#{entity.bid},#{entity.flag},#{entity.sid2},#{entity.bid2})" +
            " on duplicate key update" +
            " user_id=values(user_id)," +
            " user_type=values(user_type)," +
            " priority=values(priority)," +
            " slice_id=values(slice_id)," +
            " task_type=values(task_type)," +
            " des_user_id=values(des_user_id)," +
            " res_req=values(res_req)," +
            " state=values(state)," +
            " sid=values(sid)," +
            " bid=values(bid)," +
            " flag=values(flag)," +
            " sid2=values(sid2)," +
            " bid2=values(bid2)" +
            " </foreach>" +
            " </script>")
    int insertOrUpdateBatch(@Param("list") List<UserTask> list);

注意：多条记录进行插入或更新操作时，返回的int结果，经过测试，并非是影响的记录数。

二、使用if()（类三目运算）

第二种方式：使用if(执行条件,true操作,false操作)进行。
使用此方法时，注意where条件后面根据需要加上1=1

1、实现关键词查询

@Mapper
public interface UserMapper extends BaseMapper<UserEntity> {

    // 根据id查询、根据name模糊查询
    @Select("select t.id,t.login_name,t.name,b.name as login_station_name" +
           " from t_user t" +
           " left join t_remote_station b on t.login_station_id=b.id" +
           " WHERE 1=1" +
           " and if(#{id} is null,1=1,t.id=#{id})" +
           " and if(#{name} is null,1=1,t.name like CONCAT('%',#{name},'%'))")
    List<UserEntity> selectUserListByPage(Page<UserEntity> page,
                                          @Param("id") Long id,
                                          @Param("name") String name);
}

总结

1、使用以上任意一种方式都能实现比较复杂的动态SQL，建议使用第一种方式。
2、无论使用第一种还是第二种，都存在隐患，即，当传入参数为空的时候，可能会造成全表查询。解决的办法是：在业务实现层对参数进行非空判断，如果为空，则赋null值。
3、如果涉及到在同一个数据库实例中的跨库查询时，表名前需加上数据库名称即可，如：数据库名.表名（中间有一点）。

引文

文章参考

XML转义字符

语义 字符 转义字符
小于号 < &lt;
大于号 > &gt;
和 & &amp;
单引号 ' &apos;
双引号 " &quot;
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,179评论 5赞 476
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,229评论 2赞 380
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,032评论 0赞 336
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,533评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,531评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,539评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,916评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,574评论 0赞 256
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,813评论 1赞 296
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,568评论 2赞 320
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,654评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,354评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,937评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,918评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,152评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,852评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,378评论 2赞 342