关于Mybatis的mapper接口函数重载问题
目录
- Mybatis的接口函数能不能进行重载？
- 语法层面
- Mybatis框架方面
- 测试
- MyBatis实现方法重载的小技巧
- QuestionMapper.java
- QuestionMapper.xml
Mybatis的接口函数能不能进行重载？
- mybatis版本：3.4x
- java版本：java 8
语法层面
1、接口的方法可以进行重载，因为 java 语法可以让接口函数进行重载。
Mybatis框架方面
1、结论：可以有条件的进行重载。
2、为什么会有这个问题？：mybatis里面将接口里面的方法名称和配置文件里面的id属性进行唯一配对，在同一个命名空间下只能有一个id，那么所有函数名称相同的重载函数都会被绑定到一个id上，所以，如果要实现函数的重载，必须让一个SQL语句去适应多个函数的参数，如果是单纯的重载是肯定不行的（重载函数的定义就是参数相关），但是得益于mybatis的多种传参方式和隐性的分页功能，可以在接口里面进行函数重载，但是还是需要将所有的重载函数适配到同一个id的SQL上面去，仍然有很大的局限性，并不是可以随意的进行重载。
测试
1、数据库环境
DROP TABLE IF EXISTS sys_user;
CREATE TABLE sys_user(
id BIGINT NOT NULL AUTO_INCREMENT COMMENT '用户的ID',
user_name VARCHAR(50) COMMENT '用户名称',
user_password VARCHAR(50) COMMENT '密码',
user_email VARCHAR(50) COMMENT '邮箱',
user_info TEXT COMMENT '简介',
head_img BLOB COMMENT '头像',
create_time DATETIME COMMENT '创建时间',
PRIMARY KEY (id)
)DEFAULT CHARSET utf8;
ALTER TABLE sys_user COMMENT '用户表';
INSERT INTO sys_user VALUES ('1','admin','123456','admin@mybatis.tk','管理员',null,'2016-04-01 17:00:58');
INSERT INTO sys_user VALUES ('1001','test','123456','test@mybatis.tk','测试用户',null,'2016-04-01 17:01:52');
2、实体类
public class SysUser {
private Long id;
private String userName;
private String userPassword;
private String userEmail;
private String userInfo;
private byte[] headImg;
private Date createTime;
public SysUser(){
}
/**setter and getter*/
}
3、测试
3.1、测试模板代码
public class SysUserDaoTest {
private static SqlSessionFactory sqlSessionFactory;
private SqlSession sqlSession;
@BeforeClass
public static void beforeClass(){
String resource = "plus/mybatis-config.xml";
try{
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
}catch(IOException e){
e.printStackTrace();
}
}
@Before
public void before(){
//事物手动提交
sqlSession = sqlSessionFactory.openSession(false);
}
@After
public void after(){
//回滚事物
sqlSession.rollback(true);
//关闭会话
sqlSession.close();
}
}
3.2、测试场景一
重载实现分页、参数类型转换实现重载。
3.2.1、接口
public interface SysUserDao {
SysUser selectById(Long id);
List<SysUser> selectById(Long id,RowBounds rowBound);
}
3.2.2、mapper配置文件
<!--
id：注意事项：接口方法不能进行重载，在3.4版本后是错的！！！！！，因为至少可以分页！！！
1、接口中的所有重载方法对应XML里面的同一个ID，但是3.4之后有一个分页的插件，所以至少可以接受一个org.apache.ibatis.session.RowBounds的隐性参数。
2、虽然接口里面的方法可以进行重载，但是需要一个前提：不要指定 parameterType 属性！！
接口方法如下：
SysUser selectById(Long id);
List<SysUser> selectById(Long id,RowBounds rowBound);
SysUser selectById(String name);
测试代码如下：
SysUserDao sysUserDao = sqlSession.getMapper(SysUserDao.class);
SysUser sysUser = sysUserDao.selectById(1L);
Assert.assertEquals("admin",sysUser.getUserName());
SysUser sysUser1 = sysUserDao.selectById("1");
Assert.assertEquals("admin",sysUser1.getUserName());
/*
plus.dao.SysUserDao.selectById - ==> Preparing: SELECT * FROM sys_user WHERE id = ?;
plus.dao.SysUserDao.selectById - ==> Parameters: 1(Long)
plus.dao.SysUserDao.selectById - <== Total: 1
plus.dao.SysUserDao.selectById - ==> Preparing: SELECT * FROM sys_user WHERE id = ?;
plus.dao.SysUserDao.selectById - ==> Parameters: 1(String)
plus.dao.SysUserDao.selectById - <== Total: 1
*/
RowBounds rowBound = new RowBounds(0,2);
List<SysUser> sysUsers = sysUserDao.selectById(1L,rowBound);
Assert.assertEquals(1,sysUsers.size());
/*
plus.dao.SysUserDao.selectById - ==> Preparing: SELECT * FROM sys_user WHERE id = ?;
plus.dao.SysUserDao.selectById - ==> Parameters: 1(Long)
plus.dao.SysUserDao.selectById - <== Total: 1
*/
事实证明，当不指定参数类型的时候（也仅仅当不指定参数类型的时候才可以，因为重载重载的是参数），是可以进行
接口方法重载的，因为mybatis的参数类型推断会自动的转换参数类型，比如：
sysUserDao.selectById("楚云飞");
因为ID的类型是Long类型，所以数据类型的自动转换失败，但是是不会出现异常的，只是它选取出来的数据集为null,因为ID的类型是bigint，没有bigint值为楚云飞，所以为null结果集。
-->
<select id="selectById" resultMap="sysUser" flushCache="true">
SELECT * FROM sys_user WHERE id = #{id};
</select>
<resultMap id="sysUser" type="plus.pojo.SysUser">
<id property="id" column="id"/>
<result property="userName" column="user_name"/>
<result property="userPassword" column="user_password"/>
<result property="userEmail" column="user_email"/>
<result property="userInfo" column="user_info"/>
<result property="headImg" column="head_img" jdbcType="BLOB"/>
<result property="createTime" column="create_time" jdbcType="TIMESTAMP"/>
</resultMap>
3.3、测试场景二
参数传递方式实现重载，map参数传递和固定参数名的参数传递方式
3.3.1、接口
public interface SysUserDao {
SysUser selectByCondition(@Param("id")Long id,@Param("userName")String userName,@Param("userPassword")String userPassword);
SysUser selectByCondition(Map params);
}
3.3.2、mapper配置文件
<!--
固定参数传递：
函数接口：
SysUser selectByCondition(@Param("id")Long id,@Param("userName")String userName,@Param("userPassword")String userPassword);
SysUser selectByCondition(Map params);
测试函数：
@Test
public void selectByCondition(){
SysUserDao sysUserDao = sqlSession.getMapper(SysUserDao.class);
SysUser sysUser = sysUserDao.selectByCondition(1L,"admin","123456");
Assert.assertEquals("admin@mybatis.tk",sysUser.getUserEmail());
/*
plus.dao.SysUserDao.selectByCondition - ==> Preparing: SELECT * FROM sys_user WHERE id = ? AND user_name = ? AND user_password = ?;
plus.dao.SysUserDao.selectByCondition - ==> Parameters: 1(Long), admin(String), 123456(String)
plus.dao.SysUserDao.selectByCondition - <== Total: 1
*/
Map<String,Object> params = new HashMap<String,Object>(3);
//传入的键值必须和SQL语句里面的以及重载函数的参数名称相同才可以实现正确的重载，否则将重载出错。
params.put("id",1L);
params.put("userName","admin");
params.put("userPassword","123456");
SysUser sysUser1 = sysUserDao.selectByCondition(params);
/*
plus.dao.SysUserDao.selectByCondition - ==> Preparing: SELECT * FROM sys_user WHERE id = ? AND user_name = ? AND user_password = ?;
plus.dao.SysUserDao.selectByCondition - ==> Parameters: 1(Long), admin(String), 123456(String)
plus.dao.SysUserDao.selectByCondition - <== Total: 1
*/
Assert.assertEquals("admin@mybatis.tk",sysUser1.getUserEmail());
}
-->
<select id="selectByCondition" resultMap="sysUser" flushCache="true">
SELECT * FROM sys_user WHERE id = #{id} AND user_name = #{userName} AND user_password = #{userPassword};
</select>
3.4、完整的测试代码
package plus.dao;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.*;
import org.junit.*;
import plus.pojo.SysUser;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class SysUserDaoTest {
private static SqlSessionFactory sqlSessionFactory;
private SqlSession sqlSession;
@BeforeClass
public static void beforeClass(){
String resource = "plus/mybatis-config.xml";
try{
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
}catch(IOException e){
e.printStackTrace();
}
}
@Before
public void before(){
//事物手动提交
sqlSession = sqlSessionFactory.openSession(false);
}
@After
public void after(){
//回滚事物
sqlSession.rollback(true);
//关闭会话
sqlSession.close();
}
@Test
public void selectById(){
SysUserDao sysUserDao = sqlSession.getMapper(SysUserDao.class);
SysUser sysUser = sysUserDao.selectById(1L);
Assert.assertEquals("admin",sysUser.getUserName());
SysUser sysUser1 = sysUserDao.selectById("1");
Assert.assertEquals("admin",sysUser1.getUserName());
/*
plus.dao.SysUserDao.selectById - ==> Preparing: SELECT * FROM sys_user WHERE id = ?;
plus.dao.SysUserDao.selectById - ==> Parameters: 1(Long)
plus.dao.SysUserDao.selectById - <== Total: 1
plus.dao.SysUserDao.selectById - ==> Preparing: SELECT * FROM sys_user WHERE id = ?;
plus.dao.SysUserDao.selectById - ==> Parameters: 1(String)
plus.dao.SysUserDao.selectById - <== Total: 1
*/
RowBounds rowBound = new RowBounds(0,2);
List<SysUser> sysUsers = sysUserDao.selectById(1L,rowBound);
Assert.assertEquals(1,sysUsers.size());
/*
plus.dao.SysUserDao.selectById - ==> Preparing: SELECT * FROM sys_user WHERE id = ?;
plus.dao.SysUserDao.selectById - ==> Parameters: 1(Long)
plus.dao.SysUserDao.selectById - <== Total: 1
*/
}
@Test
public void selectByCondition(){
SysUserDao sysUserDao = sqlSession.getMapper(SysUserDao.class);
SysUser sysUser = sysUserDao.selectByCondition(1L,"admin","123456");
Assert.assertEquals("admin@mybatis.tk",sysUser.getUserEmail());
/*
plus.dao.SysUserDao.selectByCondition - ==> Preparing: SELECT * FROM sys_user WHERE id = ? AND user_name = ? AND user_password = ?;
plus.dao.SysUserDao.selectByCondition - ==> Parameters: 1(Long), admin(String), 123456(String)
plus.dao.SysUserDao.selectByCondition - <== Total: 1
*/
Map<String,Object> params = new HashMap<String,Object>(3);
params.put("id",1L);
params.put("userName","admin");
params.put("userPassword","123456");
SysUser sysUser1 = sysUserDao.selectByCondition(params);
/*
plus.dao.SysUserDao.selectById - ==> Preparing: SELECT * FROM sys_user WHERE id = ?;
plus.dao.SysUserDao.selectById - ==> Parameters: 1(Long)
plus.dao.SysUserDao.selectById - <== Total: 1
*/
Assert.assertEquals("admin@mybatis.tk",sysUser1.getUserEmail());
}
}
3.5、完整的mapper文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="plus.dao.SysUserDao">
<!--
id：当使用接口时，属性值必须为接口里面的方法名称,在同一个命名空间里面不重复，否则将启动报错；
在任何情况下，id属性不能出现英文句点 '.' (Caused by: org.apache.ibatis.builder.BuilderException: Dots are not allowed in element names, please remove it) ;
注意事项：接口方法不能进行重载，在3.4版本后是错的！！！！！，因为可以分页！！！
1、接口中的所有重载方法对应XML里面的同一个ID，但是3.4之后有一个分页的插件，所以可以接受一个org.apache.ibatis.session.RowBounds的隐性参数。
2、虽然接口里面的方法可以进行重载，但是如果要在运行的时候依然不报错的话，需要一个前提：不要指定 parameterType 属性！！
接口方法如下：
SysUser selectById(Long id);
List<SysUser> selectById(Long id,RowBounds rowBound);
SysUser selectById(String name);
测试代码如下：
SysUserDao sysUserDao = sqlSession.getMapper(SysUserDao.class);
SysUser sysUser = sysUserDao.selectById(1L);
Assert.assertEquals("admin",sysUser.getUserName());
SysUser sysUser1 = sysUserDao.selectById("1");
Assert.assertEquals("admin",sysUser1.getUserName());
/*
plus.dao.SysUserDao.selectById - ==> Preparing: SELECT * FROM sys_user WHERE id = ?;
plus.dao.SysUserDao.selectById - ==> Parameters: 1(Long)
plus.dao.SysUserDao.selectById - <== Total: 1
plus.dao.SysUserDao.selectById - ==> Preparing: SELECT * FROM sys_user WHERE id = ?;
plus.dao.SysUserDao.selectById - ==> Parameters: 1(String)
plus.dao.SysUserDao.selectById - <== Total: 1
*/
RowBounds rowBound = new RowBounds(0,2);
List<SysUser> sysUsers = sysUserDao.selectById(1L,rowBound);
Assert.assertEquals(1,sysUsers.size());
/*
plus.dao.SysUserDao.selectById - ==> Preparing: SELECT * FROM sys_user WHERE id = ?;
plus.dao.SysUserDao.selectById - ==> Parameters: 1(Long)
plus.dao.SysUserDao.selectById - <== Total: 1
*/
事实证明，当不指定参数类型的时候（也仅仅当不指定参数类型的时候才可以，因为重载重载的是参数），是可以进行
接口方法重载的，因为mybatis的参数类型推断会自动的转换参数类型，比如：
sysUserDao.selectById("楚云飞");
因为ID的类型是Long类型，所以数据类型的自动转换失败，但是是不会出现异常的，只是它选取出来的数据集为null
-->
<select id="selectById" resultMap="sysUser" flushCache="true">
SELECT * FROM sys_user WHERE id = #{_parameter};
</select>
<!--
参数传递问题：
1、接口函数：
SysUser selectByCondition(Long id,String userName,String userPassword);
参数传递：
1、默认参数传递：默认的参数的命名为 param + 序位，SQL语句如下：
SELECT * FROM sys_user WHERE id = #{param1} AND user_name = #{param2} AND user_password = #{param3};
2、默认参数传递：直接序列参数，SQL语句如下：
SELECT * FROM sys_user WHERE id = #{0} AND user_name = #{1} AND user_password = #{2};
3、固定参数传递：
函数接口：
SysUser selectByCondition(@Param("id")Long id,@Param("userName")String userName,@Param("userPassword")String userPassword);
SQL语句如下：
SELECT * FROM sys_user WHERE id = #{id} AND user_name = #{userName} AND user_password = #{userPassword};
4、使用Map传递参数：
函数接口：SysUser selectByCondition(Map params);
调用代码段：
Map<String,Object> params = new HashMap<String,Object>(3);
params.put("id",1L);
params.put("userName","admin");
params.put("userPassword","123456");
SysUser sysUser1 = sysUserDao.selectByCondition(params);
Assert.assertEquals("admin@mybatis.tk",sysUser1.getUserEmail());
SQL语句：
SELECT * FROM sys_user WHERE id = #{id} AND user_name = #{userName} AND user_password = #{userPassword};
思考：
1、与固定参数的SQL相比，没有改变SQL语句，而且两个接口实现重载。
2、接口函数可以实现重载，但是需要SQL语句来兼容这个函数的重载，也就是可以进行有条件的重载。
5、使用 $ 和 # 进行取值的区别：
1. #将传入的数据都当成一个字符串，会对自动传入的数据加一个双引号。如：order by #user_id#，如果传入的值是111,那么解析成sql时的值为order by "111", 如果传入的值是id，则解析成的sql为order by "id".
2. $将传入的数据直接显示生成在sql中。如：order by $user_id$，如果传入的值是111,那么解析成sql时的值为order by user_id, 如果传入的值是id，则解析成的sql为order by id.
3. #方式能够很大程度防止sql注入。
4.$方式无法防止Sql注入。
5.$方式一般用于传入数据库对象，例如传入表名.
6.一般能用#的就别用$.
SELECT * FROM sys_user WHERE id = ${id} AND user_name = '${userName}' AND user_password = '${userPassword}';
-->
<select id="selectByCondition" resultMap="sysUser" flushCache="true">
SELECT * FROM sys_user WHERE id = #{id} AND user_name = #{userName} AND user_password = #{userPassword};
</select>
<resultMap id="sysUser" type="plus.pojo.SysUser">
<id property="id" column="id"/>
<result property="userName" column="user_name"/>
<result property="userPassword" column="user_password"/>
<result property="userEmail" column="user_email"/>
<result property="userInfo" column="user_info"/>
<result property="headImg" column="head_img" jdbcType="BLOB"/>
<result property="createTime" column="create_time" jdbcType="TIMESTAMP"/>
</resultMap>
</mapper>
3.6、完整的接口
public interface SysUserDao {
SysUser selectById(Long id);
List<SysUser> selectById(Long id,RowBounds rowBound);
SysUser selectById(String name);
SysUser selectByCondition(@Param("id")Long id,@Param("userName")String userName,@Param("userPassword")String userPassword);
SysUser selectByCondition(Map params);
}
MyBatis实现方法重载的小技巧
QuestionMapper.java
利用接口默认方法 default 实现
QuestionMapper.xml
利用动态sql对 userId 字段进行判断
以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。
相关推荐
-
Mybatis学习总结之mybatis使用建议
简介:什么是MyBatis? (前身为iBatis) MyBatis 是一个可以自定义SQL.存储过程和高级映射的持久层框架.MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索.MyBatis可以使用简单的XML或注解用于配置和原始映射,将接口和Java的POJO(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录. 1.Mapper层参数为Map,由Service层负责重载. Mapper由于机制的问题,不能重载,参数一般设置成Ma
-
Mybatis接口Mapper内的方法为啥不能重载吗
动态代理的功能:通过拦截器方法回调,对目标target方法进行增强. 言外之意就是为了增强目标target方法.上面这句话没错,但也不要认为它就是真理,殊不知,动态代理还有投鞭断流的霸权,连目标target都不要的科幻模式. 注:本文默认认为,读者对动态代理的原理是理解的,如果不明白target的含义,难以看懂本篇文章,建议先理解动态代理. 1. 自定义JDK动态代理之投鞭断流实现自动映射器Mapper 首先定义一个pojo. public class User { private Intege
-
Mybatis的Mapper中的方法为什么不能重载
前言 在初入门Mybatis的时候可能都犯过一个错误,那就是在写Mapper接口的时候都重载过其中的方法,但是运行起来总是报错,那时候真的挺郁闷的,但是自己也查不出来原因,只能默默的改了方法名,哈哈,多么卑微的操作. 今天就写一篇文章从源码角度为大家解惑为什么Mybatis中的方法不能重载? 环境配置 本篇文章讲的一切内容都是基于Mybatis3.5和SpringBoot-2.3.3.RELEASE. 错误示范 举个栗子:假设现在有两个需求,一个是根据用户的id筛选用户,一个是根据用户的性别筛选
-
关于Mybatis的mapper接口函数重载问题
目录 Mybatis的接口函数能不能进行重载? 语法层面 Mybatis框架方面 测试 MyBatis实现方法重载的小技巧 QuestionMapper.java QuestionMapper.xml Mybatis的接口函数能不能进行重载? mybatis版本:3.4x java版本:java 8 语法层面 1.接口的方法可以进行重载,因为 java 语法可以让接口函数进行重载. Mybatis框架方面 1.结论:可以有条件的进行重载. 2.为什么会有这个问题?:mybatis里面将接口里面的
-
SpringBoot+Mybatis使用Mapper接口注册的几种方式
目录 I. 环境准备 1. 数据库准备 2. 项目环境 II. 实例演示 1. 实体类,Mapper类 2. 注册方式 2.1 @MapperScan注册方式 2.2 @Mapper 注册方式 2.3 MapperScannerConfigurer注册方式 3. 小结 III. 不能错过的源码和相关知识点 SpringBoot项目中借助Mybatis来操作数据库,对大部分java技术栈的小伙伴来说,并不会陌生:我们知道,使用mybatis,一般会有下面几个 Entity: 数据库实体类 Mapp
-
使用Spring扫描Mybatis的mapper接口的三种配置
Spring扫描Mybatis的mapper接口的配置 1.前言 mybatis支持与spring结合使用,使得mybatis中的mapper接口可以作为spring容器中的bean被应用代码中相关类,如Service类,通过@Autowired自动注入进来. 在使用方面需要在项目中引入以下包: <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifac
-
SpringBoot+Mybatis实现Mapper接口与Sql绑定几种姿势
目录 I. 环境准备 1. 数据库准备 2. 项目环境 II. 实例演示 1. 实体类,Mapper接口 2. sql文件 3. Mapper与Sql绑定 3.1 默认方式 3.2 SpringBoot配置 3.3 Mapper标签 3.4 SqlSessionFactory 4. 小结 III. 不能错过的源码和相关知识点 通常我们在使用Mybatis进行开发时,会选择xml文件来写对应的sql,然后将Mapper接口与sql的xml文件建立绑定关系,然后在项目中调用mapper接口就可以执行
-
详解mybatis通过mapper接口加载映射文件
通过 mapper 接口加载映射文件,这对于后面 ssm三大框架 的整合是非常重要的.那么什么是通过 mapper 接口加载映射文件呢? 我们首先看以前的做法,在全局配置文件 mybatis-configuration.xml 通过 <mappers> 标签来加载映射文件,那么如果我们项目足够大,有很多映射文件呢,难道我们每一个映射文件都这样加载吗,这样肯定是不行的,那么我们就需要使用 mapper 接口来加载映射文件 以前的做法: 改进做法:使用 mapper 接口来加载映射文件 1.定义
-
详解Mybatis（五）Mapper接口
(1)Mapper接口和原理 Mapper组建 1.Mapper文件和Mapper接口应该放在同一个接口中 2.Mapper文件中的namespace应该设置为Mapper接口的全限定名称 3.Mapper文件中的操作元素ID对应Mapper接口的方法名称 Mapper原理: 动态代理 (2)配置文件 userMapper.xml <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PU
-
Mybatis MapperScannerConfigurer自动扫描Mapper接口生成代理注入到Spring的方法
前言 Mybatis MapperScannerConfigurer 自动扫描 将Mapper接口生成代理注入到Spring Mybatis在与Spring集成的时候可以配置 MapperFactoryBean来生成Mapper接口的代理. 例如: <bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean"> <property name="mappe
-
Mybatis Mapper接口工作原理实例解析
KeyWords: Mybatis 原理,源码,Mybatis Mapper 接口实现类,代理模式,动态代理,Java动态代理, Proxy.newProxyInstance,Mapper 映射,Mapper 实现 MyBatis 是一款优秀的持久层框架,它支持定制化 SQL.存储过程以及高级映射.MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集.我们在使用 Mybaits 进行 ,通常只需要定义几个 Mapper 接口,然后在编写一个 xml 文件,我们在配置文件中
-
java应用开发之Mybatis通过Mapper代理自定义接口的实现
如何实现?主要分为以下两步骤 1.通过 Mapper 代理实现⾃定义接口 2.编写与方法相对应的 Mapper.xml 1.自定义接口AccountRepository package repository; import entity.Account; import java.util.List; public interface AccountRepository { public int save(Account account); public int update(Account ac