自学: https://mybatis.net.cn/(Mybatis中文官网)
环境
- jdk 1.8
- mysql 8.0
- maven 3.8.3
准备数据
CREATE DATABASE `mybatis`;
USE `mybatis`;
CREATE TABLE `user`(
`id` INT(20) NOT NULL PRIMARY KEY,
`name` VARCHAR(30) DEFAULT NULL,
`pwd` VARCHAR(30) DEFAULT NULL
)ENGINE=INNODB DEFAULT CHARSET=utf8;
INSERT INTO `user`(`id`,`name`,`pwd`)VALUES
(1,'张三','123111'),
(2,'李四','123222'),
(3,'王五','123333');
获得Mybatis
- 打开maven仓库:https://mvnrepository.com/
- 搜索 Mybatis 找到用的人数最多的 复制
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.9</version>
</dependency>
Mybatis程序
-
新建普通maven项目 (当作父工程)
-
删除src目录
-
导入maven依赖
<dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.28</version> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.5.9</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> </dependency> </dependencies>
-
新建普通maven项目(当作子工程)
-
在父工程,右键创建一个maven子工程,默认依赖父工程
-
参考官网 编写mybatisd的核心配置文件 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://127.0.0.1:3306/mybatis?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/Mybatis/dao/UserMapper.xml"/>
</mappers>
</configuration>
- 编写mybatis工具类
package com.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 MybatisUtils {
private static SqlSessionFactory sqlSessionFactory;
static {
try {
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
public static SqlSession getSqlSession() {
return sqlSessionFactory.openSession();
}
}
- 编写实体类
package com.Mybatis.pojo;
public class User {
private int id;
private String name;
private String pwd;
public int getId() {
return id;
}
public String getName() {
return name;
}
public String getPwd() {
return pwd;
}
public void setId(int id) {
this.id = id;
}
public void setName(String name) {
this.name = name;
}
public void setPwd(String pwd) {
this.pwd = pwd;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", pwd='" + pwd + '\'' +
'}';
}
}
- Dao接口
package com.Mybatis.dao;
import com.Mybatis.pojo.User;
import java.util.List;
public interface UserMapper {
List<User> getUserList();
}
- Mapper.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="com.Mybatis.dao.UserMapper">
<select id="getUserList" resultType="com.Mybatis.pojo.User">
select * from user
</select>
</mapper>
- 测试类 运行
package com.Mybatis.dao;
import com.Mybatis.pojo.User;
import com.Mybatis.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import java.util.List;
public class UserMapperTest {
@Test
public void test() {
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
List<User> userList = mapper.getUserList();
for (User user : userList) {
System.out.println(user);
}
sqlSession.close();
}
}
### Error building SqlSession.
Caused by: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration.
Caused by: java.io.IOException: Could not find resource com/Mybatis/dao/UserMapper.xml
解决办法
- maven由于他的约定大于配置,遇到配置不生效问题,解决方案如下
- 在父工程的 pom.xml 添加
<build>
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</build>
结果
User {id=1, name=‘张三’, pwd=‘123111’}
User {id=2, name=‘李四’, pwd=‘123222’}
User {id=3, name=‘王五’, pwd=‘123333’}
配置
-
configuration(配置)
-
properties(属性)
-
settings(设置)
-
typeAliases(类型别名)
-
typeHandlers(类型处理器)
-
objectFactory(对象工厂)
-
plugins(插件)
-
environments(环境配置)
- environment(环境变量)
- transactionManager(事务管理器)
- dataSource(数据源)
- environment(环境变量)
-
databaseIdProvider(数据库厂商标识)
-
mappers(映射器)
-
环境配置(environments)
<?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"> default="环境名" 可以切换多个环境
<environment id="development"> 环境名
<transactionManager type="JDBC"/> 事务管理器 type="[JDBC|MANAGED]"
<dataSource type="POOLED"> 数据源 有三种 type="[UNPOOLED|POOLED|JNDI]"
<property name="driver" value="com.mysql.cj.jdbc.Driver"/> 属性
<property name="url" value="jdbc:mysql://127.0.0.1:3306/mybatis?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<mappers> 映射器
<mapper resource="org/mybatis/builder/AuthorMapper.xml"/> 使用相对于类路径的资源引用
<mapper url="file:///var/mappers/AuthorMapper.xml"/> 使用相对于类路径的资源引用
<mapper class="org.mybatis.builder.AuthorMapper"/> 使用映射器接口实现类的完全限定类名
<mapper class="org.mybatis.builder.AuthorMapper"/> 将包内的映射器接口实现全部注册为映射器
</mappers>
</configuration>
属性(properties)
- 新建配置文件 config.properties
driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://127.0.0.1:3306/mybatis?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true
username=root
password=root
- 在mybatis-config.xml核心配置文件中引入 properties标签 (配置到第一行)
- 在配置文件与核心配置文件
数据重复且不一致
时优先使用核心配置文件
<properties resource="config.properties"/>
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
否则报错
Caused by: org.xml.sax.SAXParseException; lineNumber: 34; columnNumber: 17; 元素类型为 "configuration" 的内容必须匹配 "(properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?)"。
别名
方式一
- 在mybatis-config.xml核心配置文件引入(配置到第三行,否则报错)
<typeAliases>
<typeAlias alias="User" type="com.Mybatis.pojo.User"/>
</typeAliases>
- 在Mapper.xml映射文件 修改resultType
修改前:resultType="com.Mybatis.pojo.User"
修改后:resultType="User"
方式二
也可以指定一个包名,MyBatis 会在包名下面搜索需要的 Java Bean
<typeAliases>
<package name="com.Mybatis.pojo"/>
</typeAliases>
建议用小user
大写User也不会报错
- 修改前:resultType=“com.Mybatis.pojo.User”
- 修改后:resultType=“user”
也可以自定义别名(一般小写),在实体类加注解 @Alias
@Alias("user")
public class Author {
...
}
设置
cacheEnabled 缓存 默认 true
lazyLoadingEnabled 懒加载 默认 false
mapUnderscoreToCamelCase 驼峰映射 默认 false
useGeneratedKeys 自动生成主键 默认 false
logImpl 打印日志 默认 未设置
......
其他配置
- 类型处理器(typeHandlers)
- 对象工厂(objectFactory)
- 插件(plugins)
- MyBatis Generator Core 代码生成器(生成后需要修改检查)
- MyBatis Plus 增加了一些API,无需写映射文件,单表操作很方便
映射器
方法一
【推荐使用】
<!-- 使用相对于类路径的资源引用 -->
<mappers>
<mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
</mappers>
方法二
鸡肋 没啥用
<!-- 使用完全限定资源定位符(URL) -->
<mappers>
<mapper url="file:///var/mappers/AuthorMapper.xml"/>
</mappers>
方法三
注意:接口与映射文件必须同名,并且必须在同一个包下
否则报错:BindingException 绑定异常
<!-- 使用映射器接口实现类的完全限定类名 -->
<mappers>
<mapper class="org.mybatis.builder.AuthorMapper"/>
</mappers>
方法四
注意:接口与映射文件必须同名,并且必须在同一个包下
否则报错:BindingException 绑定异常
<!-- 将包内的映射器接口实现全部注册为映射器 -->
<mappers>
<package name="org.mybatis.builder"/>
</mappers>
作用域(Scope)和生命周期
不同作用域和生命周期类别是至关重要的,因为错误的使用会导致非常严重的并发问题。
-
SqlSessionFactoryBuilder
- new完就不需要了 => 生成了SqlSessionFactory
-
SqlSessionFactory
- 相当于数据库连接池
- 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。
- 不要重复创建多次,会浪费资源,高并发情况下可能异常。
- 有很多方法可以做到,最简单的就是使用单例模式或者静态单例模式。
-
SqlSession
- 每个线程都要实例 SqlSession
- SqlSession不是线程安全的,不能被共享
- 实例 SqlSession ,用完了,马上关闭
- 为确保每次关闭,关闭操作放到 finally 块中
XML映射
ResultMap
-
最重要最强大的元素
-
ResultMap 的设计思想是,对简单的语句做到零配置,对于复杂一点的语句,只需要描述语句之间的关系就行了。
-
表的字段与实体类属性
相同
,这种情况底层自动创建ResultMap自动映射。-
不相同
,先指定映射关系,并于通过id属性绑定 -
<resultMap id="UserRM" type="User"> <result property="password" column="pwd"/> </resultMap> <select id="getUserById" resultMap="UserRM"> select * from user </select>
-
日志
logImpl 默认:未设置
可选
-
SLF4J
-
LOG4J 【掌握】(需导包,Apache提供 2012停止更新)
-
LOG4J2
-
JDK_LOGGING
-
COMMONS_LOGGING
-
STDOUT_LOGGING 【掌握】(可以直接引用)
-
NO_LOGGING
mybatis-config.xml 配置到第二行 注意检查空格
<settings>
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
LOG4J
什么是log4j
-
Log4j是Apache的一个开源项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件
-
我们也可以控制每一条日志的输出格式
-
通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。
-
通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。
-
添加依赖
<dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency>
-
新建log4j.properties文件
# 将等级为DEBUG的日志信息输出到console和file这两个目的地,console和file的定义在下面的代码 log4j.rootLogger=DEBUG,console,file # 控制台输出的相关设置 log4j.appender.console=org.apache.log4j.ConsoleAppender log4j.appender.console.Target=System.out log4j.appender.console.Threshold=DEBUG log4j.appender.console.layout=org.apache.log4j.PatternLayout log4j.appender.console.layout.ConversionPattern=[%c]-%m%n # 文件输出的相关设置 log4j.appender.file=org.apache.log4j.RollingFileAppender log4j.appender.file.File=./log/cai.log log4j.appender.file.MaxFileSize=10mb log4j.appender.file.Threshold=DEBUG log4j.appender.file.layout=org.apache.log4j.PatternLayout log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n # 日志输出级别 log4j.logger.org.mybatis=DEBUG log4j.logger.java.sql=DEBUG log4j.logger.java.sql.Statement=DEBUG log4j.logger.java.sql.ResultSet=DEBUG log4j.logger.java.PreparedStatement=DEBUG
-
mybatis-config.xml 配置到第二行 注意检查
空格
<settings>
<setting name="logImpl" value="LOG4J"/>
</settings>
简单使用
- 使用Log4j的类 导入包 import org.apache.log4j.Logger;
- 日志对象,参数为当前类的class
import org.apache.log4j.Logger;
static Logger logger = Logger.getLogger(UserMapperTest.class);
@Test
public void Log4j() {
logger.info("info:...");
logger.debug("debug:...");
logger.error("error:...");
}
一对一
- 导入sql数据
CREATE TABLE `teacher`(
`id` INT(10) NOT NULL PRIMARY KEY,
`name` VARCHAR(30) DEFAULT NULL
)ENGINE=INNODB DEFAULT CHARSET=utf8;
INSERT INTO `teacher` (`id`, `name`) VALUES (1, '秦老师');
CREATE TABLE `student`(
`id` INT(10) NOT NULL PRIMARY KEY,
`name` VARCHAR(30) DEFAULT NULL,
`tid` INT(10) DEFAULT NULL
)ENGINE=INNODB DEFAULT CHARSET=utf8;
INSERT INTO `student` (`id`, `name`, `tid`) VALUES (1, '小明', 1),(2, '小红', 1),(3, '小张', 1),(4, '小李', 1),(5, '小王', 1);
- 实体类
package com.Mybatis.pojo;
public class Student {
private int id;
private String name;
private Teacher teacher;
public Student() {
}
public Student(int id, String name, Teacher teacher) {
this.id = id;
this.name = name;
this.teacher = teacher;
}
public int getId() {
return id;
}
public String getName() {
return name;
}
public Teacher getTeacher() {
return teacher;
}
public void setId(int id) {
this.id = id;
}
public void setName(String name) {
this.name = name;
}
public void setTeacher(Teacher teacher) {
this.teacher = teacher;
}
@Override
public String toString() {
return "Student{" +
"id=" + id +
", name='" + name + '\'' +
", teacher=" + teacher +
'}';
}
}
- 接口
package com.Mybatis.dao;
import com.Mybatis.pojo.Student;
import java.util.List;
public interface StudentMapper {
List<Student> getStudent();
List<Student> getStudent2();
}
- 映射
<?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.Mybatis.dao.StudentMapper">
<select id="getStudent" resultMap="getStudentTeacher">
select * from student
</select>
<resultMap id="getStudentTeacher" type="Student">
<id column="id" property="id"/>
<result column="name" property="name"/>
<association column="tid" property="teacher" javaType="Teacher" select="getTeacher"></association>
</resultMap>
<select id="getTeacher" resultType="Teacher">
select * from teacher where id = #{id}
</select>
<select id="getStudent2" resultMap="getStudent2RM">
select s.id s_id,s.name s_name,s.tid s_tid,t.name t_name from student s
left join teacher t
on s.tid=t.id
</select>
<resultMap id="getStudent2RM" type="Student">
<result column="s_id" property="id"/>
<result column="s_name" property="name"/>
<association property="teacher" javaType="Teacher">
<result property="name" column="t_name"/>
</association>
</resultMap>
</mapper>
一对多
- 实体类
package com.Mybatis.pojo;
import java.util.List;
public class Teacher {
private int id;
private String name;
private List<Student> students;
public Teacher() {
}
public Teacher(int id, String name, List<Student> students) {
this.id = id;
this.name = name;
this.students = students;
}
public int getId() {
return id;
}
public String getName() {
return name;
}
public List<Student> getStudents() {
return students;
}
public void setId(int id) {
this.id = id;
}
public void setName(String name) {
this.name = name;
}
public void setStudents(List<Student> students) {
this.students = students;
}
@Override
public String toString() {
return "Teacher{" +
"id=" + id +
", name='" + name + '\'' +
", students=" + students +
'}';
}
}
- 接口
package com.Mybatis.dao;
import com.Mybatis.pojo.Teacher;
import java.util.List;
public interface TeacherMapper {
List<Teacher> getTeacher();
}
- 实现
<?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.Mybatis.dao.TeacherMapper">
<select id="getTeacher" resultMap="TRM">
select t.id t_id,t.name t_name,s.name s_name
from teacher t
left join student s
on t.id=s.tid
</select>
<resultMap id="TRM" type="Teacher">
<result property="id" column="t_id"/>
<result property="name" column="t_name"/>
<collection property="students" ofType="Student">
<result property="id" column="s_id"/>
<result property="name" column="s_name"/>
</collection>
</resultMap>
</mapper>
- 测试类
package com.Mybatis.dao;
import com.Mybatis.pojo.Teacher;
import com.Mybatis.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
public class TeacherMapperTest {
SqlSession sqlSession = MybatisUtils.getSqlSession();
@Test
public void getTeacher() {
TeacherMapper teacherMapper = sqlSession.getMapper(TeacherMapper.class);
for (Teacher teacher : teacherMapper.getTeacher()) {
System.out.println(teacher);
}
sqlSession.close();
}
}
总结
1、association 封装对象属性
- 携带 javaType 指定属性对应的pojo类型
2、collection 封装集合属性
- 携带ofType 指定集合中的泛型类型
动态SQL
if
- 条件判断 true执行, false跳过执行
where
-
通常搭配 if 元素使用
-
去多余的 AND
-
去多余的 OR
set
-
通常搭配 if 元素使用
-
去多余的逗号
trim
- prefix属性 指定元素
- prefixOverrides属性 去除多余的条件或符号
where 等价定义
set 等价定义
foreach
- 遍历数组集合
- item=“item” (值是指定遍历对象)
- index=“index” (记录下标)
- open=“(” (开头)
- separator=“,” (分割)
- close=“)” (结尾)
choose、when、otherwise
<select id="findActiveBlogLike"
resultType="Blog">
SELECT * FROM BLOG WHERE state = ‘ACTIVE’
<choose>
<when test="title != null">
AND title like #{title}
</when>
<when test="author != null and author.name != null">
AND author_name like #{author.name}
</when>
<otherwise>
AND featured = 1
</otherwise>
</choose>
</select>
相当于
Integer key=3;
switch (key){
case 1:
System.out.println("1");
break;
case 2:
System.out.println("2");
break;
case 5:
System.out.println("5");
default:
System.out.println("default");
}
缓存
一级缓存
- 同一个 SqlSession 有效
- 实体对象无需序列化
- 默认开启
二级缓存
-
cache元素
- eviction (缓存类型 先进先出)
- flushInterval (间隔刷新,默认不设置)
- size (最多引用个数,默认值是 1024)
- readOnly (只读,默认false)
-
映射语句文件中的所有 select 语句的结果将会被缓存。
-
insert、update 、delete 会清空缓存
-
需要序列化实体对象
-
不同的 SqlSession 也有效,前提是同一对象的反射mapper
-
<cache eviction="FIFO" flushInterval="60000" size="512" readOnly="true"/>