MyBatis动态SQL

一、script

注解版下，使用动态SQL需要将sql语句包含在script标签里。

在 < script>< /script>内使用特殊符号，则使用java的转义字符，如双引号"" 使用\"\" 代替

<script></script>

二、< where>标签、< if>标签

if：通过判断动态拼接sql语句，一般用于判断查询条件

当查询语句的查询条件由于输入参数的不同而无法确切定义时，可以使用< where>标签对来包裹需要动态指定的SQL查询条件，而在< where>标签对中，可以使用< if test="…">条件来分情况设置SQL查询条件
当使用标签对包裹 if 条件语句时，将会忽略查询条件中的第一个and或or

<!-- 查询用户信息 -->
<select id="queryUserInfo" parameterType="com.mybatis.po.UserParam" resultType="com.mybatis.po.User">
    SELECT * FROM tb_user
    <where>
        <if test="userId > 0">
            and user_id = #{userId}
        </if>
        <if test="userName!= null and userName!=''">
            and user_name like '%${userName}%'
        </if>
        <if test="sex!=null and sex!=''">
            and sex = #{sex}
        </if>
    </where>
</select>

@Select({"<script>" +
            " select * from tb_user " +
            "<where>" +
            "<if test = 'userId != null and userId !=\"\" '> " +
            "and user_Id = #{userId} " +
            "</if>" +
            "<if test = 'userPassword != null and userPassword !=\"\" '> " +
            "and user_password like CONCAT('%',#{userPassword},'%')" +
            "</if>" +
            "</where>" +
            "</script>"})

三、< sql>片段

MyBatis提供了可以将复用性比较强的SQL语句封装成“SQL片段”，在需要使用该SQL片段的映射配置中声明一下，即可引入该SQL语句，声明SQL片段的格式如下：

<sql id="query_user_where">
    <!-- 要复用的SQL语句 -->
</sql>

例子：

<!--用户查询条件SQL片段-->
<sql id="query_user_where">
    <if test="userId>0">
        AND user_id = #{userId}
    </if>
    <if test="userName!=null and userName!=''">
        AND user_name like '%${userName}%'
    </if>
    <if test="sex!=null and sex!=''">
        AND sex = #{sex}
    </if>
</sql>
 
<!-- 查询用户信息 -->
<select id="queryUserInfo" parameterType="com.mybatis.po.UserParam" resultType="com.mybatis.po.User">
    SELECT * FROM tb_user
    <where>
        <include refid="query_user_where"/>
        <!-- 这里可能还会引入其他的SQL片段 -->
    </where>
</select>

id是SQL片段的唯一标识，是不可重复的
SQL片段是支持动态SQL语句的，但建议，在SQL片段中不要使用< where>标签,而是在调用的SQL方法中写< where>标签，因为该SQL方法可能还会引入其他的SQL片段，如果这些多个的SQL片段中都有< where>标签，那么会引起语句冲突。
SQL映射配置还可以引入外部Mapper文件中的SQL片段，只需要在refid属性填写的SQL片段的id前添加其所在Mapper文件的namespace信息即可（如：test.query_user_where）

四、< foreach>标签

< foreach>标签属性说明：

属性	说明
index	当迭代对象是数组，列表时，表示的是当前迭代的次数。
item	当迭代对象是数组，列表时，表示的是当前迭代的元素。
collection	当前遍历的对象。
open	遍历的SQL以什么开头。
close	遍历的SQL以什么结尾。
separator	遍历完一次后，在末尾添加的字符等。

需求：

SELECT * FROM tb_user WHERE user_id=2 OR user_id=4 OR user_id=5;
-- 或者
SELECT * FROM tb_user WHERE user_id IN (2,4,5);

案例：

<!-- 使用foreach标签，拼接or语句 -->
<sql id="query_user_or">
    <if test="ids!=null and ids.length>0">
        <foreach collection="ids" item="user_id" open="AND (" close=")" separator="OR">
            user_id=#{user_id}
        </foreach>
    </if>
</sql>

<!-- 使用foreach标签，拼接in语句 -->
<sql id="query_user_in">
    <if test="ids!=null and ids.length>0">
        AND user_id IN
        <foreach collection="ids" item="user_id" open="(" close=")" separator=",">
            #{user_id}
        </foreach>
    </if>
</sql>

