目录
1、MyBatis 简介
1.1、MyBatis历史
-
MyBatis最初是Apache的一个开源项目iBatis, 2010年6月这个项目由Apache Software Foundation迁移到了Google Code。随着开发团队转投Google Code旗下,iBatis3.x正式更名为MyBatis。代码于2013年11月迁移到Github
-
iBatis一词来源于“internet”和“abatis”的组合,是一个基于Java的持久层框架。iBatis提供的持久层框架包括SQL Maps和Data Access Objects(DAO)
1.2、MyBatis特性
-
MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架
-
MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集
-
MyBatis可以使用简单的XML或注解用于配置和原始映射,将接口和Java的POJO(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录
-
MyBatis 是一个 半自动的ORM(Object Relation Mapping)框架
1.3、和其它持久化层技术对比
-
JDBC
-
SQL 夹杂在Java代码中耦合度高,导致硬编码内伤
-
维护不易且实际开发需求中 SQL 有变化,频繁修改的情况多见
-
代码冗长,开发效率低
-
-
Hibernate 和 JPA
-
操作简便,开发效率高
-
程序中的长难复杂 SQL 需要绕过框架
-
内部自动生产的 SQL,不容易做特殊优化
-
基于全映射的全自动框架,大量字段的 POJO 进行部分映射时比较困难。
-
反射操作太多,导致数据库性能下降
-
-
MyBatis
-
轻量级,性能出色
-
SQL 和 Java 编码分开,功能边界清晰。Java代码专注业务、SQL语句专注数据
-
开发效率稍逊于HIbernate,但是完全能够接受
-
2、MyBatis 的下载
下载地址:GitHub - mybatis/mybatis-3: MyBatis SQL mapper framework for Java
打开上面的下载地址,往下找 Download Latest 超链接并打开
若要下载旧版本可以在下面的历史版本中点击大标题跳转到相应下载地址
在打开的页面中下载源码
3、搭建 MyBatis
3.1、开发环境
-
IDE:idea 2021.2.1
-
构建工具:maven 3.6.3
-
MySQL版本:MySQL 5.7
-
MyBatis版本:MyBatis 3.5.7
3.2、创建 maven 工程
3.2.1、打包方式:jar
<packaging>jar</packaging>
3.2.2、引入依赖
<dependencies>
<!-- Mybatis核心 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.7</version>
</dependency>
<!-- junit测试 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<!-- MySQL驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.3</version>
</dependency>
</dependencies>
3.3、创建MyBatis的核心配置文件
习惯上命名为 mybatis-config.xml,这个文件名仅仅只是建议,并非强制要求。将来整合Spring之后,这个配置文件可以省略,所以大家操作时可以直接复制、粘贴。
核心配置文件主要用于配置连接数据库的环境以及MyBatis的全局配置信息
核心配置文件存放的位置是 src/main/resources目录下
核心配置文件的内容可以从mybatis的官方文档中的 Getting Started 获得
核心配置文件的详解见之后的笔记
<?xml version="1.0" encoding="UTF-8" ?>
<!-- MyBatis配置文件中的约束 -->
<!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.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
<property name="username" value="root"/>
<property name="password" value="zyj123"/>
</dataSource>
</environment>
</environments>
<!-- 引入映射文件 -->
<mappers>
<mapper resource="org/mybatis/example/BlogMapper.xml"/>
</mappers>
</configuration>
3.4、创建数据表、实体类及 mapper 接口
MyBatis中的 mapper 接口相当于以前的 dao。但是区别在于,mapper 仅仅是接口,我们不需要提供实现类
① 在创建 mapper 接口之前,我们需要先创建数据表
② 创建含有一下属性的 User 类,并写出其无参构造、有参构造、set 和 get 方法、toString 方法③ 创建 mapper 接口
public interface UserMapper {
/**
* 添加用户信息
*/
int insertUser();
}
3.5、创建 mybatis 的映射文件
相关概念:ORM(Object Relationship Mapping)对象关系映射。
-
对象:Java的实体类对象
-
关系:关系型数据库
-
映射:二者之间的对应关系
Java概念 | 数据库概念 |
类 | 表 |
属性 | 字段 / 列 |
对象 | 记录 / 行 |
1、映射文件的命名规则
表所对应的实体类的类名+Mapper.xml
例如:表t_user,映射的实体类为User,所对应的映射文件为UserMapper.xml
因此一个映射文件对应一个实体类,对应一张表的操作
MyBatis映射文件用于编写SQL,访问以及操作表中的数据
MyBatis映射文件存放的位置是 src/main/resources/mappers 目录下
2、MyBatis中可以面向接口操作数据,要保证两个一致
mapper接口的全类名和映射文件的命名空间(namespace)保持一致
mapper接口中方法的方法名和映射文件中编写SQL的标签的id属性保持一致
3、映射文件的内容同样可以从官方文档的 Getting Started 中获得(第四页)
<?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">
<!--
MyBatis面向接口编程的两个一致:
1、映射文件的namespace要和mapper接口的全类名保持一致
2、映射文件中SQL语句的id值要和mapper接口的方法名一致
-->
<mapper namespace="com.zyj.mybatis.mapper.UserMapper">
<!-- int insertUser() -->
<insert id="insertUser">
insert into t_user values(null,'admin','123456',23,'男','123456@qq.com')
</insert>
</mapper>
然后修改 mybatis-config.xml 中引入映射文件的路径
<!-- 引入映射文件 -->
<mappers>
<mapper resource="mappers/UserMapper.xml"/>
</mappers>
3.6、通过 junit 测试功能
-
SqlSession:代表Java程序和数据库之间的会话。(HttpSession是Java程序和浏览器之间的会话)
-
SqlSessionFactory:是“生产”SqlSession的“工厂”
-
工厂模式:如果创建某一个对象,使用的过程基本固定,那么我们就可以把创建这个对象的相关代码封装到一个“工厂类”中,以后都使用这个工厂类来“生产”我们需要的对象
3.6.1、手动提交事务
@Test
public void testMybatis() throws IOException {
// 加载核心配置文件,注意Resources的全类名是org.apache.ibatis.io.Resources
InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
// 获取SqlSessionFactoryBuilder对象
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
// 通过核心配置文件所对应的字节输入流创建工厂类SqlSessionFactory,生产SqlSession对象
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
// 获取sqlSession,此时通过SqlSession对象所操作的sql都必须手动提交或回滚事务
SqlSession sqlSession = sqlSessionFactory.openSession();
// 通过代理模式创建UserMapper接口的代理实现类对象
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
// 调用UserMapper接口中的方法,就可以根据UserMapper的全类名匹配元素文件,通过调用的方法名匹配映射文件中的SQL标签,并执行标签中的SQL语句
int result = mapper.insertUser();
// 提交事务
sqlSession.commit();
System.out.println("result = " + result);
}
3.6.2、优化一:自动提交事务
@Test
public void testMybatis() throws IOException {
// 加载核心配置文件,注意Resources的全类名是org.apache.ibatis.io.Resources
InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
// 获取SqlSessionFactoryBuilder对象
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
// 通过核心配置文件所对应的字节输入流创建工厂类SqlSessionFactory,生产SqlSession对象
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
// 获取sqlSession,此时通过SqlSession对象所操作的sql都必须手动提交或回滚事务(即默认不自动提交事务)
// openSession()方法有一个参数autoCommit可以设置自动提交参数,若不写则需要手动提交
//SqlSession sqlSession = sqlSessionFactory.openSession();
SqlSession sqlSession = sqlSessionFactory.openSession(true);
// 通过代理模式创建UserMapper接口的代理实现类对象
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
// 调用UserMapper接口中的方法,就可以根据UserMapper的全类名匹配元素文件,通过调用的方法名匹配映射文件中的SQL标签,并执行标签中的SQL语句
int result = mapper.insertUser();
// 提交事务
//sqlSession.commit();
System.out.println("result = " + result);
}
3.7、加入 log4j 日志功能
3.7.1、加入依赖
在 pom.xml 中加入依赖
<!-- log4j日志 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
3.7.2、加入 log4j 的配置文件
位置:src/main/resources/log4j.xml
日志的级别:FATAL(致命)>ERROR(错误)>WARN(警告)>INFO(信息)>DEBUG(调试)
从左到右打印的内容越来越详细
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
<param name="Encoding" value="UTF-8" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%-5p %d{MM-dd HH:mm:ss,SSS} %m (%F:%L) \n" />
</layout>
</appender>
<logger name="java.sql">
<level value="debug" />
</logger>
<logger name="org.apache.ibatis">
<level value="info" />
</logger>
<root>
<level value="debug" />
<appender-ref ref="STDOUT" />
</root>
</log4j:configuration>
注:提示 URI未注册 可以不用管
运行上面的 junit 测试,控制台打印如下
DEBUG 03-12 15:50:40,838 ==> Preparing: insert into t_user values(null, 'admin', '123456', 23, '男', '123456@qq.com') (BaseJdbcLogger.java:137)
DEBUG 03-12 15:50:40,878 ==> Parameters: (BaseJdbcLogger.java:137)
DEBUG 03-12 15:50:40,881 <== Updates: 1 (BaseJdbcLogger.java:137)
result = 1
3.8、添加修改、删除功能
先写 mapper 接口中的方法,在根据方法去对应的映射文件写 SQL 语句
① 在 mapper 接口中添加方法
/**
* 修改用户信息
*/
void updateUser();
/**
* 删除用户信息
*/
void deleteUser();
② 在 UserMapper.xml 中添加 sql 语句
<!-- void updateUser(); -->
<update id="updateUser">
update t_user set username = '张三' where id = 2
</update>
<!-- void deleteUser(); -->
<delete id="deleteUser">
delete from t_user where id = 3
</delete>
③ 在测试类中进行测试
/**
* 测试修改和删除功能
* @throws IOException
*/
@Test
public void testUpdateAndDelete() throws IOException {
InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
SqlSession sqlSession = sqlSessionFactory.openSession(true);
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.updateUser();
mapper.deleteUser();
}
3.9、添加查询功能
① 在 UserMapper 接口添加方法
/**
* 根据id查询用户信息
*/
User getUserById();
/**
* 查询所有的用户信息
*/
List<User> getAllUser();
② 在 UserMapper.xml 添加 sql 语句
<!--
查询功能的标签必须设置resultType或resultMap
resultType:设置默认的映射关系
resultMap:设置自定义的映射关系(字段名跟属性名不一样、多对一、一对多的情况下)
-->
<!-- User getUserById(); -->
<select id="getUserById" resultType="com.zyj.mybatis.pojo.User">
select * from t_user where id = 2
</select>
<!-- List<User> getAllUser(); -->
<select id="getAllUser" resultType="com.zyj.mybatis.pojo.User">
select * from t_user
</select>
③ 在测试类中进行测试
/**
* 测试查询能
* @throws IOException
*/
@Test
public void testQuery() throws IOException {
InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
SqlSession sqlSession = sqlSessionFactory.openSession(true);
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User userById = mapper.getUserById();
System.out.println(userById);
List<User> allUser = mapper.getAllUser();
allUser.forEach(user -> System.out.println(user));
}