当前位置：首页>后端>正文

再战 mybatis

后端2024-04-26 02:28:08

# Mybatis简介

## MyBatis历史

-? ? MyBatis最初是Apache的一个开源项目iBatis, 2010年6月这个项目由Apache Software Foundation迁移到了Google Code。随着开发团队转投Google Code旗下，iBatis3.x正式更名为MyBatis。代码于2013年11月迁移到Github

- iBatis一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。iBatis提供的持久层框架包括SQL Maps和Data Access Objects（DAO）

## MyBatis特性

1. MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架

2. MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集

3. MyBatis可以使用简单的XML或注解用于配置和原始映射，将接口和Java的POJO（Plain Old Java Objects，普通的Java对象）映射成数据库中的记录

4. MyBatis 是一个半自动的ORM（Object Relation Mapping）框架

## MyBatis下载

- [MyBatis下载地址](https://github.com/mybatis/mybatis-3)

- ![](Resources/MyBatis下载.png)

## 和其它持久化层技术对比

- JDBC?

- SQL 夹杂在Java代码中耦合度高，导致硬编码内伤?

- 维护不易且实际开发需求中 SQL 有变化，频繁修改的情况多见?

- 代码冗长，开发效率低

- Hibernate 和 JPA

- 操作简便，开发效率高?

- 程序中的长难复杂 SQL 需要绕过框架?

- 内部自动生产的 SQL，不容易做特殊优化?

- 基于全映射的全自动框架，大量字段的 POJO 进行部分映射时比较困难。?

- 反射操作太多，导致数据库性能下降

- MyBatis

- 轻量级，性能出色?

- SQL 和 Java 编码分开，功能边界清晰。Java代码专注业务、SQL语句专注数据?

- 开发效率稍逊于HIbernate，但是完全能够接受

# 搭建MyBatis

## 开发环境

- IDE：idea 2019.2?

- 构建工具：maven 3.5.4?

- MySQL版本：MySQL 5.7?

- MyBatis版本：MyBatis 3.5.7

## 创建maven工程

- 打包方式：jar

- 引入依赖

```xml

<groupId>org.mybatis</groupId>

<artifactId>mybatis</artifactId>

</dependency>

<groupId>junit</groupId>

<artifactId>junit</artifactId>

</dependency>

<groupId>mysql</groupId>

<artifactId>mysql-connector-java</artifactId>

</dependency>

</dependencies>

```

## 创建MyBatis的核心配置文件

>习惯上命名为`mybatis-config.xml`，这个文件名仅仅只是建议，并非强制要求。将来整合Spring之后，这个配置文件可以省略，所以大家操作时可以直接复制、粘贴。

>核心配置文件主要用于配置连接数据库的环境以及MyBatis的全局配置信息

>核心配置文件存放的位置是src/main/resources目录下

```xml

<?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"/>?

<property name="username" value="root"/>?

<property name="password" value="123456"/>?

</dataSource>?

</environment>?

</environments>?

?

<mappers>?

<mapper resource="mappers/UserMapper.xml"/>?

</mappers>?

</configuration>

```

## 创建mapper接口

>MyBatis中的mapper接口相当于以前的dao。但是区别在于，mapper仅仅是接口，我们不需要提供实现类

```java

package com.atguigu.mybatis.mapper;?

public interface UserMapper {?

/**?

* 添加用户信息?

*/?

int insertUser();?

}

```

## 创建MyBatis的映射文件

- 相关概念：ORM（Object Relationship Mapping）对象关系映射。?

- 对象：Java的实体类对象?

- 关系：关系型数据库?

- 映射：二者之间的对应关系

| Java概念 | 数据库概念 |

| --- | --- |

| 类 | 表 |

| 属性 | 字段/列 |

| 对象 | 记录/行 |

- 映射文件的命名规则

- 表所对应的实体类的类名+Mapper.xml

- 例如：表t_user，映射的实体类为User，所对应的映射文件为UserMapper.xml

- 因此一个映射文件对应一个实体类，对应一张表的操作

- MyBatis映射文件用于编写SQL，访问以及操作表中的数据

- MyBatis映射文件存放的位置是src/main/resources/mappers目录下

- MyBatis中可以面向接口操作数据，要保证两个一致

- mapper接口的全类名和映射文件的命名空间（namespace）保持一致

- mapper接口中方法的方法名和映射文件中编写SQL的标签的id属性保持一致

```xml

<?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.atguigu.mybatis.mapper.UserMapper">?

?

<insert id="insertUser">?

insert into t_user values(null,'张三','123',23,'女')?

</insert>?

</mapper>

```

## 通过junit测试功能

- SqlSession：代表Java程序和数据库之间的会话。（HttpSession是Java程序和浏览器之间的会话）

- SqlSessionFactory：是“生产”SqlSession的“工厂”

- 工厂模式：如果创建某一个对象，使用的过程基本固定，那么我们就可以把创建这个对象的相关代码封装到一个“工厂类”中，以后都使用这个工厂类来“生产”我们需要的对象

```java

public class UserMapperTest {

? ? @Test

? ? public void testInsertUser() throws IOException {

? ? ? ? //读取MyBatis的核心配置文件

? ? ? ? InputStream is = Resources.getResourceAsStream("mybatis-config.xml");

? ? ? ? //获取SqlSessionFactoryBuilder对象

? ? ? ? SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();

? ? ? ? //通过核心配置文件所对应的字节输入流创建工厂类SqlSessionFactory，生产SqlSession对象

? ? ? ? SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);

? ? ? ? //获取sqlSession，此时通过SqlSession对象所操作的sql都必须手动提交或回滚事务

? ? ? ? //SqlSession sqlSession = sqlSessionFactory.openSession();

? ? //创建SqlSession对象，此时通过SqlSession对象所操作的sql都会自动提交?

SqlSession sqlSession = sqlSessionFactory.openSession(true);

? ? ? ? //通过代理模式创建UserMapper接口的代理实现类对象

? ? ? ? UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

? ? ? ? //调用UserMapper接口中的方法，就可以根据UserMapper的全类名匹配元素文件，通过调用的方法名匹配映射文件中的SQL标签，并执行标签中的SQL语句

? ? ? ? int result = userMapper.insertUser();

? ? ? ? //提交事务

? ? ? ? //sqlSession.commit();

? ? ? ? System.out.println("result:" + result);

? ? }

}

```

- 此时需要手动提交事务，如果要自动提交事务，则在获取sqlSession对象时，使用`SqlSession sqlSession = sqlSessionFactory.openSession(true);`，传入一个Boolean类型的参数，值为true，这样就可以自动提交

## 加入log4j日志功能

1. 加入依赖

```xml

</dependency>

```

2. 加入log4j的配置文件

- log4j的配置文件名为log4j.xml，存放的位置是src/main/resources目录下

- 日志的级别：FATAL(致命)>ERROR(错误)>WARN(警告)>INFO(信息)>DEBUG(调试) 从左到右打印的内容越来越详细

```xml

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

? ? <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">

? ? ? ? <param name="Encoding" value="UTF-8" />

? ? ? ? <layout class="org.apache.log4j.PatternLayout">

? ? ? ? </layout>

? ? </appender>

? ? <logger name="java.sql">

? ? ? ? <level value="debug" />

? ? </logger>

? ? <logger name="org.apache.ibatis">

? ? ? ? <level value="info" />

? ? </logger>

? ? <root>

? ? ? ? <level value="debug" />

? ? ? ? <appender-ref ref="STDOUT" />

? ? </root>

</log4j:configuration>

```

# 核心配置文件详解

>核心配置文件中的标签必须按照固定的顺序(有的标签可以不写，但顺序一定不能乱)：

properties、settings、typeAliases、typeHandlers、objectFactory、objectWrapperFactory、reflectorFactory、plugins、environments、databaseIdProvider、mappers

```xml

<?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">

? ?

? ? <properties resource="jdbc.properties"></properties>

? ? <settings>

? ? ? ?

? ? ? ? <setting name="mapUnderscoreToCamelCase" value="true"/>

? ? ? ?

? ? ? ? <setting name="lazyLoadingEnabled" value="true"/>

? ? </settings>

? ? <typeAliases>

? ? ? ? <!--

? ? ? ? typeAlias：设置某个具体的类型的别名

? ? ? ? 属性：

? ? ? ? type：需要设置别名的类型的全类名

? ? ? ? alias：设置此类型的别名，且别名不区分大小写。若不设置此属性，该类型拥有默认的别名，即类名

? ? ? ? -->

? ? ? ?

? ? ? ? <!--<typeAlias type="com.atguigu.mybatis.bean.User" alias="user">

? ? ? ? </typeAlias>-->

? ? ? ?

? ? ? ? <package name="com.atguigu.mybatis.bean"/>

? ? </typeAliases>

? ? <!--

? ? environments：设置多个连接数据库的环境

? ? 属性：

? ? default：设置默认使用的环境的id

? ? -->

? ? <environments default="mysql_test">

? ? ? ? <!--

? ? ? ? environment：设置具体的连接数据库的环境信息

? ? ? ? 属性：

? ? ? ? id：设置环境的唯一标识，可通过environments标签中的default设置某一个环境的id，表示默认使用的环境

? ? ? ? -->

? ? ? ? <environment id="mysql_test">

? ? ? ? ? ? <!--

? ? ? ? ? ? transactionManager：设置事务管理方式

? ? ? ? ? ? 属性：

? ? ? ? ? ? type：设置事务管理方式，type="JDBC|MANAGED"

? ? ? ? ? ? type="JDBC"：设置当前环境的事务管理都必须手动处理

? ? ? ? ? ? type="MANAGED"：设置事务被管理，例如spring中的AOP

? ? ? ? ? ? -->

? ? ? ? ? ? <transactionManager type="JDBC"/>

? ? ? ? ? ? <!--

? ? ? ? ? ? dataSource：设置数据源

? ? ? ? ? ? 属性：

? ? ? ? ? ? type：设置数据源的类型，type="POOLED|UNPOOLED|JNDI"

? ? ? ? ? ? type="POOLED"：使用数据库连接池，即会将创建的连接进行缓存，下次使用可以从缓存中直接获取，不需要重新创建

? ? ? ? ? ? type="UNPOOLED"：不使用数据库连接池，即每次使用连接都需要重新创建

? ? ? ? ? ? type="JNDI"：调用上下文中的数据源

? ? ? ? ? ? -->

? ? ? ? ? ? <dataSource type="POOLED">

? ? ? ? ? ? ? ?

? ? ? ? ? ? ? ? <property name="driver" value="${jdbc.driver}"/>

? ? ? ? ? ? ? ?

? ? ? ? ? ? ? ? <property name="url" value="${jdbc.url}"/>

? ? ? ? ? ? ? ?

? ? ? ? ? ? ? ? <property name="username" value="${jdbc.username}"/>

? ? ? ? ? ? ? ?

? ? ? ? ? ? ? ? <property name="password" value="${jdbc.password}"/>

? ? ? ? ? ? </dataSource>

? ? ? ? </environment>

? ? </environments>

? ?

? ? <mappers>

? ? ? ?

? ? ? ? <!--

? ? ? ? 以包为单位，将包下所有的映射文件引入核心配置文件

? ? ? ? 注意：

1. 此方式必须保证mapper接口和mapper映射文件必须在相同的包下

2. mapper接口要和mapper映射文件的名字一致

? ? ? ? -->

? ? ? ? <package name="com.atguigu.mybatis.mapper"/>

? ? </mappers>

</configuration>

```

- ![](Resources/mapper接口和mapper映射文件在同一包下.png)

# 默认的类型别名

![](Resources/默认的类型别名1.png)

![](Resources/默认的类型别名2.png)

# MyBatis的增删改查

1. 添加

```xml

insert into t_user values(null,'admin','123456',23,'男','12345@qq.com')

</insert>

```

2. 删除

```xml

? ? <delete id="deleteUser">

? ? ? ? delete from t_user where id = 6

? ? </delete>

```

3. 修改

```xml

? ? <update id="updateUser">

? ? ? ? update t_user set username = '张三' where id = 5

? ? </update>

```

4. 查询一个实体类对象

```xml

? ?

<select id="getUserById" resultType="com.atguigu.mybatis.bean.User">?

select * from t_user where id = 2?

</select>

```

5. 查询集合

```xml

select * from t_user

</select>

```

- 注意：

1. 查询的标签select必须设置属性resultType或resultMap，用于设置实体类和数据库表的映射关系?

- resultType：自动映射，用于属性名和表中字段名一致的情况?

- resultMap：自定义映射，用于一对多或多对一或字段名和属性名不一致的情况?

2. 当查询的数据为多条时，不能使用实体类作为返回值，只能使用集合，否则会抛出异常TooManyResultsException；但是若查询的数据只有一条，可以使用实体类或集合作为返回值

# MyBatis获取参数值的两种方式（重点）

- MyBatis获取参数值的两种方式：${}和#{}?

- ${}的本质就是字符串拼接，#{}的本质就是占位符赋值?

- ${}使用字符串拼接的方式拼接sql，若为字符串类型或日期类型的字段进行赋值时，需要手动加单引号；但是#{}使用占位符赋值的方式拼接sql，此时为字符串类型或日期类型的字段进行赋值时，可以自动添加单引号

## 单个字面量类型的参数

- 若mapper接口中的方法参数为单个的字面量类型，此时可以使用\${}和#{}以任意的名称（最好见名识意）获取参数的值，注意${}需要手动加单引号

```xml

select * from t_user where username = #{username}

</select>

```

```xml

<select id="getUserByUsername" resultType="User">?

select * from t_user where username = '${username}'?

</select>

```

## 多个字面量类型的参数

- 若mapper接口中的方法参数为多个时，此时MyBatis会自动将这些参数放在一个map集合中

1. 以arg0,arg1...为键，以参数为值；

2. 以param1,param2...为键，以参数为值；

- 因此只需要通过\${}和#{}访问map集合的键就可以获取相对应的值，注意${}需要手动加单引号。

- 使用arg或者param都行，要注意的是，arg是从arg0开始的，param是从param1开始的

```xml

<select id="checkLogin" resultType="User">?

select * from t_user where username = #{arg0} and password = #{arg1}?

</select>

```

```xml

select * from t_user where username = '${param1}' and password = '${param2}'

</select>

```

## map集合类型的参数

- 若mapper接口中的方法需要的参数为多个时，此时可以手动创建map集合，将这些数据放在map中只需要通过\${}和#{}访问map集合的键就可以获取相对应的值，注意${}需要手动加单引号

```xml

select * from t_user where username = #{username} and password = #{password}

</select>

```

```java

@Test

public void checkLoginByMap() {

SqlSession sqlSession = SqlSessionUtils.getSqlSession();

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

Map<String,Object> map = new HashMap<>();

map.put("usermane","admin");

map.put("password","123456");

User user = mapper.checkLoginByMap(map);

System.out.println(user);

}

```

## 实体类类型的参数

- 若mapper接口中的方法参数为实体类对象时此时可以使用\${}和#{}，通过访问实体类对象中的属性名获取属性值，注意${}需要手动加单引号

```xml

insert into t_user values(null,#{username},#{password},#{age},#{sex},#{email})

</insert>

```

```java

@Test

public void insertUser() {

SqlSession sqlSession = SqlSessionUtils.getSqlSession();

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

User user = new User(null,"Tom","123456",12,"男","123@321.com");

mapper.insertUser(user);

}

```

## 使用@Param标识参数

- 可以通过@Param注解标识mapper接口中的方法参数，此时，会将这些参数放在map集合中

1. 以@Param注解的value属性值为键，以参数为值；

2. 以param1,param2...为键，以参数为值；

- 只需要通过\${}和#{}访问map集合的键就可以获取相对应的值，注意${}需要手动加单引号

```xml

? ? <select id="CheckLoginByParam" resultType="User">

? ? ? ? select * from t_user where username = #{username} and password = #{password}

? ? </select>

```

```java

@Test

public void checkLoginByParam() {

SqlSession sqlSession = SqlSessionUtils.getSqlSession();

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

mapper.CheckLoginByParam("admin","123456");

}

```

## 总结

- 建议分成两种情况进行处理

1. 实体类类型的参数

2. 使用@Param标识参数

# MyBatis的各种查询功能

1. 如果查询出的数据只有一条，可以通过

1. 实体类对象接收

2. List集合接收

3. Map集合接收，结果`{password=123456, sex=男, id=1, age=23, username=admin}`

2. 如果查询出的数据有多条，一定不能用实体类对象接收，会抛异常TooManyResultsException，可以通过

1. 实体类类型的LIst集合接收

2. Map类型的LIst集合接收

3. 在mapper接口的方法上添加@MapKey注解

## 查询一个实体类对象

```java

/**

* 根据用户id查询用户信息

* @param id

* @return

User getUserById(@Param("id") int id);

```

```xml

select * from t_user where id = #{id}

</select>

```

## 查询一个List集合

```java

/**

* 查询所有用户信息

* @return

List<User> getUserList();

```

```xml

select * from t_user

</select>

```

## 查询单个数据

```java

/**?

* 查询用户的总记录数?

* @return?

* 在MyBatis中，对于Java中常用的类型都设置了类型别名?

* 例如：java.lang.Integer-->int|integer?

* 例如：int-->_int|_integer?

* 例如：Map-->map,List-->list?

*/?

int getCount();

```

```xml

select count(id) from t_user

</select>

```

## 查询一条数据为map集合

```java

/**?

* 根据用户id查询用户信息为map集合?

* @param id?

* @return?

*/?

Map<String, Object> getUserToMap(@Param("id") int id);

```

```xml

select * from t_user where id = #{id}

</select>

```

## 查询多条数据为map集合

### 方法一

```java

/**?

* 查询所有用户信息为map集合?

* @return?

* 将表中的数据以map集合的方式查询，一条数据对应一个map；若有多条数据，就会产生多个map集合，此时可以将这些map放在一个list集合中获取?

*/?

List<Map<String, Object>> getAllUserToMap();

```

```xml

?

<select id="getAllUserToMap" resultType="map">?

select * from t_user?

</select>

<!--

结果：

[{password=123456, sex=男, id=1, age=23, username=admin},

{password=123456, sex=男, id=2, age=23, username=张三},

{password=123456, sex=男, id=3, age=23, username=张三}]

-->

```

### 方法二

```java

/**

* 查询所有用户信息为map集合

* @return

* 将表中的数据以map集合的方式查询，一条数据对应一个map；若有多条数据，就会产生多个map集合，并且最终要以一个map的方式返回数据，此时需要通过@MapKey注解设置map集合的键，值是每条数据所对应的map集合

@MapKey("id")

Map<String, Object> getAllUserToMap();

```

```xml

select * from t_user

</select>

<!--

结果：

{

1={password=123456, sex=男, id=1, age=23, username=admin},

2={password=123456, sex=男, id=2, age=23, username=张三},

3={password=123456, sex=男, id=3, age=23, username=张三}

}

-->

```

# 特殊SQL的执行

## 模糊查询

```java

/**

* 根据用户名进行模糊查询

* @param username

* @return java.util.List<com.atguigu.mybatis.pojo.User>

* @date 2022/2/26 21:56

List<User> getUserByLike(@Param("username") String username);

```

```xml

?

?

select * from t_user where username like "%"#{mohu}"%"

</select>

```

- 其中`select * from t_user where username like "%"#{mohu}"%"`是最常用的

## 批量删除

- 只能使用\${}，如果使用#{}，则解析后的sql语句为`delete from t_user where id in ('1,2,3')`，这样是将`1,2,3`看做是一个整体，只有id为`1,2,3`的数据会被删除。正确的语句应该是`delete from t_user where id in (1,2,3)`，或者`delete from t_user where id in ('1','2','3')`

```java

/**

* 根据id批量删除

* @param ids

* @return int

* @date 2022/2/26 22:06

int deleteMore(@Param("ids") String ids);

```

```xml

delete from t_user where id in (${ids})

</delete>

```

```java

//测试类

@Test

public void deleteMore() {

SqlSession sqlSession = SqlSessionUtils.getSqlSession();

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

int result = mapper.deleteMore("1,2,3,8");

System.out.println(result);

}

```

## 动态设置表名

- 只能使用${}，因为表名不能加单引号

```java

/**

* 查询指定表中的数据

* @param tableName

* @return java.util.List<com.atguigu.mybatis.pojo.User>

* @date 2022/2/27 14:41

List<User> getUserByTable(@Param("tableName") String tableName);

```

```xml

select * from ${tableName}

</select>

```

## 添加功能获取自增的主键

- 使用场景

- t_clazz(clazz_id,clazz_name)?

- t_student(student_id,student_name,clazz_id)?

1. 添加班级信息?

2. 获取新添加的班级的id?

3. 为班级分配学生，即将某学的班级id修改为新添加的班级的id

- 在mapper.xml中设置两个属性

- useGeneratedKeys：设置使用自增的主键?

* keyProperty：因为增删改有统一的返回值是受影响的行数，因此只能将获取的自增的主键放在传输的参数user对象的某个属性中

```java

/**

* 添加用户信息

* @param user

* @date 2022/2/27 15:04

void insertUser(User user);

```

```xml

insert into t_user values (null,#{username},#{password},#{age},#{sex},#{email})

</insert>

```

```java

//测试类

@Test

public void insertUser() {

SqlSession sqlSession = SqlSessionUtils.getSqlSession();

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

User user = new User(null, "ton", "123", 23, "男", "123@321.com");

mapper.insertUser(user);

System.out.println(user);

//输出：user{id=10, username='ton', password='123', age=23, sex='男', email='123@321.com'}，自增主键存放到了user的id属性中

}

```

# 自定义映射resultMap

## resultMap处理字段和属性的映射关系

- resultMap：设置自定义映射?

- 属性：?

- id：表示自定义映射的唯一标识，不能重复

- type：查询的数据要映射的实体类的类型?

- 子标签：?

- id：设置主键的映射关系?

- result：设置普通字段的映射关系?

- 子标签属性：?

- property：设置映射关系中实体类中的属性名?

- column：设置映射关系中表中的字段名

- 若字段名和实体类中的属性名不一致，则可以通过resultMap设置自定义映射，即使字段名和属性名一致的属性也要映射，也就是全部属性都要列出来

```xml

</resultMap>

select * from t_emp

</select>

```

- 若字段名和实体类中的属性名不一致，但是字段名符合数据库的规则（使用_），实体类中的属性名符合Java的规则（使用驼峰）。此时也可通过以下两种方式处理字段名和实体类中的属性的映射关系?

1. 可以通过为字段起别名的方式，保证和实体类中的属性名保持一致?

```xml

select eid,emp_name empName,age,sex,email from t_emp

</select>

```

2. 可以在MyBatis的核心配置文件中的`setting`标签中，设置一个全局配置信息mapUnderscoreToCamelCase，可以在查询表中数据时，自动将_类型的字段名转换为驼峰，例如：字段名user_name，设置了mapUnderscoreToCamelCase，此时字段名就会转换为userName。[核心配置文件详解](#核心配置文件详解)

```xml

? ? <settings>

? ? ? ? <setting name="mapUnderscoreToCamelCase" value="true"/>

? ? </settings>

```

## 多对一映射处理

>查询员工信息以及员工所对应的部门信息

```java

public class Emp {?

private Integer eid;?

private String empName;?

private Integer age;?

private String sex;?

private String email;?

private Dept dept;

//...构造器、get、set方法等

}

```

### 级联方式处理映射关系

```xml

</resultMap>

select * from t_emp left join t_dept on t_emp.eid = t_dept.did where t_emp.eid = #{eid}

</select>

```

### 使用association处理映射关系

- association：处理多对一的映射关系

- property：需要处理多对的映射关系的属性名

- javaType：该属性的类型

```xml

</association>

</resultMap>

select * from t_emp left join t_dept on t_emp.eid = t_dept.did where t_emp.eid = #{eid}

</select>

```

### 分步查询

#### 1. 查询员工信息

- select：设置分布查询的sql的唯一标识（namespace.SQLId或mapper接口的全类名.方法名）

- column：设置分步查询的条件

```java

//EmpMapper里的方法

/**

* 通过分步查询，员工及所对应的部门信息

* 分步查询第一步：查询员工信息

* @param?

* @return com.atguigu.mybatis.pojo.Emp

* @date 2022/2/27 20:17

Emp getEmpAndDeptByStepOne(@Param("eid") Integer eid);

```

```xml

<association property="dept"

select="com.atguigu.mybatis.mapper.DeptMapper.getEmpAndDeptByStepTwo"

column="did"></association>

</resultMap>

select * from t_emp where eid = #{eid}

</select>

```

#### 2. 查询部门信息

```java

//DeptMapper里的方法

/**

* 通过分步查询，员工及所对应的部门信息

* 分步查询第二步：通过did查询员工对应的部门信息

* @param

* @return com.atguigu.mybatis.pojo.Emp

* @date 2022/2/27 20:23

Dept getEmpAndDeptByStepTwo(@Param("did") Integer did);

```

```xml

</resultMap>

select * from t_dept where did = #{did}

</select>

```

## 一对多映射处理

```java

public class Dept {

? ? private Integer did;

? ? private String deptName;

? ? private List<Emp> emps;

//...构造器、get、set方法等

}

```

### collection

- collection：用来处理一对多的映射关系

- ofType：表示该属性对饮的集合中存储的数据的类型

```xml

</collection>

</resultMap>

select * from t_dept left join t_emp on t_dept.did = t_emp.did where t_dept.did = #{did}

</select>

```

### 分步查询

####? 1. 查询部门信息

```java

/**

* 通过分步查询，查询部门及对应的所有员工信息

* 分步查询第一步：查询部门信息

* @param did

* @return com.atguigu.mybatis.pojo.Dept

* @date 2022/2/27 22:04

Dept getDeptAndEmpByStepOne(@Param("did") Integer did);

```

```xml

<collection property="emps"

select="com.atguigu.mybatis.mapper.EmpMapper.getDeptAndEmpByStepTwo"

column="did"></collection>

</resultMap>

select * from t_dept where did = #{did}

</select>

```

#### 2. 根据部门id查询部门中的所有员工

```java

/**

* 通过分步查询，查询部门及对应的所有员工信息

* 分步查询第二步：根据部门id查询部门中的所有员工

* @param did

* @return java.util.List<com.atguigu.mybatis.pojo.Emp>

* @date 2022/2/27 22:10

List<Emp> getDeptAndEmpByStepTwo(@Param("did") Integer did);

```

```xml

select * from t_emp where did = #{did}

</select>

```

## 延迟加载

- 分步查询的优点：可以实现延迟加载，但是必须在核心配置文件中设置全局配置信息：

- lazyLoadingEnabled：延迟加载的全局开关。当开启时，所有关联对象都会延迟加载?

- aggressiveLazyLoading：当开启时，任何方法的调用都会加载该对象的所有属性。否则，每个属性会按需加载?

- 此时就可以实现按需加载，获取的数据是什么，就只会执行相应的sql。此时可通过association和collection中的fetchType属性设置当前的分步查询是否使用延迟加载，fetchType="lazy(延迟加载)|eager(立即加载)"

```xml

</settings>

```

```java

@Test

public void getEmpAndDeptByStepOne() {

SqlSession sqlSession = SqlSessionUtils.getSqlSession();

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

Emp emp = mapper.getEmpAndDeptByStepOne(1);

System.out.println(emp.getEmpName());

}

```

- 关闭延迟加载，两条SQL语句都运行了![](Resources/延迟加载测试1.png)

- 开启延迟加载，只运行获取emp的SQL语句

![](Resources/延迟加载测试2.png)

```java

@Test

public void getEmpAndDeptByStepOne() {

SqlSession sqlSession = SqlSessionUtils.getSqlSession();

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

Emp emp = mapper.getEmpAndDeptByStepOne(1);

System.out.println(emp.getEmpName());

System.out.println("----------------");

System.out.println(emp.getDept());

}

```

- 开启后，需要用到查询dept的时候才会调用相应的SQL语句![](Resources/延迟加载测试3.png)

- fetchType：当开启了全局的延迟加载之后，可以通过该属性手动控制延迟加载的效果，fetchType="lazy(延迟加载)|eager(立即加载)"

```xml

<association property="dept"

select="com.atguigu.mybatis.mapper.DeptMapper.getEmpAndDeptByStepTwo"

column="did"

fetchType="lazy"></association>

</resultMap>

```

# 动态SQL

- Mybatis框架的动态SQL技术是一种根据特定条件动态拼装SQL语句的功能，它存在的意义是为了解决拼接SQL语句字符串时的痛点问题

## if

- if标签可通过test属性（即传递过来的数据）的表达式进行判断，若表达式的结果为true，则标签中的内容会执行；反之标签中的内容不会执行

- 在where后面添加一个恒成立条件`1=1`

- 这个恒成立条件并不会影响查询的结果

- 这个`1=1`可以用来拼接`and`语句，例如：当empName为null时

- 如果不加上恒成立条件，则SQL语句为`select * from t_emp where and age = and sex = and email = ?`，此时`where`会与`and`连用，SQL语句会报错

- 如果加上一个恒成立条件，则SQL语句为`select * from t_emp where 1= 1 and age = and sex = and email = ?`，此时不报错

```xml

select * from t_emp where 1=1

and emp_name = #{empName}

</if>

and age = #{age}

</if>

and sex = #{sex}

</if>

and email = #{email}

</if>

</select>

```

## where

- where和if一般结合使用：

- 若where标签中的if条件都不满足，则where标签没有任何功能，即不会添加where关键字?

- 若where标签中的if条件满足，则where标签会自动添加where关键字，并将条件最前方多余的and/or去掉?

```xml

select * from t_emp

<where>

emp_name = #{empName}

</if>

and age = #{age}

</if>

and sex = #{sex}

</if>

and email = #{email}

</if>

</where>

</select>

```

- 注意：where标签不能去掉条件后多余的and/or

```xml

emp_name = #{empName} and

</if>

age = #{age}

</if>

```

## trim

- trim用于去掉或添加标签中的内容?

- 常用属性

- prefix：在trim标签中的内容的前面添加某些内容?

- suffix：在trim标签中的内容的后面添加某些内容

- prefixOverrides：在trim标签中的内容的前面去掉某些内容?

- suffixOverrides：在trim标签中的内容的后面去掉某些内容

- 若trim中的标签都不满足条件，则trim标签没有任何效果，也就是只剩下`select * from t_emp`

```xml

select * from t_emp

emp_name = #{empName} and

</if>

age = #{age} and

</if>

sex = #{sex} or

</if>

email = #{email}

</if>

</trim>

</select>

```

```java

//测试类

@Test

public void getEmpByCondition() {

SqlSession sqlSession = SqlSessionUtils.getSqlSession();

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

List<Emp> emps= mapper.getEmpByCondition(new Emp(null, "张三", null, null, null, null));

System.out.println(emps);

}

```

![](Resources/trim测试结果.png)

## choose、when、otherwise

- `choose、when、otherwise`相当于`if...else if..else`

- when至少要有一个，otherwise至多只有一个

```xml

select * from t_emp

<where>

emp_name = #{empName}

</when>

age = #{age}

</when>

sex = #{sex}

</when>

email = #{email}

</when>

did = 1

</otherwise>

</choose>

</where>

</select>

```

```java

@Test

public void getEmpByChoose() {

SqlSession sqlSession = SqlSessionUtils.getSqlSession();

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

List<Emp> emps = mapper.getEmpByChoose(new Emp(null, "张三", 23, "男", "123@qq.com", null));

System.out.println(emps);

}

```

![](Resources/choose测试结果.png)

- 相当于`if a else if b else if c else d`，只会执行其中一个

## foreach

- 属性：?

- collection：设置要循环的数组或集合?

- item：表示集合或数组中的每一个数据?

- separator：设置循环体之间的分隔符，分隔符前后默认有一个空格，如` , `

- open：设置foreach标签中的内容的开始符?

- close：设置foreach标签中的内容的结束符

- 批量删除

```xml

delete from t_emp where eid in

#{eid}

</foreach>

</delete>

```

```java

@Test

public void deleteMoreByArray() {

SqlSession sqlSession = SqlSessionUtils.getSqlSession();

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

int result = mapper.deleteMoreByArray(new Integer[]{6, 7, 8, 9});

System.out.println(result);

}

```

![](Resources/foreach测试结果1.png)

- 批量添加

```xml

insert into t_emp values

(null,#{emp.empName},#{emp.age},#{emp.sex},#{emp.email},null)

</foreach>

</insert>

```

```java

@Test

public void insertMoreByList() {

SqlSession sqlSession = SqlSessionUtils.getSqlSession();

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

Emp emp1 = new Emp(null,"a",1,"男","123@321.com",null);

Emp emp2 = new Emp(null,"b",1,"男","123@321.com",null);

Emp emp3 = new Emp(null,"c",1,"男","123@321.com",null);

List<Emp> emps = Arrays.asList(emp1, emp2, emp3);

int result = mapper.insertMoreByList(emps);

System.out.println(result);

}

```

![](Resources/foreach测试结果2.png)

## SQL片段

- sql片段，可以记录一段公共sql片段，在使用的地方通过include标签进行引入

- 声明sql片段：`<sql>`标签

```xml

<sql id="empColumns">eid,emp_name,age,sex,email</sql>

```

- 引用sql片段：`<include>`标签

```xml

select <include refid="empColumns"></include> from t_emp

</select>

```

# MyBatis的缓存

## MyBatis的一级缓存

- 一级缓存是SqlSession级别的，通过同一个SqlSession查询的数据会被缓存，下次查询相同的数据，就会从缓存中直接获取，不会从数据库重新访问?

- 使一级缓存失效的四种情况：?

1. 不同的SqlSession对应不同的一级缓存?

2. 同一个SqlSession但是查询条件不同

3. 同一个SqlSession两次查询期间执行了任何一次增删改操作

4. 同一个SqlSession两次查询期间手动清空了缓存

## MyBatis的二级缓存

- 二级缓存是SqlSessionFactory级别，通过同一个SqlSessionFactory创建的SqlSession查询的结果会被缓存；此后若再次执行相同的查询语句，结果就会从缓存中获取?

- 二级缓存开启的条件

1. 在核心配置文件中，设置全局配置属性cacheEnabled="true"，默认为true，不需要设置

2. 在映射文件中设置标签<cache />

3. 二级缓存必须在SqlSession关闭或提交之后有效

4. 查询的数据所转换的实体类类型必须实现序列化的接口

- 使二级缓存失效的情况：两次查询之间执行了任意的增删改，会使一级和二级缓存同时失效

## 二级缓存的相关配置

- 在mapper配置文件中添加的cache标签可以设置一些属性

- eviction属性：缓存回收策略?

- LRU（Least Recently Used） – 最近最少使用的：移除最长时间不被使用的对象。?

- FIFO（First in First out） – 先进先出：按对象进入缓存的顺序来移除它们。?

- SOFT – 软引用：移除基于垃圾回收器状态和软引用规则的对象。?

- WEAK – 弱引用：更积极地移除基于垃圾收集器状态和弱引用规则的对象。

- 默认的是 LRU

- flushInterval属性：刷新间隔，单位毫秒

- 默认情况是不设置，也就是没有刷新间隔，缓存仅仅调用语句（增删改）时刷新

- size属性：引用数目，正整数

- 代表缓存最多可以存储多少个对象，太大容易导致内存溢出

- readOnly属性：只读，true/false

- true：只读缓存；会给所有调用者返回缓存对象的相同实例。因此这些对象不能被修改。这提供了很重要的性能优势。?

- false：读写缓存；会返回缓存对象的拷贝（通过序列化）。这会慢一些，但是安全，因此默认是false

## MyBatis缓存查询的顺序

- 先查询二级缓存，因为二级缓存中可能会有其他程序已经查出来的数据，可以拿来直接使用?

- 如果二级缓存没有命中，再查询一级缓存?

- 如果一级缓存也没有命中，则查询数据库?

- SqlSession关闭之后，一级缓存中的数据会写入二级缓存

## 整合第三方缓存EHCache（了解）

### 添加依赖

```xml

<groupId>org.mybatis.caches</groupId>

<artifactId>mybatis-ehcache</artifactId>

</dependency>

<groupId>ch.qos.logback</groupId>

<artifactId>logback-classic</artifactId>

</dependency>

```

### 各个jar包的功能

| jar包名称 | 作用 |

| --- | --- |

| mybatis-ehcache | Mybatis和EHCache的整合包 |

| ehcache | EHCache核心包 |

| slf4j-api | SLF4J日志门面包 |

| logback-classic | 支持SLF4J门面接口的一个具体实现 |

### 创建EHCache的配置文件ehcache.xml

- 名字必须叫`ehcache.xml`

```xml

<?xml version="1.0" encoding="utf-8" ?>

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

? ? ? ? xsi:noNamespaceSchemaLocation="../config/ehcache.xsd">

? ?

? ? <diskStore path="D:\atguigu\ehcache"/>

? ? <defaultCache

? ? ? ? ? ? maxElementsInMemory="1000"

? ? ? ? ? ? maxElementsOnDisk="10000000"

? ? ? ? ? ? eternal="false"

? ? ? ? ? ? overflowToDisk="true"

? ? ? ? ? ? timeToIdleSeconds="120"

? ? ? ? ? ? timeToLiveSeconds="120"

? ? ? ? ? ? diskExpiryThreadIntervalSeconds="120"

? ? ? ? ? ? memoryStoreEvictionPolicy="LRU">

? ? </defaultCache>

</ehcache>

```

### 设置二级缓存的类型

- 在xxxMapper.xml文件中设置二级缓存类型

```xml

```

### 加入logback日志

- 存在SLF4J时，作为简易日志的log4j将失效，此时我们需要借助SLF4J的具体实现logback来打印日志。创建logback的配置文件`logback.xml`，名字固定，不可改变

```xml

<?xml version="1.0" encoding="UTF-8"?>

? ?

? ? <appender name="STDOUT"

? ? ? ? ? ? ? class="ch.qos.logback.core.ConsoleAppender">

? ? ? ? <encoder>

? ? ? ? ? ?

? ? ? ? ? ?

? ? ? ? ? ? <pattern>[%d{HH:mm:ss.SSS}] [%-5level] [%thread] [%logger] [%msg]%n</pattern>

? ? ? ? </encoder>

? ? </appender>

? ?

? ?

? ? <root level="DEBUG">

? ? ? ?

? ? ? ? <appender-ref ref="STDOUT" />

? ? </root>

? ?

? ? <logger name="com.atguigu.crowd.mapper" level="DEBUG"/>

</configuration>

```

### EHCache配置文件说明

| 属性名 | 是否必须 | 作用 |

| --- | --- | --- |

| maxElementsInMemory | 是 | 在内存中缓存的element的最大数目 |

| maxElementsOnDisk | 是 | 在磁盘上缓存的element的最大数目，若是0表示无穷大 |

| eternal | 是 | 设定缓存的elements是否永远不过期。如果为true，则缓存的数据始终有效，如果为false那么还要根据timeToIdleSeconds、timeToLiveSeconds判断 |

| overflowToDisk | 是 | 设定当内存缓存溢出的时候是否将过期的element缓存到磁盘上 |

| timeToIdleSeconds | 否 | 当缓存在EhCache中的数据前后两次访问的时间超过timeToIdleSeconds的属性取值时，这些数据便会删除，默认值是0,也就是可闲置时间无穷大 |

| timeToLiveSeconds | 否 | 缓存element的有效生命期，默认是0.,也就是element存活时间无穷大 |

| diskSpoolBufferSizeMB | 否 | DiskStore(磁盘缓存)的缓存区大小。默认是30MB。每个Cache都应该有自己的一个缓冲区 |

| diskPersistent | 否 | 在VM重启的时候是否启用磁盘保存EhCache中的数据，默认是false |

| diskExpiryThreadIntervalSeconds | 否 | 磁盘缓存的清理线程运行间隔，默认是120秒。每个120s，相应的线程会进行一次EhCache中数据的清理工作 |

| memoryStoreEvictionPolicy | 否 | 当内存缓存达到最大，有新的element加入的时候，移除缓存中element的策略。默认是LRU（最近最少使用），可选的有LFU（最不常使用）和FIFO（先进先出 |

# MyBatis的逆向工程

- 正向工程：先创建Java实体类，由框架负责根据实体类生成数据库表。Hibernate是支持正向工程的

- 逆向工程：先创建数据库表，由框架负责根据数据库表，反向生成如下资源：?

- Java实体类?

- Mapper接口?

- Mapper映射文件

## 创建逆向工程的步骤

### 添加依赖和插件

```xml

<groupId>org.mybatis</groupId>

<artifactId>mybatis</artifactId>

</dependency>

<groupId>junit</groupId>

<artifactId>junit</artifactId>

</dependency>

<groupId>mysql</groupId>

<artifactId>mysql-connector-java</artifactId>

</dependency>

</dependency>

</dependencies>

<build>

<groupId>org.mybatis.generator</groupId>

<artifactId>mybatis-generator-maven-plugin</artifactId>

<groupId>org.mybatis.generator</groupId>

<artifactId>mybatis-generator-core</artifactId>

</dependency>

<groupId>com.mchange</groupId>

</dependency>

<groupId>mysql</groupId>

<artifactId>mysql-connector-java</artifactId>

</dependency>

</dependencies>

</plugin>

</plugins>

</build>

```

### 创建MyBatis的核心配置文件

```xml

<?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">

? ? <properties resource="jdbc.properties"/>

? ? <typeAliases>

? ? ? ? <package name=""/>

? ? </typeAliases>

? ? <environments default="development">

? ? ? ? <environment id="development">

? ? ? ? ? ? <transactionManager type="JDBC"/>

? ? ? ? ? ? <dataSource type="POOLED">

? ? ? ? ? ? ? ? <property name="driver" value="${jdbc.driver}"/>

? ? ? ? ? ? ? ? <property name="url" value="${jdbc.url}"/>

? ? ? ? ? ? ? ? <property name="username" value="${jdbc.username}"/>

? ? ? ? ? ? ? ? <property name="password" value="${jdbc.password}"/>

? ? ? ? ? ? </dataSource>

? ? ? ? </environment>

? ? </environments>

? ? <mappers>

? ? ? ? <package name=""/>

? ? </mappers>

</configuration>

```

### 创建逆向工程的配置文件

- 文件名必须是：`generatorConfig.xml`

```xml

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE generatorConfiguration

? ? ? ? PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"

? ? ? ? "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

? ? <!--

? ? targetRuntime: 执行生成的逆向工程的版本

? ? MyBatis3Simple: 生成基本的CRUD（清新简洁版）

? ? MyBatis3: 生成带条件的CRUD（奢华尊享版）

? ? -->

? ? <context id="DB2Tables" targetRuntime="MyBatis3Simple">

? ? ? ?

? ? ? ? <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"

? ? ? ? ? ? ? ? ? ? ? ? connectionURL="jdbc:mysql://localhost:3306/mybatis"

? ? ? ? ? ? ? ? ? ? ? ? userId="root"

? ? ? ? ? ? ? ? ? ? ? ? password="123456">

? ? ? ? </jdbcConnection>

? ? ? ?

? ? ? ? <javaModelGenerator targetPackage="com.atguigu.mybatis.pojo" targetProject=".\src\main\java">

? ? ? ? ? ? <property name="enableSubPackages" value="true" />

? ? ? ? ? ? <property name="trimStrings" value="true" />

? ? ? ? </javaModelGenerator>

? ? ? ?

? ? ? ? <sqlMapGenerator targetPackage="com.atguigu.mybatis.mapper"

? ? ? ? ? ? ? ? ? ? ? ? targetProject=".\src\main\resources">

? ? ? ? ? ? <property name="enableSubPackages" value="true" />

? ? ? ? </sqlMapGenerator>

? ? ? ?

? ? ? ? <javaClientGenerator type="XMLMAPPER"

? ? ? ? ? ? ? ? ? ? ? ? ? ? targetPackage="com.atguigu.mybatis.mapper" targetProject=".\src\main\java">

? ? ? ? ? ? <property name="enableSubPackages" value="true" />

? ? ? ? </javaClientGenerator>

? ? ? ?

? ? ? ?

? ? ? ?

? ? ? ? <table tableName="t_emp" domainObjectName="Emp"/>

? ? ? ? <table tableName="t_dept" domainObjectName="Dept"/>

? ? </context>

</generatorConfiguration>

```

### 执行MBG插件的generate目标

- ![](Resources/执行MBG插件的generate目标.png)

- 如果出现报错：`Exception getting JDBC Driver`，可能是pom.xml中，数据库驱动配置错误

- dependency中的驱动![](Resources/dependency中的驱动.png)

- mybatis-generator-maven-plugin插件中的驱动![](Resources/插件中的驱动.png)

- 两者的驱动版本应该相同

- 执行结果![](Resources/逆向执行结果.png)

## QBC

### 查询

- `selectByExample`：按条件查询，需要传入一个example对象或者null；如果传入一个null，则表示没有条件，也就是查询所有数据

- `example.createCriteria().xxx`：创建条件对象，通过andXXX方法为SQL添加查询添加，每个条件之间是and关系

- `example.or().xxx`：将之前添加的条件通过or拼接其他条件

![](Resources/example的方法.png)

```java

@Test public void testMBG() throws IOException {

InputStream is = Resources.getResourceAsStream("mybatis-config.xml");

SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();

SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);

SqlSession sqlSession = sqlSessionFactory.openSession(true);

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

EmpExample example = new EmpExample();

//名字为张三，且年龄大于等于20

example.createCriteria().andEmpNameEqualTo("张三").andAgeGreaterThanOrEqualTo(20);

//或者did不为空

example.or().andDidIsNotNull();

List<Emp> emps = mapper.selectByExample(example);

emps.forEach(System.out::println);

}

```

![](Resources/example测试结果.png)

### 增改

- `updateByPrimaryKey`：通过主键进行数据修改，如果某一个值为null，也会将对应的字段改为null

- `mapper.updateByPrimaryKey(new Emp(1,"admin",22,null,"456@qq.com",3));`

- ![](Resources/增删改测试结果1.png)

- `updateByPrimaryKeySelective()`：通过主键进行选择性数据修改，如果某个值为null，则不修改这个字段

- `mapper.updateByPrimaryKeySelective(new Emp(2,"admin2",22,null,"456@qq.com",3));`

- ![](Resources/增删改测试结果2.png)

# 分页插件

## 分页插件使用步骤

### 添加依赖

```xml

<groupId>com.github.pagehelper</groupId>

<artifactId>pagehelper</artifactId>

</dependency>

```

### 配置分页插件

- 在MyBatis的核心配置文件（mybatis-config.xml）中配置插件

- ![](Resources/配置分页插件.png)

```xml

</plugins>

```

## 分页插件的使用

### 开启分页功能

- 在查询功能之前使用`PageHelper.startPage(int pageNum, int pageSize)`开启分页功能

- pageNum：当前页的页码?

- pageSize：每页显示的条数

```java

@Test

public void testPageHelper() throws IOException {

InputStream is = Resources.getResourceAsStream("mybatis-config.xml");

SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();

SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);

SqlSession sqlSession = sqlSessionFactory.openSession(true);

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

//访问第一页，每页四条数据

PageHelper.startPage(1,4);

List<Emp> emps = mapper.selectByExample(null);

emps.forEach(System.out::println);

}

```

![](Resources/分页测试结果.png)

### 分页相关数据

#### 方法一：直接输出

```java

@Test

public void testPageHelper() throws IOException {

InputStream is = Resources.getResourceAsStream("mybatis-config.xml");

SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();

SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);

SqlSession sqlSession = sqlSessionFactory.openSession(true);

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

//访问第一页，每页四条数据

Page<Object> page = PageHelper.startPage(1, 4);

List<Emp> emps = mapper.selectByExample(null);

//在查询到List集合后，打印分页数据

System.out.println(page);

}

```

- 分页相关数据：

```

Page{count=true, pageNum=1, pageSize=4, startRow=0, endRow=4, total=8, pages=2, reasonable=false, pageSizeZero=false}[Emp{eid=1, empName='admin', age=22, sex='男', email='456@qq.com', did=3}, Emp{eid=2, empName='admin2', age=22, sex='男', email='456@qq.com', did=3}, Emp{eid=3, empName='王五', age=12, sex='女', email='123@qq.com', did=3}, Emp{eid=4, empName='赵六', age=32, sex='男', email='123@qq.com', did=1}]

```

#### 方法二使用PageInfo

- 在查询获取list集合之后，使用`PageInfo<T> pageInfo = new PageInfo<>(List<T> list, intnavigatePages)`获取分页相关数据

- list：分页之后的数据?

- navigatePages：导航分页的页码数

```java

@Test

public void testPageHelper() throws IOException {

InputStream is = Resources.getResourceAsStream("mybatis-config.xml");

SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();

SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);

SqlSession sqlSession = sqlSessionFactory.openSession(true);

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

PageHelper.startPage(1, 4);

List<Emp> emps = mapper.selectByExample(null);

PageInfo<Emp> page = new PageInfo<>(emps,5);

System.out.println(page);

}

```

- 分页相关数据：

```

PageInfo{

pageNum=1, pageSize=4, size=4, startRow=1, endRow=4, total=8, pages=2,

list=Page{count=true, pageNum=1, pageSize=4, startRow=0, endRow=4, total=8, pages=2, reasonable=false, pageSizeZero=false}[Emp{eid=1, empName='admin', age=22, sex='男', email='456@qq.com', did=3}, Emp{eid=2, empName='admin2', age=22, sex='男', email='456@qq.com', did=3}, Emp{eid=3, empName='王五', age=12, sex='女', email='123@qq.com', did=3}, Emp{eid=4, empName='赵六', age=32, sex='男', email='123@qq.com', did=1}],

prePage=0, nextPage=2, isFirstPage=true, isLastPage=false, hasPreviousPage=false, hasNextPage=true, navigatePages=5, navigateFirstPage=1, navigateLastPage=2, navigatepageNums=[1, 2]}

```

- 其中list中的数据等同于方法一中直接输出的page数据

#### 常用数据：

- pageNum：当前页的页码?

- pageSize：每页显示的条数?

- size：当前页显示的真实条数?

- total：总记录数?

- pages：总页数?

- prePage：上一页的页码?

- nextPage：下一页的页码

- isFirstPage/isLastPage：是否为第一页/最后一页?

- hasPreviousPage/hasNextPage：是否存在上一页/下一页?

- navigatePages：导航分页的页码数?

- navigatepageNums：导航分页的页码，\[1,2,3,4,5]

查看全文

https://www.xamrdz.com/backend/3cf1934948.html

相关文章：