这篇博客主要是记录Mybatis的基本用法,包括Mybatis的入参形式、返回参数形式以及
resultMap
的使用方法的介绍。
mapper接口代理实现编写规则
1. 映射文件中namespace要等于接口的全路径名称
2. 映射文件中sql语句id要等于接口的方法名称
3. 映射文件中传入参数类型要等于接口方法的传入参数类型
4. 映射文件中返回结果集类型要等于接口方法的返回值类型
select用法
XML中的select标签的id属性值和定义在接口方法名是一样的。
先来了解一下XML中一些标签和属性的作用。
-
select
:映射查询语句使用的标签 -
id
:命名空间中的唯一标识符,可用来代表这条语句 -
parameterType
:指定输入参数的类型 -
resultType
:指定sql输出结果的所映射的java对象类型。select指定resultType表示将单条记录映射成的Java对象。 -
#{countyCode}
:MybatisSQL中使用预编译参数的一种方式,大括号中的countyCode是传入的参数名。(如果输入参数是简单类型(string,long,double,int,boolean,float等),#{}中的参数名可以任意,可以value或者其他) -
resultMap
:用于配置Java对象的属性和查询结果列的对应关系,通过resultMap中配置的column和property可以将查询列的值映射到type对象的属性上。
多个接口参数的方法
1.直接使用POJO类参数
直接使用#{对象的属性名}即可引用对象的property属性。Mybatis通过getter()来获取值.
INSERT INTO users (name, sex, p)
VALUES (#{name},
#{sex}
);
接口文件
public interface UserDao {
public void insertUser(User user);
}
2.使用Map传递参数,直接设置parameterType为map
这个方法虽然简单易用,但是有一个弊端:这样设置的参数使用了Map,而Map需要键值对应,由于业务关联性不强,你需要深入到程序中看代码,造成可读性下降。Mybatis为我们提供了更好的是实现方法,它就是注解参数的形式,让我们看看如何实现
3.在代码中使用@Param注解
boolean updateModuleStatus(@Param("companySid") int companySid, @Param("moduleStatus") int moduleStatus);
UPDATE t_module SET
module_status = #{moduleStatus}
WHERE company_sid = #{companySid}
使用@Param注解传递多个参数,这种方式的使用受到参数个数(n)的影响。当n<=5时,它是最佳的传参方式,它比用JavaBean更好,因为它更加直观,当n>5时,建议使用JavaBean方式。
resultMap
与resultType
详解
元素 | 说明 | 备注 |
---|---|---|
resultType | 定义类的全路径,在允许自动匹配的情况下,结果集将通过JavaBean的规范映射,或定义为int、double、float等参数,也可以使用别名但是要符合别名规范,不能和resultMap同时使用 | |
resultMap | 它是映射集的引用,将执行强大的映射功能 |
我们虽然有自动映射,但是在某些时候,我们需要处理更为复杂的映射,resultMap为我们提供了这样的模式。我们需要在映射器中定义resultMap,这也是我们常见的场景。
Insert用法
insert元素,相对于select元素而言要简单许多。Mybatis会在执行插入之后返回一个整数,以表示你进行操作后插入的记录数。
属性名称 | 描述 | 备注 |
---|---|---|
id | 它和Mapper的命名空间组合起来是唯一的,作为唯一标识提供给Mybatis调用 | 如不唯一,Mybatis将抛出异常 |
parameterType | 我们可以选择JavaBean、Map等参数类型传递给SQL |
insert into Author (id,username,password,email,bio)
values (#{id},#{username},#{password},#{email},#{bio})
int insertAuthor(Author author)
主键回填和自定义
现实中有许多我们需要处理的问题,例如,主键自增字段,MySQL里面的主键需要根据一些特殊的规则去生成,在插入后我们往往需要获得这个主键,以便于未来的操作,而Mybatis提供了实现的方法。
首先我们可以使用keyProperty属性指定的哪个是主键字段,同时使用useGenerateKeys属性告诉Mybatis这个主键是否使用数据库内置策略生成。
我们的例子中t_role表就是指定id列为自增字段。因此我们建立POJO,它能提供setter和getter方法,这样便能够使用Mybatis的主键回填功能了。那么我们可以在XML中进行如下配置:
insert into t_role(role_name,note) values (#{roleName},#{note})
这样我们传入的role对象就无需设置id的值,Mybatis会用数据库的设置进行处理。这样做的好处是在Mybatis插入的时候,它会回填JavaBean的id值。我们进行调试,在插入后,它自动填充主键,方便以后使用。
//回填之后取出id值
role.getId()
实际工作往往不是我们想象的那么简单,需要根据一些特殊的关系设置主键id的值。假设我们取消表t_role的id自增的规则,我们的要求是:如果表t_role没有记录,则我们需要设置id=1,否则我们就去最大id加2,来设置新的主键,对于一些特殊要求,Mybatis也提供了对应的方法。这个时候我们可以使用selectKey元素处理,操作方法如下:
select if(max(id) is null ,1,max(id)+2 ) as newId from t_role
insert into t_role(role_name,note) values (#{roleName},#{note})
update用法和delete用法
update Author set
username = #{username},
password = #{password},
email = #{email},
bio = #{bio}
where id = #{id}
delete from Author where id = #{id}
resultMap结果映射集
resultMap是Mybatis里面最复杂的元素。它的作用是定义映射规则、级联的更新、定制类型转化器等。resultMap定义的主要是一个结果集的映射关系。
类型元素 | 含义 |
---|---|
constructor | 用于配置构造方法 |
idArg | 构造函数中的参数 |
arg | 构造函数中的参数 |
id | id元素表示那列是主键,允许多个主键,多个主键则称为联合主键 |
result | result是配置POJO到SQL列名的映射关系 |
association | 代表一对一关系 |
collection | 代表一对多关系 |
discriminator | 是鉴别器,它可以根据实际选择采用那个类作为实例,允许你根据特定的条件去关联不同的结果集。比如,人有男人和女人。你可以实例化一个人的对象,但是要根据情况用男人类或者女人类去实例化 |
case | 基于某些值的结果映射 |
resultMap
元素的属性id代表这个resultMap
的标志,type
代表着需要映射的pojo
。我们可以使用mybatis
定义好的类的别名,也可以使用自定义的类的权限定名。
使用map存储结果集
一般而言,任何select语句都可以使用map存储。
使用map的原则上是可以匹配所有的结果集的,但是使用map接口就意味着可读性的下降,所以这不是一种推荐的方式。更多的时候我们使用的是POJO方式。
使用POJO存储结果集
使用map方式就意味着可读性的下降。POJO是我们最常用的方式,也是我们推荐的方式。一方面我们可以使用自动映射,正如select语句里论述的一样。我们还可以使用select语句的属性resultMap配置映射集合,只是使用前需要配置类似的resultMap。
resultMap元素的属性id代表这个resultMap的标识,type代表着你需要映射的POJO。我们可以使用Mybatis定义好的类的别名,也可以使用自定义的类的全限定名。
映射关系中,id元素表示这个对象的主键,property代表POJO的属性名称,column表示数据库SQL的列名,于是POJO就和数据库SQL的结果一一对应起来了。接着我们在映射文件中的select元素里面做下面的配置,便可以使用了。
别名设置
在mybatis.xml
设置要添加的别名,如下:
然后在Mapper.xml
在parameterType
中设置为别名就可以了
参考资料
https://www.jianshu.com/p/7ac818945c2f
https://www.jianshu.com/p/9a3c8e3a63bf
http://www.mybatis.org/mybatis-3/zh/sqlmap-xml.html