MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
MyBatis的功能架构主要分为三层:
- 接口层:负责与应用程序交互,提供了一系列接口和实现类,如SqlSession、Executor、StatementHandler等。其中,SqlSession是MyBatis的主要接口,用于执行SQL语句、提交事务、关闭连接等操作。
- 核心处理层:是MyBatis的核心部分,负责处理SQL语句、参数映射、结果映射等功能。主要组件有Configuration、MappedStatement、SqlSource、BoundSql和TypeHandler。
- 数据源层:负责与数据库进行连接和操作,提供了DataSource和Transaction接口及其实现。MyBatis支持多种数据源,如JNDI数据源、Pooled数据源和Unpooled数据源。
MyBatis的总体流程包括:
- 加载配置并初始化:加载配置文件,将SQL的配置信息加载成为一个个MappedStatement对象(包括了传入参数映射配置、执行的SQL语句、结果映射配置),存储在内存中。
- 接收调用请求:调用MyBatis提供的API,传入参数为SQL的ID和传入参数对象,将请求传递给下层的请求处理层进行处理。
- 处理操作请求:根据SQL的ID查找对应的MappedStatement对象,根据传入参数对象解析MappedStatement对象,得到最终要执行的SQL和执行传入参数。获取数据库连接,根据得到的最终SQL语句和执行传入参数到数据库执行,并得到执行结果。根据MappedStatement对象中的结果映射配置对得到的执行结果进行转换处理,并得到最终的处理结果,释放连接资源。
- 返回处理结果:将最终的处理结果返回。
入门
要使用 MyBatis, 只需将 mybatis-x.x.x.jar 文件置于类路径(classpath)中即可。
如果使用 Maven 来构建项目,则需将下面的依赖代码置于 pom.xml 文件中:
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>x.x.x</version>
</dependency>
使用步骤
-
创建项目:
- 使用Maven或Gradle等构建工具创建一个新的Java项目。
- 在项目的
pom.xml
或build.gradle
文件中添加MyBatis和数据库驱动的依赖。
-
配置数据库:
- 在数据库中创建一个用于测试的数据表,并插入一些测试数据。
- 配置MyBatis的数据源,包括数据库URL、用户名、密码和驱动类名等。
-
编写实体类:
- 根据数据库表的结构创建一个对应的Java实体类。
- 实体类的属性应与数据库表的列相对应,并提供getter和setter方法。
-
编写Mapper接口:
- 创建一个Mapper接口,用于定义数据库操作的方法。
- Mapper接口的方法名应与SQL映射文件中定义的SQL语句的id相对应。
-
编写SQL映射文件:
- 在
resources
目录下创建一个SQL映射文件,用于定义SQL语句和映射规则。 - SQL映射文件应包含
<mapper>
标签,并指定namespace
为Mapper接口的全限定名。 - 在
<mapper>
标签内部定义SQL语句,如<select>
、<insert>
、<update>
和<delete>
等。
- 在
-
配置MyBatis:
- 在
resources
目录下创建一个MyBatis配置文件,如mybatis-config.xml
。 - 配置文件中应包含
<configuration>
标签,并指定数据源、事务管理器、映射文件等。
- 在
-
编写测试代码:
- 使用MyBatis提供的API加载配置文件和获取SqlSessionFactory对象。
- 通过SqlSessionFactory对象获取SqlSession对象,并执行Mapper接口中的方法。
- 处理执行结果并释放资源。
实例:
数据库表
CREATE TABLE y_user (
id INT PRIMARY KEY AUTO_INCREMENT,
name VARCHAR(20),
pass VARCHAR(20),
gender CHAR(1)
);
INSERT INTO y_user VALUES (1, '张三', '123', '男');
INSERT INTO y_user VALUES (2, '李四', '123', '男');
INSERT INTO y_user VALUES (3, '翠花', '123', '女');
实体类
public class User {
private Integer id;
private String name;
private String pass;
private String gender;
// Getter和Setter方法
// ...
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", pass='" + pass + '\'' +
", gender='" + gender + '\'' +
'}';
}
}
Mapper接口:
public interface UserMapper {
List<User> selectAll();
}
SQL映射文件
<?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="com.example.mapper.UserMapper">
<select id="selectAll" resultType="com.example.pojo.User">
SELECT * FROM y_user
</select>
</mapper>
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.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis_db?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="your_password"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="mapper/UserMapper.xml"/>
</mappers>
</configuration>
测试
import com.example.mapper.UserMapper;
import com.example.pojo.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 java.io.InputStream;
import java.util.List;
public class MyBatisDemo {
public static void main(String[] args) throws Exception {
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
try (SqlSession session = sqlSessionFactory.openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
List<User> users = mapper.selectAll();
for (User user : users) {
System.out.println(user);
}
}
}
}