1. MyBatis简介
1.1 MyBatis简述
MyBatis是一个Java持久层框架,用于简化数据库交互的开发。它的核心思想是将SQL语句与Java代码分离,通过配置文件或注解来映射Java对象与数据库表之间的关系。MyBatis提供了简洁的API,使得开发人员可以更方便地进行数据库操作。
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 MyBatis下载
1.4 和其它持久化层技术对比
JDBC
- SQL 夹杂在Java代码中耦合度高,导致硬编码内伤
- 维护不易且实际开发需求中 SQL 有变化,频繁修改的情况多见
- 代码冗长,开发效率低
Hibernate 和 JPA
- 操作简便,开发效率高
- 程序中的长难复杂 SQL 需要绕过框架
- 内部自动生产的 SQL,不容易做特殊优化
- 基于全映射的全自动框架,大量字段的 POJO 进行部分映射时比较困难
- 反射操作太多,导致数据库性能下降
MyBatis
- 轻量级,性能出色
- SQL 和 Java 编码分开,功能边界清晰
- Java代码专注业务、SQL语句专注数据 开发效率稍逊于HIbernate,但是完全能够接受
2. 搭建MyBatis
2.1 开发环境
IDE:IDEA2023.2
构建工具:maven 3.5.4
MySQL版本:MySQL 5
MyBatis版本:MyBatis 3.5.7
MySQL不同版本的注意事项
1、驱动类driver-class-name
MySQL 5版本使用jdbc5驱动,驱动类使用:com.mysql.jdbc.Driver
MySQL 8版本使用jdbc8驱动,驱动类使用:com.mysql.cj.jdbc.Driver
2、连接地址url MySQL 5版本的url:
jdbc:mysql://localhost:3306/ssm
MySQL 8版本的url:
jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC
否则运行测试用例报告如下错误: java.sql.SQLException: The server time zone value 'Öйú±ê׼ʱ¼ä' is unrecognized or represents more
2.2 创建Maven工程
1. 新建工程如下:
<img src="https://gitee.com/Lowell_37/picgoImg/raw/master/202310161549997.png"/>
工程文件目录如下:
<img src="https://gitee.com/Lowell_37/picgoImg/raw/master/202310132047555.png"/>
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.49</version>
</dependency>
</dependencies>
2.3 创建MyBatis的核心配置文件
核心配置文件主要用于配置连接数据库的环境以及MyBatis的全局配置信息
核心配置文件存放的位置是src/main/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>
<!--设置连接数据库的环境-->
<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/ssm?
serverTimezone=UTC"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!--引入映射文件-->
<mappers>
<package name="mappers/UserMapper.xml"/>
</mappers>
</configuration>
2.4 创建mapper接口
MyBatis中的mapper接口相当于以前的dao。但是区别在于,mapper仅仅是接口,我们不需要 提供实现类。
如UserMapper
接口:
public interface UserMapper {
/**
* 添加用户信息
*/
int insertUser();
}
2.5创建Mybatis映射文件
相关概念:ORM(Object Relationship Mapping)对象关系映射
- 对象:Java的实体类对象
- 关系:关系型数据库
- 映射:二者之间的对应关系
1、映射文件的命名规则:
表所对应的实体类的类名+Mapper.xml
例如:表t_user,映射的实体类为User,所对应的映射文件为UserMapper.xml
因此一个映射文件对应一个实体类,对应一张表的操作
MyBatis映射文件用于编写SQL,访问以及操作表中的数据
MyBatis映射文件存放的位置是src/main/resources/mappers目录下
2、 MyBatis中可以面向接口操作数据,mapper接口和映射文件要保证两个一致:
mapper接口的全类名和映射文件的命名空间(namespace)保持一致
mapper接口中方法的方法名和映射文件中编写SQL的标签的id属性保持一致
如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">
<!-- 映射文件主要写的是SQL语句-->
<mapper namespace="com.lowell.mybatis.mapper.UserMapper"><!--类名和映射文件的命名空间保持一致-->
<!--int insertUser();-->
<insert id="insertUser"><!--方法名和映射文件中编写SQL的标签的id属性保持一致-->
insert into t_user values(null, 'admi', '123456', 23, '男', '[email protected]')
</insert>
</mapper>
2.6 使用junit测试功能
在test/java
目录中创建com.lowell.mybatis.test.MyBatisTest
类:
package com.lowell.mybatis.test;
import com.lowell.mybatis.mapper.UserMapper;
import com.lowell.mybatis.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;
public class MyBatisTest {
@Test
public void testInsert() throws IOException {
// 获取核心配置文件的输入流
InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
// 获取sqlSessionFactoryBuilder对象
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
// /通过核心配置文件所对应的字节输入流创建工厂类SqlSessionFactory,生产SqlSession对象
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
// 获取sql的会话对象sqlSession(不会自动提交事务),是MyBatis提供的操作数据库的对象
// SqlSession sqlSession = sqlSessionFactory.openSession();
// 获取sql的会话对象sqlSession(会自动提交事务),是MyBatis提供的操作数据库的对象
SqlSession sqlSession = sqlSessionFactory.openSession(true);
// 通过代理模式创建UserMapper接口的代理实现类对象
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
/* 调用UserMapper接口中的方法,就可以根据UserMapper的全类名匹配元素文件,通过调用的方法名匹配
映射文件中的SQL标签,并执行标签中的SQL语句,实现添加用户信息的功能 */
int result = mapper.insertUser();*/
System.out.println("result = " + result);
// 提交事务
sqlSession.commit();
// 关闭sqlSession
sqlSession.close();
}
}
结果如下:
- SqlSession:代表Java程序和数据库之间的会话。(HttpSession是Java程序和浏览器之间的 会话)
- SqlSessionFactory:是“生产”SqlSession的“工厂”。
- 工厂模式:如果创建某一个对象,使用的过程基本固定,那么我们就可以把创建这个对象的 相关代码封装到一个“工厂类”中,以后都使用这个工厂类来“生产”我们需要的对象。
2.7 加入log4j功能
1. 在pom.xml中引入依赖
<!-- log4j日志 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
2. 加入log4j配置文件
log4j的配置文件名为log4j.xml,存放的位置是src/main/resources目录下
日志的级别 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>
3.核心配置文件详解
MyBatis核心配置文件中的标签必须按照指定的顺序配properties?,settings?,typeAliases?,typeHandlers?,objectFactory?, objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?
<?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核心配置文件中的标签必须按照指定的顺序配置:
properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,
objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?
-->
<!-- 引入properties文件,此后就可以在当前文件中使用${key}的方式访问value-->
<properties resource="jdbc.properties"/>
<!--
typeAliases:设置类型别名,即为某一个具体的类型设置一个别名
在MyBatis的范围中,就可以使用该别名表示一个具体的类型
-->
<typeAliases>
<!--
type:设置需要起别名的类型
alias:设置某个类型的别名
-->
<!-- <typeAlias type="com.lowell.mybatis.pojo.User" alias="abc"></typeAlias>-->
<!--设置type而不设置alias时,默认别名为类名,不区分大小写-->
<!-- <typeAlias type="com.lowell.mybatis.pojo.User"></typeAlias>-->
<!--通过包来设置类型别名,指定包下所有的类型将全部拥有默认的别名,即类名-->
<package name="com.lowell.mybatis.pojo"/>
</typeAliases>
<!-- 配置连接数据库的环境-->
<environments default="development">
<!--
environment:设置一个具体的连接数据库的环境
属性:
id:设置环境的唯一标识,不能重复
-->
<environment id="development">
<!--
transactionManager:设置事务管理器
属性:
type:设置事务管理的方式
type= "JDBC | MANAGED"
JDBC:表示使用JDBC中最原生的事务管理方式
MANAGED:被管理,例如Spring
-->
<transactionManager type="JDBC"/>
<!--
dataSource:设置数据源
属性:
type:设置数据源的类型
type:"POOLED|UNPOOLED|JNDI"
POOLED:表示使用数据库连接池
UNPOOLED:表示不使用数据库连接池
JNDI:表示使用上下文中的数据源
-->
<!--
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/ssm?characterencoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="******"/>
</dataSource>
-->
<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>
<environment id="test">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/ssm?characterencoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="******"/>
</dataSource>
</environment>
</environments>
<!-- 引入mybatis的映射文件-->
<mappers>
<!-- <mapper resource="mappers/UserMapper.xml"/>-->
<!--
以包的方式引入映射文件,但必须满足两个条件
1、mapper接口和映射文件所在的包必须保持一致
2、mapper接口的名字和映射文件的名字必须一致
-->
<package name="com.lowell.mybatis.mapper"/>
</mappers>
</configuration>
4.MyBatis的增删改查
创建util.SqlSessionUtil
类:
package com.lowell.mybatis.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;
public class SqlSessionUtil {
public static SqlSession getsqlSession() {
SqlSession sqlSession = null;
try {
//获取核心配置文件的输入流
InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
//获取SqlSessionFactoryBuilder
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
//获取SqlSessionFactory
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
//获取SqlSession对象
sqlSession = sqlSessionFactory.openSession(true);
} catch (IOException e) {
e.printStackTrace();
}
return sqlSession;
}
}
4.1 新增
在UserMapper
接口中,新增函数:
/**
* 新增用户信息
*/
int insertUser();
在UserMapper.xml
文件中,新增属性:
<!--int insertUser();-->
<insert id="insertUser">
insert into t_user values(null, 'lowell', '123456', 20, '男', '[email protected]')
</insert>
在MyBatisTest
中,新增测试:
@Test
public void testInsert(){
SqlSession sqlSession = SqlSessionUtil.getsqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.insertUser();
sqlSession.close();
}
测试结果:
DEBUG 10-17 17:13:30,938 ==> Preparing: insert into t_user values(null, 'lowell', '123456', 20, '男', '[email protected]') (BaseJdbcLogger.java:137)
DEBUG 10-17 17:13:30,990 ==> Parameters: (BaseJdbcLogger.java:137)
DEBUG 10-17 17:13:30,999 <== Updates: 1 (BaseJdbcLogger.java:137)
4.2 删除
在UserMapper
接口中,新增函数:
/**
* 删除用户信息
*/
void deleteUser();
在UserMapper.xml
文件中,新增属性:
<!--void deleteUser();-->
<delete id="deleteUser">
delete from t_user where id = 3
</delete>
在MyBatisTest
中,新增测试:
@Test
public void testDelete(){
SqlSession sqlSession = SqlSessionUtil.getsqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.deleteUser();
sqlSession.close();
}
测试结果:
DEBUG 10-17 17:19:45,576 ==> Preparing: delete from t_user where id = 3 (BaseJdbcLogger.java:137)
DEBUG 10-17 17:19:45,642 ==> Parameters: (BaseJdbcLogger.java:137)
DEBUG 10-17 17:19:45,658 <== Updates: 1 (BaseJdbcLogger.java:137)
id=3的用户已经被删除:
<table ><tr> <td><img src="https://gitee.com/Lowell_37/picgoImg/raw/master/202310171720636.png" alt="image-20231017172017392" style="zoom: 33%;" align="left"/></td> <td><img src="https://gitee.com/Lowell_37/picgoImg/raw/master/202310171720487.png" alt="image-20231017172045304" style="zoom:33%;" align="right"/></td> </tr></table>
4.3 修改
在UserMapper
接口中,新增函数:
/**
* 修改用户信息
*/
void updateUser();
在UserMapper.xml
文件中,新增属性:
<!--void updateUser();-->
<update id="updateUser">
update t_user set username='Lida',password='123' where id = 2
</update>
在MyBatisTest
中,新增测试:
@Test
public void testUpdate(){
SqlSession sqlSession = SqlSessionUtil.getsqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.updateUser();
sqlSession.close();
}
测试结果:
DEBUG 10-17 17:29:02,650 ==> Preparing: update t_user set username='Lida',password='123' where id = 2 (BaseJdbcLogger.java:137)
DEBUG 10-17 17:29:02,743 ==> Parameters: (BaseJdbcLogger.java:137)
DEBUG 10-17 17:29:02,759 <== Updates: 1 (BaseJdbcLogger.java:137)
<table ><tr> <td><img src="https://gitee.com/Lowell_37/picgoImg/raw/master/202310171729531.png" alt="image-20231017172951346" style="zoom: 33%;" align="left"/></td> <td><img src="https://gitee.com/Lowell_37/picgoImg/raw/master/202310171730071.png" alt="image-20231017173032918" style="zoom:33%;" align="right"/></td> </tr></table>
4.4 查询一个实体类对象
在UserMapper
接口中,新增函数:
/**
* 根据id查询用户信息
*/
User getUserById();
在UserMapper.xml
文件中,新增属性:
<!--User getUserById();-->
<!--
resultType:设置结果类型,即查询的数据是要转换为的java类型
resultMap:自定义映射,处理多对一或者一对多的映射关系
-->
<select id="getUserById" resultType="com.lowell.mybatis.pojo.User">
select * from t_user where id = 1;
</select>
在MyBatisTest
中,新增测试:
@Test
public void testGetUserById() {
SqlSession sqlSession = SqlSessionUtil.getsqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User user = mapper.getUserById();
System.out.println("user = " + user);
}
测试结果:
DEBUG 10-17 17:34:59,232 ==> Preparing: select * from t_user where id = 1; (BaseJdbcLogger.java:137)
DEBUG 10-17 17:34:59,300 ==> Parameters: (BaseJdbcLogger.java:137)
DEBUG 10-17 17:34:59,353 <== Total: 1 (BaseJdbcLogger.java:137)
user = User{id=1, username='admin', password='123456', age=23, gender='男', email='[email protected]'}
4.5 查询list集合
在UserMapper
接口中,新增函数:
/**
* 查询所有用户
* @return
*/
List<User> getAllUser();
在UserMapper.xml
文件中,新增属性:
<!--List<User> getAllUser();-->
<select id="getAllUser" resultType="User">
select * from t_user;
</select>
在MyBatisTest
中,新增测试:
@Test
public void testGetAllUser() {
SqlSession sqlSession = SqlSessionUtil.getsqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
List<User> userList = mapper.getAllUser();
// 将获取的list集合迭代输出
userList.forEach(System.out::println);
}
测试结果:
DEBUG 10-17 18:46:36,885 ==> Preparing: select * from t_user; (BaseJdbcLogger.java:137)
DEBUG 10-17 18:46:36,911 ==> Parameters: (BaseJdbcLogger.java:137)
DEBUG 10-17 18:46:36,932 <== Total: 9 (BaseJdbcLogger.java:137)
User{id=1, username='admin', password='123456', age=23, gender='男', email='[email protected]'}
User{id=2, username='Lida', password='123', age=33, gender='女', email='[email protected]'}
User{id=4, username='lowell', password='123456', age=null, gender='', email=''}
User{id=11, username='Frank', password='null', age=null, gender='null', email='null'}
User{id=12, username='xiaoming', password='123456', age=21, gender='男', email='[email protected]'}
User{id=13, username='admi', password='123456', age=23, gender='男', email='[email protected]'}
User{id=14, username='admi', password='123456', age=23, gender='男', email='[email protected]'}
User{id=15, username='admi', password='123456', age=23, gender='男', email='[email protected]'}
User{id=16, username='lowell', password='123456', age=20, gender='男', email='[email protected]'}
标签:mapper,17,映射,UserMapper,sqlSession,MyBatis From: https://blog.51cto.com/LowellHere/8727875注意:
1、查询的标签select必须设置属性resultType或resultMap,用于设置实体类和数据库表的映射关系
resultType:自动映射,用于属性名和表中字段名一致的情况
resultMap:自定义映射,用于一对多或多对一或字段名和属性名不一致的情况