1. 多表查詢
上篇博客中,我們示例的2個查詢都是單表查詢,但實際的業務場景肯定是需要多表查詢的,比如現在有個需求:
查詢某個用戶擁有的所有角色。這個需求要涉及到sys_user,sys_user_role,sys_role三張表,如何實現呢?
首先,在SysUserMapper接口中定義如下方法。
/**
* 根據用戶id獲取角色信息
*
* @param userId
* @return
*/
List<SysRole> selectRolesByUserId(Long userId);
然后打開對應的SysUserMapper.xml文件,添加如下select語句:
<select id="selectRolesByUserId" resultType="com.zwwhnly.mybatisaction.model.SysRole">
SELECT r.id,
r.role_name roleName,
r.enabled,
r.create_by createBy,
r.create_time createTime
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}
</select>
細心的讀者可能會發現,我們雖然使用到了多表查詢,但是resultType設置的仍然是單表,即只包含角色表的信息。
如果我希望這個查詢語句同時返回SysUser表的user_name字段呢,該如何設置resultType?
方法1:直接在SysRole實體類中添加userName字段。
private String userName;
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
此時resultType不用修改。
方法2:新建擴展類,在擴展類中添加userName字段。
package com.zwwhnly.mybatisaction.model;
public class SysRoleExtend extends SysRole {
private String userName;
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
}
此時需要將resultType修改為:com.zwwhnly.mybatisaction.model.SysRoleExtend。
這種方式比較適合需要少量額外字段的場景。如果需要其他表的大量字段,可以使用方式3或者方式4,個人推薦使用方式4。
方法3:在SysRole實體類中添加SysUser類型的字段。
private SysUser sysUser;
public SysUser getSysUser() {
return sysUser;
}
public void setSysUser(SysUser sysUser) {
this.sysUser = sysUser;
}
此時resultType不用修改。
方法4(推薦使用):新建擴展類,在擴展類中添加SysUser類型的字段。
書中推薦的是方式3,方式4是我個人認為更好的方式,因為實體類一般由工具自動生成,增加了字段后,后續容易忘記導致被覆蓋掉。
package com.zwwhnly.mybatisaction.model;
public class SysRoleExtend extends SysRole {
private SysUser sysUser;
public SysUser getSysUser() {
return sysUser;
}
public void setSysUser(SysUser sysUser) {
this.sysUser = sysUser;
}
}
此時需要將resultType修改為:com.zwwhnly.mybatisaction.model.SysRoleExtend。
此時xml中的查詢語句如下。
<select id="selectRolesByUserId" resultType="com.zwwhnly.mybatisaction.model.SysRoleExtend">
SELECT r.id,
r.role_name roleName,
r.enabled,
r.create_by createBy,
r.create_time createTime,
u.user_name "sysUser.userName",
u.user_email "sysUser.userEmail"
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}
</select>
在SysUserMapperTest中添加測試代碼如下。
@Test
public void testSelectRolesByUserId() {
SqlSession sqlSession = getSqlSession();
try {
SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);
List<SysRole> sysRoleList = sysUserMapper.selectRolesByUserId(1L);
Assert.assertNotNull(sysRoleList);
Assert.assertTrue(sysRoleList.size() > 0);
} finally {
sqlSession.close();
}
}
運行該測試方法,輸入日志如下。
DEBUG [main] - ==> Preparing: SELECT r.id, r.role_name roleName, r.enabled, r.create_by createBy, r.create_time createTime, u.user_name "sysUser.userName", u.user_email "sysUser.userEmail" 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 = ?
DEBUG [main] - ==> Parameters: 1(Long)
TRACE [main] - <== Columns: id, roleName, enabled, createBy, createTime, sysUser.userName, sysUser.userEmail
TRACE [main] - <== Row: 1, 管理員, 1, 1, 2019-06-27 18:21:12.0, admin, admin@mybatis.tk
TRACE [main] - <== Row: 2, 普通用戶, 1, 1, 2019-06-27 18:21:12.0, admin, admin@mybatis.tk
DEBUG [main] - <== Total: 2
2. 多個接口參數的用法
2.1 參數類型是基本類型
截止目前,我們定義的方法都只有1個參數,要么是只有1個基本類型的參數,比如selectById(Long id);。
要么是只有1個對象作為參數,即將多個參數合並成了1個對象。
但有些場景下,比如只有2個參數,沒有必要為這2個參數再新建一個對象,比如我們現在需要根據用戶的id和角色的狀態來獲取用戶的所有角色,那么該如何使用呢?
首先,在接口SysUserMapper中添加如下方法。
/**
* 根據用戶id和角色的enabled狀態獲取用戶的角色
*
* @param userId
* @param enabled
* @return
*/
List<SysRole> selectRolesByUserIdAndRoleEnabled(Long userId,Integer enabled);
然后,打開對應的SysUserMapper.xml文件,添加如下代碼。
<select id="selectRolesByUserIdAndRoleEnabled" resultType="com.zwwhnly.mybatisaction.model.SysRole">
SELECT r.id,
r.role_name roleName,
r.enabled,
r.create_by createBy,
r.create_time createTime
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>
在SysUserMapperTest測試類中,添加如下測試方法。
@Test
public void testselectRolesByUserIdAndRoleEnabled() {
SqlSession sqlSession = getSqlSession();
try {
SysUserMapper sysUserMapper = sqlSession.getMapper(SysUserMapper.class);
List<SysRole> sysRoleList = sysUserMapper.selectRolesByUserIdAndRoleEnabled(1L, 1);
Assert.assertNotNull(sysRoleList);
Assert.assertTrue(sysRoleList.size() > 0);
} finally {
sqlSession.rollback();
sqlSession.close();
}
}
運行該測試方法,發現報如下錯誤。
報錯信息中說未找到參數userId,可用的參數是[0,1,param1,param2],也就是說我們將代碼修改為:
WHERE u.id = #{0} AND r.enabled = #{1}
或者修改為:
WHERE u.id = #{param1} AND r.enabled = #{param2}
這么使用是可以測試通過的,不過這樣使用,代碼閱讀起來不夠友好,因此並不推薦這么使用。
推薦在接口方法的參數前添加@Param注解,如下所示:
/**
* 根據用戶id和角色的enabled狀態獲取用戶的角色
*
* @param userId
* @param enabled
* @return
*/
List<SysRole> selectRolesByUserIdAndRoleEnabled(@Param("userId") Long userId, @Param("enabled") Integer enabled);
運行剛剛添加的測試方法,測試通過,輸出日志如下:
DEBUG [main] - ==> Preparing: SELECT r.id, r.role_name roleName, r.enabled, r.create_by createBy, r.create_time createTime 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
TRACE [main] - <== Row: 1, 管理員, 1, 1, 2019-06-27 18:21:12.0
TRACE [main] - <== Row: 2, 普通用戶, 1, 1, 2019-06-27 18:21:12.0
DEBUG [main] - <== Total: 2
2.2 參數類型是對象
為了演示參數類型是對象的使用方法,我們在接口SysUserMapper中添加如下方法:
/**
* 根據用戶id和角色的enabled狀態獲取用戶的角色
*
* @param user
* @param role
* @return
*/
List<SysRole> selectRolesByUserAndRole(@Param("user") SysUser user, @Param("role") SysRole role);
此時對應的xml中的語句為:
<select id="selectRolesByUserAndRole" resultType="com.zwwhnly.mybatisaction.model.SysRole">
SELECT r.id,
r.role_name roleName,
r.enabled,
r.create_by createBy,
r.create_time createTime
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 = #{user.id} AND r.enabled = #{role.enabled}
</select>
3. 源碼及參考
源碼地址:https://github.com/zwwhnly/mybatis-action.git,歡迎下載。
劉增輝《MyBatis從入門到精通》
原創不易,如果覺得文章能學到東西的話,歡迎點個贊、評個論、關個注,這是我堅持寫作的最大動力。
如果有興趣,歡迎添加我的微信:zwwhnly,等你來聊技術、職場、工作等話題(PS:我是一名奮斗在上海的程序員)。