MyBatis.md

1、简介

1.1 什么是 MyBatis？

• MyBatis 是一款优秀的持久层框架，
• 它支持自定义 SQL、存储过程以及高级映射。
• MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
• MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

如何获取Mybatis？

• github：https://github.com/mybatis/mybatis-3/releases
• 中文文档：https://mybatis.org/mybatis-3/zh/index.html

1.2 持久层

数据持久化

• 持久化就是将程序的数据在持久状态和瞬时状态转化的过程。
• 内存：断电即失
• 数据库（JDBC），io文件持久化
• 内存太贵且断电即失，有些数据需要存储，将其持久化

1.3 为什么需要Mybatis？

• 方便
• 传统的JDBC代码太复杂。简化；框架；自动化
• 帮助程序员将数据存入数据库中
• 优点：
  • 简单易学
  • 灵活
  • sql和代码的分离，提高了可维护性
  • 提供映射标签，支持对象与数据库的orm字段关系映射
  • 提供对象关系映射标签，支持对象关系组建维护
  • 提供xml标签，支持编写动态sql。

2、第一个Mybatis程序

思路：搭建环境-导入Mybatis-编写代码-测试

2.1 搭建环境

搭建数据库

CREATE DATABASE `mybatis`;

use `mybatis`;

CREATE TABLE `user`(
    `id` INT(20) NOT NULL PRIMARY KEY,
    `name` VARCHAR(30) DEFAULT NULL,
    `pwd` VARCHAR(30) DEFAULTNULL
)ENGINE=INNODB DEFAULT CHARSET=utf-8;

INSERT INTO `user`(`id`,`name`,`pwd`) VALUES
(1,'kuangsheng','123456'),
(2,'zhangsan','123456'),
(3,'lisi','123456'),

新建项目

1. 新建一个普通的maven项目
2. 删除src目录
3. 导入maven依赖

       <!--导入依赖-->
       <dependencies>
           <!--mysql驱动-->
           <dependency>
               <groupId>mysql</groupId>
               <artifactId>mysql-connentor-java</artifactId>
               <version>8.0.21</version>
           </dependency>
           <!--mybatis-->
           <dependency>
               <groupId>org.mybatis</groupId>
               <artifactId>mybatis</artifactId>
               <version>3.5.2</version>
           </dependency>
           <!--junit-->
           
       </dependencies>
   

2.2 创建一个模块

• 编写mybatis的核心配置文件

  <?xml version="1.0" encoding="UTF-8" ?>
  <!DOCTYPE configuration
          PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
          "http://mybatis.org/dtd/mybatis-3-config.dtd">
  <!--核心配置文件-->
  <configuration>
      <environments default="development">
          <environment id="development">
              <transactionManager type="JDBC"/>
              <dataSource type="POOLED">
                  <property name="driver" value="com.mysql.jdbc.Driver"/>
                  <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                  <property name="username" value="root"/>
                  <property name="password" value=""/>
              </dataSource>
          </environment>
      </environments>
      <mappers>
          <mapper resource="com/kuang/dao/UserMapper.xml"/>
      </mappers>
  </configuration>
  
  

• 编写mybatis工具类

  //sqlSessionFactory--->sqlSession
  public class MybatisUtils {
  
      private static SqlSessionFactory sqlSessionFactory;
      static {
          String resource = "mybatis-config.xml";
          try {
              InputStream inputStream = Resources.getResourceAsStream(resource);
              sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
          } catch (IOException e) {
              e.printStackTrace();
          }
      }
  
  //既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。
  // SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。
  
      public static SqlSession getSqlSessionFactory() {
          return sqlSessionFactory.openSession();
      }
  }
  
  

2.3 编写代码

• 实体类

  package com.kuang.pojo;
  
  // 实体类
  public class User {
      private int id;
      private String name;
      private String pwd;
  
      public User() {
  
      }
  
      public User(int id, String name, String pwd) {
          this.id = id;
          this.name = name;
          this.pwd = pwd;
      }
  
      public int getId() {
          return id;
      }
  
      public void setId(int id) {
          this.id = id;
      }
  
      public String getName() {
          return name;
      }
  
      public void setName(String name) {
          this.name = name;
      }
  
      public String getPwd() {
          return pwd;
      }
  
      public void setPwd(String pwd) {
          this.pwd = pwd;
      }
  
      @Override
      public String toString() {
          return "User{" +
                  "id=" + id +
                  ", name='" + name + '\'' +
                  ", pwd='" + pwd + '\'' +
                  '}';
      }
  }
  
  

• Dao接口

  public interface UserDao {
      List<User> getUserList();
  }
  
  

• 接口实现类由原来的UserDaoImpl转变为一个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">
  <!--namespace=绑定一个对应的Dao/Mapper接口-->
  <mapper namespace="com.kuang.dao.UserDao">
  <!--select查询语句-->
      <select id="getUserList" resultType="com.kuang.pojo.User">
          select * from mybatis.user
      </select>
  </mapper>
  

2.4 测试

注意点：
org.apache.ibatis.binding.BindingException: Type interface com.kuang.dao.UserDao is not known to the MapperRegistry.

