【MyBatis】 MyBatis修炼之七 MyBatis XML方式的基本用法（多个接口参数）

在实际应用中，我们使用的接口方法的参数不仅只有一个，而且还可能是多个参数，如果是一个参数的时候，可以分为两种情况：一种是基本数据类型，另一种是JaveBean。当接口参数是一个基本数据类型的时候，它在XML文件中对应的SQL语句只会使用一个参数，当接口参数是一个JavaBean类型的时候，它在XML文件中对应的SQL语句会有多个参数，这些参数为JavaBean的属性。

而当接口参数为多个参数时，如果这个几个参数都是属于同一个JavaBean，我们可以将其合并为一个JavaBean中，并使用这个JavaBean作为接口方法的参数，但是这种情况并不适用于所有情况，我们不可能为所有的多个参数去创建JavaBean类，因此对于参数比较少的情况，我们可以采用两种方式：使用Map类型作为参数，或使用@param注解。

使用Map类型作为参数的方法，就是使用Map中的key值来映射XML中SQL使用的参数值的名字，value就是参数值，需要多个参数时，通过Map的key-value方式传递参数值，由于这种方式我们在使用时都需要手动的为参数创建Map，非常麻烦，所以我们基本不采用此种方式。

MyBatis参考文档：

中文版：http://www.mybatis.org/mybatis-3/zh/index.html
英文版：http://www.mybatis.org/mybatis-3/

工具

JDK 1.6及以上版本
MyBatis 3.30版本
MySQL 6.3版本
Eclipse4 及以上版本
Apache Maven 构建工具

项目源码下载地址：https://github.com/JFAlex/MyBatis/tree/master/MyBatis_No.7

下面开始@param注解的使用。
现在我们根据用户id和角色的enable状态来查询用户所有的角色，定义一个接口方法(此时接口参数前未加@param注解):

public List selectRolesByUserIdAndRoleEnabled(Long userId, Integer enabled);

这个接口方法对应的UserMapper.xml中的代码为：

然后在测试类UserMapperTest中添加测试方法：

@Test
    public void testSelectRolesByUserIdAndRoleEnabled() {
        // 获取SqlSession
        SqlSession sqlSession = getSqlSession();

        // 获取UserMapper接口
        try {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            // 调用selectById方法，查询id=1的用户
            List roleList = userMapper.selectRolesByUserIdAndRoleEnabled(1L,1);
        } catch(Exception e){
            e.printStackTrace();
        }finally {
            // 关闭SqlSession
            sqlSession.close();
        }
    }

右键单击测试类，在Run As选项中选择JUnit Test执行测试，测试输出日志会显示错误如下。

org.apache.ibatis.exceptions.PersistenceException: 
### Error querying database.  Cause: org.apache.ibatis.binding.BindingException: Parameter 'userId' not found. Available parameters are [0, 1, param1, param2]

这个错误的意思是，XML可以使用的参数只有0，1，param1,param2，没有userId。0和1，param1和param2都是MyBatis根据参数位置自定义的名字，这时如果将XML中的#{userId}改为#{0} 或者#{param1}，将#{enabled}改成#{1}或者#{param2}，这个方法就可以被正常执行了，但是，我们通常情况下采用这种方式来实现。

现在我们修改接口方法中的参数，添加@param注解：

public List selectRolesByUserIdAndRoleEnabled(@Param("userId")Long userId, @Param("enabled")Integer enabled);

此时XML文件中不用作任何修改，然后右键单击测试类，在Run As选项中选择JUnit Test执行测试，输入日志：

DEBUG [main] - Opening JDBC Connection
DEBUG [main] - Created connection 1320677379.
DEBUG [main] - Setting autocommit to false on JDBC Connection [com.mysql.jdbc.JDBC4Connection@4eb7f003]
DEBUG [main] - ==>  Preparing: select r.id, r.role_name roleName, r.enabled, r.create_by createBy, r.create_time createTime, u.user_name as "user.userName" from sys_user u inner join sys_user_role ur on u.id=ur.user_id inner join sys_role r on ur.role_id=r.id where u.id = ? and r.enabled = ? 
DEBUG [main] - ==> Parameters: 1(Long), 1(Integer)
TRACE [main] - <==    Columns: id, roleName, enabled, createBy, createTime, user.userName
TRACE [main] - <==        Row: 1, 管理员, 1, 1, 2017-08-09 15:26:52.0, admin
TRACE [main] - <==        Row: 2, 普通用户, 1, 1, 2017-08-09 15:26:52.0, admin
DEBUG [main] - <==      Total: 2
DEBUG [main] - Resetting autocommit to true on JDBC Connection [com.mysql.jdbc.JDBC4Connection@4eb7f003]
DEBUG [main] - Closing JDBC Connection [com.mysql.jdbc.JDBC4Connection@4eb7f003]
DEBUG [main] - Returned connection 1320677379 to pool.

现在可以正确获取数据库的数据了，这时XML文件中对应的SQL的可用参数变成了[userID，enabled，param1，param2]，如果我们把#{userID}和#{enabled}修改成#{param1}和#{param2}，也是可以通过的。

还有一个情况就是，如果参数是多个JavaBean时，将接口方法修改为JavaBean类型

public List selectRolesByUserIdAndRoleEnabled(@Param("user")SysUser user, @Param("role")SysRole role);

这时，在XML中我们不能直接使用#{userID}和#{enabled}，而是通过#{user.userID}和#{role.enabled}从两个JavaBean中获取对应的属性值。这里就不提供代码说明了。

除了以上常用的参数类型外，接口的参数还可以能是集合或者数组，有关集合和数组的用法，以后再做讲解。

项目源码下载地址：https://github.com/JFAlex/MyBatis/tree/master/MyBatis_No.7

上一篇：【MyBatis】 MyBatis修炼之六 MyBatis XML方式的基本用法（UPDATE、DELETE）

下一篇：【MyBatis】 MyBatis修炼之八 MyBatis 注解方式的基本用法

【MyBatis】 MyBatis修炼之七 MyBatis XML方式的基本用法（多个接口参数）

工具

你可能感兴趣的:(【MyBatis】 MyBatis修炼之七 MyBatis XML方式的基本用法（多个接口参数）)