首页 > 软件编程 > java > MyBatis注解实现动态SQL

MyBatis注解实现动态SQL问题

2023-02-07 08:58:39 作者：杨哥学编程

这篇文章主要介绍了MyBatis注解实现动态SQL问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

MyBatis注解实现动态SQL

在 Mybatis 中，使用注解可以很方便的进行sql操作，但很多动态 SQL 都是由 xml 配置实现的。

而随着 SpringBoot的逐渐发展，越来越多的配置由配置文件转成注解的形式。其中包括动态 SQL 。

Mybatis 的注解中，使用太过长的sql语句看起来很不美观。

@Select("SELECT title from book_tbl where id = #{id}")

如果想要在 mapper 中进行非必要关键字的查询时就需要使用动态 SQL，与 xml 配置不同的是，@Select注解中 SQL 语句必须以 <script> 标签包裹。

@Select("<script>"+
			"SELECT id " +
            "from book_tbl" +
            "<where>" +
            "<if test 'company_id != null'>" +
            "and company_id = #{company_id}" +
            "</if>" +
            "<if test 'title != null'>" +
            "and title like CONCAT('%',#{title},'%')" +
            "</if>" +
            "</where>" +
            "ORDER BY create_time desc,rank desc" +
        "</script>")

MyBatis动态拼接 SQL参数

之前用JPA可以在@Query注解上拼接sql，实现动态查询；现在用mybatis，如何实现sql的动态拼接参数

举例，在JPA中可以实现类似于下面的sql拼接

plateNumber2 = plateNumber2 + "," + plateNumber;
String[] split = plateNumber2.split(",");
StringBuffer stringBuffer = new StringBuffer();
stringBuffer.append("SELECT plate_number from p_park_record where park_key = '"+parkDO.getParkKey()+"'");
stringBuffer.append(" and (");
for (int i = 0; i < split.length; i++) {
    stringBuffer.append(" plate_number = "+split[i]);
    if (i != split.length-1){
        stringBuffer.append(" OR ");
    }
}
stringBuffer.append(" )");
stringBuffer.append(" order by sensor_exit_time desc");
stringBuffer.append(" limit 1");

此代码中，核心问题是for循环，将不确定数量的同一个参数做拼接

那么在mybatis中该如何实现

mybatis实现：

plateNumber2 = plateNumber2 + "," + plateNumber;
ParkRecordDO parkRecordDO = new ParkRecordDO();
parkRecordDO.setPlateNumber(plateNumber2);
parkRecordDO.setParkKey(parkDO.getParkKey());
String onlyPlateNum = parkRecordMapper.getOnlyPlateNum(parkRecordDO);

    <select id="getOnlyPlateNum" parameterType="ParkRecordDO" resultType="java.lang.String">
        SELECT plate_number from p_park_record where park_key = #{parkKey} and sensor_exit_time is not null and
        <foreach collection="plateNumber.split(',')" index="index" item="id" open="(" separator=" or " close=")">
            plate_number = #{id}
        </foreach>
        order by sensor_exit_time desc
        limit 1
    </select>

如此实现，与JPA拼接效果相同，重点在于“<foreach”标签中separator属性，该属性为元素之间的分隔符，将分隔符设置为“or”，以此来实现该程序逻辑的拼接

最后补充几个知识点

foreach标签的使用

<!--
        foreach
        collection：指定要遍历的集合
                    list类型的参数会特殊处理封装在map中，map的key就叫list
              item：将当前遍历出的元素赋值给指定的变量
              separator：元素之间的分割符
              open: 遍历出的所有结果拼接一个开始字符
              close：遍历出的所有结果拼接一个结束字符
              index：索引，遍历list的时候是索引，item就是当前值；
                          遍历map时index标识的就是map的key，item就是map的值
              #{变量名}: 就能取出变量的值就是当前遍历出的元素
-->
<select id="queryUserByForEach" resultType="user">
    select * from easybuy_user where id in
    <foreach collection="ids" item="item_id" separator=","
             open="(" close=")">
        #{item_id}
    </foreach>
</select>


<insert id="batchSaveUser" parameterType="user">
    insert into easybuy_user(loginName, userName, password) values
    <foreach collection="userList" item="user" separator=",">
        (#{user.loginName}, #{user.userName}, #{user.password})
    </foreach>
</insert>

set标签的使用

<!--
        使用set标签或者trim标签与if标签相结合
        实现动态更新sql语句的拼接
-->
<update id="updateUserByCondition" parameterType="user">
    update easybuy_user
    <set>
        <if test="userName != null">
            username = #{userName},
        </if>
        <if test="email != null">
            email = #{email},
        </if>
    </set>
    where id = 26;
</update>

choose和when标签的使用（作用类似与java中的switch-case）

<select id="queryUserByChoose" resultType="com.unistart.entity.User">
    select * from easybuy_user
    <where>
        <choose>
            <when test="id != null">
                id=#{id}
            </when>
            <when test="userName != null">
                userName like #{userName}
            </when>
            <when test="sex != null">
                sex = #{sex}
            </when>
            <otherwise>
                1=1;
            </otherwise>
        </choose>
    </where>
</select>

trim标签的使用

<!--
        trim标签的使用：解决后面多出的and或or
        prefix=""：前缀，trim标签体中是整个字符串拼串后的结果
                prefix给拼串后的整个字符串加一个前缀
        prefixOverrides=""：前缀覆盖：去掉整个字符串前面多余的字符
        suffix=""：后缀，给拼串后的整个字符串加一个后缀
        suffixOverrides=""：后缀覆盖，去掉整个字符串后面多余的字符
-->
<select id="queryUserByTrim" resultType="user">
    select * from easybuy_user
    <trim prefix="where" suffixOverrides="and">
        <if test="id != null">
            id = #{id} and
        </if>
        <if test="userName != null and userName!=&quot;&quot;">
            userName like #{userName} and
        </if>
        <if test="email != null and email!=&quot;&quot;">
            email = #{email} and
        </if>
    </trim>
</select>

where标签的使用

<!--
        查询用户：要求，携带哪些字段查询条件就按这些字段进行查询
        使用的OGNL，类似与EL表达式

        从参数中取值进行判断，遇见特殊符号使用转义字符
        使用where标签时要注意，它只能去除第一个多出来的and或or
-->
<select id="queryUserByCondition" resultType="user">
    select * from easybuy_user
    <where>
        <if test="id != null">
            and id = #{id}
        </if>
        <if test="userName != null and userName!=&quot;&quot;">
            and userName like #{userName}
        </if>
        <if test="email != null and email!=&quot;&quot;">
            and email = #{email}
        </if>
    </where>
</select>

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

MyBatis注解实现动态SQL问题