@Insert("<script>" +
            "insert into tb_user(user_id,user_account,user_password,blog_url,blog_remark) values" +
            "<foreach collection = 'list' item = 'item' index='index' separator=','>" +
            "(#{item.userId},#{item.userAccount},#{item.userPassword},#{item.blogUrl},#{item.blogRemark})" +
            "</foreach>" +
            "</script>")
    int insertByList(@Param("list") List<UserInfo> userInfoList);

    @Select("<script>" +
            "select * from tb_user" +
            " WHERE user_id IN " +
            "<foreach collection = 'list' item = 'id' index='index' open = '(' separator= ',' close = ')'>" +
            "#{id}" +
            "</foreach>" +
            "</script>")
    List<UserInfo> selectByList(@Param("list") List<Integer> ids);
    
	@Update({"<script>" +
            "<foreach item='item' collection='list' index='index' open='' close='' separator=';'>" +
            " UPDATE tb_user " +
            "<set>" +
            "<if test='item.userAccount != null'>user_account = #{item.userAccount},</if>" +
            "<if test='item.userPassword != null'>user_password=#{item.userPassword}</if>" +
            "</set>" +
            " WHERE user_id = #{item.userId} " +
            "</foreach>" +
            "</script>"})
   	int updateBatch(@Param("list")List<UserInfo> userInfoList);

五、< choose>标签、< when>标签、< otherwise>标签

有时我们不想应用到所有的条件语句，而只想从中择其一项。针对这种情况，MyBatis提供了choose元素，它有点像Java中的switch语句。

<select id="queryUserChoose" parameterType="com.mybatis.po.UserParam" resultType="com.mybatis.po.User">
    SELECT * FROM tb_user
    <where>
        <choose>
            <when test="userId>0">
                AND user_id = #{userId}
            </when>
            <when test="userName!=null and userName!=''">
                AND user_name like '%${userName}%'
            </when>
            <otherwise>
                AND sex = '女'
            </otherwise>
        </choose>
    </where>
</select>

@Select("<script>"
            + "select * from tb_user "
            + "<where>"
            + "<choose>"
            + "<when test='userId != null and userId != \"\"'>"
            + "   and user_id = #{userId}"
            + "</when>"
            + "<otherwise test='userAccount != null and userAccount != \"\"'> "
            + "   and user_account like CONCAT('%', #{userAccount}, '%')"
            + "</otherwise>"
            + "</choose>"
            + "</where>"
            + "</script>")
    List<UserInfo> selectAll(UserInfo userInfo);

六、< trim>标签、< set>标签

MyBatis还提供了< trim>标签，我们可以通过自定义< trim>标签来定制< where>标签的功能。比如，和< where>标签等价的自定义 < trim>标

prefixOverrides 属性会忽略通过管道分隔的文本序列（注意此例中的空格也是必要的）。它的作用是移除所有指定在 prefixOverrides 属性中的内容，并且插入 prefix 属性中指定的内容。

使用自定义< trim>标签来定制< where>标签的功能，获取用户信息:

<!-- 查询用户信息 -->
<select id="queryUserTrim" parameterType="com.mybatis.po.UserParam" resultType="com..mybatis.po.User">
    SELECT * FROM tb_user
    <trim prefix="WHERE" prefixOverrides="AND |OR ">
        <if test="userId>0">
            and user_id = #{userId}
        </if>
        <if test="userName!=null and userName!=''">
            and user_name like '%${userName}%'
        </if>
        <if test="sex!=null and sex!=''">
            and sex = #{sex}
        </if>
    </trim>
</select>

在修改用户信息的SQL配置方法中，使用< set>标签过滤多余的逗号：

<!-- 修改用户信息 -->
<update id="updateUser" parameterType="com.pjb.mybatis.po.UserParam">
    UPDATE tb_user
    <set>
        <if test="userName != null">user_name=#{userName},</if>
        <if test="sex != null">sex=#{sex},</if>
        <if test="age >0 ">age=#{age},</if>
        <if test="blogUrl != null">blog_url=#{blogUrl}</if>
    </set>
    where user_id = #{userId}
</update>

这里，< set>标签会动态前置SET关键字，同时也会删掉无关的逗号，因为用了条件语句之后很可能就会在生成的SQL语句的后面留下这些逗号。因为用的是“if”元素，若最后一个“if”没有匹配上而前面的匹配上，SQL 语句的最后就会有一个逗号遗留。

MyBatis动态SQL