后端
Java
Spring

Mybatis入门

# Mybatis入门操作

# Mybatis内容

✨ MyBatis的简介

✨ MyBatis的快速入门

✨ MyBatis的映射文件概述

✨ MyBatis的增删改查操作

✨ MyBatis的核心配置文件概述

✨ MyBatis的相应API

# 1.Mybatis简介

# 1.1 原始Jdbc操作

# 1.2 原始Jdbc操作分析

原始jdbc开发存在的问题如下：

① 数据库连接创建、释放频繁造成系统资源浪费从而影响系统性能

② sql 语句在代码中硬编码，造成代码不易维护，实际应用 sql 变化的可能较大，sql 变动需要改变java代码。

③ 查询操作时，需要手动将结果集中的数据手动封装到实体中。插入操作时，需要手动将实体的数据设置到sql语句的占位符位置

应对上述问题给出的解决方案：

① 使用数据库连接池初始化连接资源

② 将sql语句抽取到xml配置文件中

③ 使用反射、内省等底层技术，自动将实体与表进行属性与字段的自动映射

# 1.3 什么是Mybatis

# 2.Mybatis的快速入门

# 2.1 Mybatis的开发步骤

# 2.2 环境搭建步骤

导入Mybatis的坐标和其他相关的坐标
创建好一个user的数据表，内容为(id,username,password)
创建好对应的User实体类
编写UserMapper的映射文件
编写Mybatis的核心文件

# 2.3 导入相关的坐标

<!--mybatis坐标--> 
<dependency> 
    <groupId>org.mybatis</groupId> 
    <artifactId>mybatis</artifactId> 
    <version>3.4.5</version>
</dependency>

<!--mysql驱动坐标--> 
<dependency> 
    <groupId>mysql</groupId> 
    <artifactId>mysql-connector-java</artifactId> 
    <version>5.1.6</version> <scope>runtime</scope>
</dependency>

<!--单元测试坐标--> 
<dependency>
    <groupId>junit</groupId> 
    <artifactId>junit</artifactId>
    <version>4.12</version> 
    <scope>test</scope>
</dependency>

<!--日志坐标--> 
<dependency> 
    <groupId>log4j</groupId> 
    <artifactId>log4j</artifactId> 
    <version>1.2.12</version>
</dependency>

# 2.4 编写User的实体类

mysql> select * from user;
+----+----------+----------+
| id | username | password |
+----+----------+----------+
|  1 | zhangsan | 000000   |
|  2 | lisi     | 123456   |
+----+----------+----------+
2 rows in set (0.01 sec)

public class User {
    private Integer id;
    private String username;
    private String password;

    public User() {
    }

