@Param注解的作用

@Param 注解在 Java 中(尤其是 MyBatis 框架中)非常常见,它的主要作用是:


🧠 作用:为 MyBatis 映射器接口方法的参数命名,以便在 SQL 中引用


✅ 举个例子你就明白了:

less 复制代码
java
深色版本
@Select("SELECT * FROM users WHERE id = #{id}")
User selectById(@Param("id") Integer id);

在这个例子中:

  • @Param("id") 表示给传入的参数起一个名字叫 "id"
  • 在 SQL 语句中就可以用 #{id} 来引用这个参数。

📌 为什么需要 @Param?

情况一:只有一个参数时(可以省略)

python 复制代码
java
深色版本
@Select("SELECT * FROM users WHERE id = #{id}")
User selectById(Integer id);

✅ 这种情况可以不加 @Param,MyBatis 默认会把参数名识别为 id_parameter


情况二:有多个参数时(必须使用 @Param)

less 复制代码
java
深色版本
@Select("SELECT * FROM users WHERE name = #{name} AND age = #{age}")
List<User> findUsers(@Param("name") String name, @Param("age") int age);

❌ 如果你不加 @Param,MyBatis 就不知道哪个参数对应 name,哪个对应 age,就会报错!


情况三:传入多个对象或 Map

less 复制代码
java
深色版本
@Update({
  "<script>",
  "UPDATE orders SET status = #{status}",
  "<where>",
  "id IN",
  "<foreach item='id' collection='ids' open='(' separator=',' close=')'>#{id}</foreach>",
  "</where>",
  "</script>"
})
int updateOrderStatus(@Param("ids") List<Integer> ids, @Param("status") String status);

在这种复杂场景下,@Param 可以让你清晰地指定每个参数的名称和用途。


🧩 总结一下:什么时候该用 @Param

参数数量 是否建议使用 @Param 原因
1个基本类型/简单对象 ❌ 可选 可以不用,但加上更明确
多个参数 ✅ 必须用 否则无法区分参数
多个集合/List/Map ✅ 推荐用 避免歧义,便于 SQL 引用

📚 衍生知识:SQL 中还可以怎么写?

sql 复制代码
sql
深色版本
WHERE name = #{name} AND age = #{age}
WHERE name = #{arg0} AND age = #{arg1}  -- 不推荐,依赖顺序,可读性差
WHERE name = ${name}                    -- 不安全,慎用(容易被注入)

如果你是在使用 Spring Boot + MyBatis 开发项目,正确使用 @Param 是写出清晰、安全 SQL 的关键一步!

相关推荐
RainbowSea3 小时前
github 仓库主页美化定制
后端
摆烂z3 小时前
Docker与Jib(maven插件版)实战
java
RainbowSea3 小时前
从 Spring Boot 2.x 到 3.5.x + JDK21:一次完整的生产环境迁移实战
java·spring boot·后端
笨手笨脚の3 小时前
Spring Core常见错误及解决方案
java·后端·spring
奶油松果3 小时前
Springboot自动装配 - redis和redission
java·spring boot·redis
计算机毕设匠心工作室3 小时前
【python大数据毕设实战】全球大学排名数据可视化分析系统、Hadoop、计算机毕业设计、包括数据爬取、数据分析、数据可视化、机器学习、实战教学
后端·python·mysql
霍夫曼4 小时前
UTC时间与本地时间转换问题
java·linux·服务器·前端·javascript
VX:Fegn08954 小时前
计算机毕业设计|基于Java人力资源管理系统(源码+数据库+文档)
java·开发语言·数据库·vue.js·spring boot·后端·课程设计
荔枝hu4 小时前
springboot和shiro组合引入SseEmitter的一些坑
java·spring boot·后端·sseeitter
老华带你飞4 小时前
健身房|基于springboot + vue健身房管理系统(源码+数据库+文档)
java·数据库·vue.js·spring boot·后端