SSM07 —— MyBatis的Dao层实现

本文记录了MyBatis的进阶知识，包括：Dao层（持久层）实现，映射文件的深入知识，核心配置文件的深入知识，多表操作，注解开发

MyBatis的Dao层实现

传统开发方式

• 编写UserDao接口

  public interface UserDao {
  	List<User> findAll() throws IOException; 
  }

• 编写UserDaoImpl实现

  public class UserDaoImpl implements UserDao {
  	public List<User> findAll() throws IOException {
  	InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
  	SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
  	SqlSession sqlSession = sqlSessionFactory.openSession();
  	List<User> userList = sqlSession.selectList("userMapper.findAll");
  	sqlSession.close();
  	return userList; 
      } 
  }

• 测试传统方式

  @Test
  public void testTraditionDao() throws IOException {
  	//当前dao层实现是手动编写的
      UserDao userDao = new UserDaoImpl();
  	List<User> all = userDao.findAll();
  	System.out.println(all);
  }

代理开发方式

介绍：

采用 Mybatis 的代理开发方式实现 DAO 层的开发，这种方式是企业的主流。

Mapper 接口开发方法只需要程序员编写Mapper 接口（相当于Dao 接口），由Mybatis 框架根据接口定义创建接口的动态代理对象，代理对象的方法体同上边Dao接口实现类方法。

Mapper 接口开发需要遵循以下规范：

• Mapper.xml文件中的namespace与mapper接口的全限定名相同

• Mapper接口方法名和Mapper.xml中定义的每个statement的id相同

• Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql的parameterType的类型相同

• Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同

流程：

• 编写UserMapper接口

  

• 测试代理方式

  @Test
  public void testProxyDao() throws IOException {
  	InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
  	SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
  	SqlSession sqlSession = sqlSessionFactory.openSession();
  	//获得MyBatis框架生成的UserMapper接口的实现类
  	UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
  	User user = userMapper.findById(1);
  	System.out.println(user);
  	sqlSession.close();
  }

MyBatis映射文件深入

动态sql语句

概述：

Mybatis 的映射文件中，前面我们的 SQL 都是比较简单的，有些时候业务逻辑复杂时，我们的 SQL是动态变化的，此时在前面的学习中我们的 SQL 就不能满足要求了。

参考的官方文档，描述如下：

动态SQL之<if>

我们根据实体类的不同取值，使用不同的 SQL语句来进行查询。比如在 id如果不为空时可以根据id查询，如果username 不同空时还要加入用户名作为条件。这种情况在我们的多条件组合查询中经常会碰到。

<select id="findByCondition" parameterType="user" resultType="user">
    select * from user
    <where>
        <if test="id!=0">
            and id=#{id}
        </if>
        <if test="username!=null">
            and username=#{username}
        </if>
        <if test="password!=null">
            and password=#{password}
        </if>
    </where>
</select>

动态SQL之<foreach>

循环执行sql的拼接操作，例如：SELECT * FROM USER WHERE id IN (1,2,5)

<select id="findByIds" parameterType="list" resultType="user">
    select * from user
    <where>
        <foreach collection="list" open="id in(" close=")" item="id" separator=",">
            #{id}
        </foreach>
    </where>
</select>

foreach标签的属性含义如下：

<foreach>标签用于遍历集合，它的属性：

• collection：代表要遍历的集合元素，注意编写时不要写#{}
• open：代表语句的开始部分
• close：代表结束部分
• item：代表遍历集合的每个元素，生成的变量名
• separator：代表分隔符

SQL片段抽取

SQL 中可将重复的 sql 提取出来，使用时用 include 引用即可，最终达到 sql 重用的目的

<!--sql语句抽取-->
<sql id="selectUser">select * from user</sql>

<select id="findByIds" parameterType="list" resultType="user">
    <include refid="selectUser"></include>
    <where>
        <foreach collection="list" open="id in(" close=")" item="id" separator=",">
            #{id}
        </foreach>
    </where>
</select>

MyBatis映射文件配置总结：

<select>：查询

<insert>：插入

<update>：修改

<delete>：删除

<where>：where条件

<if>：if判断

<foreach>：循环

<sql>：sql片段抽取