    public User(Integer id, String username, String password) {
        this.id = id;
        this.username = username;
        this.password = password;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

# 2.5 UserMapper映射文件

1.关于开头和结束的约束

UserMapper的开头约束

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

sqlMapConfig的结束约束

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

2.编写UserMapper映射文件

<?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="userMapper">
    <!--数据库的查询操作-->
    <select id="findAll" resultType="user">
        select *
        from user
    </select>
</mapper>

# 2.6 MyBatis核心文件

我这里jdbc的连接信息单独抽出来存放到jdbc.properties配置文件中
所以核心配置文件需要配置引入properties配置文件
可以设置自定义别名，我设置的是user自定义别名，UserMapper则可以不使用类路径
配置数据源的环境，这里需要多添加一个事务和数据源类型
需要加载映射文件，就是装载sql的配置文件

<?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>
    <!--引入配置文件-->
    <properties resource="jdbc.properties"></properties>
    
    <!--自定义别名-->
    <typeAliases>
        <typeAlias type="com.example.domain.User" alias="user">			</typeAlias>
    </typeAliases>
    
    <!--配置数据源环境-->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"></transactionManager>
            <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>
        <mapper resource="com/example/mapper/UserMapper.xml"></mapper>
    </mappers>
    
</configuration>

# 2.7 编写测试代码

public class MybatisTest{
    @Test
    public void test1() throws IOException {
        // 获得核心配置文件
        SqlSession sqlSession = getSqlSession();
        // 执行操作 参数：namespace + id
        List<User> useList = sqlSession.selectList("userMapper.findAll");
        // 打印数据
        System.out.println(useList);
        // 释放资源
        sqlSession.close();
    }

    
	// 这里我将SqlSession单独抽取出来作为一个方法  方便调用
    private SqlSession getSqlSession() throws IOException {
        // 获得核心配置文件
        InputStream is = Resources.getResourceAsStream("sqlMapConfig.xml");
        // 获得session工厂对象
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        // 获得session回话对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
        return sqlSession;
    }
}

# 3. MyBatis的映射文件概述

# 4. Mybatis的增删改查

# 4.1 增删改查的注意事项

增加操作的注意事项

插入语句使用insert标签
在映射文件中使用parameterType属性指定要插入的数据类型
Sql语句中使用#{实体属性名}方式引用实体中的属性值
插入操作使用的API是sqlSession.insert(“命名空间.id”,实体对象);
插入操作涉及数据库数据变化，所以要使用sqlSession对象显示的提交事务，即sqlSession.commit()

修改操作注意问题

修改语句使用update标签
修改操作使用的API是sqlSession.update(“命名空间.id”,实体对象);

删除操作注意问题

删除语句使用delete标签
Sql语句中使用#{任意字符串}方式引用传递的单个参数
删除操作使用的API是sqlSession.delete(“命名空间.id”,Object);

# 4.2 插入数据

1.编写UserMapper映射文件

	<!--数据库添加操作-->
	<!--这里是可以使用别名的，不使用别名要默认使用类路径-->
    <insert id="save" parameterType="com.example.domain.User">
        insert into user value(#{id},#{username},#{password})
    </insert>

2.编写插入实体User的代码

    @Test
    public void test2() throws IOException {
        User user = new User();
        user.setUsername("wangwu");
        user.setPassword("123456");

        
        // 这里我们使用的是上面提取的方法
        SqlSession sqlSession = getSqlSession();
        // 执行操作 参数：namespace + id
        int insert = sqlSession.insert("userMapper.save", user);
        // 打印数据
        System.out.println(insert);
        // Mybatis更新操作  事务的提交
        sqlSession.commit();
        // 释放资源
        sqlSession.close();
    }

# 4.3 修改数据

1.编写UserMapper映射文件

	<!--数据库更新操作-->
    <update id="update" parameterType="user">
        update user set username=#{username},password=#{password} where id = #{id}
    </update>

2.编写插入实体User的代码

    @Test
    public void test2() throws IOException {
        User user = new User();
        user.setId(1);
        user.setUsername("wulei");
        user.setPassword("000000");
        
        // 这里我们使用的是上面提取的方法
        SqlSession sqlSession = getSqlSession();
        // 执行操作 参数：namespace + id
        int insert = sqlSession.insert("userMapper.update", user);
        // 打印数据
        System.out.println(insert);
        // Mybatis更新操作  事务的提交
        sqlSession.commit();
        // 释放资源
        sqlSession.close();
    }

# 4.4 删除数据

1.编写UserMapper映射文件

	<!--数据库删除操作-->
    <delete id="delete" parameterType="java.lang.Integer">
        delete from user where id = #{id}
    </delete>

2.编写插入实体User的代码

    @Test
    public void test2() throws IOException {
        User user = new User();
   		user.setId(3);
        
        // 这里我们使用的是上面提取的方法
        SqlSession sqlSession = getSqlSession();
        // 执行操作 参数：namespace + id
        int insert = sqlSession.insert("userMapper.delete", user);
        // 打印数据
        System.out.println(insert);
        // Mybatis更新操作  事务的提交
        sqlSession.commit();
        // 释放资源
        sqlSession.close();
    }

# 4.5 知识总结

# 5.MyBatis的核心配置概述

# 5.1 MyBatis核心配置层级关系

# 5.2 Mybatis常用配置解析

# 1. environments标签

其中，事务管理器（transactionManager）类型有两种：

JDBC：这个配置就是直接使用了JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域。
MANAGED：这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如JEE 应用服务器的上下文）。默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为。

其中，数据源（dataSource）类型有三种：

UNPOOLED：这个数据源的实现只是每次被请求时打开和关闭连接。
POOLED：这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来。
JNDI：这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。

数据库环境的配置，支持多环境配置

# 2. mapper标签

该标签的作用是加载映射的，加载方式有如下几种：
• 使用相对于类路径的资源引用，例如：<mapperresource="org/mybatis/builder/AuthorMapper.xml"/>
• 使用完全限定资源定位符（URL），例如：
<mapper url="file:///var/mappers/AuthorMapper.xml"/>
• 使用映射器接口实现类的完全限定类名，例如：
<mapper class="org.mybatis.builder.AuthorMapper"/>
• 将包内的映射器接口实现全部注册为映射器，例如：
<package name="org.mybatis.builder"/>

# 3. Properties标签

实际开发中，习惯将数据源的配置信息单独抽取成一个properties文件，该标签可以加载额外配置的properties文件

# 4. typeAliases标签

类型别名是为Java 类型设置一个短的名字。原来的类型名称配置如下

上面我们是自定义的别名，mybatis框架已经为我们设置好的一些常用的类型的别名

# 6. Mybatis的相应API

# 6.1 SqlSessionFactoryBuilder

SqlSession工厂构建器SqlSessionFactoryBuilder

常用API：SqlSessionFactory build(InputStream inputStream)

通过加载mybatis的核心文件的输入流的形式构建一个SqlSessionFactory对象

String resource = "org/mybatis/builder/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(inputStream);

其中， Resources 工具类，这个类在 org.apache.ibatis.io 包中。Resources 类帮助你从类路径下、文件系统或一个 web URL 中加载资源文件。

# 6.2 SqlSessionFactory

SqlSessionFactory 有多个个方法创建 SqlSession 实例。常用的有如下两个：

# 6.3 SqlSession会话对象

SqlSession 实例在 MyBatis 中是非常强大的一个类。在这里你会看到所有执行语句、提交或回滚事务和获取映射器实例的方法。

执行语句的方法主要有：

<T> T selectOne(String statement, Object parameter) 
<E> List<E> selectList(String statement, Object parameter) 
int insert(String statement, Object parameter) 
int update(String statement, Object parameter) 
int delete(String statement, Object parameter)

操作事务的方法主要有：

void commit()
void rollback()

# 7. Mybatis的Dao层实现

# 7.1 代理开发方式

代理开发方式的介绍

采用 Mybatis 的代理开发方式实现 DAO 层的开发，这种方式是我们后面进入企业的主流。

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

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

Mapper.xml文件中的namespace与mapper接口的全限定名相同
Mapper接口方法名和Mapper.xml中定义的每个statement的id相同
Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql的parameterType的类型相同
Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同

# 7.2 UserMapper接口

# 7.3 代理方式的实现

1.配置userMappler.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">

<!--这里的命名空间必须要和UserMapper接口的类路径相同S-->
<mapper namespace="com.example.dao.UserMapper">
    <!--数据库的查询操作根据ID-->
    <select id="selectById" parameterType="int" resultType="user">
        select *
        from user where id = #{id}
    </select>

    <!--数据库的查询操作查询所有-->
    <select id="findAll" resultType="user">
        select *
        from user;
    </select>
</mapper>

2.UserMapper接口的实现

public interface UserMapper {
    // 方法的名称必须和id相同
    public List<User> findAll();
    
    public List<User> selectById(int id);
}

3.测试代理的代码如下

唯一的不同就是使用SqlSession.getMapper()的代理方式获得mybatis的数据库的增删改查。

public class ServiceDemo {

    public static void main(String[] args) throws IOException {
        InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory  sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
        SqlSession sqlSession = sqlSessionFactory.openSession();
        
        // 使用getMapper获取UserMapper的接口代理
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        
        // List<User> userList = userMapper.findAll();
        // 直接使用UserMapper的代理调用方法即可
        List<User> userList = userMapper.selectById(1);
        System.out.println(userList);
        sqlSession.close();
    }
}

# 8. Mybatis实现动态Sql

MyBatis映射文件配置：

<select>：查询
<insert>：插入
<update>：修改
<delete>：删除
<where>：where条件
<if>：if判断
<foreach>：循环
<sql>：sql片段抽取

# 8.1 动态Sql语句

动态sql语句概述

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

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

# 8.2 动态SQL的If

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

	<!-- 数据库的多条件查询-->
	<select id="findByCondition" parameterType="user" resultType="user">
        select * from user
    	<!--使用where的方式内嵌IF-->
        <where>
            <if test="id != 0" >
                and id = #{id}
            </if>
            <if test="username != null">
                and username = #{username}
            </if>
            <if test="password != null">
                and password = #{password}
            </if>
        </where>

    </select>

当查询条件id和username都存在时，控制台打印的sql语句如下：

… … …
//获得MyBatis框架生成的UserMapper接口的实现类
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User condition = new User();
condition.setId(1);
condition.setUsername("lucy");
User user = userMapper.findByCondition(condition);
… … …

# 8.3 动态SQL之ForEach

foreach标签的属性含义如下：

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

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

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

	<!--使用foreach的方式查询数据-->
	<select id="selectByIds" parameterType="list" resultType="user">
        select * from user
        <where>
            <foreach collection="list" open="(" close=")" item="id" separator=",">
                #{id}
            </foreach>
        </where>
    </select>

测试代码片段如下：

… … …
//获得MyBatis框架生成的UserMapper接口的实现类
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

//模拟条件ids
List<Integer> ids = new ArrayList<>();
// 获取ids的数据
List<User> userList = userMapper.selectByIds(ids);
System.out.println(userList);
sqlSession.close();

# 8.4 SQL的片段抽取

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

	<!--抽取sql片段简化编写-->
	<sql id="selectUser">select * from user</sql>

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

# 9.Mybatis的核心配置

# 9.1 typeHandlers标签

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

你可以重写类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。具体做法为：实现org.apache.ibatis.type.TypeHandler 接口，或继承一个很便利的类org.apache.ibatis.type.BaseTypeHandler，然后可以选择性地将它映射到一个JDBC类型。例如需求：一个Java中的Date数据类型，我想将之存到数据库的时候存成一个1970年至今的毫秒数，取出来时转换成java的Date，即java的Date与数据库的varchar毫秒值之间换。

使用的需求如下：

我在数据库表单中插入了四个键值对，分别是id、username、password、birthday。
birthday是一个bigint类型的，在java的User实体类中使用的是Date，我需要通过BaseTypeHandler转换
实现java类型和数据库的类型互相转换的功能实现

开发步骤：

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

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

③ 在MyBatis核心配置文件中进行注册

④ 测试转换是否正确

1.新建一个自定义的类，继承BaseTypeHandler,重写四个方法。

public class DateTypeHandler extends BaseTypeHandler<Date> {
    // 将java类型转换成数据库需要的类型
    @Override
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, Date date, JdbcType jdbcType) throws SQLException {
        long time = date.getTime();
        preparedStatement.setLong(i,time);
    }

    // 将数据库中的类型 转换为java类型
    // string 要转换的字符串
    // resultSet 查询出的结果
    @Override
    public Date getNullableResult(ResultSet resultSet, String s) throws SQLException {
        // 获得结果中需要的数据(long) 转换为Date类型
        long along = resultSet.getLong(s);
        Date date = new Date(along);
        return  date;

    }

    // 将数据库中的类型 转换为java类型
    @Override
    public Date getNullableResult(ResultSet resultSet, int i) throws SQLException {
        long along = resultSet.getLong(i);
        Date date = new Date(along);
        return  date;
    }

    // 将数据库中的类型 转换为java类型
    @Override
    public Date getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
        long aLong = callableStatement.getLong(i);
        Date date = new Date(aLong);
        return date;
    }
}

2.在配置文件中，配置注册类型自定义转换器

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

3.使用测试代码测试案列

@Test
    public void test1() throws IOException {
        // 获取SqlSession的数据库连接
        SqlSession sqlSession = getSqlSession();

        // 创建一个user的传递参数
        User user = new User();
        user.setId(8);
        user.setUsername("test1");
        user.setPassword("111111");
        // 这里是直接使用Date的时间
        user.setBirthday(new Date());

        UserMapper usermapper = sqlSession.getMapper(UserMapper.class);
        usermapper.save(user);
        // 释放资源
        sqlSession.close();


    }

