MyBatis 映射教程

Posted 2020-08-06 总结和积累的地方

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了MyBatis 映射教程相关的知识，希望对你有一定的参考价值。

认识MyBatis

MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。2013年11月迁移到Github。
iBATIS一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。iBATIS提供的持久层框架包括SQL Maps和Data Access Objects（DAO）

mybatis图册

技术分享

简介

　　前面说过了简单的数据库查询和管理查询，在开发需求中有一些一对一、一对多和多对多的需求开发，如在开发购物车的时候，订单和用户是一对一，用户和订单是一对多，用户和商品是多对多。这些在Hibernate开发中也是常见的，Hibernate中是通过数据映射来实现的，在MyBatis中也是通过配置文件的数据映射来实现。

一对一查询

　　如果我们要查询订单信息，关联查询创建订单的用户信息，那么这就是典型的一对一查询。实现一对一查询有两种实现方式：使用resultType和resultMap。resultType需要额外定义POJO，然后把查询的字段和新定义的POJO一一对应。resultMap则需要通过配置文件来实现两个POJO的一对一关联。下面我们就这两种方式来分别实现。

　　resultType：

　　1、创建POJO，将需要映射的新的属性加入到新的POJO中。

 1  public class OrderCustom extends Orders{
 2    //添加用户信息
 3    private String username;
 4    private String sex;
 5    private String address;
 6    public String getUsername() {
 7      return username;
 8    }
 9    public void setUsername(String username) {
10      this.username = username;
11    }
12    public String getSex() {
13      return sex;
14    }
15    public void setSex(String sex) {
16      this.sex = sex;
17    }
18    public String getAddress() {
19      return address;
20    }
21    public void setAddress(String address) {
22      this.address = address;
23    }
24  }

　　2、映射文件：

 1  <select id="findOrderUser" resultType="com.luchao.mybatis.first.po.OrderCustom">
 2      select
 3      orders.*,
 4      user.username,
 5      user.sex,
 6      user.address
 7      from orders,user
 8      where
 9      orders.user_id = user.id
10  </select>

　　3、Mapper接口的实现：

1 //查询订单和用户信息
2  public List<OrderCustom> findOrderUser() throws Exception;

　　4、测试代码：

1  public void findOrdersUser() throws Exception {
2      // 获取sqlSession对象
3      SqlSession sqlSession = sqlSessionFactory.openSession();
4      // 创建OrderMapper对象，MyBatis自动生成mapper代理
5      OrderMapper orderMapper = sqlSession.getMapper(OrderMapper.class);
6      // 调用orderMapper的方法，查询订单和用户信息
7      List<OrderCustom> orderCustoms = orderMapper.findOrderUser();
8      System.out.println(orderCustoms.size());
9  }

　　resultMap实现：

　　resultMap将查询结果中的订单信息映射到Orders对象中，在orders类中添加User属性，将关联查询出来的用户信息映射到orders对象中的user属性中。

　　1、创建POJO，在Order类中加入User属性。

 1 public class Orders {
 2    private Integer id;
 3    private Integer userId;
 4    private String number;
 5    private Date createtime;
 6    private String note;
 7    //用户信息
 8    private User user;
 9    //订单条目
10    private List<Orderdetail> orderdetails;
11    public Integer getId() {
12      return id;
13    }
14    public void setId(Integer id) {
15      this.id = id;
16    }
17    public Integer getUserId() {
18      return userId;
19    }
20    public void setUserId(Integer userId) {
21      this.userId = userId;
22    }
23    public String getNumber() {
24      return number;
25    }
26    public void setNumber(String number) {
27      this.number = number == null ? null : number.trim();
28    }
29    public Date getCreatetime() {
30      return createtime;
31    }
32    public void setCreatetime(Date createtime) {
33      this.createtime = createtime;
34    }
35    public String getNote() {
36      return note;
37    }
38    public void setNote(String note) {
39      this.note = note == null ? null : note.trim();
40    }
41    public User getUser() {
42      return user;
43    }
44    public void setUser(User user) {
45      this.user = user;
46    }
47    public List<Orderdetail> getOrderdetails() {
48      return orderdetails;
49    }
50    public void setOrderdetails(List<Orderdetail> orderdetails) {
51      this.orderdetails = orderdetails;
52    }  
53  }

　　2、映射文件：

 1  <!-- 订单查询关联用户的resultMap,将整个查询结果映射到orders中 -->
 2    <resultMap type="com.luchao.mybatis.first.po.Orders" id="ordersUserResultMap">
 3      <id column="id" property="id" />
 4      <result column="user_id" property="userId" />
 5      <result column="number" property="number" />
 6      <result column="createtime" property="createtime" />
 7      <result column="note" property="note" />
 8      <!-- 配置映射的关联的用户信息 -->
 9      <!-- association：用于映射关联查询单个对象的信息 property：要将关联查询的用户信息映射到Orders中哪个属性 -->
