MyBatis

MyBatis

1、MyBatis简介

1.1、MyBatis特性

MyBatis是一个基于java的持久层框架，包括SQL Maps和Data Access Object（DAO）

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

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

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

MyBatis 是一个半自动的ORM(Object Relation Mapping)框架

1.2、MyBatis下载

https://github.com/mybatis/mybatis-3

1.3、和其它持久化层技术对比

• JDBC

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

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

  • 代码冗长，开发效率低

• Hibernate 和 JPA

  • 操作简便，开发效率高

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

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

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

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

• MyBatis

  • 轻量级，性能出色

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

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

2、搭建MyBatis

2.1、创建工程

创建Maven工程，设置打包方式为jar，引入依赖

 <!--pom.xml-->
     <dependencies>
         <!-- Mybatis核心 --> 
         <dependency>
             <groupId>org.mybatis</groupId>
             <artifactId>mybatis</artifactId>
             <version>3.5.7</version>
         </dependency>
         <!-- junit测试 --> 
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
             <version>4.12</version>
             <scope>test</scope>
         </dependency>
         <!-- MySQL驱动 --> 
         <dependency>
             <groupId>mysql</groupId>
             <artifactId>mysql-connector-java</artifactId>
             <version>5.1.3</version>
         </dependency>
     </dependencies>

 

2.2、创建MyBatis核心配置文件

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

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

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

<!--==========src/main/resources/mybatis-config.xml.tld============-->
<?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="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>
    <!--引入映射文件-->
    <mappers>
        <mapper resource="org/mybatis/example/BlogMapper.xml"/>
    </mappers>
</configuration>

 

2.3、创建mapper接口

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

 

2.4、创建MyBatis的映射文件

• 相关概念:ORM(Object Relationship Mapping)对象关系映射。

  • 对象:Java的实体类对象

  • 关系:关系型数据库

  • 映射:二者之间的对应关系

Java概念	数据库概念
类	表
属性	字段 / 列
对象	记录 / 行

1. 映射文件的命名规则:

表所对应的实体类的类名+Mapper.xml 例如:表t_user，映射的实体类为User，所对应的映射文件为UserMapper.xml

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

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

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

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

   1. mapper接口的全类名和映射文件的命名空间(namespace)保持一致

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

<!--================src/main/resources/mappers/UserMapper.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.colin.mybatis.mapper.UserMapper">

    <!--int insertUser();-->
    <insert id="insertUser">
        insert into t_user values(null,'admin','123456',23,'男','12345@qq.com')
    </insert>

</mapper>

 

2.5、通过jUnit测试功能

报错Cannot find class: com.mysql.cj.jdbc.Driver:数据库连接驱动的版本不正确，在pom.xml中将mysql:mysql-connector-java:8.0.29改为最新版本即可

SqlSession:代表Java程序和数据库之间的会话。(HttpSession是Java程序和浏览器之间的 会话)

SqlSessionFactory:是“生产”SqlSession的“工厂”。

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

 

public class MyBatisTest {

    @Test
    public void testMyBatis() throws IOException {
        // 1.读取MyBatis的核心配置文件
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");

        // 2.获取SqlSessionFactoryBuilder
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();

        // 3.通过核心配置文件所对应的字节输入流创建工厂类SqlSessionFactory，生产SqlSession对象
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);

        // 4.创建SqlSession对象，此时通过SqlSession对象所操作的sql都必须手动提交或回滚事务
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // 创建SqlSession对象，此时通过SqlSession对象所操作的sql都会自动提交
				// SqlSession sqlSession = sqlSessionFactory.openSession(true);

        // 5.通过代理模式创建UserMapper接口的代理实现类对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);

        // 6.调用UserMapper接口中的方法，就可以根据UserMapper的全类名匹配元素文件，通过调用的方法名匹配映射文件中的SQL标签，并执行标签中的SQL语句
        int result = mapper.insertUser();

        // 7.提交事务
        sqlSession.commit();

        System.out.println("result = " + result);

    }

}

 

2.6、加入log4j日志功能

加入依赖：

<!-- log4j日志 --> 
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

 

加入log4j的配置文件：

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

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

<!--=================log4j.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">
            <param name="ConversionPattern" value="%-5p %d{MM-dd HH:mm:ss,SSS}%m  (%F:%L) \n" />
        </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>

 

 

3、核心配置文件

