Mybatis学习笔记

2024-01-02 19:09:10

简介

什么是Mybatis？

MyBatis 是一款优秀的持久层框架。
它支持自定义 SQL、存储过程以及高级映射。
MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。
MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。
2013年11月迁移到Github。

如何获取Mybatis？

maven获取：

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

Github获取：https://github.com/mybatis/mybatis-3
中文文档：https://mybatis.org/mybatis-3/zh/index.html

持久化

持久化就是将程序的数据在持久状态和顺时状态转化的过程
内存：断点即失
数据库（jdbc），io文件持久化

为什么需要持久化？

有一些对象，不能让他丢掉
内存太贵了

持久层

完成持久化工作的代码块
层界限十分明显

为什么使用Mybatis？

简单易学
灵活
SQL和代码分离，提高了可维护性
提供映射标签，支持对象和数据库的orm字段关系映射
提供对象关系映射标签，支持对象关系组建维护
提供xml标签，支持编写动态sql
使用的人多！

基础实践

第一个Mybatis程序

搭建环境

搭建数据库

create DATABASE mybatis;

use mybatis;

create table user (
	id int(20) not null primary key,
	name VARCHAR(30) DEFAULT null,
	pwd VARCHAR(30) DEFAULT null
)ENGINE=INNODB DEFAULT charset=utf8;

insert into user(id, `name`, pwd) values
(1, 'name1', '1'),
(2, 'name2', '2'),
(3, 'name3', '3')

新建项目

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

<!--mysql-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.47</version>
</dependency>
<!--mybatis-->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.2</version>
</dependency>
<!--junit-->
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>

创建一个模块

编写mybatis的核心配置文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://192.168.43.200:3306/mybatis?useSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

编写mybatis工具类

public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory;

    static {
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。
     * SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。
     */
    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }
}

编写代码

实体类

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

    public User() {
    }

    public User(int id, String name, String pwd) {
        this.id = id;
        this.name = name;
        this.pwd = pwd;
    }

    public int getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPwd() {
        return pwd;
    }

    public void setPwd(String pwd) {
        this.pwd = pwd;
    }

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

dao接口

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

dao实现类

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--namespace绑定了一个mapper接口-->
<mapper namespace="com.xubadou.mapper.UserMapper">

    <!--select 查询语句-->
    <select id="getUserList" resultType="com.xubadou.pojo.User">
        select * from mybatis.user
    </select>

</mapper>

测试

注意点：
org.apache.ibatis.binding.BindingException: Type interface com.xubadou.mapper.UserMapper is not known to the MapperRegistry.
这个异常代表着我们没有在核心配置文件中配置mapper

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

执行测试还有可能出现下面的异常，项目编译之后，没有UserMapper.xml文件：
这个时候需要在pom.xml文件中加入如下代码，放开文件的过滤：

<!--在build中配置resources，来防止我们资源导出失败的问题-->
<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>true</filtering>
        </resource>
        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>true</filtering>
        </resource>
    </resources>
</build>

Junit测试代码：

@Test
public void test() {
    //1.获取SqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();

    //2.getMapper
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    List<User> userList = userMapper.getUserList();
    for (User user : userList) {
        System.out.println(user);
    }

    //3.关闭SqlSession
    sqlSession.close();
}

实现增删改查

namespace

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

select

查询语句

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

1.编写接口

//根据用户Id获取用户
User getUserByID(int id);

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

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

3.测试

@Test
public void getUserByID() {
    //1.获取SqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();

    //2.getMapper
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    User user = userMapper.getUserByID(1);
    System.out.println(user);

    //3.关闭SqlSession
    sqlSession.close();
}

insert

