本文为 SSM 框架系列之 MyBatis 第一部分:初识 MyBatis 与 第一个 MyBaits 程序
其它内容的链接如下:
【1】MyBatis01:初识 MyBatis 与 第一个 MyBaits 程序
【2】MyBatis02:CRUD 操作
【3】MyBatis03:配置解析
【4】MyBatis04:作用域和生命周期
【5】MyBatis05:分页
【6】MyBatis06:日志
【7】MyBatis07:使用注解开发
【8】MyBatis08:ResultMap 的结果集映射
【9】MyBatis09:动态 SQL 与缓存
传送门:
1 初识 MyBatis
1.1 定义
MyBatis 是一款优秀的持久层框架,它避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的过程。
同时,它可以使用简单的 XML 或注解来配置和映射原生信息,将接口和 Java 的 实体类 【Plain Old Java Objects】映射成数据库中的记录。
1.2 什么是持久化
持久化是将程序数据在持久状态和瞬时状态间转换的机制,即把数据(如内存中的对象)保存到可永久保存的存储设备中(如磁盘)的机制。
之所以需要持久化,是因为内存本生是不可靠的,可能会导致某些数据丢失。同时,也会因为内存的容量限制不能一直呆在内存中,需要持久化来缓存到外存。
2 第一个MyBatis 程序
2.1 环境配置、操作步骤与目录结构
2.1.1 环境配置
目前我的环境是:
- jdk 11
- MySQL 8.0.16
- maven 3.6.3
参考的环境是:
- jdk 1.8
- MySQL 5.7.1
- maven 3.6.1
2.1.2 操作步骤
- 搭建实验数据库
- 导入 MyBatis 相关 jar 包
- 编写 MyBatis 核心配置文件
- 编写 MyBatis 工具类来连接数据库的资源
- 创建一个与数据库的表相对应的实体类
- 编写一个 Mapper 接口类来规范功能
- 编写对应的 Mapper.xml 配置文件来实现接口
- 编写测试类
2.1.3 第一个 MyBatis 的目录结构
2.2 搭建实验数据库
利用 IDEA 自带的 Database 与数据库相连接,然后输入如下 sql 语句,建立一个用户表,其中包含用户名和用户密码。
create database `mybatis`;
use `mybatis`;
drop table if exists `user`;
create table`user`(
`id` int(20) not null primary key,
`name` varchar(30) default null,
`password` varchar(30) default null
)engine = InnoDB default charset = utf8;
insert into `user`(`id`, `name`, `password`) values
(1, 'sharm', '123456'), (2, 'luma', '123456');
2.3 编写 MyBatis 核心配置文件
在 main/resources
目录下新建 mybatis-config.xml
文件,用于 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>
<!--mybatis 的官方默认代码,不要修改它-->
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<!--数据库驱动器的驱动-->
<property name="driver" value="com.mysql.jdbc.Driver"/>
<!--数据库的 url-->
<property name="url"
value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&useUnicode=true&characterEncoding=utf8"/>
<!--数据库的名称和密码-->
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!--主程序中每一个 mapper.xml都必须写一个,否则会报错-->
<mappers>
<mapper resource="sharm/dao/UserMapper.xml"/>
</mappers>
</configuration>
2.4 编写 MyBatis 工具类来连接数据库的资源
按照 Maven 约束,在 java.sharm
目录下新建一个 utils
包,在其中新建 MyBatis 工具类。其中的代码是 MyBatis 官方约定的,最好不要修改。
package sharm.utils;
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;
/**
* 通过 Mybatis 的官方教程:https://mybatis.org/mybatis-3/zh/getting-started.html
*/
public class MyBatisUtils {
private static SqlSessionFactory sqlSessionFactory;
static {
try {
// 1 从 XML 中构建 SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
//2 获取SqlSession连接
public static SqlSession getSession(){
return sqlSessionFactory.openSession();
}
}
2.5 创建一个与数据库的表相对应的实体类
按照 Maven 约束,在 java.sharm
目录下新建一个 pojo
包用于存放实体类,同时因为需要将数据库的内容注入到 Java 对象中。其中的变量名一定要和数据库表中的字段一定要一一对应。
package sharm.pojo;
public class User {
private int id;
private String name;
private String password;
public User() {
}
public User(int id, String name, String password) {
this.id = id;
this.name = name;
this.password = password;
}
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 getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", password='" + password + '\'' +
'}';
}
}
2.6 编写一个 UserMapper 接口类来规范功能
package sharm.dao;
import sharm.pojo.User;
import java.util.List;
public interface UserMapper {
/**
* 查询对应表中的所有对象
* @return
*/
List<User> selectUser();
}
2.7 编写对应的 UserMapper.xml 配置文件来实现接口
这一点和原来的 Dao 层有点区别,原来是用一个实现类来实现接口,现在使用一个 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">
<!--namespace 很重要,不能写错。 namespace = 绑定一个对应的 Dao/Mapper 接口-->
<mapper namespace="sharm.dao.UserMapper">
<select id="selectUser" resultType="sharm.pojo.User">
select * from mybatis.user
</select>
</mapper>
2.8 编写测试类
在 test.java.sharm.dao
下建立 UserTest 测试类用于测试。
package sharm.dao;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import sharm.pojo.User;
import sharm.utils.MyBatisUtils;
import java.util.List;
public class UserTest {
@Test
public void testSelectUser(){
//3 从 SqlSessionFactory 中获取 SqlSession
SqlSession session = MyBatisUtils.getSession();
//4 探究已映射的 SQL 语句
UserMapper mapper = session.getMapper(UserMapper.class);
List<User> users = mapper.selectUser();
for (User user: users){
System.out.println(user);
}
session.close();
}
}
2.9 自己出错的点
- 把 mybatis-config.xml 文件错误地放在了 main 的同级目录下,应该放在 main 中的 resources 目录下;
- 测试文件应该放在 test 文件夹下的同级目录下;
- mybatis-config.xml 要添加 mappers 映射,同时其中的 resource 标签的内容要用斜杠表示每一级。如sharm.dao.UserMapper.xml → sharm/dao/UserMapper.xml;
- 之所以使用父项目和子模块的概念,是因为这样只需要在父项目的 pom.xml 中写入依赖,子模块就会自动导入父项目的依赖。
- 当本地仓库已经有某个 jar 包之后,直接在
artifactId
输入对应的 jar 包名就会出现。