MyBatis-@param注解详解

最新推荐文章于 2024-04-15 19:56:37 发布
最新推荐文章于 2024-04-15 19:56:37 发布
阅读量1.9w 收藏 84
点赞数 24
分类专栏： mybatis 文章标签： mybatis @param
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xuonline4196/article/details/87994394
版权

一、源码解析

一、useActualParamName配置

useActualParamName： 允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的工程必须采用Java 8编译，并且加上-parameters选项。（从3.4.1开始）
mybatis的全局配置useActualParamName决定了mapper中参数的写法，默认为true
1.如果useActualParamName设置为true时
传递参数需要使用

#{arg0}-#{argn}或者#{param1}-#{paramn}

2.如果useActualParamName设置为false时
传递参数需要使用

#{0}-#{n}或者#{param1}-#{paramn}

二、源码解读（3.4.6）

在mapper的代理对象调用方法时，最终会是MapperMethod对象的execute方法。如下：

@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  try {
    // 如果目标方法是Object类继承来的，直接调用目标方法
    if (Object.class.equals(method.getDeclaringClass())) {
      return method.invoke(this, args);
    } else if (isDefaultMethod(method)) {
      return invokeDefaultMethod(proxy, method, args);
    }
  } catch (Throwable t) {
    throw ExceptionUtil.unwrapThrowable(t);
  }
  // 从缓存中获取MapperMethod 对象,如果没有就创建新的并添加
  final MapperMethod mapperMethod = cachedMapperMethod(method);
  // 执行sql 语句
  return mapperMethod.execute(sqlSession, args);
}

MapperMethod的一个内部类MethodSignature封装了Mapper接口中定义的方法的相关信息。而MethodSignature的一个属性ParamNameResolver对象处理接口中定义的方法的参数列表。

ParamNameResolver 的属性

// 记录参数在参数列表中的位置索引与参数名称之间的对应关系
private final SortedMap<Integer, String> names;

// 记录对应的方法参数是否使用了@Param注解
private boolean hasParamAnnotation;

ParamNameResolver的构造函数

/**
 * 通过反射读取方法中的信息，并初始化上面两个字段
 * @param config
 * @param method
 */
public ParamNameResolver(Configuration config, Method method) {
  // 获取参数列表中每个参数的类型
  final Class<?>[] paramTypes = method.getParameterTypes();
  // 获取参数列表上的注解  @Param
  final Annotation[][] paramAnnotations = method.getParameterAnnotations();
  // 该集合用于记录参数索引与参数名称的对应关系
  final SortedMap<Integer, String> map = new TreeMap<Integer, String>();
  int paramCount = paramAnnotations.length;
  // 遍历所有参数
  for (int paramIndex = 0; paramIndex < paramCount; paramIndex++) {
    if (isSpecialParameter(paramTypes[paramIndex])) {
      // 如果参数是RowBounds类型或者ResultHandler类型，则跳过该参数
      continue;
    }
    String name = null;
    // 遍历该参数上的注解集合
    for (Annotation annotation : paramAnnotations[paramIndex]) {
      if (annotation instanceof Param) {
        // 获取@Param注解指定的参数名称
        hasParamAnnotation = true;
        name = ((Param) annotation).value();
        break;
      }
    }
    // 没有@Param注解的话 执行下面逻辑
    if (name == null) {
      // useActualParamName==true时  即name = arg0 ...
      if (config.isUseActualParamName()) {
        name = getActualParamName(method, paramIndex);
      }
      if (name == null) {//useActualParamName == false是  即 name="0" ...
        // use the parameter index as the name ("0", "1", ...)
        // 使用参数的索引作为其名称
        name = String.valueOf(map.size());
      }
    }
    map.put(paramIndex, name);
  }
  names = Collections.unmodifiableSortedMap(map);
}

names集合主要是在ParamNameResolver.getNamedParams方法中使用

/**
 *
 * @param args 用户传入的参数值列表
 * @return
 */
