Mybatis-3

0. 案例环境

0.1 案例数据初始化sql

  1. CREATE DATABASE /*!32312 IF NOT EXISTS*/`mybatis_db` /*!40100 DEFAULT CHARACTER SET utf8 */;
  3. USE `mybatis_db`;
  4. DROP TABLE IF EXISTS `orders`;
  5. CREATE TABLE `orders` (
  6.   `id` int(11) NOT NULL AUTO_INCREMENT,
  7.   `createtime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '创建时间',
  8.   `price` int(11) DEFAULT NULL COMMENT '价格',
  9.   `remark` varchar(100) DEFAULT NULL COMMENT '备注',
  10.   `user_id` int(11) DEFAULT NULL COMMENT '用户id',
  11.   PRIMARY KEY (`id`)
  12. ) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;
  13. insert  into `orders`(`id`,`createtime`,`price`,`remark`,`user_id`) values (1,'2014-06-26 16:55:43',2000,'无',2),(2,'2021-02-23 16:55:57',3000,'无',3),(3,'2021-02-23 16:56:21',4000,'无',2);
  14. DROP TABLE IF EXISTS `role`;
  16. CREATE TABLE `role` (
  17.   `id` int(11) NOT NULL AUTO_INCREMENT,
  18.   `name` varchar(100) DEFAULT NULL COMMENT '角色名',
  19.   `desc` varchar(100) DEFAULT NULL COMMENT '角色描述',
  20.   PRIMARY KEY (`id`)
  21. ) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;
  23. /*Data for the table `role` */
  25. insert  into `role`(`id`,`name`,`desc`) values (1,'总经理','一人之下'),(2,'CFO',NULL);
  27. /*Table structure for table `user` */
  29. DROP TABLE IF EXISTS `user`;
  31. CREATE TABLE `user` (
  32.   `id` int(11) NOT NULL AUTO_INCREMENT,
  33.   `username` varchar(50) DEFAULT NULL,
  34.   `age` int(11) DEFAULT NULL,
  35.   `address` varchar(50) DEFAULT NULL,
  36.   PRIMARY KEY (`id`)
  37. ) ENGINE=InnoDB AUTO_INCREMENT=33 DEFAULT CHARSET=utf8;
  39. /*Data for the table `user` */
  41. insert  into `user`(`id`,`username`,`age`,`address`) values (2,'pdd',26,NULL),(3,'UZI',19,'上海11'),(4,'RF',19,NULL);
  43. /*Table structure for table `user_role` */
  45. DROP TABLE IF EXISTS `user_role`;
  47. CREATE TABLE `user_role` (
  48.   `user_id` int(11) DEFAULT NULL,
  49.   `role_id` int(11) DEFAULT NULL
  50. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
  52. /*Data for the table `user_role` */
  54. insert  into `user_role`(`user_id`,`role_id`) values (2,2),(2,1),(3,1);

0.2 实体类

0.2.1 User.java

  1. public class User {
  3.     private Integer id;
  5.     private String username;
  7.     private Integer age;
  9.     private String address;
  12.     @Override
  13.     public String toString() {
  14.         return "User{" +
  15.                 "id=" + id +
  16.                 ", username='" + username + '\'' +
  17.                 ", age=" + age +
  18.                 ", address='" + address + '\'' +
  19.                 '}';
  20.     }
  22.     public Integer getId() {
  23.         return id;
  24.     }
  26.     public void setId(Integer id) {
  27.         this.id = id;
  28.     }
  30.     public String getUsername() {
  31.         return username;
  32.     }
  34.     public void setUsername(String username) {
  35.         this.username = username;
  36.     }
  38.     public Integer getAge() {
  39.         return age;
  40.     }
  42.     public void setAge(Integer age) {
  43.         this.age = age;
  44.     }
  46.     public String getAddress() {
  47.         return address;
  48.     }
  50.     public void setAddress(String address) {
  51.         this.address = address;
  52.     }
  54.     public User() {
  55.     }
  57.     public User(Integer id, String username, Integer age, String address) {
  58.         this.id = id;
  59.         this.username = username;
  60.         this.age = age;
  61.         this.address = address;
  62.     }
  64. }

0.2.2 Order.java

  1. public class Order {
  2.     private Integer id;
  3.     private Date createtime;
  4.     private Integer price;
  5.     private String remark;
  6.     private Integer userId;
  8.     @Override
  9.     public String toString() {
  10.         return "Order{" +
  11.                 "id=" + id +
  12.                 ", createtime=" + createtime +
  13.                 ", price=" + price +
  14.                 ", remark='" + remark + '\'' +
  15.                 ", userId=" + userId +
  16.                 '}';
  17.     }
  18.       public Order() {
  19.     }
  20.     public Integer getId() {
  21.         return id;
  22.     }
  24.     public void setId(Integer id) {
  25.         this.id = id;
  26.     }
  28.     public Date getCreatetime() {
  29.         return createtime;
  30.     }
  32.     public void setCreatetime(Date createtime) {
  33.         this.createtime = createtime;
  34.     }
  36.     public Integer getPrice() {
  37.         return price;
  38.     }
  40.     public void setPrice(Integer price) {
  41.         this.price = price;
  42.     }
  44.     public String getRemark() {
  45.         return remark;
  46.     }
  48.     public void setRemark(String remark) {
  49.         this.remark = remark;
  50.     }
  52.     public Integer getUserId() {
  53.         return userId;
  54.     }
  56.     public void setUserId(Integer userId) {
  57.         this.userId = userId;
  58.     }
  60.     public Order(Integer id, Date createtime, Integer price, String remark, Integer userId) {
  61.         this.id = id;
  62.         this.createtime = createtime;
  63.         this.price = price;
  64.         this.remark = remark;
  65.         this.userId = userId;
  66.     }
  67. }

0.2.3 Role.java

  2. public class Role {
  3.     private Integer id;
  4.     private String name;
  5.     private String desc;
  7.     @Override
  8.     public String toString() {
  9.         return "Role{" +
  10.                 "id=" + id +
  11.                 ", name='" + name + '\'' +
  12.                 ", desc='" + desc + '\'' +
  13.                 '}';
  14.     }
  15.     public Role() {
  16.     }
  17.     public Integer getId() {
  18.         return id;
  19.     }
  21.     public void setId(Integer id) {
  22.         this.id = id;
  23.     }
  25.     public String getName() {
  26.         return name;
  27.     }
  29.     public void setName(String name) {
  30.         this.name = name;
  31.     }
  33.     public String getDesc() {
  34.         return desc;
  35.     }
  37.     public void setDesc(String desc) {
  38.         this.desc = desc;
  39.     }
  41.     public Role(Integer id, String name, String desc) {
  42.         this.id = id;
  43.         this.name = name;
  44.         this.desc = desc;
  45.     }
  46. }

1. ResultMap

1.1 基本使用

  1. 我们可以使用resultMap标签自定义结果集和实体类属性的映射规则。
  1.     <!--
  2.         resultMap 用来自定义结果集和实体类的映射
  3.             属性：
  4.                 id 相当于这个resultMap的唯一标识
  5.                 type 用来指定映射到哪个实体类
  6.         id标签  用来指定主键列的映射规则
  7.             属性：
  8.                 property 要映射的属性名
  9.                 column  对应的列名
  10.         result标签 用来指定普通列的映射规则
  11.             属性：
  12.                 property 要映射的属性名
  13.                 column 对应的列名
  14.     -->
  15.     <resultMap id="orderMap" type="com.sangeng.pojo.Order" >
  16.         <id column="id" property="id"></id>
  17.         <result column="createtime" property="createtime"></result>
  18.         <result column="price" property="price"></result>
  19.         <result column="remark" property="remark"></result>
  20.         <result column="user_id" property="userId"></result>
  21.     </resultMap>
  23.     <!--使用我们自定义的映射规则-->
  24.     <select id="findAll" resultMap="orderMap">
  25.         SELECT id,createtime,price,remark,user_id  FROM ORDERS
  26.     </select>

1.2 自动映射

  1. 我们定义resultMap时默认情况下自动映射是开启状态的。也就是如果结果集的列名和我们的属性名相同是会自动映射的我们只需要写特殊情况的映射关系即可。

例如：

下面这种写法和上面的写法会有相同的效果，因为其他属性的属性名和结果集的列名都是相同的会自动映射。

  1.     <resultMap id="orderMap" type="com.sangeng.pojo.Order" >
  2.         <result column="user_id" property="userId"></result>
  3.     </resultMap>
  4.     <!--使用我们自定义的映射规则-->
  5.     <select id="findAll" resultMap="orderMap">
  6.         SELECT id,createtime,price,remark,user_id  FROM ORDERS
  7.     </select>
  1. 如有需要可以选择关闭自动映射可以把resultMap的autoMapping属性设置为false。

例如：

  1.     <resultMap id="orderMap" type="com.sangeng.pojo.Order" autoMapping="false">
  2.         <id column="id" property="id"></id>
  3.         <result column="createtime" property="createtime"></result>
  4.         <result column="price" property="price"></result>
  5.         <result column="remark" property="remark"></result>
  6.         <result column="user_id" property="userId"></result>
  7.     </resultMap>

1.3 继承映射关系

  1. 我们可以使用resultMap 的extends属性来指定一个resultMap，从而复用重复的映射关系配置。

例如：

  1.       <!--定义个父映射，供其他resultMap继承-->
  2.     <resultMap id="baseOrderMap" type="com.sangeng.pojo.Order" >
  3.         <id column="id" property="id"></id>
  4.         <result column="createtime" property="createtime"></result>
  5.         <result column="price" property="price"></result>
  6.         <result column="remark" property="remark"></result>
  7.     </resultMap>
  8.     <!--继承baseOrderMap，然后只需要写自己特有的映射关系即可-->
  9.     <resultMap id="orderMap" type="com.sangeng.pojo.Order" autoMapping="false" extends="baseOrderMap">
  10.         <result column="user_id" property="userId"></result>
  11.     </resultMap>

2. 多表查询

  1. 有的时候我们需要查询多张表的数据才可以得到我们要的结果。
  3. 我们可以直接写一个多表关联的SQL进行查询。也可以分步进行多次的查询来拿到我们需要的结果。
  5. Mybatis就提供了对应的配置，可以让我们去更方便的进行相应的查询和对应的结果集处理。

2.1 多表关联查询

2.1.1 一对一关系

  1. 两个实体之间是一对一的关系。(例如我们需要查询订单，要求还需要下单用户的数据。这里的订单相对于用户是一对一。)

例如：

方法定义如下

  1.     //根据订单id查询订单，要求把下单用户的信息也查询出来
  2.     Order findById(Integer id);

因为期望Order中还能包含下单用户的数据，所以可以再Order中增加一个属性

  1. private User user;

SQL语句如下

  2. SELECT 
  3.     o.id,o.`createtime`,o.`price`,o.`remark`,o.`user_id`,u.`id` uid,u.`username`,u.`age`,u.`address`
  4. FROM 
  5.     orders o,USER u
  6. WHERE
  7.     o.`user_id` = u.`id`
  8.     AND o.id = 2

结果集

image-2.png

我们可以使用如下两种方式封装结果集。

2.1.1.1 使用ResultMap对所有字段进行映射
  1. 可以使用ResultMap设置user对象的属性的映射规则。

①resultMap定义，主要是对user对象的属性设置映射规则

  1.      <resultMap id="baseOrderMap" type="com.sangeng.pojo.Order" >
  2.         <id column="id" property="id"></id>
  3.         <result column="createtime" property="createtime"></result>
  4.         <result column="price" property="price"></result>
  5.         <result column="remark" property="remark"></result>
  6.     </resultMap>
  8.     <resultMap id="orderMap" type="com.sangeng.pojo.Order" autoMapping="false" extends="baseOrderMap">
  9.         <result column="user_id" property="userId"></result>
  10.     </resultMap>
  12.     <!--Order和User关联的映射-->
  13.     <resultMap id="orderUserMap" type="com.sangeng.pojo.Order" autoMapping="false" extends="orderMap">
  14.         <result property="user.id" column="uid"></result>
  15.         <result property="user.username" column="username"></result>
  16.         <result property="user.age" column="age"></result>
  17.         <result property="user.address" column="address"></result>
  18.     </resultMap>

②使用定义好的resultMap

  1. <!--根据订单id查询订单，要求把下单用户的信息也查询出来-->
  2.     <select id="findById" resultMap="orderUserMap">
  3.         SELECT
  4.             o.`id`,o.`createtime`,o.`price`,o.`remark`,o.`user_id`,u.`id` uid,u.`username`,u.`age`,u.`address`
  5.         FROM
  6.             orders o,`user` u
  7.         WHERE
  8.             o.id = #{id} AND
  9.             o.`user_id`=u.`id`
  10.     </select>

2.1.1.2 使用ResultMap中的association
  1. 可以使用ResultMap中的子标签association 来设置关联实体类的映射规则.

①定义resultMap

  1.      <resultMap id="baseOrderMap" type="com.sangeng.pojo.Order" >
  2.         <id column="id" property="id"></id>
  3.         <result column="createtime" property="createtime"></result>
  4.         <result column="price" property="price"></result>
  5.         <result column="remark" property="remark"></result>
  6.     </resultMap>
  8.     <resultMap id="orderMap" type="com.sangeng.pojo.Order" autoMapping="false" extends="baseOrderMap">
  9.         <result column="user_id" property="userId"></result>
  10.     </resultMap>
  12.     <!--Order和User关联的映射（使用association）-->
  13.     <resultMap id="orderUserMapUseAssociation" type="com.sangeng.pojo.Order" autoMapping="false" extends="orderMap">
  14.         <association property="user" javaType="com.sangeng.pojo.User">
  15.             <id property="id" column="uid"></id>
  16.             <result property="username" column="username"></result>
  17.             <result property="age" column="age"></result>
  18.             <result property="address" column="address"></result>
  19.         </association>
  20.     </resultMap>

②使用resultMap

  1. <!--根据订单id查询订单，要求把下单用户的信息也查询出来-->
  2.     <select id="findById" resultMap="orderUserMapUseAssociation">
  3.         SELECT
  4.             o.`id`,o.`createtime`,o.`price`,o.`remark`,o.`user_id`,u.`id` uid,u.`username`,u.`age`,u.`address`
  5.         FROM
  6.             orders o,`user` u
  7.         WHERE
  8.             o.id = #{id} AND
  9.             o.`user_id`=u.`id`
  10.     </select>

2.1.2 一对多关系

  1. 两个实体之间是一对多的关系。(例如我们需要查询用户，要求还需要该用户所具有的角色信息。这里的用户相对于角色是一对多的。)

例如：

方法定义如下

  1.     //根据id查询用户，并且要求把该用户所具有的角色信息也查询出来
  2.     User findById(Integer id);

因为期望User中还能包含该用户所具有的角色信息，所以可以在User中增加一个属性

  1. //    该用户所具有的角色
  2.     private List<Role> roles;

SQL语句如下

  1. SELECT 
  2.     u.`id`,u.`username`,u.`age`,u.`address`,r.id rid,r.name,r.desc
  3. FROM 
  4.     USER u,user_role ur,role r
  5. WHERE 
  6.     u.id=ur.user_id AND ur.role_id = r.id
  7.     AND u.id = 2

结果集
image-3.png
我们可以使用如下的方式封装结果集。

2.1.2.1 使用ResultMap中的collection
  1. 可以使用ResultMap中的子标签association 来设置关联实体类的映射规则.

①定义ResultMap

  1.     <!--定义User基本属性映射规则-->
  2.     <resultMap id="userMap" type="com.sangeng.pojo.User">
  3.         <id property="id" column="id"></id>
  4.         <result property="username" column="username"></result>
  5.         <result property="age" column="age"></result>
  6.         <result property="address" column="address"></result>
  7.     </resultMap>
  9.     <resultMap id="userRoleMap" type="com.sangeng.pojo.User"  extends="userMap">
  10.         <collection property="roles" ofType="com.sangeng.pojo.Role" >
  11.             <id property="id" column="rid"></id>
  12.             <result property="name" column="name"></result>
  13.             <result property="desc" column="desc"></result>
  14.         </collection>
  15.     </resultMap>

②使用ResultMap

  2.     <select id="findById" resultMap="userRoleMap" >
  3.         SELECT 
  4.             u.`id`,u.`username`,u.`age`,u.`address`,r.id rid,r.name,r.desc
  5.         FROM 
  6.             USER u,user_role ur,role r
  7.         WHERE 
  8.             u.id=ur.user_id AND ur.role_id = r.id
  9.             AND u.id = #{id}
  10.     </select>

最终封装完的结果如下：
image-5.png

2.2 分步查询

  1. 如果有需要多表查询的需求我们也可以选择用多次查询的方式来查询出我们想要的数据。Mybatis也提供了对应的配置。
  3. 例如我们需要查询用户，要求还需要查询出该用户所具有的角色信息。我们可以选择先查询User表查询用户信息。然后在去查询关联的角色信息。

2.2.1实现步骤

  1. 具体步骤如下：

①定义查询方法
  1. 因为我们要分两步查询: 1.查询User 2.根据用户的id查询Role  所以我们需要定义下面两个方法，并且把对应的标签也先写好

1.查询User

  1.     //根据用户名查询用户，并且要求把该用户所具有的角色信息也查询出来
  2.     User findByUsername(String username);
  1.     <!--根据用户名查询用户-->
  2.     <select id="findByUsername" resultType="com.sangeng.pojo.User">
  3.         select id,username,age,address from user where username = #{username}
  4.     </select>

2.根据user_id查询Role

  1. public interface RoleDao {
  2.     //根据userId查询所具有的角色
  3.     List<Role> findRoleByUserId(Integer userId);
  4. }
  1.     <!--根据userId查询所具有的角色-->
  2.     <select id="findRoleByUserId" resultType="com.sangeng.pojo.Role">
  3.         select 
  4.             r.id,r.name,r.desc
  5.         from 
  6.             role r,user_role ur
  7.         where 
  8.             ur.role_id = r.id
  9.             and ur.user_id = #{userId}
  10.     </select>

②配置分步查询
  1. 我们期望的效果是调用findByUsername方法查询出来的结果中就包含角色的信息。所以我们可以设置findByUsername方法的RestltMap，指定分步查询
  1.     <resultMap id="userMap" type="com.sangeng.pojo.User">
  2.         <id property="id" column="id"></id>
  3.         <result property="username" column="username"></result>
  4.         <result property="age" column="age"></result>
  5.         <result property="address" column="address"></result>
  6.     </resultMap>
  7.     <!--
  8.            select属性：指定用哪个查询来查询当前属性的数据 写法：包名.接口名.方法名
  9.            column属性：设置当前结果集中哪列的数据作为select属性指定的查询方法需要参数
  10.        -->
  11.     <resultMap id="userRoleMapBySelect" type="com.sangeng.pojo.User" extends="userMap">
  12.         <collection property="roles"
  13.                     ofType="com.sangeng.pojo.Role"
  14.                     select="com.sangeng.dao.RoleDao.findRoleByUserId"
  15.                     column="id">
  16.         </collection>
  17.     </resultMap>
  1. 指定findByUsername使用我们刚刚创建的resultMap
  1.     <!--根据用户名查询用户-->
  2.     <select id="findByUsername" resultMap="userRoleMapBySelect">
  3.         select id,username,age,address from user where username = #{username}
  4.     </select>

2.2.2 设置按需加载

  1. 我们可以设置按需加载，这样在我们代码中需要用到关联数据的时候才会去查询关联数据。
  3. 有两种方式可以配置分别是全局配置和局部配置
  1. 局部配置
    设置fetchType属性为lazy 
    1. <resultMap id="userRoleMapBySelect" type="com.sangeng.pojo.User" extends="userMap">
    2.     <collection property="roles"
    3.                 ofType="com.sangeng.pojo.Role"
    4.                 select="com.sangeng.dao.RoleDao.findRoleByUserId"
    5.                 column="id" fetchType="lazy">
    6.     </collection>
    7. </resultMap>
  1. 全局配置
    设置lazyLoadingEnabled为true 
    1. <settings>
    2.    <setting name="lazyLoadingEnabled" value="true"/>
    3. </settings>

3.分页查询-PageHelper

  1. 我们可以使用PageHelper非常方便的帮我们实现分页查询的需求。不需要自己在SQL中拼接SQL相关参数，并且能非常方便的获取的总页数总条数等分页相关数据。

3.1 实现步骤

①定义方法查询方法以及生成对应标签

  1.     List<User> findAll();
  1.     <select id="findAll" resultType="com.sangeng.pojo.User">
  2.         select id,username,age,address from user
  3.     </select>

② 引入依赖

  1. <dependency>
  2.     <groupId>com.github.pagehelper</groupId>
  3.     <artifactId>pagehelper</artifactId>
  4.     <version>4.0.0</version>
  5. </dependency>

③ 配置Mybatis核心配置文件使用分页插件

  1.  <plugins>
  2.         <!-- 注意：分页助手的插件  配置在通用馆mapper之前 -->
  3.         <plugin interceptor="com.github.pagehelper.PageHelper">
  4.             <!-- 指定方言 -->
  5.             <property name="dialect" value="mysql"/>
  6.         </plugin>
  7.     </plugins>

④ 开始分页查询

我们只需要在使用查询方法前设置分页参数即可

  1.     //设置分页参数
  2.     UserDao userDao = session.getMapper(UserDao.class);
  3.     //设置分页查询参数
  4.     PageHelper.startPage(1,1);
  5.     List<User> users = userDao.findAll();
  6.     System.out.println(users.get(0));

如果需要获取总页数总条数等分页相关数据，只需要创建一个PageInfo对象，把刚刚查询出的返回值做为构造方法参数传入。然后使用pageInfo对象获取即可。

  1.     PageInfo<User> pageInfo = new PageInfo<User>(users);
  2.     System.out.println("总条数："+pageInfo.getTotal());
  3.     System.out.println("总页数："+pageInfo.getPages());
  4.     System.out.println("当前页："+pageInfo.getPageNum());
  5.     System.out.println("每页显示长度："+pageInfo.getPageSize());

3.2 一对多多表查询分页问题

  1. 我们在进行一对多的多表查询时，如果使用了PageHelper进行分页。会出现关联数据不全的情况。我们可以使用分步查询的方式解决该问题。

4.Mybatis缓存

  1. Mybatis的缓存其实就是把之前查到的数据存入内存（map）,下次如果还是查相同的东西，就可以直接从缓存中取，从而提高效率。
  3. Mybatis有一级缓存和二级缓存之分，一级缓存（默认开启）是sqlsession级别的缓存。二级缓存相当于mapper级别的缓存。

4.1 一级缓存

几种不会使用一级缓存的情况
1.调用相同方法但是传入的参数不同
2.调用相同方法参数也相同，但是使用的是另外一个SqlSession
3.如果查询完后，对同一个表进行了增，删改的操作，都会清空这sqlSession上的缓存
4.如果手动调用SqlSession的clearCache方法清除缓存了，后面也使用不了缓存

4.2 二级缓存

  1. 注意：只在sqlsession调用了close或者commit后的数据才会进入二级缓存。

4.2.1 开启二级缓存

①全局开启

在Mybatis核心配置文件中配置

  1.     <settings>
  2.         <setting name="cacheEnabled" value="true"/>
  3.     </settings>

②局部开启

在要开启二级缓存的mapper映射文件中设置 cache标签

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
  3. <mapper namespace="com.sangeng.dao.RoleDao">
  4.     <cache></cache>
  5. </mapper>

4.2.2 使用建议

  1. 二级缓存在实际开发中基本不会使用。