<!--src/main/resources/mybatis-config.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>

    <!--
        MyBatis核心配置文件中标签的顺序：
        properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,
        objectWrapperFactory?,reflectorFactory?,plugins?,environments?,
        databaseIdProvider?,mappers?
    -->

    <!--引入properties文件，properties文件在resources目录下可以直接访问-->
    <properties resource="jdbc.properties"/>
    <!--<properties resource="mappers/jdbc.properties"/>-->

    <!--设置类型别名-->
    <typeAliases>
        <!--
						方式一：
            typeAlias:设置某个类型的别名
            属性：
                type:设置需要设置别名的类型
                alias:设置某个类型的别名，若不设置该属性，则该类型拥有默认的别名（不区分首字母大小写的类名）
        -->
        <typeAlias type="com.colin.mybatis.pojo.User" alias="User"></typeAlias>
        <!--方式二：以包为单位，将包下所有类型设置默认的类型别名（不区分首字母大小写的类名）-->
        <package name="com.colin.mybatis.pojo"/>
    </typeAliases>

    <!--配置连接数据库的环境-->
    <!--
        enviroments:配置多个连接数据库的环境
        属性：
            default:设置默认使用的环境的id
    -->
    <environments default="development">
        <!--
            enviroment:配置某个具体的环境
            属性：
                id:连接数据库的环境的唯一标识，不能重复
        -->
        <environment id="development">
            <!--
                transactionManager:设置事务管理方式
                属性：
                    type="JDBC"/"MANAGED"
                    JDBC:当前环境中执行sql时使用的时JDBC中原生的事务管理方式，事务的提交回滚需要手动处理
                    MANAGED:设置事务被管理，例如spring中的AOP
            -->
            <transactionManager type="JDBC"/>
            <!--
                dataSource:配置数据源
                属性：
                    type:设置数据源的类型
                    type="POOLED"/"UNPOOLED"/"JNDI"
                    POOLED:表示使用数据库连接池缓存数据库连接
                    UNPOOLED:表示不使用数据库连接池
                    JNDI:表示使用上下文中的数据源
            -->
            <dataSource type="POOLED">
                <!--properties文件中键名设置为xxx.xxx是为了防止重名，因为${}是通过键名直接获取对应的值的-->
                <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>
        <!--mapper:引入单个映射文件，要求文件在resources目录下-->
        <!--src/main/resources/mappers/UserMapper.xml-->
        <!--<mapper resource="mappers/UserMapper.xml"/>-->

        <!--
            package:以包为单位，将包下所有的映射文件引入核心配置文件
            要求：
                1）mapper接口和mapper映射文件在相同的包下（在资源目录下创建一个路径相同的文件夹或直接放在接口的mapper文件夹中）
                    例如：src/main/java/com/colin/mybatis/mapper/UserMapper.java
                         src/main/resources/com/colin/mybatis/mapper/UserMapper.xml
                2）mapper接口要和mapper映射文件的名字一致
        -->
        <package name="com.colin.mybatis.mapper"/>
    </mappers>
</configuration>

 

4、MyBatis增删改查

注意:

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

   1. resultType:自动映射，用于属性名和表中字段名一致的情况

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

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

<!--==============UserMapper.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)保持一致-->
<mapper namespace="com.colin.mybatis.mapper.UserMapper">

    <!--int insertUser();-->
    <insert id="insertUser">
        insert into t_user
        values (null,'admin','1234',23,'男','admin@qq.com')
    </insert>
    <!--int updateUser();-->
    <update id="updateUser">
        update t_user set username = 'admin2' where id = 5
    </update>
    <!--int deleteUser();-->
    <delete id="deleteUser">
        delete from t_user where id = 5
    </delete>
    <!--User getUserById();-->
    <select id="getUserById" resultType="com.colin.mybatis.pojo.User">
        select * from t_user where id = 4
    </select>
    <!--List<User> getAllUser();-->
    <select id="getAllUser" resultType="com.colin.mybatis.pojo.User">
        select * from t_user
    </select>

</mapper>

 

//================src/main/java/com/colin/mybatis/mapper/UserMapper.java===============
public interface UserMapper {

    /**
     * 添加用户信息
     */
    int insertUser();

    /**
     * 修改用户信息
     */
    int updateUser();

    /**
     * 删除用户信息
     */
    int deleteUser();

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

    /**
     * 查询所有用户信息
     */
    List<User> getAllUser();

}

 

//==================测试====================
		@Test
    public void testMyBatisCURD() throws IOException {
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
//        int result = mapper.insertUser();
//        int result = mapper.updateUser();
//        int result = mapper.deleteUser();
//        User user = mapper.getUserById();
        List<User> users = mapper.getAllUser();
        sqlSession.commit();
//        System.out.println("result = " + result);
//        System.out.println("user = " + user);
        users.forEach(user -> System.out.println(user));
    }

 

封装SqlSessionUtils工具类

//=============src/main/java/com/colin/mybatis/utils/SqlSessionUtils.java================
public class SqlSessionUtils {

    public static SqlSession getSqlSession(){
        SqlSession sqlSession = null;
        try {
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
            sqlSession = sqlSessionFactory.openSession(true); // 设置自动提交
        } catch (IOException e) {
            e.printStackTrace();
        }
        return sqlSession;
    }

}

//==========测试===========
    @Test
    public void testMyBatisCURD1(){
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> users = mapper.getAllUser();
        users.forEach(user -> System.out.println(user));
    }

 

5、获取参数值的两种方式（重点）

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

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

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

能用#{}就不要用${}

5.1、单个字面量类型的参数

若mapper接口中的方法参数为单个的字面量类型

此时可以使用${}和#{}以任意的名称获取参数的值，注意${}需要手动加单引号

<!--User getUserByUsername(String username);-->
<select id="getUserByUsername" resultType="User">
  	<!--select * from t_user where username = #{username}-->
	  select * from t_user where username = '${username}'
</select>

 

5.2、多个字面量类型的参数

• 若mapper接口中的方法参数为多个时，此时MyBatis会自动将这些参数放在一个map集合中，默认以两种方式进行存储：

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

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

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

    <!--User checkLogin(String username, String password);-->
    <select id="checkLogin" resultType="User">
        <!--select * from t_user where username = #{arg0} and password =#{arg1}-->
        select * from t_user where username = '${param1}' and password = '${param2}'
    </select>

 

5.3、map集合类型的参数

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

手动创建的map集合可以通过自定义的键来访问

    <!--User checkLoginByMap(Map<String,Object> map);-->
    <select id="checkLoginByMap" resultType="User">
        select * from t_user where username = #{username} and password = #{password}
    </select>

 

    @Test
    public void testCheckLoginByMap(){
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        HashMap<String, Object> map = new HashMap<>();
        map.put("username", "admin");
        map.put("password", "1234");
        User user = mapper.checkLoginByMap(map);
        System.out.println(user);
    }

 