public Object getNamedParams(Object[] args) {
  final int paramCount = names.size();
  if (args == null || paramCount == 0) {
    return null;
  } else if (!hasParamAnnotation && paramCount == 1) {// 未使用@Param注解且参数列表只有一个
    return args[names.firstKey()];//即args[0] 参数的值
  } else {
    // 下面是为参数创建param+索引的格式作为默认参数名称 如：param1  下标从1开始
    final Map<String, Object> param = new ParamMap<Object>();
    int i = 0;
    for (Map.Entry<Integer, String> entry : names.entrySet()) {
      param.put(entry.getValue(), args[entry.getKey()]);
      // add generic param names (param1, param2, ...)
      final String genericParamName = GENERIC_NAME_PREFIX + String.valueOf(i + 1);
      // ensure not to overwrite parameter named with @Param
      if (!names.containsValue(genericParamName)) {
        param.put(genericParamName, args[entry.getKey()]);
      }
      i++;
    }
    return param;
  }
}

二.使用@param参数注解

一、单一属性

service层示例

todoItemsMapper.selectItembyparam1(1,"medium")

dao层示例

List<CuxTodoItems> selectItembyparam1(@Param("id") int userId,@Param("pty") String Priority);

xml映射对应示例

  <select id="selectItembyparam1" resultMap="BaseResultMap">
      SELECT *
      FROM  cux_todo_items
      WHERE user_id = #{id}
      AND   priority = #{pty}
  </select>

数据库数据
在这里插入图片描述
查询结果

[{
	"todoItemId": 2,
	"userId": 1,
	"todoItemTitle": "bbbb",
	"todoItemContent": "待办事项2",
	"priority": "medium",
	"creationDate": 1544405869000,
	"lastUpdateDate": 1544498631000,
	"comments": "bb"
}, {
	"todoItemId": 4,
	"userId": 1,
	"todoItemTitle": "dddd",
	"todoItemContent": "待办事项4",
	"priority": "medium",
	"creationDate": 1544422911000,
	"lastUpdateDate": 1544422980000,
	"comments": "ddd"
}]

注意：采用#{}的方式把@Param注解括号内的参数进行引用（括号内参数对应的是形参）xml映射的查询字段应该为@Param注解括号内的参数例如上面查询参数应该为id而不是userId，如果xml映射的查询字段不与@Param注解的形参一样则会出现如下异常
在这里插入图片描述

二、JavaBean对象

一、单个javabean对象

service 层示例

   CuxTodoItems items = new CuxTodoItems();
   items.setUserId(1);
   items.setPriority("low");
   List<CuxTodoItems> itemsList = todoItemsMapper.selectItembyparam2(items);
   return itemsList;

dao层示例

    List<CuxTodoItems> selectItembyparam2(@Param("item") CuxTodoItems cuxTodoItems);

xml映射对应示例

<select id="selectItembyparam2" resultMap="BaseResultMap">
     SELECT *
     FROM  cux_todo_items
     WHERE user_id = #{item.userId}
     AND   priority = #{item.priority}
</select>

数据库数据
在这里插入图片描述
查询结果：

	[{
		"todoItemId": 5,
		"userId": 1,
		"todoItemTitle": "eee",
		"todoItemContent": "待办事项5",
		"priority": "low",
		"creationDate": 1544423076000,
		"lastUpdateDate": 1544494032000,
		"comments": "ee"
	}, {
		"todoItemId": 6,
		"userId": 1,
		"todoItemTitle": "fffffffff",
		"todoItemContent": "ffffffffff",
		"priority": "low",
		"creationDate": 1544495766000,
		"lastUpdateDate": 1544495772000,
		"comments": "ffffffffffffffffffff"
	}]

二、多个javabean对象

service层

    CuxTodoItems items = new CuxTodoItems();
    items.setPriority("high");
    CuxUsers users = new CuxUsers();
    users.setUserId(2);
    List<CuxTodoItems> itemsList = todoItemsMapper.selectItembyparam3(items,users);

dao层

    List<CuxTodoItems> selectItembyparam3(@Param("it") CuxTodoItems cuxTodoItems, @Param("us")CuxUsers user);

xml对应示例

<select id="selectItembyparam3" resultMap="BaseResultMap">
   SELECT *
   FROM  cux_todo_items
   WHERE user_id = #{us.userId}
   AND   priority = #{it.priority}
 </select>

数据库数据
在这里插入图片描述
查询结果

	[{
		"todoItemId": 7,
		"userId": 2,
		"todoItemTitle": "ggg",
		"todoItemContent": "代办事项g",
		"priority": "high",
		"creationDate": 1551448314000,
		"lastUpdateDate": 1552485099000,
		"comments": "备注g"
	}]

注意：当使用@param注解JavaBean对象时，@Param注解括号内的参数为形参，xml内的查询字段应该是 形参.bean属性，若形参.bean属性的形参不与@Param注解括号内的参数形参一样或者直接使用bean属性为查询字段则会出现如下异常：
在这里插入图片描述

