MyBatis（一）

发表于 更新于 阅读次数： 本文字数： 2.6k 阅读时长 ≈ 9 分钟

因为内容太多了，所以将其拆分为以下内容

参考

https://www.bilibili.com/video/BV1NE411Q7Nx

https://mybatis.org/mybatis-3/zh/index.html

Mybatis

简介

什么是 MyBatis？

Mybatis

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

使用

  • 要使用 MyBatis， 只需将 mybatis-x.x.x.jar 文件置于类路径（classpath）中即可。

    如果使用 Maven 来构建项目，则需将下面的依赖代码置于 pom.xml 文件中：

1
2
3
4
5
<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>x.x.x</version>
</dependency>

作用域（Scope）和生命周期

SqlSessionFactoryBuilder

这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。

SqlSessionFactory

SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

SqlSession

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。 如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。 这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。

Mybatis上手

搭建环境

MySQL5.7 + IDEA + Navicat Premium

创建数据库

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
create database mybatis;

user mybatis;


create table `user`(
	`id` INT(20) NOT NULL PRIMARY KEY,
	`name` VARCHAR (30) DEFAULT NULL,
	`pwd` VARCHAR(30) DEFAULT NULL
)ENGINE=INNODB DEFAULT CHARSET=UTF8;

INSERT INTO USER(id,name,pwd) VALUES
(1,'张三','123456'),
(2,'李四','123789'),
(3,'王五','456789')

新建项目

普通的 maven 项目

pom.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<dependencies>

    <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.16</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.4.6</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/junit/junit -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
    </dependency>

</dependencies>

核心配置

mybatis-config.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<?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.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8&amp;serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>

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

</configuration>

工具类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
public class MybatisUtil {
    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();
        }
    }

    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();

    }
}

编写代码

实体类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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接口

1
2
3
public interface UserMapper {
    List<User> getUserList();
}

Mapper 配置文件

接口实现类由原来的 Impl 转为 Mapper 配置文件

1
2
3
4
5
6
7
8
9
10
11
<?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">
<mapper namespace="com.dao.UserMapper">

    <select id="getUserList" resultType="com.pojo.User">
        select * from user
    </select>

</mapper>

测试

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
public class UserDaoTest {

    @Test
    public void test(){

        SqlSession sqlSession = MybatisUtil.getSqlSession();

        UserMapper mapper = sqlSession.getMapper(UserMapper.class);


        List<User> userList = mapper.getUserList();

        for (User user : userList) {
            System.out.println(user);
        }

        sqlSession.close();
    }
}

CRUD

namespace

1
2
3
4
5
6
7
<mapper namespace="com.dao.UserMapper">

    <select id="getUserList" resultType="com.pojo.User">
        select * from user
    </select>

</mapper>

namespace 绑定对应 Mapper 接口

select

选择，查询语句；

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

1、编写接口

1
User getUserById(int id);

2、编写对应的 Mapper 配置

1
2
3
4
5
<select id="getUserById" parameterType="int" resultType="com.pojo.User">
    select *
    from user
    where id = #{id}
</select>

3、测试

1
2
3
4
5
6
7
8
9
10
11
12
13
@Test
public void test1() {

    SqlSession sqlSession = MybatisUtil.getSqlSession();

    UserMapper mapper = sqlSession.getMapper(UserMapper.class);

    User user = mapper.getUserById(1);

    System.out.println(user);

    sqlSession.close();
}

insert