10      <association property="user" javaType="com.luchao.mybatis.first.po.User">
11        <!-- id：关联查询用户的唯 一标识 column：指定唯 一标识用户信息的列 javaType：映射到user的哪个属性 -->
12        <id column="user_id" property="id" />
13        <result column="username" property="username" />
14        <result column="sex" property="sex" />
15        <result column="address" property="address" />
16      </association>
17    </resultMap>
18  <select id="findOrderUserMap" resultMap="ordersUserResultMap">
19      select
20      orders.*,
21      user.username,
22      user.sex,
23      user.address
24      from orders,user
25      where
26      orders.user_id = user.id
27    </select>

　　association：用于映射关联查询单个对象的信息，property：要将关联查询的用户信息映射到Orders中哪个属性。

　　3、Mapper接口

1 //查询订单和用户信息通过resultMap
2  public List<Orders> findOrderUserMap() throws Exception;

　　4、测试代码：

1 public void findOrdersUserMap() throws Exception {
2      // 获取sqlSession对象
3      SqlSession sqlSession = sqlSessionFactory.openSession();
4      // 创建OrderMapper对象，MyBatis自动生成mapper代理
5      OrderMapper orderMapper = sqlSession.getMapper(OrderMapper.class);
6      // 调用orderMapper的方法，查询订单和用户信息
7      List<Orders> orders = orderMapper.findOrderUserMap();
8      System.out.println(orders.size());
9  }

　　resultType和resultMap实现一对一查询总结：

　　resultType：使用resultType实现较为简单，如果pojo中没有包括查询出来的列名，需要增加列名对应的属性，即可完成映射。如果没有查询结果的特殊要求建议使用resultType。

　　resultMap：需要单独定义resultMap，实现有点麻烦，如果对查询结果有特殊的要求，使用resultMap可以完成将关联查询映射pojo的属性中。resultMap可以实现延迟加载，resultType无法实现延迟加载。

一对多查询

　　如果需要查询订单及订单明细的信息，那么这就是一对多的查询需求。

　　1、POJO和上面resultMap的Order的POJO相同，将订单明细设为List作为Order的属性。

　　2、映射文件：

 1  <!-- 订单及订单明细和用户信息的map 使用继承不用在配置订单和用户信息 -->
 2    <resultMap type="com.luchao.mybatis.first.po.Orders" id="ordersOrderdetailResultMap"
 3      extends="ordersUserResultMap">
 4      <collection property="orderdetails"
 5        ofType="com.luchao.mybatis.first.po.Orderdetail">
 6        <result column="orderdetail_id" property="id" />
 7        <result column="items_id" property="itemsId" />
 8        <result column="items_num" property="itemsNum" />
 9        <result column="orders_id" property="ordersId" />
10      </collection>
11    </resultMap>
12  <select id="findOrderAndOrderdetailMap" resultMap="ordersOrderdetailResultMap">
13      select
14      orders.*,
15      user.username,
16      user.sex,
17      user.address,
18      orderdetail.id orderdetail_id,
19      orderdetail.items_id,
20      orderdetail.items_num,
21      orderdetail.orders_id
22      from
23      orders,user,orderdetail
24      where orders.user_id = user.id and
25      orderdetail.orders_id = orders.id
26    </select>

　　订单及订单明细的resultMap，使用extends继承，不用在中配置订单信息和用户信息的映射。

　　collection：对关联查询到多条记录映射到集合对象中，property：将关联查询到多条记录映射到Orders哪个属性。

　　ofType：指定映射到list集合属性中pojo的类型，注意这里是ofType与一对一还是有区别的。

　　3、Mapper接口：

1 //查询订单、订单明细和用户信息通过resultMap
2  public List<Orders> findOrderAndOrderdetailMap() throws Exception;

　　4、测试代码：

 1 public void findOrderAndOrderdetailMap() throws Exception {
 2      // 获取sqlSession对象
 3      SqlSession sqlSession = sqlSessionFactory.openSession();
 4      // 创建OrderMapper对象，MyBatis自动生成mapper代理
 5      OrderMapper orderMapper = sqlSession.getMapper(OrderMapper.class);
 6      // 调用orderMapper的方法，查询订单和用户信息
 7      List<Orders> orders = orderMapper.findOrderAndOrderdetailMap();
 8      System.out.println(orders.get().getOrderdetails().size());
 9      System.out.println(orders.size());
10    }

　　一对多小结：

　　mybatis使用resultMap的collection对关联查询的多条记录映射到一个list集合属性中。

　　使用resultType实现：

　　将订单明细映射到orders中的orderdetails中，需要自己处理，使用双重循环遍历，去掉重复记录，将订单明细放在orderdetails中。这样会比较麻烦。

多对多

　　如果我们查询用户及用户购买商品信息，这个就是多对多，可以使用MyBatis的多对多映射。

　　将用户信息映射到user中。在user类中添加订单列表属性List<Orders> orderslist，将用户创建的订单映射到orderslist，在Orders中添加订单明细列表属性List<OrderDetail>orderdetials，将订单的明细映射到orderdetials，在OrderDetail中添加Items属性，将订单明细所对应的商品映射到Items。