三.不使用@param参数注解

一、单一属性

一、一个单一属性

service

todoItemsMapper.selectItembyparam4(2);

dao 层

List<CuxTodoItems> selectItembyparam4( int userId);

xml对应示例

<select id="selectItembyparam4" resultMap="BaseResultMap">
        SELECT *
        FROM  cux_todo_items
        WHERE user_id = #{aa}
</select>

数据库数据
在这里插入图片描述
查询结果：

[{
	"todoItemId": 7,
	"userId": 2,
	"todoItemTitle": "ggg",
	"todoItemContent": "代办事项g",
	"priority": "high",
	"creationDate": 1551448314000,
	"lastUpdateDate": 1552485099000,
	"comments": "备注g"
}]

注意：当查询参数为一个单一属性且没有使用注解时xml中查询字段#{}内可以为任意值

二、多个单一属性

service层

todoItemsMapper.selectItembyparam5(1,"high");

dao层

List<CuxTodoItems> selectItembyparam5( int userId,String Priority);

xml对应示例

<select id="selectItembyparam5" resultMap="BaseResultMap">
        SELECT *
        FROM  cux_todo_items
        WHERE user_id = #{param1}
        AND   priority = #{param2}
 </select>

数据库数据
在这里插入图片描述
查询结果：

[{
	"todoItemId": 3,
	"userId": 1,
	"todoItemTitle": "ccc",
	"todoItemContent": "待办事项3",
	"priority": "high",
	"creationDate": 1544405882000,
	"lastUpdateDate": 1544423018000,
	"comments": "cc"
}]

注意：
1.如果useActualParamName设置为true时
传递参数需要使用#{arg0}-#{argn}或者#{param1}-#{paramn}
若使用#{0}-#{n}，则会出现如下异常
在这里插入图片描述

2.如果useActualParamName设置为false时
传递参数需要使用 #{0}-#{n}或者#{param1}-#{paramn}
若使用#{arg0}-#{argn}则会出现如下异常
在这里插入图片描述

二、JavaBean对象

一、单个javabean对象

service层

CuxTodoItems items = new CuxTodoItems();
items.setUserId(2);
items.setPriority("high");
List<CuxTodoItems> itemsList = todoItemsMapper.selectItembyparam6(items);

dao层

List<CuxTodoItems> selectItembyparam6( CuxTodoItems cuxTodoItems);

xml对应查询字段

<select id="selectItembyparam6" resultMap="BaseResultMap">
  SELECT *
  FROM  cux_todo_items
  WHERE user_id = #{userId}
  AND priority = #{priority}
</select>

数据库数据
在这里插入图片描述
查询结果

[{
	"todoItemId": 7,
	"userId": 2,
	"todoItemTitle": "ggg",
	"todoItemContent": "代办事项g",
	"priority": "high",
	"creationDate": 1551448314000,
	"lastUpdateDate": 1552485099000,
	"comments": "备注g"
}]

注意：xml查询字段需要与javabean属性一致

二、多个javabean对象

service层

CuxTodoItems items = new CuxTodoItems();
items.setPriority("medium");
CuxUsers users = new CuxUsers();
users.setUserId(1);
List<CuxTodoItems> itemsList = todoItemsMapper.selectItembyparam7(items,users);

dao层

List<CuxTodoItems> selectItembyparam7( CuxTodoItems cuxTodoItems, CuxUsers user);

xml对应查询

<select id="selectItembyparam7" resultMap="BaseResultMap">
        SELECT *
        FROM  cux_todo_items
        WHERE priority = #{param1.priority}
        AND   user_id = #{param2.userId}
 </select>

数据库数据
在这里插入图片描述
查询结果：

[{
	"todoItemId": 2,
	"userId": 1,
	"todoItemTitle": "bbbb",
	"todoItemContent": "待办事项2",
	"priority": "medium",
	"creationDate": 1544405869000,
	"lastUpdateDate": 1544498631000,
	"comments": "bb"
}, {
	"todoItemId": 4,
	"userId": 1,
	"todoItemTitle": "dddd",
	"todoItemContent": "待办事项4",
	"priority": "medium",
	"creationDate": 1544422911000,
	"lastUpdateDate": 1544422980000,
	"comments": "ddd"
}]

