一、什么是MyBatis
(一)MyBatis概述
- MyBatis官网 - https://mybatis.org/mybatis-3
MyBatis是支持普通SQL查询,存储过程和高级映射的优秀持久层框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis使用简单的XML或注解用于配置和原始映射,将接口和Java的POJOs(Plan Old Java Objects,普通的Java对象)映射成数据库中的记录。 - 在Maven仓库里查找MyBatis - https://mvnrepository.com/artifact/org.mybatis/mybatis
(二)ORM工具的基本思想
无论是Hibernate还是MyBatis,你会发现它们的共同点:
- 从配置文件(通常是XML配置文件)得到SQL会话工厂对象。
- 由SQL会话工厂对象产生SQL会话对象。
- 利用SQL会话对象完成对数据的增删改查和事务提交等。
- 在用完之后关闭SQL会话对象。
- 在Java对象和数据库之间有做映射的XML配置文件。
二、创建数据库与表
1、在Navicat里创建MySQL数据库testdb
2、创建用户表 - t_user
CREATE TABLE `t_user` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`name` varchar(50) DEFAULT NULL,
`age` int(11) DEFAULT NULL,
`address` varchar(255) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;
- 执行SQL语句来创建用户表
- 查看用户表结构
3、在用户表里插入3条记录
INSERT INTO `t_user` VALUES ('1', '李洪刚', '20', '江阳区嘉裕花园3栋四楼15#');
INSERT INTO `t_user` VALUES ('2', '王云华', '30', '纳溪区大渡镇红鱼村三大队');
INSERT INTO `t_user` VALUES ('3', '郑小翠', '21', '江阳区老窖花园2栋五楼15号');
- 执行SQL语句插入记录
- 查看用户表记录
采用Maven构建工具,不用你手动去下载jar包,所有jar包仓库统一管理,只要配置一下pom文件,run-install…依赖的包就会下载下来,省去你管理依赖的时间。(pom: Project Object Model 项目对象模型)
三、案例演示MyBatis基本使用
(一)创建Maven项目 - MyBatisDemo
(二)在pom文件里添加相应的依赖
<?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>net.hw.mybatis</groupId>
<artifactId>MyBatisDemo</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.6</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.40</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.2</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
</dependencies>
</project>
- 添加了新的依赖,单击一下红圈指定的刷新按钮
- 查看下载到本地的jar包
补充:如何利用Maven仓库添加jar包依赖元素?
1、打开Maven Repository网
- 官网网址 - http://mvnrepository.com
2、在搜索框里输入待查的jar包名
- 搜索MyBatis
- 将红框里的依赖元素复制到pom文件里的<dependencies>元素里
(三)创建与用户表对应的用户实体类 - User
- 用户实体类的属性对应用户表的字段(列)
package net.hw.mybatis.bean;
/**
* 功能:用户实体类
* 作者:华卫
* 日期:2021年03月03日
*/
public class User {
private int id;
private String name;
private int age;
private String address;
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 int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", age=" + age +
", address='" + address + '\'' +
'}';
}
}
(四)创建用户实体关系映射配置文件
- 在resources目录里创建mapper子目录,然后在里面创建实体关系映射配置文件 - 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="net.hw.mybatis.mapper.UserMapper">
<select id="findById" parameterType="int" resultType="User">
SELECT * FROM t_user WHERE id = #{id};
</select>
<select id="findAll" resultType="User">
SELECT * FROM t_user;
</select>
</mapper>
- 传入参数一般用
#
,查询属性值一般用$
(五)创建MyBatis配置文件
- 在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>
<!--配置实体类别名-->
<typeAliases>
<typeAlias type="net.hw.mybatis.bean.User" alias="User"/>
</typeAliases>
<!--配置数据库环境-->
<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://localhost:3306/testdb?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="p@ssw0rd"/>
</dataSource>
</environment>
</environments>
<!--配置实体关系映射器文件-->
<mappers>
<mapper resource="mapper/UserMapper.xml"/>
</mappers>
</configuration>
- 简要说明
- mybatis-config.xml 是 MyBatis 用来建立 sessionFactory 用的,里面主要包含了数据库连接相关内容,还有 Java 类所对应的别名,比如
<typeAlias type = "net.hw.mybatis.bean.User" alias = "User" />
,这个别名非常重要,在具体类的映射中,比如UserMapper.xml 中 resultType 就是对应这里的User。要保持一致。 - mybatis-config.xml 里面 的
<mapper resource="mapper/UserMapper.xml"/>
是包含要映射的类的实体关系映射配置文件。 - 在UserMapper.xml 文件里面主要是定义各种SQL 语句,以及这些语句的参数,以及要返回的类型等。
(六)创建日志属性文件
- 在resources目录里创建log4j.properties文件
log4j.rootLogger=WARN, stdout, logfile
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m%n
log4j.appender.logfile=org.apache.log4j.FileAppender
log4j.appender.logfile.File=target/mybatis.log
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - %m%n
(七)创建测试类测试用户操作
1、创建测试类 - TestUserOperation
- 在test/java目录里创建net.hw.mybatis.bean包,然后在包里创建测试类 - TestUserOperation
package net.hw.mybatis.bean;
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 org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.io.IOException;
import java.io.Reader;
import java.util.List;
/**
* 功能:测试用户操作
* 作者:华卫
* 日期:2021年03月03日
*/
public class TestUserOperation {
private SqlSession sqlSession; // SQL会话
@Before
public void init() {
try {
// 读取MyBatis配置文件
Reader reader = Resources.getResourceAsReader("mybatis-config.xml");
// 基于MyBatis配置文件构建SQL会话工厂
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader);
// 利用SQL会话工厂获取SQL会话
sqlSession = factory.openSession();
// 提示用户SQL会话创建成功
System.out.println("sqlSession对象已创建。");
} catch (IOException e) {
e.printStackTrace();
}
}
@Test
public void testFindById() {
int id = 1;
User user = sqlSession.selectOne("net.hw.mybatis.mapper.UserMapper.findById", id);
if (user != null) {
System.out.println(user);
} else {
System.out.println("编号为[" + id + "]的用户未找到。");
}
}
@Test
public void testFindAll() {
List<User> users = sqlSession.selectList("net.hw.mybatis.mapper.UserMapper.findAll");
users.forEach(user -> System.out.println(user));
}
@After
public void destroy() {
// 关闭SQL会话
sqlSession.close();
// 提示用户SQL会话对象关闭
System.out.println("sqlSession对象已关闭。");
}
}
2、运行测试方法 - testFindById()
- 修改testFindById()代码,再运行查看结果
3、运行测试方法 - testFindAll()
四、采用接口方式使用MyBatis
- 前面,我们采用SqlSession实例来直接执行已映射的SQL语句:
sqlSession.selectOne( "net.hw.mybatis.mapper.UserMapper.findById", id);
其实还有更好更简洁的方式,使用合理描述参数和SQL语句返回值的接口(比如UserMapper.class),这样代码更简单,不容易发生字符串文字和转换的错误。
(一)创建用户映射器接口
- 创建net.hw.mybatis.mapper包,然后在包里创建用户映射器接口 - UserMapper
- 注意:UserMapper接口的完整路路径(包名+接口名)必须是<mapper>\元素的
namespace
属性值net.hw.mybatis.mapper.UserMapper
,并且里面定义的方法名必须与UserMapper.xml里定义的SQL语句的id
值保持一致,比如 findById、findAll。
(二)创建测试类测试用户映射器接口
1、创建测试类 - TestUserMapper
- 在test/java里创建net.hw.mybatis.mapper包,然后在包里创建测试类 - TestUserMapper
package net.hw.mybatis.mapper;
import net.hw.mybatis.bean.User;
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 org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.io.IOException;
import java.io.Reader;
import java.util.List;
/**
* 功能:测试用户映射器接口
* 作者:华卫
* 日期:2021年03月03日
*/
public class TestUserMapper {
private SqlSession sqlSession; // SQL会话
private UserMapper userMapper; // 用户映射器
@Before
public void init() {
try {
// 读取MyBatis配置文件作为字符输入流
Reader reader = Resources.getResourceAsReader("mybatis-config.xml");
// 基于MyBatis配置文件构建SQL会话工厂
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader);
// 利用SQL会话工厂获取SQL会话
sqlSession = factory.openSession();
// 利用SQL会话获取用户映射器对象
userMapper = sqlSession.getMapper(UserMapper.class);
// 提示用户SQL会话对象创建成功
System.out.println("sqlSession对象已创建。");
} catch (IOException e) {
e.printStackTrace();
}
}
@Test
public void testFindById() {
int id = 1;
User user = userMapper.findById(id);
if (user != null) {
System.out.println(user);
} else {
System.out.println("编号为[" + id + "]的用户未找到。");
}
}
@Test
public void testFindAll() {
List<User> users = userMapper.findAll();
users.forEach(user -> System.out.println(user));
}
@After
public void destroy() {
// 关闭SQL会话
sqlSession.close();
// 提示用户SQL会话对象关闭
System.out.println("sqlSession对象已关闭。");
}
}