1
2
3
<insert id="addUser" parameterType="com.pojo.User">
    insert into user(id, name, pwd) values (#{id}, #{name}, #{pwd});
</insert>

update

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

delete

1
2
3
<delete id="deleteUser" parameterType="int">
    delete from user where id=#{id}
</delete>

注意：

增删改需要提交事务

1
2
3
if (result > 0) {
    sqlSession.commit();
}

parameterType

  • map
  • Object
  • 基本类型

分页

方式一：limit实现

1
2
3
<select id="getUserByPage" parameterType="map" resultType="user">
    select * from user limit #{startIndex},#{pageSize}
</select>

方式二：RowBounds实现（了解）

java 对象层面实现分页

方式三：插件（了解）

Mybatis-PageHelper

配置

MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。

  • mybatis-config.xml

  • 配置文档的顶层结构如下：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    configuration（配置）
    properties（属性）
    settings（设置）
    typeAliases（类型别名）
    typeHandlers（类型处理器）
    objectFactory（对象工厂）
    plugins（插件）
    environments（环境配置）
    environment（环境变量）
    transactionManager（事务管理器）
    dataSource（数据源）
    databaseIdProvider（数据库厂商标识）
    mappers（映射器）

注意：

xml 标签有顺序

The content of element type "configuration" must match "(properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?)".

属性（properties）

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

编写配置文件

db.properties

1
2
3
4
driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
username=root
password=root

使用8.0以上驱动与要加上serverTimezone=UTC

在核心配置文件加入

1
<properties resource="db.properties"/>

可以引入外部配置也可以直接增加属性，但优先使用外部配置

设置（settings）

类型别名（typeAliases）

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。

方式一：

1
2
3
<typeAliases>
    <typeAlias alias="User" type="com.pojo.User"/>
</typeAliases>
1
2
3
<select id="getUserList" resultType="User"> <!-- resultType 与上配置的 alias 一致 -->
    select * from user
</select>

方式二：

也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean

1
2
3
<typeAliases>
    <package name="com.pojo"/>
</typeAliases>

每一个实体类包 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。

若有注解，则别名为其注解值。

1
2
3
4
@Alias("author")
public class Author {
    ...
}

环境配置（environments）

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。还有许多类似的使用场景。

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

事务管理器（transactionManager）

在 MyBatis 中有两种类型的事务管理器（也就是 type="[JDBC|MANAGED]"）

默认 JDBC

数据源（dataSource）

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。有三种内建的数据源类型（也就是 type="[UNPOOLED|POOLED|JNDI]"）

默认 POOLED

其他配置

类型处理器（typeHandlers）

处理枚举类型

对象工厂（objectFactory）

插件（plugins）

映射器（mappers）

方式一：

1
2
3
<mappers>
    <mapper resource="com/dao/UserMapper.xml"/>
</mappers>

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

1
2
3
<mappers>
    <mapper class="com.dao.UserMapper"/>
</mappers>

注意：

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

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

1
2
3
<mappers>
    <package name="com.dao"/>
</mappers>

注意：

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

结果映射

resultMap 元素是 MyBatis 中最重要最强大的元素。它可以让你从 90% 的 JDBC ResultSets 数据提取代码中解放出来，并在一些情形下允许你进行一些 JDBC 不支持的操作。实际上，在为一些比如连接的复杂语句编写映射代码的时候，一份 resultMap 能够代替实现同等功能的数千行代码。ResultMap 的设计思想是，对简单的语句做到零配置，对于复杂一点的语句，只需要描述语句之间的关系就行了。

MyBatis 会在幕后自动创建一个 ResultMap，再根据属性名来映射列到 JavaBean 的属性上。如果列名和属性名不能匹配上，需要显式配置 ResultMap，这就是 ResultMap 的优秀之处——你完全可以不用显式地配置它们。

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

1
2
3
<select id="getUserById" parameterType="int" resultType="user">
    select * from user where id = #{id}
</select>

上面实体类 User，pwd 属性改为 password，查询 password 为 null

解决问题：

  • 起别名
1
2
3
<select id="getUserById" parameterType="int" resultType="user">
    select id,name,pwd as password from user where id = #{id}
</select>
  • 结果集映射 ResultMap
1
2
3
4
5
<resultMap id="UserMap" type="User">
    <result column="id" property="id"/>
    <result column="name" property="name"/>
    <result column="pwd" property="password"/>
</resultMap>

column 指数据库字段，property 指实体类属性

注意因为上面前两个都是一一对应的，可以省去，只剩下不同的，如下：

1
2
3
<resultMap id="UserMap" type="User0">
    <result column="pwd" property="password"/>
</resultMap>
1
2
3
<select id="getUserById" parameterType="int" resultMap="UserMap">
    select * from user where id = #{id}
</select>

因为内容太多了，所以将其拆分为以下内容