前言
中文文档:https://mybatis.org/mybatis-3/zh/index.html
流程图:
一、Mybatis简介
【简介】
- MyBatis 是一款优秀的持久层框架。
- 它支持自定义 SQL、存储过程以及高级映射。
- MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
- MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
- 原名ibatis,原来东家Apache,后迁移到谷歌
【持久化】
- 持久化:将程序在持久状态和瞬时状态的转化的过程
- 瞬时状态:内存,断电即失
- 持久状态:数据库、io持久化
- 持久化的原因:有些对象不能被丢掉
【为什么需要Mybatis】
- 使用的人多。
- 简化JDBC代码,提高生产力。
- 解除SQL与程序的耦合,SQL与代码分离。
- 提高可维护性。
二、环境搭建
1. 创建数据库
CREATE DATABASE `mybatis`;
USER `mybatis`;
CREATE TABLE `user`(
`id` INT(20) NOT NULL PRIMARY KEY,
`name` VARCHAR(30) DEFAULT NULL,
`passwd` VARCHAR(30) DEFAULT null
)ENGINE=INNODB CHARSET=utf8;
INSERT INTO `user`(`id`,`name`,`passwd`) VALUES
(1,"张三","123"),
(2,"李四","456"),
(3,"王五","789");
2. maven依赖
<dependencies>
<!--Mysql驱动-->
<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.21</version>
</dependency>
<!--Mybatis-->
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.6</version>
</dependency>
<!--Junit-->
<!-- https://mvnrepository.com/artifact/junit/junit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.1</version>
<scope>test</scope>
</dependency>
</dependencies>
3.创建并配置mybatis-config.xml
mybatis-config.xml是对 MyBatis 系统的核心设置
在resources下面创建 mybatis-config.xml
配置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>
<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?
useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=UTC"/>
<property name="username" value="root"/>
<property name="password" value="root123123"/>
</dataSource>
</environment>
</environments>
<!--mappers映射-->
<mappers>
<mapper resource="org/mybatis/example/xxxMapper.xml"/>
</mappers>
</configuration>
三、编写代码
1.从 XML 中构建 SqlSessionFactory
MybatisUtil工具类
因此我们手动写一个MybatisUtil工具类(固定写法):
package com.stdpei.mybatis.util;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.IOException;
import java.io.InputStream;
/**
* @author huxuehao
* @create 2021-06-15-13:27
*/
public class MybatisUtil {
private static SqlSessionFactory sqlSessionFactory = null;
static {
try {
// 从 XML 文件中构建 SqlSessionFactory 的实例
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
// 获得 SqlSession 的实例。SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。
// 可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
}
2. 从 SqlSessionFactory 中获取 SqlSession
这里的工作我们其实已经封装在MybatisUtil中了,如下:
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
3.探究已映射的 SQL 语句
上面提到"可以通过 SqlSession 实例来直接执行已映射的 SQL 语句",下面我们就来看一看这里话的含义。
在此之前,我得先说明一下下面会提及到的"Mapper ",Mapper 其实就相当于与我们在javaweb阶段的DAO,是对数据库交互的部分。
一个SQL语句在Mybatis中可以通过 XML 定义,下面来看一下如何通过xml来定义一个SQL语句。
我们先要创建一个xml文件(xxxMapper.xml),xxxMapper.xml的位置也是有有讲究的,我们知道造maven中是“约定大于配置”的,所以我们需要将该文件放在resource下。如图:
在创建xml之前,我们需要一个pojo实体来,因为我们需要查询数据库中的表,按照规范,一张表对应着一个实体来
实体类User:
package com.stdpei.mybatis.pojo;
/**
* @author huxuehao
* @create 2021-06-15-13:37
*/
//实体类
public class User {
private int id;
private String name;
private String passwd;
public User(int id) {
}
public User(int id, String name, String passwd) {
this.id = id;
this.name = name;
this.passwd = passwd;
}
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 getPasswd() {
return passwd;
}
public void setPasswd(String passwd) {
this.passwd = passwd;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", passwd='" + passwd + '\'' +
'}';
}
}
创建并配置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-->
<mapper namespace="com.stdpei.mybatis.mapper.UserMapper">
<!--查询-->
<!--
id="getUserList"绑定接口中的抽象方法;
resultType="com.stdpei.mybatis.pojo.User:绑定返回结果的类型
-->
<select id="getUserList" resultType="com.stdpei.mybatis.pojo.User" >
select * from `user`
</select>
</mapper>
四、测试
代码:
public class UserMapperTest {
@Test
public void test(){
SqlSession sqlSession = MybatisUtil.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
List<User> userList = mapper.getUserList();
for (User user: userList) {
System.out.print(user.getId()+"\t");
System.out.print(user.getName()+"\t");
System.out.println(user.getPasswd());
}
}
}
测试结果:
五、可能会遇到对的问题
1. 关于在mybatis-config.xml中造注册mappers的问题
2.关于在xxxMapper.xml中的MapperRegistry(mapper注册问题)
3.资源编码的问题
如果遇到如下报错:
maven 项目运行时出控制台报错:com.sun.org.apache.xerces.internal.impl.io.MalformedByteSequenceException: 1字节的 UTF-8 序列的字节 1 无效。
该错误是由一些配置文件引起的:如mybatis-config.xml的编码问题;
解决方案:
在项目依赖配置文件 pom.xml 中加入构建项目编码属性:
<!--资源文件编码的问题-->
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>