MyBatis参数传递（提供ParamNameResolver类来进行参数封装）源码分析

迈不过友情╰ 2024-03-16 10:37 65阅读 0赞

MyBatis接口方法中可以接收各种各样的参数，MyBatis底层对于这些参数进行不同的封装处理方式。

单个参数：实体类、Map集合、Collection、List、Array以及其他类型。

多个参数：Param注解定义的名称要与sql语句中参数占位符中的名称相同。

![1460c0572b03455b91d8d2c2c1de8c2c.png][]

![67f9a49b6e2247b4b865f06aa679e116.png][] 这里就引入了一个问题：为什么需要Param注解，以及使用Param注解时参数是如何进行传递的？那么就需要对MyBatis底层对于这些参数进行不同的封装处理方式进行深刻的理解。

**MyBatis提供了ParamNameResolver类来进行参数封装参数封装，下面进入源码进行分析：**

**1.首先先看一下多个参数是如何进行传递的：**

**先准备一个UserMapper类的查询方法：**

UserInfo select(@Param("username") String username, @Param("password") String password);

**准备一个UserMapper.xml中的sql:**

<select id="select" resultType="model.UserInfo">
        select * from tb_user where username=#{username} and password = #{password}
    </select>

关于多个参数的传递，其实是封装为Map集合的：

map.put(“arg0”,参数值1);

map.put(“param1”,参数值1);

map.put(“arg1”,参数值2);

map.put(“param2”,参数值2);

其实也就是说在sql中我们可以通过arg0、arg1、param1、param2等来获取对应的参数。

首先，不加param注解的时候，这个时候运行会报错，但是我们可以看到一些提示信息：

![5984d96cbb1a4123ae43a2331fd1ffe4.png][]

意思就是说，当前传递的参数没有获取到，目前能够获取的参数有\[arg1, arg0, param1, param2\]这四个。接下来把sql中占位符的参数改成arg0和arg1，此时运行成功。同理，占位符的参数改成param1和param2，也是能够运行成功的。

![16a155041fe84a4b9f398647fd8770b0.png][]

![6fce5c7c8e5a4b1f80ccc14942ef2beb.png][]

接下来，我们看一下**ParamNameResolver类的源码，里面有一个getNamedParams方法：通过断点调试的方法我们能够清晰看到整个过程：**（这里具体过程不赘述，只看结果）

![e034cfcf85654e16afe650ed356d0887.png][]

分析结果就是，咱们其实是可以用arg0、arg1、param1、param2等来获取对应的参数，但是不推荐，因为当多个参数进行传递时，使用这种方式会让代码可读性非常差。推荐使用@Param注解来定义参数名称。使用@Param注解其实就是替换了map集合中的arg的键名，param的键名是不变的，下面代码演示能够说明问题。

![500e1dcd30fd42eb8102a6b98cf46b06.png][]

![6f2c555f95094e72b70fd7ac394ccdb0.png][]

![5ca213711dc54ad4a4fd05bde24d0e68.png][]

**2.现在看一下单个参数是如何进行传递的：**

**1.实体类**

可以直接使用，属性名和参数占位符保持一致就可以。

**2.Map集合**

可以直接使用，键名和参数占位符保持一致就可以。

**3.其他类型**

可以直接使用。比如int id，sql中占位符写什么都是可以的。示例：

![8f590a4e949f41a29dbd0a23c02331c0.png][]

![290081eaceca4937af63848cb675563b.png][]

![dcfeeaa07bda4faab9223ef42b3ca182.png][] **4.Collection（list/array）**

**准备传入一个集合参数：**

![075544ac99fc4dec83e40d462c498501.png][]

**通过断点调试还是会进入getNamedParams方法，然后进入wrapToMapIfCollection方法：**

![247cae24ef8241f994aa26d0f7c1cbcd.png][]

![077cbe4ddd294eadab10fc0fe24f2530.png][] ![2d1dc562b0354c1db9b66eb81f28deac.png][]

**小结：**

**传入的collection集合，那么会封装为Map集合：**

map.put(“arg0”,collection集合);

map.put(“collection”,collection集合);

**传入的list集合，那么也会封装为Map集合：**

map.put(“arg0”,list集合);

map.put(“collection”,list集合);

map.put(“list”,list集合);

**传入的array数组，那么也会封装为Map集合：**

map.put(“arg0”,array数组);

map.put(“array”,array数组);

**3.总结**

在实际开发中当传入多个参数、collection集合、list集合和array数组等的时候，要尽量避免使用这种默认的参数，最好使用**@Param注解**来替换Map集合中的默认键名，并使用修改后的名称来获取值，这样会使代码可读性更高。

[1460c0572b03455b91d8d2c2c1de8c2c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/783c32ec4ccc4f48be39a4738221f0d1.png
[67f9a49b6e2247b4b865f06aa679e116.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/1f5ede6a060b4ae28fff8fad42636ba4.png
[5984d96cbb1a4123ae43a2331fd1ffe4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/93c0381e946d402fad95ac1ac2bcea1b.png
[16a155041fe84a4b9f398647fd8770b0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/30be6510b03f40f5914b8d6d06dd4372.png
[6fce5c7c8e5a4b1f80ccc14942ef2beb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/8790be16e8ed4bf2baabb593d7b096a2.png
[e034cfcf85654e16afe650ed356d0887.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/60c61060d9f740beb9be6a0336269246.png
[500e1dcd30fd42eb8102a6b98cf46b06.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/c6dcf91515e54d568972fbb5a9c9f6cd.png
[6f2c555f95094e72b70fd7ac394ccdb0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/90c27d4b6b15479d80cc5ba90a62caff.png
[5ca213711dc54ad4a4fd05bde24d0e68.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/5c3683d3e34548ec90341ea0dfa9a3cd.png
[8f590a4e949f41a29dbd0a23c02331c0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/129c9381a00a4b3595380e004999c24c.png
[290081eaceca4937af63848cb675563b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/e9885d6a4203404b98c50cf7c31eadd8.png
[dcfeeaa07bda4faab9223ef42b3ca182.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/d0d62669079843da927d3ffb5cc35af5.png
[075544ac99fc4dec83e40d462c498501.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/c21da07a289c4fa98ce84ed3f0519549.png
[247cae24ef8241f994aa26d0f7c1cbcd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/7e597fe7edb043aba22607cdcc4de680.png
[077cbe4ddd294eadab10fc0fe24f2530.png]: https://img-blog.csdnimg.cn/077cbe4ddd294eadab10fc0fe24f2530.png
[2d1dc562b0354c1db9b66eb81f28deac.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/f57cd7c16b1b40fe9dcc0f889e59ad51.png