    private SqlSession getSqlSession() throws IOException {
        InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
        SqlSession sqlSession = sqlSessionFactory.openSession(true);
        return sqlSession;
    }

4.查询数据库数据

mysql> select * from user where id = 8;
+----+----------+----------+---------------+
| id | username | password | birthday      |
+----+----------+----------+---------------+
|  8 | test1    | 111111   | 1659153013852 |
+----+----------+----------+---------------+
1 row in set (0.00 sec)

# 9.2 plugins标签

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

开发步骤：

① 导入通用PageHelper的坐标

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

③ 测试分页数据获取

1.导入通用的PageHelper坐标

	<!-- 分页助手 -->
	<dependency>
      <groupId>com.github.pagehelper</groupId>
      <artifactId>pagehelper</artifactId>
      <version>3.7.5</version>
    </dependency>

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

2.在mybatis核心配置文件中配置PageHelper插件

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

3.测试分页代码的实现

@Test
    public void test3() throws IOException {
        // 直接调用上面的方法
        SqlSession sqlSession = getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

        // 设置分页的参数  当前页+每页的条数
        PageHelper.startPage(2,3);

        // 循环遍历每个user的数据
        List<User> userList = userMapper.findAll();
        for (User user : userList) {
            System.out.println(user);
        }

        // 获得分页的相关参数
        PageInfo<User> pageInfo = new PageInfo<User>(userList);
        System.out.println("当前页" + pageInfo.getPageNum());
        System.out.println("每页显示条数" + pageInfo.getPageSize());
        System.out.println("总条数" + pageInfo.getTotal());
        System.out.println("总页数" + pageInfo.getPages());
        System.out.println("上一页" + pageInfo.getPrePage());
        System.out.println("下一页" + pageInfo.getNextPage());
        System.out.println("是否为第一个" + pageInfo.isIsFirstPage());
        System.out.println("是否为最后一个" + pageInfo.isIsLastPage());
		// 释放资源
        sqlSession.close();
    }

上次更新: 2023/11/28, 22:03:59

← Spring的事务管理 Mybatis多表查询→