MyBatis核心配置文件深入

typeHandlers标签

无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时， 都会用类型处理器将获取的值以合适的方式转换成 Java 类型。下表描述了一些默认的类型处理器（截取部分）。

你可以重写类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。具体做法为：实现org.apache.ibatis.type.TypeHandler 接口， 或继承一个很便利的类 org.apache.ibatis.type.BaseTypeHandler， 然后可以选择性地将它映射到一个JDBC类型。

例如需求：一个Java中的Date数据类型，我想将之存到数据库的时候存成一个1970年至今的毫秒数，取出来时转换成java的Date，即java的Date与数据库的varchar毫秒值之间转换。

开发步骤：

• 定义转换类继承类BaseTypeHandler<T>

• 覆盖4个未实现的方法，其中setNonNullParameter为java程序设置数据到数据库的回调方法，getNullableResult为查询时 MySQL的字符串类型转换成 java的Type类型的方法

  public class DateTypeHandler extends BaseTypeHandler<Date> {
      //将java类型 转换成 数据库需要的类型
      public void setNonNullParameter(PreparedStatement preparedStatement, int i, Date date, JdbcType jdbcType) throws SQLException {
          long time = date.getTime();
          preparedStatement.setLong(i,time);
      }
  
      //将数据库中类型 转换成java类型
      //String参数  要转换的字段名称
      //ResultSet 查询出的结果集
      public Date getNullableResult(ResultSet resultSet, String s) throws SQLException {
          //获得结果集中需要的数据(long) 转换成Date类型 返回
          long aLong = resultSet.getLong(s);
          Date date = new Date(aLong);
          return date;
      }
  
      //将数据库中类型 转换成java类型
      public Date getNullableResult(ResultSet resultSet, int i) throws SQLException {
          long aLong = resultSet.getLong(i);
          Date date = new Date(aLong);
          return date;
      }
  
      //将数据库中类型 转换成java类型
      public Date getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
          long aLong = callableStatement.getLong(i);
          Date date = new Date(aLong);
          return date;
      }
  }

• 在MyBatis核心配置文件中进行注册(sqlMapConfig.xml)

  <!--注册类型处理器-->
  <typeHandlers>
      <typeHandler handler="com.itheima.handler.DateTypeHandler"></typeHandler>
  </typeHandlers>

• 测试转换是否正确

  @Test
  public void test1() throws IOException {
      InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
      SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
      SqlSession sqlSession = sqlSessionFactory.openSession();
      UserMapper mapper = sqlSession.getMapper(UserMapper.class);
  
      //创建user
      User user = new User();
      user.setUsername("ceshi");
      user.setPassword("abc");
      user.setBirthday(new Date());
      //执行保存操作
      mapper.save(user);
  
      sqlSession.commit();
      sqlSession.close();
  }

plugins标签

MyBatis可以使用第三方的插件来对功能进行扩展，分页助手PageHelper是将分页的复杂操作进行封装，使用简单的方式即可获得分页的相关数据

开发步骤：

• 导入通用PageHelper的坐标

  <dependency>
      <groupId>com.github.pagehelper</groupId>
      <artifactId>pagehelper</artifactId>
      <version>3.7.5</version>
  </dependency>
  <dependency>
      <groupId>com.github.jsqlparser</groupId>
      <artifactId>jsqlparser</artifactId>
      <version>0.9.1</version>
  </dependency>

• 在mybatis核心配置文件中配置PageHelper插件

  <!--配置分页助手插件,注意配置在mapper之前-->
  <plugins>
      <plugin interceptor="com.github.pagehelper.PageHelper">
          <property name="dialect" value="mysql"></property>
      </plugin>
  </plugins>