MapperRegistry是什么？ 每一个Mapper.XML都需要在Mybatis核心配置文件中注册，在核心配置文件中注册mappers

• Junit测试

  public class UserMapperTest {
  
      @Test
      public void test(){
  //        第一步：获取SqlSession对象
          SqlSession sqlSession = MybatisUtils.getSqlSession();
  //        方式一：getMapper
          UserMapper userDao = sqlSession.getMapper(UserMapper.class);
          List<User> userList = userDao.getUserList();
  
          for (User user : userList) {
              System.out.println(user);
  
          }
          sqlSession.close();
  
      }
  }
  
  

可能会遇到的问题：

1. 配置文件没有注册
2. 绑定接口错误
3. 方法名不对
4. 返回类型不对
5. Maven导出资源问题
6. UTF-8字符无效

3、CUDR

3.1 namespace

namespace中的包名要和Dao/mapper接口的包名一致！

3.2 select

选择，查询语句；

• id：就是对应的namespace中的方法名；
• resultType：Sql语句执行的返回值！
• parameterType：参数类型

1. 编写接口

   //    根据ID查询用户
       User getUserById(int id);
   

2. 编写对应的mapper中的sql语句

       <select id="getUserById" resultType="com.kuang.pojo.User" parameterType="int">
           select * from mybatis.user where id = #{id};
       </select>
   

3. 测试

       @Test
       public void getUserById(){
   //        第一步：获取SqlSession对象
           SqlSession sqlSession = MybatisUtils.getSqlSession();
   //        方式一：getMapper
           UserMapper mapper = sqlSession.getMapper(UserMapper.class);
           User user = mapper.getUserById(2);
           System.out.println(user);
           sqlSession.close();
       }
   

3.3 insert

1. 编写java接口

   //    insert一个用户
       int addUser(User user);
   

