@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 的关键一步!

相关推荐
Terio_my1 小时前
Java bean 数据校验
java·开发语言·python
Tony Bai1 小时前
【Go开发者的数据库设计之道】07 诊断篇:SQL 性能诊断与问题排查
开发语言·数据库·后端·sql·golang
超级大只老咪2 小时前
何为“类”?(Java基础语法)
java·开发语言·前端
花花鱼2 小时前
spring boot项目使用tomcat发布,也可以使用Undertow(理论)
spring boot·后端·tomcat
我笑了OvO2 小时前
C++类和对象(1)
java·开发语言·c++·类和对象
weixin_436525074 小时前
Gitee - IDEA 主支 master 和分支 dev 的使用
java·ide·intellij-idea
你的人类朋友4 小时前
快速搭建redis环境并使用redis客户端进行连接测试
前端·redis·后端
sheji34164 小时前
【开题答辩全过程】以 YF精品视频动漫平台为例,包含答辩的问题和答案
java·eclipse
小蕾Java5 小时前
Java 开发工具,最新2025 IDEA 使用
java·ide·intellij-idea
是席木木啊5 小时前
Idea升级到2024版本:“marketplace plugins are not loaded”解决方案
java·ide·intellij-idea