mybatis动态SQL常用的标签使用及说明

1. 标签

在MyBatis的动态SQL世界里，标签有个更接地气的名字——SQL片段。它的作用，说白了就是帮你把一段常用的SQL语句“打包”起来，方便在多个地方重复调用。

怎么用呢？很简单。你只需要给这个片段起一个在当前命名空间下独一无二的ID，然后在需要的地方，用标签通过这个ID把它“引入”进来就行。至于片段里写什么，只要是符合SQL语法规范的，都没问题，灵活性很高。

来看一个典型的例子，比如定义一个通用的查询字段列表：

    
    
        id, name, age, hobby, del_flag, create_time, update_time
    
    
        select
        
        from animal
    

（小提示：标签写成单标签也是完全等效的，这里用了双标签，看个人习惯。）

2.标签

接下来这个标签，堪称是解决动态条件查询拼接痛点的“神器”。标签的聪明之处在于，它会智能判断：如果其包裹的SQL片段最终有内容，就自动在前面加上WHERE关键字；如果里面是空的，那就什么都不加。更妙的是，它还会自动帮你处理掉紧随其后的第一个AND或OR，避免出现WHERE AND ...这种语法错误。

看下面的示例就一目了然了：

    
        select * from animal
        
            
                and name = #{name}
            
        
    

3. 标签

如果你需要实现“多选一”的逻辑，那么标签就是你的不二之选。它完全对应着Ja va里的switch-case语句。

其执行逻辑是：从上到下依次判断标签中的条件，一旦某个条件满足，就执行其中的SQL片段，并且只进入这一个分支。如果所有的都不满足，则会执行中的内容，相当于default。

示例：

    
        select * from animal
        
            
                hobby = #{hobby} and name = #{name}
            
            
                hobby = #{hobby}
            
            
                name = #{name}
            
        
    

4.标签

标签可以看作是标签在更新语句中的“孪生兄弟”。它专为UPDATE语句设计，作用同样很智能：当其内部动态生成的SQL有内容时，自动在行首添加SET关键字。

它的另一个核心价值在于，能自动剔除掉更新字段列表末尾多余的逗号。这个功能在动态拼接多个set字段时尤其有用，能有效避免因最后一个字段后的逗号导致的语法错误。

来看两个更新示例：

    
        update animal
        
            
                age = #{age}
            
            
                name = #{name},
            
            
                hobby = #{hobby}
            
        
        where id = #{id}
    

    
    update animal
    
        
            `name` = #{name,jdbcType=VARCHAR},
        
        
            `age` = #{age,jdbcType=VARCHAR},
        
        
            hobby = #{hobby,jdbcType=VARCHAR},
        
        
            create_time = #{create_time,jdbcType=TIMESTAMP},
        
        
            update_time = #{update_time,jdbcType=TIMESTAMP},
        
    
    where id = #{id,jdbcType=INTEGER}
    

5.标签

当你需要处理集合遍历，比如构建IN (...)语句或者批量操作时，标签就是最得力的助手。它支持遍历List、Array和Map。

掌握它的几个关键属性，用起来就非常顺手了：

• collection：指定要遍历的集合参数名。
• item：遍历时每个元素的别名。
• separator：定义每个元素之间的分隔符，比如逗号。
• index：在遍历List或Array时是下标；在遍历Map时是key。
• open/close：在整个循环内容的前后添加指定的字符串，常用于包裹括号。

一个经典的IN查询示例：

    
        SELECT * FROM animal
        WHERE id in
        
            #{id}
        
    

6.标签，用来定义变量

最后这个标签，功能非常直接——就是用来在动态SQL中定义和使用变量的。这在一些需要对参数进行预处理（比如拼接模糊查询的%）的场景下特别好用。

举个例子，我们想实现一个按名字模糊查询的功能：

• 首先，在Mapper接口中定义方法：

List getByName(@Param("animalName") String name);

• 然后，在XML映射文件中使用标签预处理参数：

    
        
        
        select * from animal
        
            
                and `name` like #{animalNameLike}
            
        
    

总结

以上就是MyBatis动态SQL中几个核心标签的详细用法和实战示例。灵活运用这些标签，能让你编写出的Mapper XML既清晰又强大，极大地提升开发效率。希望这份梳理能为大家在实际开发中提供清晰的参考。

您可能感兴趣的文章:

• 一文详解MyBatis中动态SQL的封装原理与常用标签实战应用
• MyBatis CRUD 常用动态 SQL 标签整理
• MyBatis 动态 SQL 优化之标签的实战与技巧(常见用法)
• MyBatis中实现动态SQL标签
• Mybatis动态Sql标签使用小结
• MyBatis 动态SQL之where标签的使用
• MyBatis动态SQL之＜choose＞＜when＞＜otherwise＞标签的使用