11. Mybatis 参数传递与引用

刺骨的言语ヽ痛彻心扉 2024-04-17 14:57 23阅读 0赞

Mybatis 的参数传递与引用, 指的是在sql 映射文件中如何引用java 中传递的参数. Mybatis 支持命名参数和位置参数两种方式, 也可以自动从pojo中获取属性值.

## 1. 参数传递方式 ##

和jdbc 类似, Mybatis 的参数传递也包含位置参数和命名参数.

### 1.1 位置参数 ###

位置参数是Mybatis 默认管理的, Mybatis会将参数列表转换为两种位置参数, 一组下标从0开始, 一组下标从1 开始.

*  \#\{arg0\}, \#\{arg1\}, \#\{arg2\}…
 *  \#\{param1\}, \#\{param2\}, \#\{param3\}…

public UserPO findById(Integer id);

### 1.2 命名参数 ###

自定义命名参数需要通过@Param 注解指定.

public UserPO findById(@Param("id") Integer id);

## 2. 参数引用 ##

*  参数引用, 指的是在sql 映射文件中, 如何获取Mapper 中方法传如的参数.
 *  无论是引用命名参数还是位置参数, Mybatis都是通过\#\{\} 或$\{\}
    
     *  \#\{\}: 采用预编译sql方式, 使用占位符? 拼接sql
     *  $\{\}: 采用字符串替换方式, 直接使用传入的字符串拼接sql

## 2. 传参模式 ##

Mapper 的形参列表多种多样, 笔者只能列举几种常用的传参模式以及对应的引用方式.

### 2.1 常用传参模式 ###

<table> 
 <thead> 
  <tr> 
   <th align="left">形参列表</th> 
   <th align="left">参数定义</th> 
   <th align="left">参数获取</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">单个基本类型</td> 
   <td align="left">UserPO findById(int id);</td> 
   <td align="left">#{id}, #{param1}, #{arg0}…</td> 
  </tr> 
  <tr> 
   <td align="left">单个数组</td> 
   <td align="left">List queryListByIdArray(Integer[] ids));</td> 
   <td align="left">#{array[0]},#{array[1]}</td> 
  </tr> 
  <tr> 
   <td align="left">单个列表</td> 
   <td align="left">List queryListByIdList(List ids);</td> 
   <td align="left">#{list[0]},#{list[1]}</td> 
  </tr> 
  <tr> 
   <td align="left">单个自定义类型</td> 
   <td align="left">UserPO findByQuery(UserQuery query)?</td> 
   <td align="left">#{idEq}</td> 
  </tr> 
  <tr> 
   <td align="left">多个基本类型</td> 
   <td align="left">UserPO findByUsernameAndPwd(String username, String password);</td> 
   <td align="left">#{param1}, #{param2}, #{arg0}, #{arg1}</td> 
  </tr> 
  <tr> 
   <td align="left">命名参数-多个基本类型</td> 
   <td align="left">UserPO findByUP(@Param(“id”) Integer id, @Param(“username”) String username);</td> 
   <td align="left">#{id}, #{username}</td> 
  </tr> 
  <tr> 
   <td align="left">命名参数-多个自定义类型</td> 
   <td align="left">UserPO findByQuery2(@Param(“q1”) UserQuery query, @Param(“q2”) UserQuery query2);</td> 
   <td align="left">#{q1.idEq}, #{q2.usernameEq}</td> 
  </tr> 
 </tbody> 
</table>

### 2.2 传参设计 ###

笔者认为, 当形参过多时, 将多个参数封装成一个TO(Transfer Object) 或Map 进行传递, 代码会更优雅.

*  单个参数时, 直接使用参数名引用
 *  多个参数, 使用@Param 进行命名, 然后使用命名参数进行引用
 *  对于特殊类型, Mybatis做了内置命名:
    
     *  对于数组类型, 引用对象名为array
     *  对于集合类型, 引用对象名为collection
     *  对于列表类型, 引用对象名为list

## 3. 常用传参模式举例 ##

### 3.1 单个基本类型 ###

当形参列表为单个基本类型参数时, 获取参数时, 可以使用任何变量名, 不仅仅局限于param1, arg0. 不过还是推荐使用形参名称.

**方法签名:**

UserPO findById(int id);

**sql 片段:**

<select id="findById" resultType="UserPO">
        select * from t_user where id = #{personId}
    </select>

### 3.2 单个数组 ###

当形参列表为数组时, 只能通过array表示数组, 不能通过param1/arg0表示. 因为Mybatis 为List 内部定义了别名.

**方法签名:**

List<UserPO> queryListByIdArray(Integer[] ids);

**sql 片段:**

<select id="queryListByIdArray" resultType="UserPO">
        select * from t_user where id in (${array[0]}, ${array[1]})
    </select>

### 3.3 单个列表 ###

当形参列表为数组时, 只能通过list表示数组, 不能通过param1/arg0表示.

**方法签名:**

List<UserPO> queryListByIdList(List<Integer> ids);

**sql 片段:**

<select id="queryListByIdList" resultType="UserPO">
        select * from t_user where id in (${list[0]}, ${list[1]})
    </select>

### 3.4 单个自定义类型 ###

当形参为单个vo时, 通过属性名称直接获取对象的属性值

**方法签名:**

UserPO findByQuery(UserQuery query);

**sql 片段:**

<select id="findByQuery" resultType="UserPO">
        select * from t_user where username = #{idEq} and password=#{usernameEq}
    </select>

### 3.5 多个基本类型 ###

当形参列表为多个基本类型参数时, 可使用Mybatis默认生成的变量名param\*或arg\*获取参数值, 也可混合使用,但不推荐混合使用.

**方法签名:**

UserPO findByUsernameAndPwd(String username, String password);

**sql 片段:**

<select id="findByUsernameAndPwd" resultType="UserPO">
        select * from t_user where username = #{arg0} and password=#{param2}
    </select>

### 3.6 命名参数-多个基本类型 ###

当形参列表为多个基本类型参数时, 也可以使用命名参数. 使用命名参数, sql可读性更强.

**方法签名:**

UserPO findByUP(@Param("username") String username, @Param("password") String password);

**sql 片段:**

<select id="findByUP" resultType="UserPO">
        select * from t_user where username = #{username} and password=#{password}
    </select>

### 3.7 命名参数-多个自定义类型 ###

当形参列表为多个自定义类型参数时, 推荐使用命名参数.

**方法签名:**

UserPO findByQuery2(@Param("q1") UserQuery query, @Param("q2") UserQuery query2);

**sql 片段:**

<select id="findByQuery2" resultType="UserPO">
        select * from t_user where username = #{q1.usernameEq} and password=#{q2.passwordEq}
    </select>