• 测试分页数据获取

  @Test
  public void test3() throws IOException {
      InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
      SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
      SqlSession sqlSession = sqlSessionFactory.openSession();
      UserMapper mapper = sqlSession.getMapper(UserMapper.class);
  
      //设置分页相关参数   当前页+每页显示的条数
      PageHelper.startPage(3,3);
  
      List<User> userList = mapper.findAll();
      for (User user : userList) {
          System.out.println(user);
      }
  
      //获得与分页相关参数
      PageInfo<User> pageInfo = new PageInfo<User>(userList);
      System.out.println("当前页："+pageInfo.getPageNum());
      System.out.println("每页显示条数："+pageInfo.getPageSize());
      System.out.println("总条数："+pageInfo.getTotal());
      System.out.println("总页数："+pageInfo.getPages());
      System.out.println("上一页："+pageInfo.getPrePage());
      System.out.println("下一页："+pageInfo.getNextPage());
      System.out.println("是否是第一个："+pageInfo.isIsFirstPage());
      System.out.println("是否是最后一个："+pageInfo.isIsLastPage());
  
      sqlSession.close();
  }

核心配置文件常用标签总结

• properties标签：该标签可以加载外部的properties文件

• typeAliases标签：设置类型别名

• environments标签：数据源环境配置标签

• typeHandlers标签：配置自定义类型处理器

• plugins标签：配置MyBatis的插件

MyBatis多表操作

一对一查询

模型：

用户表和订单表的关系为，一个用户有多个订单，一个订单只从属于一个用户

一对一查询的需求：查询一个订单，与此同时查询出该订单所属的用户

查询语句：：select * from orders o,user u where o.uid=u.id;

创建Order实体：

public class Order {

    private int id;
    private Date ordertime;
    private double total;

    //当前订单属于哪一个用户
    private User user;
	
    //省略get set方法
}

创建User实体：

public class User {

    private int id;
    private String username;
    private String password;
    private Date birthday;
}

创建OrderMapper接口：

public interface OrderMapper {

    //查询全部的方法
    public List<Order> findAll();

}

配置OrderMapper.xml

<resultMap id="orderMap" type="order">
    <!--手动指定字段与实体属性的映射关系
            column: 数据表的字段名称
            property：实体的属性名称
        -->
    <id column="oid" property="id"></id>
    <result column="ordertime" property="ordertime"></result>
    <result column="total" property="total"></result>
    <!--<result column="uid" property="user.id"></result>
    <result column="username" property="user.username"></result>
    <result column="password" property="user.password"></result>
    <result column="birthday" property="user.birthday"></result>-->
    
    <!--
            property: 当前实体(order)中的属性名称(private User user)
            javaType: 当前实体(order)中的属性的类型(User)
    -->
    <association property="user" javaType="user">
        <id column="uid" property="id"></id>
        <result column="username" property="username"></result>
        <result column="password" property="password"></result>
        <result column="birthday" property="birthday"></result>
    </association>
</resultMap>
<select id="findAll" resultMap="orderMap">
    SELECT *,o.id oid FROM orders o,USER u WHERE o.uid=u.id
</select>

一对多查询

模型：

用户表和订单表的关系为，一个用户有多个订单，一个订单只从属于一个用户

一对多查询的需求：查询一个用户，与此同时查询出该用户具有的订单

对应的sql语句：select *,o.id oid from user u left join orders o on u.id=o.uid;

修改User实体

public class User {

    private int id;
    private String username;
    private String password;
    private Date birthday;

    //描述的是当前用户存在哪些订单
    private List<Order> orderList;
}

创建UserMapper接口

public interface OrderMapper {
    //查询全部的方法
    public List<Order> findAll();
}

配置UserMapper.xml

<resultMap id="userMap" type="user">
    <id column="uid" property="id"></id>
    <result column="username" property="username"></result>
    <result column="password" property="password"></result>
    <result column="birthday" property="birthday"></result>
    <!--配置集合信息
            property:集合名称
            ofType：当前集合中的数据类型
        -->
    <collection property="orderList" ofType="order">
        <!--封装order的数据-->
        <id column="oid" property="id"></id>
        <result column="ordertime" property="ordertime"></result>
        <result column="total" property="total"></result>
    </collection>
</resultMap>

<select id="findAll" resultMap="userMap">
    SELECT *,o.id oid FROM USER u,orders o WHERE u.id=o.uid
</select>

多对多查询

用户表和角色表的关系为，一个用户有多个角色，一个角色被多个用户使用

多对多查询的需求：查询用户同时查询出该用户的所有角色

对应的sql语句：select u.*,r.*,r.id rid from user u left join user_role ur on u.id=ur.user_id inner join role r on ur.role_id=r.id;

