目录
一、Mybatis的详细介绍
(1)概念
MyBatis是一个优秀的持久层框架,他封装了JDBC,几乎避免了手写JDBC的绝大部分代码,可以避免那些重复而繁多的JDBC代码。
(2)主要特点
SQL 映射配置:
- MyBatis 使用 XML 文件或注解来配置 SQL 语句。
- XML 文件包含了
<mapper>
元素,其中定义了 SQL 语句、参数类型和返回类型等信息。- 注解是直接在 Java 接口的方法上使用,如
@Select
、@Insert
等注解来指定 SQL 语句。动态 SQL:
- MyBatis 支持动态 SQL 生成,即根据运行时的条件动态构建 SQL 语句。通过 XML 中的标签如
<if>
、<choose>
、<when>
、<otherwise>
和<foreach>
来实现。- 动态 SQL 能够根据条件灵活地添加或删除 SQL 子句。
参数映射:
- 参数映射使得从 Java 对象到 SQL 语句中的参数映射变得更加容易。
- 可以通过
#{}
占位符来指定参数值,MyBatis 会自动处理这些占位符的替换,并正确处理 SQL 注入问题。- 对于复杂的参数对象,还可以使用
<constructor>
和<resultMap>
来指定更复杂的映射规则。结果映射:
- 结果映射是 MyBatis 的一个关键特性,它能够自动将数据库查询结果映射到 Java 对象。
- 简单的结果映射可以直接通过
<resultMap>
元素或注解来定义。- 对于更复杂的情况,如关联查询,可以使用
<association>
和<collection>
元素来处理一对多或多对一的关系。缓存机制:
- MyBatis 提供了二级缓存机制,可以显著提高查询效率。
- 缓存分为一级缓存(默认开启,基于
SqlSession
的缓存)和二级缓存(可选配置,基于映射器的缓存)。- 二级缓存可以在不同
SqlSession
实例之间共享数据,但需要注意并发和数据一致性的问题。事务管理:
- MyBatis 支持本地事务管理,即在一个
SqlSession
内部的所有操作都会在一个事务内完成。- 也可以通过外部事务管理器集成,比如 Spring 的事务管理功能,来支持更复杂的事务需求。
(3)mybatis的工作流程
- 1)加载配置文件:
开始时,先加载 MyBatis 的配置文件。这个配置文件通常是一个 XML 文件,其中包含了数据库连接信息、事务管理器配置、以及其他全局设置。
- 2)创建 SqlSessionFactory:
一旦配置文件被加载,就可以使用 SqlSessionFactoryBuilder 类来创建一个SqlSessionFactory 实例。SqlSessionFactory 是用来创建 SqlSession 的工厂类,它会在内部初始化所有的配置信息,并准备好执行 SQL 语句。
- 3)获取 SqlSession:
使用
SqlSessionFactory
创建一个SqlSession
实例。SqlSession
是与数据库交互的主要入口点,它代表了一个会话,在这个会话中可以执行多个 SQL 语句。
- 4)执行 SQL:
通过
SqlSession
调用映射器接口中的方法来执行 SQL 语句。映射器接口是一个 Java 接口,其方法名与 XML 映射文件中的 SQL 语句相对应。例如,如果你有一个名为UserMapper
的接口,里面定义了selectUserById
方法,那么就可以通过调用sqlSession.getMapper(UserMapper.class).selectUserById(id)
来执行相应的 SQL 语句。
- 5)处理结果:
当 SQL 语句被执行后,MyBatis 会自动将查询结果映射成 Java 对象。这个过程由结果映射规则控制,这些规则定义在 XML 映射文件中或者使用注解的方式。
- 6)提交或回滚事务:
如果执行的是更新操作(如插入、更新或删除),那么需要提交事务。如果执行过程中出现了异常,则可能需要回滚事务。这可以通过
SqlSession
的commit()
和rollback()
方法来完成。
- 7)关闭 SqlSession:
最后,不要忘记关闭
SqlSession
,以释放数据库连接和其他资源。
二、环境准备
1.首先创建一个Maven项目,在pom.xml中引入项目需要的相关依赖,依赖如下所示。
主要依赖有 mybatis依赖,lombok依赖,junit单元测试依赖,mysql核心配置依赖
<dependencies>
<dependency>
<!--1.mybatis依赖-->
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.16</version>
</dependency>
<dependency>
<!--2.lombok依赖,用于生成get和set等方法-->
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.30</version>
<scope>provided</scope>
</dependency>
<dependency>
<!--3.用于单元测试的依赖-->
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>RELEASE</version>
<scope>test</scope>
</dependency>
<!--4.mysql核心配置依赖-->
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<version>8.0.33</version>
</dependency>
</dependencies>
2.创建一个简单的用户表如下。
3.将目录结构补充完整,包括mybatis的xml映射文件。
注意:UserMapper 接口和 UserMapper.xml 文件必须在相同的包下,并且名字也要完全相同。
4.配置mybatis配置文件和书写映射文件。
(1)mybatis.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>
<!--引入外部文件 database.properties -->
<properties resource="database.properties"/>
<settings>
<!--控制台输出sql日志文件-->
<setting name="logImpl" value="STDOUT_LOGGING"/>
<!--手动开启一级缓存,默认情况也是开启状态-->
<setting name="localCacheScope" value="SESSION"/>
</settings>
<!--设置环境信息-->
<environments default="mysql">
<environment id="mysql">
<!--事务管理-->
<transactionManager type="JDBC"/>
<!--连接池,连接数据库-->
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
<!--映射文件的位置-->
<mappers>
<mapper resource="com/its/mapper/UserMapper.xml"/>
</mappers>
</configuration>
单独的数据库配置文件如下
jdbc.driver = com.mysql.cj.jdbc.Driver
jdbc.url = jdbc:mysql:///demo_test
jdbc.username = root
jdbc.password = root
【说明】以上两个配置文件是可以写在一起的,都可以写在mybatis.xml中。分开再写一个database.properties文件是为了将数据库连接的配置单独写一份,方便维护和管理。用的时候只需引用一下即可。
三、书写代码和相关的SQL语句
mapper包下的UserMapper接口的代码如下
UserMapper.xml映射文件的代码如下
上面所有完成之后进行测试,test包下MybatisTest.java的测试代码如下:
package com.its;
import com.its.mapper.UserMapper;
import com.its.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 org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
public class MybatisTest {
SqlSession session;
//@Before这个注解会在@Tset注解运行之前执行
@Before //因为每一个测试时都需要有这步操作,所以统一写在这里,减少代码量
public void init() throws IOException {
//读取核心配置文件信息
InputStream is = Resources.getResourceAsStream("mybatis.xml");
//获取一个SqlSessionFactory 数据库会话工厂
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
session = sqlSessionFactory.openSession();
}
//@After这个注解会在@Tset注解运行之后执行,通常用于释放资源等
@After
public void destroy(){
session.close();
}
@Test
public void list01(){//查询所有
UserMapper mapper = session.getMapper(UserMapper.class);
List<User> list = mapper.list();
list.forEach(System.out::println);
}
@Test
public void save() {//增加
UserMapper mapper = session.getMapper(UserMapper.class);
int i = mapper.save(new User("hua", "123456"));
session.commit();
System.out.println(i);
}
@Test
public void delete() {//删除
UserMapper mapper = session.getMapper(UserMapper.class);
int i = mapper.delete(2);
System.out.println(i);
}
@Test
public void update() {//修改
UserMapper mapper = session.getMapper(UserMapper.class);
int i = mapper.update(new User(1, "sun", "123"));
session.commit();
System.out.println(i);
}
@Test
public void queryUserById() {//通过id查询用户
UserMapper mapper = session.getMapper(UserMapper.class);
User user1 = mapper.queryUserById(1);
User user2 = mapper.queryUserById(1);
System.out.println(user1);
System.out.println(user2);
}
}
四、mybatis配置文件和映射文件详解
(1)mybatis配置文件
先用一张图了解其各个标签的作用
- settings标签标签常用配置代码
<settings>
<!--设置日志输出-->
<setting name="logImpl" value="STDOUT_LOGGING"/>
<!-- 延迟加载 -->
<setting name="lazyLoadingEnabled" value="true"/>
<!-- 关联对象 按需加载 -->
<setting name="aggressiveLazyLoading" value="false"/>
</settings>
- Properties标签常用配置代码
<!--引用外部properties文件 -->
<properties resource="db.properties"></properties>
- typeAliases标签常用配置代码
<typeAliases>
<!-- 方式一,给单个类起别名 -->
<typeAlias type="com.its.bean.Book" alias="book"/>
<!-- 方式二,自动扫描包,默认为类名首字母小写,推荐使用 -->
<package name="com.its.pojo"/>
</typeAliases>
- environment标签常用配置代码
<!--设置环境信息-->
<environments default="mysql">
<environment id="mysql">
<!--事务管理-->
<transactionManager type="JDBC"/>
<!--连接池,连接数据库-->
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
- mapper标签常用配置代码
<mappers>
<!-- 方式一 使用路径引入 -目前推荐第一种 -->
<mapper resource="com/its/mapper/BookMapper.xml"/>
<!-- 方式二 使用包名引入(自动扫描接口,需要接口和映射文件绑定) -->
<package name="com.its.mapper"/>
<!-- 方式三 使用接口类引入 -->
<mapper class="com.its.BookDaoMapper"/>
<!-- 方式四 使用本地文件路径引入 -->
<mapper url="file:///d:BookMapper.xml" />
</mappers>
接下来查看一下完整的mybatis配置文件代码,如mybatis.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>
<!--引入外部文件 database.properties -->
<properties resource="database.properties"/>
<settings>
<!--控制台输出sql日志文件-->
<setting name="logImpl" value="STDOUT_LOGGING"/>
<!--手动开启一级缓存,默认情况也是开启状态-->
<setting name="localCacheScope" value="SESSION"/>
</settings>
<!--设置环境信息-->
<environments default="mysql">
<environment id="mysql">
<!--事务管理-->
<transactionManager type="JDBC"/>
<!--连接池,连接数据库-->
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
<!--映射文件的位置-->
<mappers>
<mapper resource="com/its/mapper/UserMapper.xml"/>
</mappers>
</configuration>
额外的database.properties文件配置代码如下
jdbc.driver = com.mysql.cj.jdbc.Driver
jdbc.url = jdbc:mysql:///demo_test
jdbc.username = root
jdbc.password = root
(2)mybatis映射文件
同样用一张图先查看一下各个标签的用法
接下来查看映射文件的全部代码格式,如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="要映射的接口,全类名">
<insert id="方法名" parameterType="参数类型,全类名">
<!--插入操作-->
</insert>
<update id="" parameterType="">
<!--修改操作-->
</update>
<delete id="delete" parameterType="">
<!--删除操作-->
</delete>
<select id="" resultType="返回的结果类型">
<!--查询操作-->
</select>
</mapper>