2. 编写对应的mapper中sql语句

   <!--对象中的属性，可以直接取出来-->
       <insert id="addUser" parameterType="com.kuang.pojo.User">
           insert into mybatis.user (id, name, pwd)
           values (#{id}, #{name}, #{pwd});
   
       </insert>
   

3. 测试（注意：增删改需要提交事务）

   //    增删改需要提交事务
       @Test
       public void addUserTest(){
           SqlSession sqlSession = MybatisUtils.getSqlSession();
           UserMapper mapper = sqlSession.getMapper(UserMapper.class);
           mapper.addUser(new User(4, "哈哈", "123123"));
   
   //        必须提交事务
           sqlSession.commit();
           sqlSession.close();
       }
   

3.4 update

1. 编写java接口

   //    修改用户
       int updateUser(User user);
   

2. 编写对应的mapper中sql语句

       <update id="updateUser" parameterType="com.kuang.pojo.User">
           update mybatis.user
           set name = #{name},
               pwd = #{pwd}
               where id = #{id};
       </update>
   

3. 测试（注意：增删改需要提交事务）

       <update id="updateUser" parameterType="com.kuang.pojo.User">
           update mybatis.user
           set name = #{name},
               pwd = #{pwd}
               where id = #{id};
       </update>
   

3.4 delete

1. 编写java接口

   //    删除一个用户
       int deleteUser(int id);
   

2. 编写对应的mapper中sql语句

       <delete id="deleteUser" parameterType="int">
           delete
           from mybatis.user
           where id = #{id};
       </delete>
   

3. 测试（注意：增删改需要提交事务）

       @Test
       public void deleteUserTest(){
           SqlSession sqlSession = MybatisUtils.getSqlSession();
           UserMapper mapper = sqlSession.getMapper(UserMapper.class);
           mapper.deleteUser(3);
   
   //        必须提交事务
           sqlSession.commit();
           sqlSession.close();
       }
   

注意：增删改需要提交事务

3.5 万能的Map

假设，我们的实体类，或者数据库中的表，字段或者参数太多，我们应当考虑使用Map！

1. 接口

   // 万能的map
   int addUser(Map<String, Object> map);
   

2. 编写接口对应的mapper中的xml

   <!--传递map的key-->
       <insert id="addUser1" parameterType="map">
           insert into mybatis.user (id, pwd)
           values (#{usrid}, #{pwd});
       </insert>
   

3. 测试

       @Test
       public void addUser1Test(){
           SqlSession sqlSession = MybatisUtils.getSqlSession();
           UserMapper mapper = sqlSession.getMapper(UserMapper.class);
   
           Map<String, Object> map = new HashMap<String, Object>();
           map.put("usrid", 3);
           map.put("pwd", "222333");
           mapper.addUser1(map);
           sqlSession.commit();
           sqlSession.close();
       }
   

• Map传递参数直接在sql中取出key接口！parameterType="map"
• 对象传递参数，直接在sql中取对象的属性即可！parameterType="com.kuang.pojo.User"
• 只有一个基本类型的参数的情况下，可以直接在sql中取到！parameterType="int"参数也可以不写
• 多个参数用Map，或者注解

3.6 模糊查询怎么写

1. java代码执行的时候，传递通配符% %

   List<User> userList = userDao.getUserLike(%"呵"%);
   

2. 在sql拼接中使用通配符% %

   select * from user where name like "%"#{value}"%";
   

4、配置文件

4.1 核心配置文件

• mybatis-config.xml
• MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。

  configuration（配置）
  properties（属性）
  settings（设置）
  typeAliases（类型别名）
  typeHandlers（类型处理器）
  objectFactory（对象工厂）
  plugins（插件）
  environments（环境配置）
  environment（环境变量）
  transactionManager（事务管理器）
  dataSource（数据源）
  databaseIdProvider（数据库厂商标识）
  mappers（映射器）
  

4.2 环境配置（environments）

Mybatis可以配置适应多种环境

不过要记住：尽管可以配置多个环境，但是每个SqlSessionFactory实例只能选择一种环境。

Mybatis默认的事务还礼其就是JDBC，连接池：POOLED

4.3 属性（properties）

我们可以通过properties属性来实现引用配置文件。

这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。【db.properties】

编写一个配置文件：
db.properties

dirver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
username=root
password=

在核心配置中引入

<!--引入外部配置文件-->
    <properties resource="db.properties">
        <property name="username" value="root"/>
<!--        优先引用外部配置文件中的配置-->
        <property name="password" value="root"/>
    </properties>

• 可以直接引入外部配置文件！
• 可以在其中增加一些属性配置文件！
• 如果两个文件有同一字段，优先使用外部配置文件！

4.4 类型别名（typeAliases）

• 类型别名是为java类型设置一个短的名字。
• 存在的意义仅在于用来减少类完全限定名的冗余。

<!--可以给实体类起别名-->
    <typeAliases>
        <typeAlias type="com.kuang.pojo.User" alias="User"/>
    </typeAliases>

也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如：
扫描实体类的包，它的默认别名就为这个类的类名首字母小写！（其实和类名一致也可以）

<!--可以给实体类起别名-->
    <typeAliases>
<!--        <typeAlias type="com.kuang.pojo.User" alias="User"/>-->
        <package name="com.kuang.pojo"/>

    </typeAliases>

在实体类少的时候，使用第一种方式。
如果实体类十分多，建议使用第二种。
第一种可以DIY别名，第二种“不行”；如果非要改，需要在实体类上增加注解。

@Alias("user")
public class User {}

4.5 设置（settings）

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。

4.6 映射器（mappers）

MapperRegistry:注册绑定我们的Mapper文件；
方式一：使用相对于类路径的资源引用【推荐使用】

    <mappers>
        <mapper resource="com/kuang/dao/UserMapper.xml"/>
    </mappers>

方式二：使用class文件绑定注册

    <mappers>
        <mapper class="com.kuang.dao.UserMapper"/>
    </mappers>

注意点：

• 接口和他的配置文件Mapper必须同名！
• 接口和他的配置文件Mapper必须在同一个包下！

方式三：使用扫描包进行注入绑定

    <mappers>
        <package name="com.kuang.dao"/>
    </mappers>

注意点：

• 接口和他的配置文件Mapper必须同名！
• 接口和他的配置文件Mapper必须在同一个包下！

练习：

• 将数据库配置文件外部引入
• 实体类别名
• 保证UserMapper接口和UserMapper.xml改为一致！并放在同一个包下！

4.7 生命周期和作用域

作用域和生命周期类别是至关重要的，因为错误的使用会导致非常严重的并发问题。

SqlSssionFactoryBuilder：

• 一旦创建了SqlSessionFactory就不需要它了
• 局部变量

SqlSessionFactory：

• 相当于：数据库连接池
• SqlSessionFactory一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或者创建另一个实例。
• 因此，SqlSessionFactory的最佳作用域为应用作用域。
• 最简单的就是使用单例模型或者静态单例模式。

SqlSession

• 连接到连接池的一个请求
• SqlSession的实例不是线程安全的，因此不能被共享，所以他的最佳作用域是请求或方法作用域。
• 用完之后关闭，否者资源被占用。

解决属性名和字段名不一致的问题

5.1 问题

数据库中的字段

新建一个项目，拷贝之前的，测试实体类字段不一致的情况。

public class User {
    private int id;
    private String name;
    private String pwd;
}

测试出现问题：

select * from mybatis.user where id  = #{id}
// 类型处理器
select id, name, pwd from mybatis.user where id = #{id}

5.2 解决方法

• 起别名

    <select id="getUserById" resultType="com.kuang.pojo.User">
        select id,name,pwd as password from mybatis.user where id = #{id}
    </select>

• ResultMap

结果集映射

id name pwd
id name password

	<!--结果集映射-->
    <resultMap id="UserMap" type="User">
    	<!--property是实体类中的属性，column是数据库中的字段 -->
        <result property="id" column="id"/>
        <result property="name" column="name"/>
        <result property="password" column="pwd"/>
    </resultMap>

    <select id="getUserById" resultMap="UserMap">
        select * from mybatis.user where id = #{id};
    </select>

• resultMap 元素是 MyBatis 中最重要最强大的元素。
• ResultMap 的设计思想是，对简单的语句做到零配置，对于复杂一点的语句，只需要描述语句之间的关系就行了。