MyBatis学习笔记–持续上传更新
前言
本次学习笔记基于尚硅谷在B站推出的MyBatis课程进行学习记录,在此感谢尚硅谷官方“让天下没有难学的技术”。感谢!
- 视频学习地址:https://www.bilibili.com/video/BV1VP4y1c7j7
- 学习思维导图:
一、Mybatis简介
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)。
- SQL Maps:SQL Map提供了一个简洁的框架,使用简单的XML描述文件将Java Bean,Map实现和基本数据类型的包装类(String,Integer等)映射成JDBC的PreparedStatement。
- Data Access Objects(DAO,数据访问对象):DAO对象包括数据引擎功能,通过数据引擎功能,它可以访问结构化查询语言(SQL)数据库。
2、MyBatis特性
- MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架
- MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集
- MyBatis 可以使用简单的XML或注解用于配置和原始映射,将接口和Java的POJO(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录
- MyBatis 是一个 半自动的ORM(Object Relation Mapping)框架
3、MyBatis下载
- MyBatis下载地址:https://github.com/mybatis/mybatis-3
- MyBatis中文文档:https://mybatis.org/mybatis-3/zh/index.html
4、MyBatis和其它持久化层技术对比
- JDBC
- SQL 夹杂在Java代码中耦合度高,导致硬编码内伤
- 维护不易且实际开发需求中 SQL 有变化,频繁修改的情况多见
- 代码冗长,开发效率低
- Hibernate 和 JPA
- 操作简便,开发效率高
- 程序中的长难复杂 SQL 需要绕过框架
- 内部自动生产的 SQL,不容易做特殊优化
- 基于全映射的全自动框架,大量字段的 POJO 进行部分映射时比较困难。
- 反射操作太多,导致数据库性能下降
- MyBatis
- 轻量级,性能出色
- SQL 和 Java 编码分开,功能边界清晰。Java代码专注业务、SQL语句专注数据
- 开发效率稍逊于HIbernate,但是完全能够接受
二、MyBatis框架搭建及实现CRUD
开发环境
- IDE:idea 2020.3
- 构建工具:maven 3.6.3
- MySQL版本:MySQL 5.7
- MyBatis版本:MyBatis 3.5.7
创建maven工程
来吧,展示!
1. 引入依赖
1.定义打包方式:jar。
2.引入对应依赖:Mybatis核心,junit测试,MySQL驱动,log4j日志。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.atguigu.mybatis</groupId>
<artifactId>MyBatis_demo1</artifactId>
<version>1.0-SNAPSHOT</version>
<!--打包方式为jar-->
<packaging>jar</packaging>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<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>
<!-- log4j日志 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
</dependencies>
</project>
2. 创建核心配置文件
核心配置文件:
- 主要用于配置连接数据库的环境以及MyBatis的全局配置信息
- 核心配置文件存放的位置是
src/main/resources
目录下
(习惯上命名为mybatis-config.xml,这个文件名仅仅只是建议,并非强制要求。将来整合Spring之后,这个配置文件可以省略,所以大家操作时可以直接复制、粘贴。)
<?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.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/数据库名"/>
<property name="username" value="root"/>
<property name="password" value="密码"/>
</dataSource>
</environment>
</environments>
<!--引入映射文件-->
<mappers>
<mapper resource="mappers/UserMapper.xml"/>
</mappers>
</configuration>
3. 创建表及实体类
3.1 创建数据库&表
1)创建数据库:mybatis
2)创建数据表:t_user
3.2 创建实体类
根据表字段从而创建相应属性,并通过idea快捷键Alt+Insert
快速生成无参/有参构造方法、get/set方法、toString方法等。
package com.min.mybatis.pojo;
/**
* 用户类
*/
public class User {
private Integer id;
private String username;
private String password;
private Integer age;
private String sex;
private String email;
public User(Integer id, String username, String password, Integer age, String sex, String email) {
this.id = id;
this.username = username;
this.password = password;
this.age = age;
this.sex = sex;
this.email = email;
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", username='" + username + '\'' +
", password='" + password + '\'' +
", age=" + age +
", sex='" + sex + '\'' +
", email='" + email + '\'' +
'}';
}
}
4. 导入日志文件
- 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>
5. 编写mapper接口
MyBatis中的mapper接口相当于以前的dao。但是区别在于,mapper仅仅是接口,我们不需要提供实现类。
package com.min.mybatis.mapper;
import com.min.mybatis.pojo.User;
import java.util.List;
/**
* 用户mapper接口
*/
public interface UserMapper {
/**
* MyBatis面向接口编程要保证两个一致:
*
* 1. mapper接口的全类名 和 映射文件的命名空间(namespace)保持一致
* 2. mapper接口中方法的方法名 和 映射文件中编写SQL的标签的id属性保持一致
*
* 表--实体类--mapper接口--映射文件
*/
//说明:增删改都是返回数量,可以用int接收,不需查看返回值用void
/**
* 添加用户信息
*/
int insertUser();
/**
* 修改用户信息
*/
void updateUser();
/**
* 删除用户信息
*/
void deleteUser();
/**
* 根据id查询用户信息
*/
User getUserById();
/**
* 查询所有的用户信息
*/
List<User> getAllUser();
}
6. 编写映射文件
MyBatis中可以面向接口操作数据,要保证两个一致:
- mapper接口的全类名和映射文件的命名空间(namespace)保持一致
- mapper接口中方法的方法名和映射文件中编写SQL的标签的id属性保持一致
<?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.min.mybatis.mapper.UserMapper">
<!--int insertUser();-->
<insert id="insertUser">
insert into t_user
values (null, 'admin', '123456', 23, '男', '12345@qq.com')
</insert>
<!--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>
<!--User getUserById();-->
<!--
查询功能的标签必须设置resultType或resultMap
resultType:设置默认的映射关系
resultMap:设置自定义的映射关系
-->
<select id="getUserById" resultType="com.min.mybatis.pojo.User">
select * from t_user where id = 1
</select>
<!--List<User> getAllUser();-->
<select id="getAllUser" resultType="com.min.mybatis.pojo.User">
select * from t_user
</select>
</mapper>
7. 编写测试类
注意:SqlSession默认不自动提交事务,若需要自动提交事务,则在获取sqlSession对象时,使用SqlSession sqlSession = sqlSessionFactory.openSession(true);
,传入一个Boolean类型的参数,值为true,这样就可以自动提交。
package com.min.mybatis.test;
import com.min.mybatis.mapper.UserMapper;
import com.min.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;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
public class UserMapperTest {
@Test
public void testInsertUser() throws IOException {
//1、加载核心配置文件
/**注意事项:
* 1)Resources是org.apache.ibatis.io包下的
* 2)getResourceAsStream是以字符流方式获取核心配置文件信息的
*/
InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
//2、获取SqlSessionFactoryBuilder对象
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
//3、获取SqlSessionFactory
/**
* 通过核心配置文件所对应的字节输入流创建工厂类SqlSessionFactory,生产SqlSession对象
*/
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
//4、获取sqlSession对象
/**(1)此时通过SqlSession对象所操作的sql都必须手动提交或回滚事务*/
//SqlSession sqlSession = sqlSessionFactory.openSession();
/**(2)此时通过SqlSession对象所操作的sql都会自动提交*/
SqlSession sqlSession = sqlSessionFactory.openSession(true);
//5、获取mapper接口对象
/**
* 底层通过【代理模式】创建UserMapper接口的代理实现类对象
*/
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
//6、测试功能
/**
* 调用UserMapper接口中的方法,就可以根据UserMapper的全类名匹配元素文件,
* 通过调用的方法名匹配映射文件中的SQL标签,并执行标签中的SQL语句
*/
int result = userMapper.insertUser();
/**
* 手动提交事务
* 当在第4步获取sqlSession对象时,设置sqlSessionFactory.openSession(true);就是自动提交事务
*/
//sqlSession.commit();
System.out.println("result:" + result);
}
@Test
public void testUpdateUser() throws IOException {
//1、加载核心配置文件
InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
//2、获取SqlSessionFactoryBuilder对象
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
//3、获取SqlSessionFactory
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
//4、获取sqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession(true);
//5、获取mapper接口对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
//6、测试功能
userMapper.updateUser();
}
@Test
public void testDeleteUser() throws IOException {
//1、加载核心配置文件
InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
//2、获取SqlSessionFactoryBuilder对象
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
//3、获取SqlSessionFactory
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
//4、获取sqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession(true);
//5、获取mapper接口对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
//6、测试功能
userMapper.deleteUser();
}
@Test
public void testGetUserById() throws IOException {
//1、加载核心配置文件
InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
//2、获取SqlSessionFactoryBuilder对象
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
//3、获取SqlSessionFactory
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
//4、获取sqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession(true);
//5、获取mapper接口对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
//6、测试功能
User user = userMapper.getUserById();
System.out.println(user);
}
@Test
public void testGetAllUser() throws IOException {
//1、加载核心配置文件
InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
//2、获取SqlSessionFactoryBuilder对象
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
//3、获取SqlSessionFactory
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
//4、获取sqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession(true);
//5、获取mapper接口对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
//6、测试功能
List<User> list = userMapper.getAllUser();
list.forEach(user -> System.out.println(user));
}
}
三、核心配置文件详解
1、核心配置文件标签
核心配置文件(mybatis-config.xml
)中的标签必须按照固定的顺序:
properties、settings、typeAliases、typeHandlers、objectFactory、objectWrapperFactory、reflectorFactory、plugins、environments、databaseIdProvider、mappers
2、核心配置文件案例
<?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>
<!--引入properties文件,此时就可以${属性名}的方式访问属性值-->
<properties resource="jdbc.properties"></properties>
<settings>
<!--将表中字段的下划线自动转换为驼峰-->
<setting name="mapUnderscoreToCamelCase" value="true"/>
<!--开启延迟加载-->
<setting name="lazyLoadingEnabled" value="true"/>
</settings>
<typeAliases>
<!--
typeAlias:设置某个具体的类型的别名
属性:
type:需要设置别名的类型的全类名
alias:设置此类型的别名,且别名不区分大小写。若不设置此属性,该类型拥有默认的别名,即类名
-->
<!--<typeAlias type="com.atguigu.mybatis.bean.User"></typeAlias>-->
<!--<typeAlias type="com.atguigu.mybatis.bean.User" alias="user"></typeAlias>-->
<!--以包为单位,将包下所有的类型设置默认的类型别名,即类名且不区分大小写-->
<package name="com.atguigu.mybatis.bean"/>
</typeAliases>
<!--
environments:设置多个连接数据库的环境
属性:
default:设置默认使用的环境的id
-->
<environments default="mysql_test">
<!--
environment:设置具体的连接数据库的环境信息
属性:
id:设置环境的唯一标识,可通过environments标签中的default设置某一个环境的id,表示默认使用的环境
-->
<environment id="mysql_test">
<!--
transactionManager:设置事务管理方式
属性:
type:设置事务管理方式,type="JDBC|MANAGED"
type="JDBC":设置当前环境的事务的提交或回滚的管理都必须手动处理
type="MANAGED":设置事务被管理,例如spring中的AOP
-->
<transactionManager type="JDBC"/>
<!--
dataSource:设置数据源
属性:
type:设置数据源的类型,type="POOLED|UNPOOLED|JNDI"
type="POOLED":表示使用数据库连接池缓存数据库连接,即会将创建的连接进行缓存,下次使用可以从缓存中直接获取,不需要重新创建
type="UNPOOLED":表示不使用数据库连接池,即每次使用连接都需要重新创建
type="JNDI":表示调用上下文中的数据源
-->
<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="UserMapper.xml"/> -->
<!--
以包为单位,将包下所有的映射文件引入核心配置文件
注意:
1. 此方式必须保证mapper接口和mapper映射文件必须在相同的包下
2. mapper接口要和mapper映射文件的名字一致
-->
<package name="com.atguigu.mybatis.mapper"/>
</mappers>
</configuration>
四、MyBatis获取参数值的两种方式(重点)
MyBatis获取参数值的两种方式:${}
和 #{}
- ${}的本质就是:字符串拼接
- ${}使用字符串拼接的方式拼接sql,若为字符串类型或日期类型的字段进行赋值时,需要手动加单引号
- #{}的本质就是:占位符赋值
- #{}使用占位符赋值的方式拼接sql,此时为字符串类型或日期类型的字段进行赋值时,可以自动添加单引号
1、单个字面量类型的参数
若mapper接口中的方法参数为单个的字面量类型,此时可以使用${}和#{}以任意的名称(最好见名识意)获取参数的值,注意使用${}时需要手动加单引号。
1)使用#{}
占位符赋值
<!--User getUserByUsername(String username);-->
<select id="getUserByUsername" resultType="User">
select * from t_user where username = #{username}
</select>
2)使用${}
字符串拼接
<!--User getUserByUsername(String username);-->
<select id="getUserByUsername" resultType="User">
select * from t_user where username = '${username}'
</select>
2、多个字面量类型的参数
若mapper接口中的方法参数为多个时,此时MyBatis会自动将这些参数放在一个map集合中,有两种键值对情况:
- 以arg0,arg1… …为键,以参数为值
- 以param1,param2… …为键,以参数为值
- 因此只需要通过${}或#{}访问map集合提供的键就可以获取相对应的值(注意${}需要手动加单引号)
- 其中map提供的键,使用arg或者param都行,要注意的是:arg是从arg0开始的,param是从param1开始的
<!--User checkLogin(String username,String password);-->
<select id="checkLogin" resultType="User">
select * from t_user where username = #{param1} and password = #{param2}
</select>
select * from t_user where username = #{arg0} and password = #{arg1}
select * from t_user where username = '${param1}' and password = '${param2}'
3、map集合类型的参数
若mapper接口中的方法需要的参数为多个时,此时可以手动创建map集合,将这些数据放在map中只需要通过${}和#{}访问map集合的键就可以获取相对应的值(注意${}需要手动加单引号)
<!--User checkLoginByMap(Map<String,Object> map);-->
<select id="checkLoginByMap" resultType="User">
select * from t_user where username = #{username} and password = #{password}
</select>
@Test
public void checkLoginByMap() {
SqlSession sqlSession = SqlSessionUtils.getSqlSession();
ParameterMapper mapper = sqlSession.getMapper(ParameterMapper.class);
//手动创建map集合
Map<String,Object> map = new HashMap<>();
map.put("usermane","admin");
map.put("password","123456");
User user = mapper.checkLoginByMap(map);
System.out.println(user);
}
4、实体类类型的参数
若mapper接口中的方法参数为实体类对象时,此时可以使用${}和#{}(注意${}需要手动加单引号),通过访问实体类对象中的属性名获取属性值,其实是因为实体类中成员变量的get/set方法就可以用这样的方式以属性名参数获取值。
<!--int insertUser(User user);-->
<insert id="insertUser">
insert into t_user values(null,#{username},#{password},#{age},#{sex},#{email})
</insert>
@Test
public void insertUser() {
SqlSession sqlSession = SqlSessionUtils.getSqlSession();
ParameterMapper mapper = sqlSession.getMapper(ParameterMapper.class);
User user = new User(null,"Tom","123456",12,"男","123@321.com");
mapper.insertUser(user);
}
5、使用@Param
标识参数
@param注解源码解析:https://www.bilibili.com/video/BV1VP4y1c7j7?p=29
可以通过@Param注解标识mapper接口中的方法参数,此时,会将这些参数放在map集合中:
- 以@Param注解的value属性值为键,以参数为值
- 以param1,param2… …为键,以参数为值
- 只需要通过${}和#{}访问map集合的键就可以获取相对应的值(注意${}需要手动加单引号)
//验证登录(使用@Param)
User checkLoginByParam(@Param("username") String username,@Param("password") String password)
<!--User CheckLoginByParam(@Param("username") String username, @Param("password") String password);-->
<select id="CheckLoginByParam" resultType="User">
select * from t_user where username = #{username} and password = #{password}
</select>
@Test
public void checkLoginByParam() {
SqlSession sqlSession = SqlSessionUtils.getSqlSession();
ParameterMapper mapper = sqlSession.getMapper(ParameterMapper.class);
mapper.CheckLoginByParam("admin","123456");
}
6、总结
建议分成两种情况进行处理
- 实体类类型的参数
- 使用@Param标识参数