189 8069 5689

MyBatis中@Param注解的四种使用场景,最后一种经常被人忽略!

有一些小伙伴觉得 MyBatis 只有方法中存在多个参数的时候,才需要添加 @Param 注解,其实这个理解是不准确的。即使 MyBatis 方法只有一个参数,也可能会用到 @Param 注解。
但是,在你总结出规律之前,你可能会觉得莫名其妙,有的时候一个参数明明不用添加 @Param 注解,有的时候,却需要添加,不添加会报错。
MyBatis 中 @Param 注解的四种使用场景,最后一种经常被人忽略!

创新互联建站是一家网站设计公司,集创意、互联网应用、软件技术为一体的创意网站建设服务商,主营产品:响应式网站开发成都品牌网站建设成都全网营销。我们专注企业品牌在网站中的整体树立,网络互动的体验,以及在手机等移动端的优质呈现。成都网站设计、网站制作、移动互联产品、网络运营、VI设计、云产品.运维为核心业务。为用户提供一站式解决方案,我们深知市场的竞争激烈,认真对待每位客户,为客户提供赏析悦目的作品,网站的价值服务。

有的人会觉得这是 MyBatis 各个版本差异的锅,不可否认,MyBatis 发展很快,不同版本之间的差异还挺明显的,不过这个加不加 @Param 注解的问题,却并不是版本的锅!今天松哥就和大家来聊一聊这个问题,到底哪些情况下需要添加 @Param 注解。
首先,如下几个需要添加 @Param 注解的场景,相信大家都已经有共识了:
第一种:方法有多个参数,需要 @Param 注解

@Mapper
public interface UserMapper {
    Integer insert(@Param("username") String username, @Param("address") String address);
}

对应的 XML 文件如下:


    insert into user (username,address) values (#{username},#{address});

这是最常见的需要添加 @Param 注解的场景。
MyBatis 中 @Param 注解的四种使用场景,最后一种经常被人忽略!

第二种:方法参数要取别名,需要 @Param 注解
当需要给参数取一个别名的时候,我们也需要 @Param 注解,例如方法定义如下:

@Mapper
public interface UserMapper {
    User getUserByUsername(@Param("name") String username);
}

对应的 XML 定义如下:

老实说,这种需求不多,费事。
MyBatis 中 @Param 注解的四种使用场景,最后一种经常被人忽略!

第三种:XML 中的 SQL 使用了 $ ,那么参数中也需要 @Param 注解
会有注入漏洞的问题,但是有的时候你不得不使用符号,例如要传入列名或者表名的时候,这个时候必须要添加 @Param 注解,例如:

@Mapper
public interface UserMapper {
    List getAllUsers(@Param("order_by")String order_by);
}

对应的 XML 定义如下:

前面这三种,都很容易懂,相信很多小伙伴也都懂,除了这三种常见的场景之外,还有一个特殊的场景,经常被人忽略。
MyBatis 中 @Param 注解的四种使用场景,最后一种经常被人忽略!

第四种,那就是动态 SQL ,如果在动态 SQL 中使用了参数作为变量,那么也需要 @Param 注解,即使你只有一个参数。
如果我们在动态 SQL 中用到了 参数作为判断条件,那么也是一定要加 @Param 注解的,例如如下方法:

@Mapper
public interface UserMapper {
    List getUserById(@Param("id")Integer id);
}

定义出来的 SQL 如下:

这种情况,即使只有一个参数,也需要添加 @Param 注解,而这种情况却经常被人忽略!
好了,不知道大家有没有 GET 到呢?有问题欢迎留言讨论。


文章名称:MyBatis中@Param注解的四种使用场景,最后一种经常被人忽略!
网页网址:http://jkwzsj.com/article/ppgppc.html

其他资讯