　　1、POJO

 1 public class Orderdetail {
 2    private Integer id;
 3    private Integer ordersId;
 4    private Integer itemsId;
 5    private Integer itemsNum;
 6    //商品信息
 7    private Items items;
 8    public Integer getId() {
 9      return id;
10    }
11    public void setId(Integer id) {
12      this.id = id;
13    }
14    public Integer getOrdersId() {
15      return ordersId;
16    }
17    public void setOrdersId(Integer ordersId) {
18      this.ordersId = ordersId;
19    }
20    public Integer getItemsId() {
21      return itemsId;
22    }
23    public void setItemsId(Integer itemsId) {
24      this.itemsId = itemsId;
25    }
26    public Integer getItemsNum() {
27      return itemsNum;
28    }
29    public void setItemsNum(Integer itemsNum) {
30      this.itemsNum = itemsNum;
31    }
32    public Items getItems() {
33      return items;
34    }
35    public void setItems(Items items) {
36      this.items = items;
37    }
38    @Override
39    public String toString() {
40      return "Orderdetail [id=" + id + ", ordersId=" + ordersId
41          + ", itemsId=" + itemsId + ", itemsNum=" + itemsNum + "]";
42    } 
43  }

　　2、映射文件：

 1 <!-- 查询用户及购买的商品 -->
 2    <resultMap type="com.luchao.mybatis.first.po.User" id="ordersItemsResultMap">
 3      <!-- 用户信息 -->
 4      <id column="user_id" property="id" />
 5      <result column="username" property="username" />
 6      <result column="sex" property="sex" />
 7      <result column="address" property="address" />
 8      <!-- 订单信息 一个用户对应多个订单，使用collection映射 -->
 9      <collection property="ordersList" ofType="com.luchao.mybatis.first.po.Orders">
10        <id column="id" property="id" />
11        <result column="user_id" property="userId" />
12        <result column="number" property="number" />
13        <result column="createtime" property="createtime" />
14        <result column="note" property="note" />
15        <!-- 订单明细 一个订单包括 多个明细 -->
16        <collection property="orderdetails"
17          ofType="com.luchao.mybatis.first.po.Orderdetail">
18          <id column="id" property="id" />
19          <result column="items_id" property="itemsId" />
20          <result column="items_num" property="itemsNum" />
21          <result column="orders_id" property="ordersId" />
22          <!-- 商品信息 一个订单明细对应一个商品 -->
23          <association property="items"
24            javaType="com.luchao.mybatis.first.po.Items">
25            <id column="items_id" property="id" />
26            <result column="items_name" property="name" />
27            <result column="items_detail" property="detail" />
28            <result column="items_price" property="price" />
29          </association>
30        </collection>
31      </collection>
32    </resultMap>
33  <select id="findOrderAndItemMap" resultMap="ordersItemsResultMap">
34      select
35      orders.*,
36      user.username,
37      user.sex,
38      user.address,
39      orderdetail.id orderdetail_id,
40      orderdetail.items_id,
41      orderdetail.items_num,
42      orderdetail.orders_id,
43      items.id items_id,
44      items.name items_name,
45      items.detail items_detail,
46      items.price items_price
47      from orders,user,orderdetail,items
48      where orders.user_id =
49      user.id and orderdetail.orders_id = orders.id AND orderdetail.items_id
50      = items.id
51    </select>

　　可以看出，多对多基本上就是一对多和一对一的组合，所有复杂问题基本都是简单问题的组合，只要细细分析，理清楚其原理。

　　3、Mapper接口：

1 //查询订单、订单明细和用户信息通过resultMap
2  public List<User> findOrderAndItemMap() throws Exception;

　　4、测试代码：

 1 public void findOrderAndItemMap() throws Exception {
 2      // 获取sqlSession对象
 3      SqlSession sqlSession = sqlSessionFactory.openSession();
 4      // 创建OrderMapper对象，MyBatis自动生成mapper代理
 5      OrderMapper orderMapper = sqlSession.getMapper(OrderMapper.class);
 6      // 调用orderMapper的方法，查询订单和用户信息
 7      List<User> users = orderMapper.findOrderAndItemMap();
 8      System.out.println(users.get().getOrdersList().get()
 9          .getOrderdetails().get().getId());
10      // System.out.println(orders.size());
11  }

　　多对多查询总结：

　　上边的需求就使用resultType将查询到的记录映射到一个扩展的pojo中，很简单实现明细清单的功能，但是这种不能实现延迟加载。使用resultMap将用户购买的商品明细列表映射到对象中，可以实现延迟加载。使用resultMap是针对那些对查询结果映射有特殊要求的功能，，比如特殊要求映射成list中包括多个list。

resultMap总结　

　　1、resultType：

　　作用：

　　将查询结果按照sql列名pojo属性名一致性映射到pojo中。

　　场合：

　　常见一些明细记录的展示，比如用户购买商品明细，将关联查询信息全部展示在页面时，此时可直接使用resultType将每一条记录映射到pojo中，在前端页面遍历list（list中是pojo）即可。

　　2、resultMap：

　　使用association和collection完成一对一和一对多高级映射（对结果有特殊的映射要求）。

　　association：

　　作用：

　　将关联查询信息映射到一个pojo对象中。

　　场合：