注意：
1.如果useActualParamName设置为true时
传递参数需要使用#{arg0.bean属性}-#{argn.bean属性}或者#{param1.bean属性}-#{paramn.bean属性}
若使用#{0.bean属性}-#{n.bean属性}，则会出现如下异常
在这里插入图片描述
2.如果useActualParamName设置为false时
传递参数需要使用 #{0.bean属性}-#{n.bean属性}或者#{param1.bean属性}-#{paramn.javabean属性}
若使用#{arg0.bean属性}-#{argn.bean属性}则会出现如下异常

在这里插入图片描述

四、总结：

1.如果接口方法有一个或多个参数，并且使用了@Param注解，若注解的为单一属性则sql语句中的参数用注解的value值，若为bean则sql语句中使用的参数注解的value.bean属性值

2.如果接口方法的参数只有一个，并且没有使用@Parma注解，若为单一属性，则sql语句直接使用任何名称均可，若为bean，则sql 语句中的参数直接为bean的属性值就行。

3.如果接口的方法有多个参数，并且没有使用@Parma注解，单一属性 时sql语句使用param1…paramn，bean时sql语句使用param1.属性值…paramn.属性值是不会错的。

项目地址：
https://github.com/xu158/MyBatisParam.git
参考博客：
https://blog.csdn.net/u012031380/article/details/54924641/
https://my.oschina.net/u/3737136/blog/1811654

