【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<SysRole> selectRolesByUserIdAndRoleEnabled(Long userId, Integer enabled);

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

    <select id="selectRolesByUserIdAndRoleEnabled" resultType="mybatis.simple.model.SysRole">
        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 =
        #{userId} and r.enabled = #{enabled}
    </select>

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

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

        // 获取UserMapper接口
        try {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            // 调用selectById方法,查询id=1的用户
            List<SysRole> 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<SysRole> 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<SysRole> 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 注解方式的基本用法

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容