5.4、实体类类型的参数

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

属性主要是由get/set方法决定的，而不是成员变量，可能存在有get/set方法但没有成员变量的情况

    <!--int insertUser(User user);-->
    <insert id="insertUser">
        insert into t_user values(null, #{username}, #{password}, #{age}, #{sex}, #{email})
    </insert>

 

    @Test
    public void testInsertUser(){
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        int result = mapper.insertUser(new User(null, "admin3", "123456", 23, "男", "123456@qq.com"));
        System.out.println("result = " + result);
    }

 

5.5、使用@Param标识参数（推荐）

可以通过 @Param 注解标识mapper接口中的方法参数，此时，会将这些参数放在map集合中： 以 @Param 注解的value属性值为键，以参数为值； 以 param1,param2... 为键，以参数为值； 只需要通过${}和#{}访问map集合的键就可以获取相对应的值，注意${}需要手动加单引号

如果需要传输多个字面量类型的参数，建议使用 @Param 方式

    <!--User checkLoginByParam(@Param("username") String username, @Param("password") String password);-->
    <select id="checkLoginByParam" resultType="User">
        select * from t_user where username = #{username} and password = #{password}
    </select>

 

    /**
     * 通过@Param验证登录
     */
    User checkLoginByParam(@Param("username") String username, @Param("password") String password);
//================================
		@Test
    public void testCheckLoginByParam(){
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User user1 = mapper.checkLoginByParam("admin", "1234");
        System.out.println(user1);
    }

 

6、MyBatis的各种查询功能

6.1、查询一个实体类对象

若查询出的数据只有一条，可以通过实体类对象或list集合接收

若查询出的数据有多条，只能通过list集合接收，不能通过实体类对象接收，否则会抛出异常TooManyResultsException

/**
* 根据用户id查询用户信息 * @param id
* @return
*/
User getUserById(@Param("id") int id);	// 推荐使用@Param的方式

 

<!--User getUserById(@Param("id") int id);-->
<select id="getUserById" resultType="User">
    select * from t_user where id = #{id}
</select>

 

6.2、查询一个list集合

/**
* 查询所有用户信息 * @return
*/
List<User> getUserList();

 

<!--List<User> getUserList();-->
<select id="getUserList" resultType="User">
    select * from t_user
</select>

 

6.3、查询单个数据

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

• 例如:java.lang.Integer-->int,integer

• 例如:int-->_int,_integer

• 例如:Map-->map,List-->list,String-->string

/**
* 查询用户的总记录数
* @return
*/
int getCount();

 

<!--int getCount();-->
<select id="getCount" resultType="_integer">
    select count(id) from t_user
</select>

 

6.4、查询一条数据为map集合

/**
* 根据用户id查询用户信息为map集合 
* @param id
* @return
*/
Map<String, Object> getUserToMap(@Param("id") int id);

 

<!--Map<String, Object> getUserToMap(@Param("id") int id);-->
<select id="getUserToMap" resultType="map">
    select * from t_user where id = #{id}
</select>
<!--结果:{password=123456, sex=男, id=1, age=23, username=admin}-->

 

6.5、查询多条数据为map集合

以map集合的形式查询多条数据

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

/**
* 查询所有用户信息为map集合
* @return
*/
List<Map<String, Object>> getAllUserToMap();

 

<!--Map<String, Object> getAllUserToMap();-->
<select id="getAllUserToMap" resultType="map">
    select * from t_user
</select>

 

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

/**
* 查询所有用户信息为map集合
* @return
*/
@MapKey("id")
Map<String, Object> getAllUserToMap();

 

<!--Map<String, Object> getAllUserToMap();-->
<select id="getAllUserToMap" resultType="map">
    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=张三}
} 
-->

 

 

7、特殊SQL的执行

7.1、模糊查询