喝水的鱼.
关注
  • 24
    点赞
  • 踩
  • 84
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
Mybatis使用@param注解四种情况解析
09-07
主要介绍了Mybatis使用@param注解四种情况解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
MyBatis @Param注解的使用和参数的说明
莫得感情得码农
05-30 2097
1.为什么要使用@Param注解 在上篇博客中，我们以及将代码跑起来了，在跑起来后，我们是否思考过当方法中传递多个参数的时候，这个方法该怎么办，有人可能想到用逗号分开，但是发现会报错。就很神奇，说明MyBatis有专门的方法来解决多个简单参数赋值的方法。这就是我今天要说的@Param注解 2.@Param注解的使用情况 在什么情况使用@Param注解呢？？ 1.当方法有多个参数时。（最常用） 2.想给方法的参数取别名。（可以将复杂的参数名称换个简单的） 3.当xml文件的sql语句含...
Mybatis：mapper接口中的@Param注解的用法总结
m0_59960942的博客
03-01 2002
@Param注解的用法总结（全网巨详细）
Mybatis省略@Param导致的问题
最新发布
xiao_ying_bo_ke的博客
04-15 452
在历史代码中有些同事在mapper没有使用@Param注解，尤其是多个参数时，没有使用@Param注解会报错，因为引入jpa，所以没有报错，但是项目开发过程中没有使用JPA相关的功能，清除掉此Maven依赖，项目也是正常运行，这种问题也是很难发现的，所以在开发过程中一定要注意代码的规范性，不要给自己留坑。2、经过网上查找资料，在java8中 新增了-parameters 参数，开启此参数可以将编译后的 class 文件保留源码中的参数名称，而不是(arg0，arg1)。保留参数名称方便判断反射参数。
【详解】@Param注解的用法
m0_67402235的博客
07-28 1万+
首先明确这个注解是为SQL语句中参数赋值而服务的。@Param的作用就是给参数命名，比如在mapper里面某方法A（intid），当添加注解后A（@Param(“userId”)intid），也就是说外部想要取出传入的id值，只需要取它的参数名userId就可以了。将参数值传如SQL语句中，通过#{userId}进行取值给SQL的参数赋值。...
MyBatis 中 @Param 注解的四种使用场景，最后一种经常被人忽略
2401_83817343的博客
03-26 459
例如下面这样：@Mapper对应的 XML 文件如下：这是最常见的需要添加 @Param 注解的场景。当需要给参数取一个别名的时候，我们也需要 @Param 注解，例如方法定义如下：@Mapper对应的 XML 定义如下：老实说，这种需求不多，费事。$ 会有注入漏洞的问题，但是有的时候你不得不使用 $ 符号，例如要传入列名或者表名的时候，这个时候必须要添加 @Param 注解，例如：@Mapper。
Mybatis中@Param的用法和作用详解
热门推荐
M_Jack的博客
03-15 1万+
用注解来简化xml配置的时候,@Param注解的作用是给参数命名,参数命名后就能根据名字得到参数值,正确的将参数传入sql语句中我们先来看Mapper接口中的@Select方法?1234567package Mapper; public interface Mapper { @Select("select s_id id,s_name name,class_id classid from stud...
Mybatis中@Param解释以及动态SQL详解
时光、疏离了记忆づ童话的博客
11-09 4936
文章目录一、@Param注解二、Mybatis动态SQL2.1 if 和 where 标签2.2 trim和if标签2.3 foreach 标签2.4 choose、when、otherwise 标签三、总结 一、@Param注解 @Param是MyBatis所提供的作为Dao层的注解，作用是用于传递参数，从而可以与SQL中的的字段名相对应。 首先需要明确一下@Param和@RequestParam虽然看起来有那么一点相似，但其实是没有任何关系的，就像鱼香茄子和鱼一样。 注解 来源 @Pa
mybatis中@Param的用法
拒绝熬夜啊的博客
02-11 1279
mybatis中@Param的用法
mybatis接口函数参数注解@Param
sai的学习历程
05-07 1427
mybatis中mapper接口函数参数注解@Param使用
Mybatis中@Param注解作用
已被格式化的叔叔
09-08 9591
1.关于@Param @Param是MyBatis所提供的(org.apache.ibatis.annotations.Param)，作为Dao层的注解，作用是用于传递参数，从而可以与SQL中的的字段名相对应，一般在2=<参数数<=5时使用最佳。 2.原始的方法 当只有一个参数时，没什么好说的，传进去一个值也只有一个参数可以匹配。当存在多个参数时，传进去的值就区分不开了，这时可以考虑用Map，例如接口 public List<Role> findRoleByMap(Map&
MyBatis-Plus Generator配置详解
09-07
主要介绍了MyBatis-Plus Generator配置详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
MyBatis-Plus入门+MyBatis-Plus文档手册 中文pdf高清版.rar
11-09
mybatis在持久层框架中还是比较火的，一般项目都是基于ssm。虽然mybatis可以直接在xml中...《MyBatis-Plus入门文档》主要介绍了MyBatis-Plus入门使用，以及关于mybatis-plus的更多介绍及特性，感兴趣的可以下载学习一下
MyBatis-Plus 的官方示例(mybatis-plus-samples-master.zip)
05-05
本工程为 MyBatis-Plus 的官方示例，项目结构如下： mybatis-plus-sample-quickstart: 快速开始示例 mybatis-plus-sample-quickstart-springmvc: 快速开始示例（Spring MVC版本） mybatis-plus-sample-reduce-...
MyBaties中@Param注解
weixin_46251037的博客
10-09 246
即：用注解来简化xml配置的时候,@Param注解的作用是给参数命名,参数命名后就能根据名字得到参数值,正确的将参数传入sql语句中。用注解来简化xml配置的时候,@Param注解的作用是给参数命名,参数命名后就能根据名字得到参数值,正确的将参数传入sql语句中。在方法接受多个参数的情况下，建议一定要使用@Param注解给参数命名。在方法只接受一个参数的情况下，可以不使用@Param。采用#{}的方式把@Param注解括号内的参数进行引用。@Param用于dao层，是mybatis中的注解。
Mybatis中 @Param注解 的作用
lelelele777的博客
05-17 745
Mybatis中 @Param注解 的作用
Mybatis @Param注解的作用
kunAUGUST的博客
09-17 1256
1.@Param注解用于给参数命名 如果传递的参数类型是基本数据类型和String类型，需要使用这个注解 踩坑就是如果不使用@Param注解，参数传递不过去，虽然名字是一样的，但是Param不能省略 这里就是给接口里面的参数重命名为#｛｝里面的名称 List<EditCheckIdToFuncName> getEditCheckIdToFunctionNameByMap(@Param("studyId") String studyId, @Param("ecrfDraftId") String
mybatis-plus纯注解
09-09
Mybatis-Plus是一个基于MyBatis的增强工具，它提供了丰富的功能来简化开发过程并提高开发效率。在Mybatis-Plus中，可以使用注解来进行一对多查询，从而避免了N+1问题的出现。使用@Many注解，我们可以通过一条SQL联合查询语句完成一对多关系的查询。具体实现方法可以参考进阶文章《Mybatis巧用@Many注解让一条SQL联合查询语句完成一对多查询》。使用注解进行一对多查询可以减少代码量，并且提高查询效率，是使用Mybatis-Plus进行一对多查询的一种推荐方法。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值