MyBatis不用@Param传递多个参数的操作

时间:2021-11-16 17:58:47

背景

假设我们要保存一个小狗的信息到数据库中

通常的做法

我们在使用mybatis 接口和xml对应的时候,常常是这样写的:

接口

?
1
2
3
public interface DogDao {
 void save(@Param("dogName") String dogName, @Param("age")int age);
}

xml

?
1
2
3
4
<insert id="save">
 INSERT INTO dog
 values (null, #{dogName}, #{age});
</insert>

因为mybatis在执行的之后动态生成实现类,而在java中使用反射会将方法中的参数名称擦除,所以如果在xml中要接收到规定参数名称的参数,通过注解标识是简单又可行的方法,一方面可以自定义方法参数的绑定,另外一方面在xml中也可以起有意义的名称与@Param中的value对应。

如果不加@Param注解,也想用xml接收响应的参数

?
1
2
3
public interface DogDao {
 void save(Integer id, String dogName, int age);
}

由于在反射和jdk动态代理会将方法名称抹除,所以在解析参数的时候不能像上面的xml#{dogName}这样接收,会将参数的名称序列化成以下方式,param1…paramn

MyBatis不用@Param传递多个参数的操作

所以在xml中我们要用以下方式来接收:

?
1
2
3
4
<insert id="save">
 INSERT INTO dog
 values (null, #{param2}, #{param2});
</insert>

不想用@Param修饰,但是希望在xml中用方法中的原参数名称接收

我们在jdk不能使用反射获取参数名称,但是在jdk1.8之后提供了Parameter这个反射类,可以配置-parameter这个参数到javac编译器上,可以用来获取方法参数上的名称,但是javac编译器默认是关闭的,所以我们在编译代码的时候应该打开它,我们用maven插件的方式开启

在:pom文件中加入以下插件:

?
1
2
3
4
5
6
7
8
9
<plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-compiler-plugin</artifactId>
 <version>3.8.0</version>
 <configuration>
  <compilerArgument>-parameters</compilerArgument>
  <encoding>UTF-8</encoding>
 </configuration>
</plugin>

这样,javac编译器就能将方法的参数在反射编译的时候一同传递了,我们也不用借助注解就能达到在xml中获取方法中的实际参数的名称,除了加入编译插件,还要加入mybatis的配置开启:

?
1
2
3
<settings>
 <setting name="useActualParamName" value="false"/>
</settings>

官方文档是这样对这个配置说明的:

允许使用方法签名中的名称作为语句参数名称。 为了使用该特性,你的项目必须采用 Java 8 编译,并且加上 -parameters 选项。(新增于 3.4.1)

java 代码:

?
1
2
3
public interface DogDao {
 void save(Integer id, String dogName, int age);
}

xml代码:

?
1
2
3
4
<insert id="save">
 INSERT INTO dog
 values (null, #{dogName}, #{age});
</insert>

补充:mybatis传多个参数(不使用@param注解情况和使用@param注解的情况)

方法1:顺序传参法

1.不使用@param注解传递多个参数的情况

注: 使用jdk1.7得到的是: [1, 0, param1, param2]

使用1.8得到的则是: [arg1, arg0, param1, param2]

#{}里面的数字代表你传入参数的顺序。

这种方法不建议使用,sql层表达不直观,且一旦顺序调整容易出错。

举个栗子:

Dao层

?
1
List<User> demo(int userid, String name);

对应的XML编写

jdk1.7

?
1
2
3
4
<select id="demo" resultMap="User">
 select *
 from user where user_id=#{0} and name= #{1}
 </select>

jdk1.8之后

第一种写法

?
1
2
3
4
<select id="demo" resultMap="User">
 select *
 from user where user_id=#{arg0} and name= #{arg1}
 </select>

第二种写法

?
1
2
3
4
<select id="demo" resultMap="User">
 select *
 from user where user_id=#{param0} and name= #{param1}
 </select>

方法2:@Param注解传参法

?
1
2
3
4
5
public User selectUser(@Param("userName") String name, int @Param("deptId") deptId);
<select id="selectUser" resultMap="UserResultMap">
 select * from user
 where user_name = #{userName} and dept_id = #{deptId}
</select>

#{}里面的名称对应的是注解@Param括号里面修饰的名称。

这种方法在参数不多的情况还是比较直观的,推荐使用。

方法3:Map传参法

?
1
2
3
4
5
public User selectUser(Map<String, Object> params);
<select id="selectUser" parameterType="java.util.Map" resultMap="UserResultMap">
 select * from user
 where user_name = #{userName} and dept_id = #{deptId}
</select>

#{}里面的名称对应的是Map里面的key名称。

这种方法适合传递多个参数,且参数易变能灵活传递的情况。

方法4:Java Bean传参法

?
1
2
3
4
5
public User selectUser(User user);
<select id="selectUser" parameterType="com.test.User" resultMap="UserResultMap">
 select * from user
 where user_name = #{userName} and dept_id = #{deptId}
</select>

#{}里面的名称对应的是User类里面的成员属性。

这种方法很直观,但需要建一个实体类,扩展不容易,需要加属性,看情况使用。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持服务器之家。如有错误或未考虑完全的地方,望不吝赐教。

原文链接:https://blog.csdn.net/tangyaya8/article/details/90300554