创建Role实体，修改User实体

public class User {

    private int id;
    private String username;
    private String password;
    private Date birthday;

    //描述的是当前用户存在哪些订单
    private List<Order> orderList;
    //代表当前用户具备哪些角色
	private List<Role> roleList;
}

public class Role {

    private int id;
    private String roleName;
    private String roleDesc;
}

添加UserMapper接口方法

List<User> findAllUserAndRole();

配置UserMapper.xml

<resultMap id="userRoleMap" type="user">
    <!--user的信息-->
    <id column="userId" property="id"></id>
    <result column="username" property="username"></result>
    <result column="password" property="password"></result>
    <result column="birthday" property="birthday"></result>
    <!--user内部的roleList信息-->
    <collection property="roleList" ofType="role">
        <id column="roleId" property="id"></id>
        <result column="roleName" property="roleName"></result>
        <result column="roleDesc" property="roleDesc"></result>
    </collection>
</resultMap>

<select id="findUserAndRoleAll" resultMap="userRoleMap">
    SELECT * FROM USER u,sys_user_role ur,sys_role r WHERE u.id=ur.userId AND ur.roleId=r.id
</select>

测试代码

@Test
public void test3() throws IOException {
    InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    SqlSession sqlSession = sqlSessionFactory.openSession();

    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    List<User> userAndRoleAll = mapper.findUserAndRoleAll();
    for (User user : userAndRoleAll) {
        System.out.println(user);
    }

    sqlSession.close();
}

MyBatis注解开发

常用注解

这几年来注解开发越来越流行，Mybatis也可以使用注解开发方式，这样我们就可以减少编写Mapper映射文件了。我们先围绕一些基本的CRUD来学习，再学习复杂映射多表操作。

• @Insert：实现新增

• @Update：实现更新

• @Delete：实现删除

• @Select：实现查询

• @Result：实现结果集封装

• @Results：可以与@Result 一起使用，封装多个结果集

• @One：实现一对一结果集封装

• @Many：实现一对多结果集封装

增删改查操作

UserMapper接口：

public interface UserMapper {

    @Insert("insert into user values(#{id},#{username},#{password},#{birthday})")
    public void save(User user);

    @Update("update user set username=#{username},password=#{password} where id=#{id}")
    public void update(User user);

    @Delete("delete from user where id=#{id}")
    public void delete(int id);

    @Select("select * from user where id=#{id}")
    public User findById(int id);

    @Select("select * from user")
    public List<User> findAll();
}

public class MyBatisTest {

    private UserMapper mapper;

    @Before
    public void before() throws IOException {
        InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
        SqlSession sqlSession = sqlSessionFactory.openSession(true);
        mapper = sqlSession.getMapper(UserMapper.class);
    }


    @Test
    public void testSave(){
        User user = new User();
        user.setUsername("tom");
        user.setPassword("abc");
        mapper.save(user);
    }

    @Test
    public void testUpdate(){
        User user = new User();
        user.setId(18);
        user.setUsername("lucy");
        user.setPassword("123");
        mapper.update(user);
    }

    @Test
    public void testDelete(){
        mapper.delete(18);
    }

    @Test
    public void testFindById(){
        User user = mapper.findById(2);
        System.out.println(user);
    }

    @Test
    public void testFindAll(){
        List<User> all = mapper.findAll();
        for (User user : all) {
            System.out.println(user);
        }
    }
}

修改MyBatis的核心配置文件，我们使用了注解替代的映射文件，所以我们只需要加载使用了注解的Mapper接口即可

<mappers>
<!--扫描使用注解的类--> 
    <mapper class="com.itheima.mapper.UserMapper"></mapper>
</mappers>

或者指定扫描包含映射关系的接口所在的包

<!--加载映射关系-->
<mappers>
    <!--指定接口所在的包-->
    <package name="com.itheima.mapper"></package>
</mappers>

复杂映射开发

实现复杂关系映射之前我们可以在映射文件中通过配置<resultMap>来实现，使用注解开发后，我们可以使用@Results注解，@Result注解，@One注解，@Many注解组合完成复杂关系的配置

一对一查询

一对多查询

多对多查询