<insert id="insertUser" parameterType="com.xubadou.pojo.User" >
    insert into mybatis.user(id, name, pwd) values(#{id}, #{name}, #{pwd})
</insert>

update

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

delete

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

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

sqlSession.commit();

万能Map

int insertUser2(Map map);

<insert id="insertUser2" parameterType="map" >
    insert into mybatis.user(id, name, pwd) values(#{uId}, #{uName}, #{uPwd})
</insert>

@Test
public void insertUser2() {
    //1.获取SqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();

    //2.getMapper
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

    Map<String, Object> user = new HashMap<String, Object>(16);
    user.put("uId", 4);
    user.put("uName", "xxx");
    user.put("uPwd", "45333");
    int code = userMapper.insertUser2(user);
    System.out.println(code);

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

    //3.关闭SqlSession
    sqlSession.close();
}

Map传递参数，直接在sql中取出key即可！【parameterType=“map”】
对象传递参数，直接在sql中取出对象的属性即可！【parameterType=“com.xubadou.mapper.UserMapper”】
只有一个基本类型参数的情况下，可以直接在sql中取到！
多个参数用Map，或者注解！

模糊查询

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

List<User> userList = maper.getUserLike("%李%")；

2.在SQL拼接中使用通配符

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

配置解析

核心配置文件

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

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

环境配置（environments）

Mybatis可以配置成使用多种环境
尽管可以配置多个环境，但每个SqlSessionFactory实例只能选择一种环境
学会使用配置多套运行环境
Mybatis默认的事务管理器就是JDBC，连接池：POOLED

属性（properties）

可以通过properties属性来实现引用配置文件
这些属性都是可外部配置且可动态替换的，既可以在典型的Java属性文件（properties文件）中配置，也可以通过properties标签的字标签来传递

编写配置文件
db.properties

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://192.168.43.200:3306/mybatis?useSSL=false&useUnicode=true&characterEncoding=UTF-8
username=root
password=123456

在核心配置文件中引入

<properties resource="db.properties">
    <property name="username" value="root"/>
    <property name="password" value="12345"/>
</properties>

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

类型别名

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

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

也可以指定一个包名下面搜索需要的Java Bean
扫描实体类的包，它的默认别名就为这个类的类名，首字母小写！

<typeAliases>
    <package name="com.xubadou.pojo"/>
</typeAliases>

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

@Alias("user")
public class User {

映射器（mappers）

MapperRegistry：注册绑定我们的Mapper文件
方式一：

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

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

<mappers>
    <mapper class="com.xubadou.mapper.UserMapper"/>
</mappers>

注意点：

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

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

<mappers>
    <package name="com.xubadou.mapper"/>
</mappers>

注意点：

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

生命周期与作用域

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

SqlSessionFactoryBuilder

一旦创建了 SqlSessionFactory，就不再需要它了
局部方法变量

SqlSessionFactory

类似于数据库连接池
一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例
最佳作用域是应用作用域
最简单的就是使用单例模式或者静态单例模式

SqlSession

类似于到连接池的一个请求
每个线程都应该有它自己的 SqlSession 实例
SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域
用完需要赶紧关闭

ResultMap结果集映射

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

当属性和字段不一致的时候，会出现下面的问题：

解决方法：

方式一起别名

<select id="getUserList" resultType="user">
    select id, name, pwd password from mybatis.user
</select>

方式二使用resultMap

<!--结果集映射-->
<resultMap id="userMap" type="user">
    <result property="password" column="pwd"/>
</resultMap>

<!--select 查询语句-->
<select id="getUserList" resultMap="userMap">
    select id, name, pwd from mybatis.user
</select>

resultMap 元素是 MyBatis 中最重要最强大的元素
ResultMap 的设计思想是，对简单的语句做到零配置，对于复杂一点的语句，只需要描述语句之间的关系就行了
这就是 ResultMap 的优秀之处——你完全可以不用显式地配置它们

分页

Limit实现分页

接口

//分页查询
List<User> getUserPage(Map<String, Object> map);

mapper.xml

<select id="getUserPage" parameterType="map" resultMap="userMap">
    select id, name, pwd from user limit #{startIndex}, #{pageSize}
</select>

测试

@Test
public void getUserPage() {
     //1.获取SqlSession对象
     SqlSession sqlSession = MybatisUtils.getSqlSession();

     //2.getMapper
     UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
     Map<String, Object> params = new HashMap<String, Object>(16);
     params.put("startIndex", 1);
     params.put("pageSize", 2);
     List<User> userList = userMapper.getUserPage(params);
     for (User user : userList) {
         System.out.println(user);
     }

     //3.关闭SqlSession
     sqlSession.close();
 }

RowBounds分页

在java代码层面实现分页

@Test
public void getUserPageByRowBounds() {
    //1.获取SqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();

    //2.getMapper
    List<User> userList = sqlSession.selectList("com.xubadou.mapper.UserMapper.getUserList", null, new RowBounds(1, 2));
    for (User user : userList) {
        System.out.println(user);
    }

    //3.关闭SqlSession
    sqlSession.close();
}

注解开发

使用注解来映射简单语句会使代码显得更加简洁
但对于稍微复杂一点的语句，Java 注解不仅力不从心，还会让你本就复杂的 SQL 语句更加混乱不堪
如果你需要做一些很复杂的操作，最好用 XML 来映射语句。

修改接口

//获取用户列表
@Select("select * from user")
List<User> getUserList();

修改核心配置文件

<mappers>
    <mapper class="com.xubadou.mapper.UserMapper"/>
</mappers>

Mybatis执行流程剖析

注解实现增删改查

复杂查询

多对一查询

创建测试用的表，然后插入一下测试数据

CREATE TABLE `teacher` (
  `id` INT(10) NOT NULL,
  `name` VARCHAR(30) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=INNODB DEFAULT CHARSET=utf8;

INSERT INTO teacher(`id`, `name`) VALUES (1, '秦老师'); 

CREATE TABLE `student` (
  `id` INT(10) NOT NULL,
  `name` VARCHAR(30) DEFAULT NULL,
  `tid` INT(10) DEFAULT NULL,
  PRIMARY KEY (`id`),
  KEY `fktid` (`tid`),
  CONSTRAINT `fktid` FOREIGN KEY (`tid`) REFERENCES `teacher` (`id`)
) ENGINE=INNODB DEFAULT CHARSET=utf8;

INSERT INTO `student` (`id`, `name`, `tid`) VALUES (1, '小明', 1); 
INSERT INTO `student` (`id`, `name`, `tid`) VALUES (2, '小红', 1); 
INSERT INTO `student` (`id`, `name`, `tid`) VALUES (3, '小张', 1); 
INSERT INTO `student` (`id`, `name`, `tid`) VALUES (4, '小李', 1); 
INSERT INTO `student` (`id`, `name`, `tid`) VALUES (5, '小王', 1);

测试环境搭建

导入lombok
新建实体类Teacher，Student
建立Mapper接口
建立Mapper.XML文件
在核心配置文件中绑定注册我们的Mapper接口或者文件！
测试查询是否能够成功！

码农公寓

简介