模糊查询建议使用“%”#{ }"%"这种方式

    /**
     * 根据用户名模糊查询用户信息
     * @param username
     * @return
     */
    List<User> getUserByLike(@Param("username") String username);

 

    <!--List<User> getUserByLike(@Param("username") String username);-->
    <select id="getUserByLike" resultType="User">
        <!--方法一：使用${}-->
        <!--select * from t_user where username like '%${username}%'-->
        <!--方法二：使用concat拼接-->
        <!--select * from t_user where username like concat('%',#{username},'%')-->
        <!--方法三（推荐）：使用"%"#{ }"%"-->
        select * from t_user where username like "%"#{username}"%"
    </select>

 

7.2、批量删除

由于#{}在sql语句中会自动被解析为一对单引号（最终使占位符被解析为一个问号字符），所以批量删除只能使用${}

    /**
     * 批量删除
     * @param ids
     * @return
     */
    int deleteMore(@Param("ids") String ids);
//===============================
    @Test
    public void testDeleteMore(){
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        SelectMapper mapper = sqlSession.getMapper(SelectMapper.class);
        int i = mapper.deleteMore("1,2,7");
        System.out.println("i = " + i);
    }

 

    <!--int deleteMore(@Param("ids") String ids);-->
    <delete id="deleteMore">
        delete from t_user where id in (${ids})
    </delete>

 

7.3、动态设置表名

设置要查询的表的表名，因为表名不能带有单引号，所以动态设置表名只能使用${}

    /**
     * 查询指定表中的数据
     * @param tableName
     * @return
     */
    List<User> getUserByTableName(@Param("tableName") String tableName);
//=========================
    @Test
    public void testGetUserByTableName(){
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        SelectMapper mapper = sqlSession.getMapper(SelectMapper.class);
        List<User> t_user = mapper.getUserByTableName("t_user");
        t_user.forEach(System.out::println);
    }

 

    <!--List<User> getUserByTableName(@Param("tableName") String tableName);-->
    <select id="getUserByTableName" resultType="User">
        select * from ${tableName}
    </select>

 

7.4、添加功能获取自增的主键

获取添加时自增的键对应的值，如user的id

useGeneratedKeys:true表示当前标签中的使用了自增的主键

keyProperty:将获取的自增的主键放在传输的参数user对象的某个属性中

/**
* 添加用户信息
* @param user
* @return
*/
int insertUser(User user);

 

<!--int insertUser(User user);-->
<insert id="insertUser" useGeneratedKeys="true" keyProperty="id">
    insert into t_user values(null,#{username},#{password},#{age},#{sex})
</insert>

 

8、自定义映射resultMap

数据库的命名规范：所有标识符都使用小写，单词之间下划线连接

由于数据库字段的命名规范和java命名规范不同，所以需要使用自定义映射 例如：数据库中的字段emp_name和java pojo中的属性empName

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

若字段名和实体类中的属性名不一致，则可以通过resultMap设置自定义映射

如果使用resultMap，建议将所有字段名和属性名的映射都设置出来（不论名字是否相同）

<!--src/main/resources/com/colin/mybatis/mapper/EmpMapper.xml-->
		<!--
        resultMap:设置自定义映射
        属性:
            id:表示自定义映射的唯一标识
            type:查询的数据要映射的实体类的类型
        子标签:
            id:设置主键的映射关系
            result:设置普通字段的映射关系
            association:设置多对一的映射关系
            collection:设置一对多的映射关系
            属性:
                property:设置映射关系中实体类中的属性名
                column:设置映射关系中表中的字段名
    -->
    <resultMap id="empResultMap" type="Emp">
        <id property="eid" column="eid"></id>
        <result property="empName" column="emp_name"></result>
        <result property="age" column="age"></result>
        <result property="sex" column="sex"></result>
        <result property="email" column="email"></result>
    </resultMap>

    <!--List<Emp> getAllEmp();-->
    <select id="getAllEmp" resultMap="empResultMap">
        select * from t_emp
    </select>

 

若字段名和实体类中的属性名不一致，但是字段名符合数据库的规则(使用_)，实体类中的属性名符合Java的规则(使用驼峰)

• 此时也可通过以下两种方式处理字段名和实体类中的属性的映射关系:

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

  • 可以在MyBatis的核心配置文件中设置一个全局配置信息mapUnderscoreToCamelCase，可以在查询表中数据时，自动将_类型的字段名转换为驼峰

  <!--src/main/resources/mybatis-config.xml-->
  		<!--设置MyBatis的全局配置-->
      <settings>
          <!--将_自动映射为驼峰，emp_name->empName-->
          <setting name="mapUnderscoreToCamelCase" value="true"/>
      </settings>

 

例如:字段名user_name，设置了mapUnderscoreToCamelCase，此时字段名就会转换为userName

 

8.2、多对一映射处理

多中创建一的对象，一中设置多的集合 例如：多个员工对应一个部门，在员工类中设置部门对象，在部门中设置员工集合

• 多对一映射处理：

  • 方式一：级联方式处理

      <!--
          方式一：级联映射
          结果为Emp{eid=1, empName='zhangsan', age=1, sex='男', email='123', dept=Dept{did=1, deptName='A'}}
      -->
      <resultMap id="empAndDeptResultMap1" type="Emp">
          <id property="eid" column="eid"></id>
          <result property="empName" column="emp_name"></result>
          <result property="age" column="age"></result>
          <result property="sex" column="sex"></result>
          <result property="email" column="email"></result>
          <result property="dept.did" column="did"></result>
          <result property="dept.deptName" column="dept_name"></result>
      </resultMap>
      <!--Emp getEmpAndDept(@Param("eid") Integer eid);-->
      <select id="getEmpAndDept" resultMap="empAndDeptResultMap1">
          select * from t_emp left join t_dept on t_emp.did = t_dept.did where t_emp.eid = #{eid}
      </select>

   

  • 方式二：使用association处理

  		<!--
          方式二：使用association
  				association:处理多对一的映射关系
  				属性：
  						property:需要处理多对映射关系的属性名
          		javaType:该属性的java类型
          结果与方式一相同
      -->
      <resultMap id="empAndDeptResultMap2" type="Emp">
          <id property="eid" column="eid"></id>
          <result property="empName" column="emp_name"></result>
          <result property="age" column="age"></result>
          <result property="sex" column="sex"></result>
          <result property="email" column="email"></result>
          <association property="dept" javaType="Dept">
              <id property="did" column="did"></id>
              <result property="deptName" column="dept_name"></result>
          </association>
      </resultMap>
      <!--Emp getEmpAndDept(@Param("eid") Integer eid);-->
      <select id="getEmpAndDept" resultMap="empAndDeptResultMap2">
          select * from t_emp left join t_dept on t_emp.did = t_dept.did where t_emp.eid = #{eid}
      </select>

   

  • 方式三：分步查询

    • 第一步：查询员工信息

      /**
        * 通过分步查询查询员工信息 
        * @param eid
        * @return
        */
      Emp getEmpByStep(@Param("eid") int eid);

       

      <resultMap id="empDeptStepMap" type="Emp">
              <id column="eid" property="eid"></id>
              <result column="ename" property="ename"></result>
              <result column="age" property="age"></result>
              <result column="sex" property="sex"></result>
              <!--
      						select:设置分步查询，查询某个属性的值的sql的标识(namespace.sqlId)
      						column:将sql以及查询结果中的某个字段设置为分步查询的条件
      				-->
              <association property="dept" 
                           select="com.atguigu.MyBatis.mapper.DeptMapper.getEmpDeptByStep" 
                           column="did">
        			</association>
      </resultMap>
      
      <!--Emp getEmpByStep(@Param("eid") int eid);-->
      <select id="getEmpByStep" resultMap="empDeptStepMap">
          select * from t_emp where eid = #{eid}
      </select>

       

    • 第二步：根据员工所对应的部门id查询部门信息

      /**
        * 分步查询的第二步:根据员工所对应的did查询部门信息
        * @param did
        * @return
        */
      Dept getEmpDeptByStep(@Param("did") int did);

       

      <!--Dept getEmpDeptByStep(@Param("did") int did);-->
      <select id="getEmpDeptByStep" resultType="Dept">
          select * from t_dept where did = #{did}
      </select>

       

8.3、一对多映射处理

• 一对多映射处理：

  • collection

      /**
       * 获取部门以及部门中所有的员工信息
       * @param did
       * @return
       */
      Dept getDeptAndEmp(@Param("did") Integer did);
  //========================
      @Test
      public void testGetDeptAndEmp(){
          SqlSession sqlSession = SqlSessionUtils.getSqlSession();
          DeptMapper mapper = sqlSession.getMapper(DeptMapper.class);
          Dept deptAndEmp = mapper.getDeptAndEmp(2);
          System.out.println("deptAndEmp = " + deptAndEmp);
      }

   

      <resultMap id="deptAndEmpResultMap" type="Dept">
          <id property="did" column="did"></id>
          <result property="deptName" column="dept_name"></result>
          <!--
  						collection:处理一对多的映射关系
  								ofType:设置collection标签所处理的集合属性中存储数据的类型
  				-->
          <collection property="emps" ofType="Emp">
              <id property="eid" column="eid"></id>
              <result property="empName" column="emp_name"></result>
              <result property="age" column="age"></result>
              <result property="sex" column="sex"></result>
              <result property="email" column="email"></result>
          </collection>
      </resultMap>
      <!--Dept getDeptAndEmp(@Param("did") Integer did);-->
      <select id="getDeptAndEmp" resultMap="deptAndEmpResultMap">
          select * from t_dept left join t_emp on t_dept.did = t_emp.did where t_dept.did = #{did}
      </select>

   

  • 分步查询

    • 第一步：查询部门信息

      /**
        * 分步查询部门和部门中的员工 
        * @param did
        * @return
        */
      Dept getDeptByStep(@Param("did") int did);

       

      <resultMap id="deptEmpStep" type="Dept">
        	<id property="did" column="did"></id>
        	<result property="dname" column="dname"></result>
        	<collection property="emps" fetchType="eager" select="com.atguigu.MyBatis.mapper.EmpMapper.getEmpListByDid" column="did">
        	</collection>
      </resultMap>
      <!--Dept getDeptByStep(@Param("did") int did);-->
      <select id="getDeptByStep" resultMap="deptEmpStep">
        	select * from t_dept where did = #{did}
      </select>

       

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

      /**
        * 根据部门id查询员工信息 
        * @param did
        * @return
        */
      List<Emp> getEmpListByDid(@Param("did") int did);

       

      <!--List<Emp> getEmpListByDid(@Param("did") int did);-->
      <select id="getEmpListByDid" resultType="Emp">
          select * from t_emp where did = #{did}
      </select>

       

分步查询的优点:可以实现延迟加载，在分步查询中只加载查询的信息（否则会加载所有步骤的查询信息），但是必须在核心配置文件中设置全局配置信息

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

aggressiveLazyLoading:当开启时，任何方法的调用都会加载该对象的所有属性。否则，每个属性会按需加载，此时就可以实现按需加载，获取的数据是什么，就只会执行相应的sql

开启了全局延迟加载后，可通过association和collection中的fetchType属性设置当前的分步查询是否使用延迟加载 fetchType=”lazy”(延迟加载),”eager”(立即加载)

<!--src/main/resources/mybatis-config.xml-->
		<!--设置MyBatis的全局配置-->
 <settings>
     <!--将_自动映射为驼峰，emp_name->empName-->
     <setting name="mapUnderscoreToCamelCase" value="true"/>
     <!--开启延迟加载-->
     <setting name="lazyLoadingEnabled" value="true"/>
 </settings>

 

9、动态SQL

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

动态SQL指的是映射文件中的一系列标签

9.1、if

if标签可通过test属性的表达式进行判断，若表达式的结果为true，则标签中的内容会执行;反之标签中的内容不会执行

    /**
     * 多条件查询
     * @param emp
     * @return
     */
    List<Emp> getEmpByCondition(Emp emp);
//=====================
    @Test
    public void testGetEmpByCondition(){
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        DynamicSQLMapper mapper = sqlSession.getMapper(DynamicSQLMapper.class);
        List<Emp> list = mapper.getEmpByCondition(new Emp(null, "zhangsan", null, "", ""));
        System.out.println(list);
    }

 

    <!--List<Emp> getEmpByCondition(Emp emp);-->
    <select id="getEmpByCondition" resultType="Emp">
        select * from t_emp where 1=1
        <!--
            if:如果满足标签中的条件则拼接sql
                null:传入的查询信息中没有这个字段
                "":传入的查询信息中有这个字段但没有设置这个字段的值
								加上1=1是为了防止and在拼接时出错
        -->
        <if test="empName != null and empName != ''">
            and emp_name = #{empName}
        </if>
        <if test="age != null and age !=''">
            and age = #{age}
        </if>
        <if test="sex != null and sex !=''">
            and sex = #{sex}
        </if>
        <if test="email != null and email !=''">
            and email = #{email}
        </if>
    </select>

 

9.2、where

where和if一般结合使用:

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

b>若where标签中的if条件满足，则where标签会自动添加where关键字，并将条件最前方多余的and去掉，例如:and age = #{age}

注意:where标签不能去掉条件最后多余的and，例如:age = #{age} and

    <!--List<Emp> getEmpByCondition(@Param("emp") Emp emp);-->
    <select id="getEmpByCondition1" resultType="Emp">
        select * from t_emp
        <where>
            <if test="empName != null and empName != ''">
                and emp_name = #{empName}
            </if>
            <if test="age != null and age !=''">
                and age = #{age}
            </if>
            <if test="sex != null and sex !=''">
                and sex = #{sex}
            </if>
            <if test="email != null and email !=''">
                and email = #{email}
            </if>
        </where>
    </select>

 

9.3、trim

trim用于去掉或添加标签中的内容（只能去掉最开头和最末尾的内容，不是对每一个if进行处理）

• 常用属性:

  • prefix:在trim标签中的内容的前面添加某些内容

  • prefixOverrides:在trim标签中的内容的前面去掉某些内容

  • suffix:在trim标签中的内容的后面添加某些内容

  • suffixOverrides:在trim标签中的内容的后面去掉某些内容

    <!--List<Emp> getEmpByCondition2(@Param("emp") Emp emp);-->
    <select id="getEmpByCondition2" resultType="Emp">
        select * from t_emp
        <trim prefix="where" suffixOverrides="and|or">
            <if test="empName != null and empName != ''">
                emp_name = #{empName} and
            </if>
            <if test="age != null and age !=''">
                age = #{age} and
            </if>
            <if test="sex != null and sex !=''">
                sex = #{sex} and
            </if>
            <if test="email != null and email !=''">
                email = #{email} and
            </if>
        </trim>
    </select>

 

9.4、choose、when、otherwise

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

choose是父标签，when=if，otherwise=else

    <!--List<Emp> getEmpByCondition3(@Param("emp") Emp emp);-->
    <select id="getEmpByCondition3" resultType="Emp">
        select * from t_emp
            <where>
                <choose>
                    <when test="empName != null and empName != ''">
                        emp_name = #{empName}
                    </when>
                    <when test="age != null and age !=''">
                        age = #{age}
                    </when>
                    <when test="sex != null and sex !=''">
                        sex = #{sex}
                    </when>
                    <when test="email != null and email !=''">
                        email = #{email}
                    </when>
                    <otherwise>
                        did = 1
                    </otherwise>
                </choose>
            </where>
    </select>

 

9.5、foreach

foreach的属性:

collection:设置要循环的数组或集合

item:表示集合或数组中的每一个数据

separator:设置循环体之间的分隔符

open:设置foreach标签中的内容的开始符

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

<!--批量添加-->
<!--int insertMoreEmp(@Param("emps") List<Emp> emps);-->
<insert id="insertMoreEmp">
    insert into t_emp values
    <foreach collection="emps" item="emp" separator=",">
      	<!--传输过来的是list对象,所以要通过emp.属性进行访问-->
        (null,#{emp.ename},#{emp.age},#{emp.sex},#{emp.email},null)
    </foreach>
</insert>

<!--批量删除的两种方式-->
<!--int deleteMoreByArray(@Param("eids") int[] eids);-->
<delete id="deleteMoreByArray">
    delete from t_emp where
    <foreach collection="eids" item="eid" separator="or">
				eid = #{eid}
		</foreach>
</delete>
<!--int deleteMoreByArray(@Param("eids") int[] eids);-->
<delete id="deleteMoreByArray">
    delete from t_emp where eid in
    <foreach collection="eids" item="eid" separator="," open="(" close=")">
				#{eid}
    </foreach>
</delete>

 

9.6、SQL片段

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

<!--
		设置SQL片段
		替换sql语句中的*
-->
<sql id="empColumns">
    eid,ename,age,sex,did
</sql>

<!--引用SQL片段-->
select <include refid="empColumns"></include> from t_emp

 

10、MyBatis的缓存

缓存只对查询功能有效

10.1、MyBatis的一级缓存

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

• 使一级缓存失效的四种情况:

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

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

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

  4. 同一个SqlSession两次查询期间手动清空了缓存，例如：sqlSession.clearCache();

10.2、MyBatis的二级缓存

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

• 二级缓存开启的条件:

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

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

  3. 二级缓存必须在SqlSession关闭或提交之后有效（数据在关闭或提交了SqlSession之后才会被保存在二级缓存中），如sqlSession.close();

  4. 查询的数据所转换的实体类类型必须实现序列化的接口，如public class Emp implements Serializable {}

• 使二级缓存失效的情况:

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

10.3、二级缓存的相关配置

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

• eviction:缓存回收策略，

  • LRU(Least Recently Used):最近最少使用的，移除最长时间不被使用的对象。

  • FIFO(First in First out):先进先出，按对象进入缓存的顺序来移除它们。

  • SOFT:软引用，移除基于垃圾回收器状态和软引用规则的对象。

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

• flushInterval属性:刷新间隔，单位毫秒

  • 默认情况是不设置，也就是没有刷新间隔，缓存仅仅调用语句时刷新

• size属性:引用数目，正整数

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

• readOnly属性:只读，true/false

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

  • false:读写缓存;会返回缓存对象的拷贝(通过序列化)。这会慢一些，但是安全，因此默认是false。

10.4、MyBatis缓存查询的顺序

• 二级缓存-->一级缓存-->数据库

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

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

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

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

10.5、整合第三方缓存EHCache

第三方缓存只能代替MyBatis的二级缓存

1. 添加依赖

        <!-- Mybatis EHCache整合包 -->
        <dependency>
            <groupId>org.mybatis.caches</groupId>
            <artifactId>mybatis-ehcache</artifactId>
            <version>1.2.1</version>
        </dependency>
        <!-- slf4j日志门面的一个具体实现 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>

 

2. 各jar包功能

3. 在资源目录下创建EHCache的配置文件ehcache.xml

<!--src/main/resources/ehcache.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="/Users/colin13/IdeaProjects/MyBatis/ehcache"/>
    
    <defaultCache
            maxElementsInMemory="1000"
            maxElementsOnDisk="10000000"
            eternal="false"
            overflowToDisk="true"
            timeToIdleSeconds="120"
            timeToLiveSeconds="120"
            diskExpiryThreadIntervalSeconds="120"
            memoryStoreEvictionPolicy="LRU">
    </defaultCache>
</ehcache>

 

4. 在mapper配置文件设置二级缓存的类型

 <!--src/main/resources/com/colin/mybatis/mapper/CacheMapper.xml-->
		<!--设置二级缓存的类型-->
    <cache type="org.mybatis.caches.ehcache.EhcacheCache"/>

 

5. 加入logback日志

   存在SLF4J时，作为简易日志的log4j将失效，此时我们需要借助SLF4J的具体实现logback来打印日志。

   创建logback的配置文件logback.xml

<!--src/main/resources/logback.xml-->
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true">
    
    <!-- 指定日志输出的位置 -->
    <appender name="STDOUT"
        class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!-- 日志输出的格式 -->
            <!-- 按照顺序分别是:时间、日志级别、线程名称、打印日志的类、日志主体内容、换行 -->
            <pattern>[%d{HH:mm:ss.SSS}] [%-5level] [%thread] [%logger] [%msg]%n</pattern>
        </encoder>
    </appender>

    <!-- 设置全局日志级别。日志级别按顺序分别是:DEBUG、INFO、WARN、ERROR -->
    <!-- 指定任何一个日志级别都只打印当前级别和后面级别的日志。 -->
    <root level="DEBUG">
        <!-- 指定打印日志的appender，这里通过“STDOUT”引用了前面配置的appender -->
        <appender-ref ref="STDOUT" />
    </root>

    <!-- 根据特殊需求指定局部日志级别 -->
    <logger name="com.atguigu.crowd.mapper" level="DEBUG"/>

</configuration>

 

6. EHCache配置文件说明

7. 测试

    @Test
    public void testGetEmpByEid(){
        try {
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
            SqlSession sqlSession1 = sqlSessionFactory.openSession(true);
            CacheMapper mapper1 = sqlSession1.getMapper(CacheMapper.class);
            System.out.println(mapper1.getEmpByEid(1));
            sqlSession1.close();
            SqlSession sqlSession2 = sqlSessionFactory.openSession(true);
            CacheMapper mapper2 = sqlSession2.getMapper(CacheMapper.class);
            System.out.println(mapper2.getEmpByEid(1));
            sqlSession2.close();
        } catch (IOException e) {
            e.printStackTrace();
        }

 

11、MyBatis的逆向工程

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

逆向工程:先创建数据库表，由框架负责根据数据库表，反向生成如下资源:Java实体类、Mapper接口、Mapper映射文件

11.1、创建逆向工程的步骤

1. 添加依赖和插件

<!--pom.xml-->
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.colin</groupId>
    <artifactId>MyBatis_MBG</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <!-- 依赖MyBatis核心包 -->
    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.7</version>
        </dependency>
        <!-- junit测试 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <!-- log4j日志 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
        <!-- MySQL驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.29</version>
        </dependency>
    </dependencies>

    <!-- 控制Maven在构建过程中相关配置 -->
    <build>
        <!-- 构建过程中用到的插件 -->
        <plugins>
            <!-- 具体插件，逆向工程的操作是以构建过程中插件形式出现的 -->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.0</version>
             		<configuration>
                    <overwrite>true</overwrite>
                    <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                </configuration>

                <!-- 插件的依赖 -->
                <dependencies>
                    <!-- 逆向工程的核心依赖 -->
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.3.2</version>
                    </dependency>

                    <!-- 数据库连接池 -->
                    <dependency>
                        <groupId>com.mchange</groupId>
                        <artifactId>c3p0</artifactId>
                        <version>0.9.2</version>
                    </dependency>

                    <!-- MySQL驱动 -->
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.29</version>
                    </dependency>

                </dependencies>

            </plugin>
        </plugins>
    </build>

</project>

 

2. 创建MyBatis的核心配置文件

jdbc.properties log4j.xml mybatis-config.xml

3. 创建逆向工程的配置文件

文件名必须是:generatorConfig.xml

<!--src/main/resources/generatorConfig.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">
<generatorConfiguration>
    <!--
        targetRuntime: 执行生成的逆向工程的版本
            MyBatis3Simple: 生成基本的CRUD(清新简洁版)
														只有最基本的增删改查和查询所有记录一共5个方法
            MyBatis3: 生成带条件的CRUD(奢华尊享版)
    -->

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

      	<!-- 控制MyBatis逆向工程的注释 -->
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
      
        <!-- 数据库的连接信息 -->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mybatis?useUnicode=true&amp;characterEncoding=utf-8&amp;rewriteBatchedStatements=true"
                        userId="root"
                        password="12345678">
        </jdbcConnection>
      
    	  <!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，为 true时把JDBC DECIMAL 和
     	       NUMERIC 类型解析为java.math.BigDecimal -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!--
            javaModelGenerator:javaBean的生成策略
                targetPackage:设置的包
                targetProject:生成路径(可以理解为生成的文件在targetProject/targetPackage下)
                属性:
                    enableSubPackages:是否能够使用子包，true表示targetPackage中每个.都表示一个子包，false表示targetPackage是一个包名
                    trimStrings:去除字段名前后的空格
        -->
        <javaModelGenerator targetPackage="com.colin.mybatis.pojo" targetProject="src/main/java">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!-- sqlMapGenerator:mapper映射文件的生成策略 -->
        <sqlMapGenerator targetPackage="com.colin.mybatis.mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!-- javaClientGenerator:Mapper接口的生成策略 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.colin.mybatis.mapper"  targetProject="src/main/java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <!-- 需要进行逆向分析的表 -->
        <!-- tableName:表名，如果设置为*号，可以对应所有表，此时不写domainObjectName -->
        <!-- domainObjectName：指定生成出来的实体类的类名 -->
        <table tableName="t_emp" domainObjectName="Emp"/>
        <table tableName="t_dept" domainObjectName="Dept"/>
      
    </context>
</generatorConfiguration>

 

4. 执行MBG插件的generate目标

 

11.2、QBC查询

QBC：根据条件查询

要使用QBC，首先需要修改generatorConfig.xml中context标签为<context id="DB2Tables" targetRuntime="MyBatis3">

条件增删改查中，null表示不对该字段进行增删改查，而普通增删改查中，null表示该字段值为null

    @Test
    public void testMBG(){
        try {
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
            SqlSession sqlSession = sqlSessionFactory.openSession(true);
            EmpMapper mapper = sqlSession.getMapper(EmpMapper.class);

            // 查询所有数据
            List<Emp> list = mapper.selectByExample(null);
            list.forEach(System.out::println);

            // QBC 根据条件查询
            // 1.创建xxxExample对象
            EmpExample empExample = new EmpExample();
            // 2.xxxExample.createCriteria()创建条件对象
            // 通过andxxx方法建立查询sql语句，每个条件之间是and关系
            empExample.createCriteria().andEmpNameEqualTo("zhangsan").andDidIsNotNull();
            // 通过or可以继续拼接其他条件
            empExample.or().andAgeIsNotNull();
            // 最终结果为：select eid, emp_name, age, sex, email, did from t_emp WHERE ( emp_name = ? and did is not null ) or( age is not null )
            List<Emp> list1 = mapper.selectByExample(empExample);
            list1.forEach(System.out::println);
        } catch (IOException e) {
            e.printStackTrace();
        }

    }

 

12、分页插件

12.1、分页插件使用步骤

1. 添加依赖

<!-- https://mvnrepository.com/artifact/com.github.pagehelper/pagehelper -->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>5.2.0</version>
</dependency>

 

2. 配置分页插件

<!--src/main/resources/mybatis-config.xml-->
    <!--设置插件-->
    <plugins>
        <!--设置分页插件-->
        <plugin interceptor="com.github.pagehelper.PageInterceptor"/>
    </plugins>

 

12.2、分页插件的使用

    /**
     * 测试分页插件
     * sql分页语句:limit index,pageSize
     * index:当前页的起始索引
     * pageSize:每页显示的条数
     * pageNum:当前页的页码
     * 分页公式:index = (pageNum - 1) * pageSize
     */
    @Test
    public void testPageHelper(){
        try {
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
            SqlSession sqlSession = sqlSessionFactory.openSession(true);
            EmpMapper mapper = sqlSession.getMapper(EmpMapper.class);

            // 1.启用分页插件（在查询功能之前）
            PageHelper.startPage(1,3);
            // 实际上返回的是一个page对象,其中包含了部分信息
            // Page<Object> page = PageHelper.startPage(1, 3);

            // 2.查询所有数据
            List<Emp> list = mapper.selectByExample(null);

            // 通过PageInfo可以查询详细信息
          	// PageInfo<T> pageInfo = new PageInfo<>(List<T> list, int navigatePages)
            // list:分页之后的数据 navigatePages:导航分页的页码数
            PageInfo<Emp> pageInfo = new PageInfo<>(list, 5);

            list.forEach(System.out::println);
            // System.out.println("page = " + page);
            System.out.println("pageInfo = " + pageInfo);

        } catch (IOException e) {
            e.printStackTrace();
        }
    }

 

分页相关数据

/**
* PageInfo{
* pageNum=8, pageSize=4, size=2, startRow=29, endRow=30, total=30, pages=8,
* list=Page{count=true, pageNum=8, pageSize=4, startRow=28, endRow=32, total=30, pages=8, reasonable=false, pageSizeZero=false},
* prePage=7, nextPage=0, isFirstPage=false, isLastPage=true, hasPreviousPage=true, hasNextPage=false, navigatePages=5, navigateFirstPage4, navigateLastPage8, navigatepageNums=[4, 5, 6, 7, 8]
* }
*/

pageNum:当前页的页码

pageSize:每页显示的条数

size:当前页显示的真实条数

total:总记录数

pages:总页数

prePage:上一页的页码

nextPage:下一页的页码

isFirstPage/isLastPage:是否为第一页/最后一页

hasPreviousPage/hasNextPage:是否存在上一页/下一页

navigatePages:导航分页的页码数

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

假设navigatePages=5，则pageNum=1～3时，navigatepageNums=[1,2,3,4,5]；pageNum=4时，navigatepageNums=[2,3,4,5,6]

 

13、常见错误

Cause: java.lang.IllegalArgumentException: Result Maps collection already contains value

解决：target文件夹可能生成了多个mapper.xml，删除target重新启动项目即可