一.简介
Mybatis是一款优秀的持久层框架,它支持自定义SQL,存储过程以及高级映射。Mybatis免除了几乎所有的JDBC代码以及设置参数和获取结果集的工作。Mybatis可以通过简单的XML或注解来配置原始类型,接口和JavaPOJO为数据库中的记录。
一.1相关知识
数据持久化:持久化就是将数据在持久状态和瞬间状态转换的过程。
内存:断电就没了。
数据库(JDBC),io文件持久化。
为什么要持久化:
- 不能丢掉对象
- 节约内存
持久层: - 完成持久化工作的代码
- 层的界限十分明显。
二.创建项目
二.1 创建数据表
CREATE DATABASE `mybatis`;
USE `mybatis`;
CREATE DATABASE `mybatis`;
CREATE TABLE `user`(
`id` INT(20) NOT NULL,
`name` VARCHAR(30) DEFAULT NULL,
`pwd` VARCHAR(30) DEFAULT NULL,
PRIMARY KEY(`id`)
)ENGINE=INNODB DEFAULT CHARSET=utf8;
INSERT INTO `user`(`id`,`name`,`pwd`) VALUES
(1,'狂神','123456'),
(2,'张三','abcdef'),
(3,'李四','987654');
二.2 创建maven项目
创建一个普通的maven项目(我用的是spring框架)
二.3 导入依赖
要想项目中使用mybatis只需要将mybatis的文件添加到类路径classpath中即可。
maven的依赖:
<!-- mysql驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.28</version>
</dependency>
<!-- junit-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<!-- mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
二.4 在resources目录下创建mybatis的核心配置文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"https://mybatis.org/dtd/mybatis-3-config.dtd">
<!--configuration核心配置文件-->
<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/mybatis?useSSL=true&useUnicode=true&characterEncoding=YTF-8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
</configuration>
二.5 创建实体类
package com.example.mybatistest.bean;
public class User {
private int id;
private String name;
private String pwd;
public User() {
}
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPwd() {
return pwd;
}
public void setPwd(String pwd) {
this.pwd = pwd;
}
public User(int id, String name, String pwd) {
this.id = id;
this.name = name;
this.pwd = pwd;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", pwd='" + pwd + '\'' +
'}';
}
}
二.5 创建dao
package com.example.mybatistest.dao;
import com.example.mybatistest.bean.User;
import java.util.List;
public interface UserDao {
List<User> getUserList();
}
二.6 创建MybatisUntils的工具类
package com.example.mybatistest.util;
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;
// SqlSessionFactory--> SqlSession
public class MybatisUntils {
private static SqlSessionFactory sqlSessionFactory;
static {
try {
//获取 SqlSessionFactory对象
String resource = "mybatis/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
//既然有了 SqlSessionFactory,顾名思义,我们可以从中获得 SqlSession 的实例。
// SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
}
二.8 在resources目录创建UserMapper配置文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--namespace绑定了一个对应的Dao/Mapper接口-->
<mapper namespace="com.example.mybatistest.dao.UserDao">
<!-- select查询-->
<select id="getUserList" resultType="com.example.mybatistest.bean.User">
select * from mybatis.user
</select>
</mapper>
二.9 在mybatis-config.xml文件中注册UserMapper
<!-- 每一个Mapper.xml都需要在MyBatis核心配置文件中注册-->
<mappers>
<mapper resource="mybatis/UserMapper.xml"/>
</mappers>
二.10 在pom文件的bulid中添加
<!--在build中配置resources,来防止资源导出失败的问题-->
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
<include>**/*.properties</include>
</includes>
<filtering>false</filtering>
</resource>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.xml</include>
<include>**/*.properties</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>
二.11 创建test
package com.example.mybatistest;
import com.example.mybatistest.bean.User;
import com.example.mybatistest.dao.UserDao;
import com.example.mybatistest.util.MybatisUntils;
import org.apache.ibatis.session.SqlSession;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
@SpringBootTest
class MybatisTestApplicationTests {
@Test
void contextLoads() {
// 第一步 获取SqlSession对象
SqlSession sqlSession = MybatisUntils.getSqlSession();
// 执行sql
// 方式一: getMapper
UserDao userDao = sqlSession.getMapper(UserDao.class);
List<User> userList = userDao.getUserList();
for (User user:userList
) {
System.out.println(user);
}
// 关闭sqlSession会话
sqlSession.close();
}
}
二.12运行结果
SqlSession
每个线程都有自己的SqlSession实例。SqlSession的实例不是线程安全的,因此不能被共享的,所以它的最佳的作用域是请求或者方法作用域。绝对不能将SqlSession实例放在一个类的静态域,甚至一个类的实例变量也不行。也不能将SqlSession的实例放在任何类型的托管作用域中,比如Servlet框架中HttpSession。所以要保证每次你打开了会话完成业务后一定要关闭会话,最后放在finally块中。
标准示范:
try(SqlSession session = sqlSessionFactory.openSession()){
// 你的应用逻辑代码
}
三. Mybatis下的增删改查
三.1 抽象方法:
//UserDaopackage com.example.mybatistest.dao;
import com.example.mybatistest.bean.User;
import java.util.List;
import java.util.Map;
public interface UserDao {
// 获取用户信息列表
List<User> getUserList();
// 根据ID查询用户
User getUserById(int id);
// 增加用户
void addUser(User user);
// 更新用户
void updateUser(User user);
// Map形式插入用户
//插入用户
int addUser2(Map<String,Object> map);
}
三.2 UserMapper.xml配置xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--namespace绑定了一个对应的Dao/Mapper接口-->
<mapper namespace="com.example.mybatistest.dao.UserDao">
<!-- select查询-->
<select id="getUserList" resultType="com.example.mybatistest.bean.User">
select * from mybatis.user
</select>
<select id="getUserById" resultType="com.example.mybatistest.bean.User" parameterType="int">
select * from mybatis.user where id = #{id}
</select>
<insert id="addUser" parameterType="com.example.mybatistest.bean.User">
insert into mybatis.user (id,name,pwd) values (#{id},#{name},#{pwd});
</insert>
<update id="updateUser" parameterType="com.example.mybatistest.bean.User">
update mybatis.user set name=#{name} ,pwd=#{pwd} where id=#{id};
</update>
<delete id="deleterUser" parameterType="int">
delete from mybatis.user where id=#{id};
</delete>
<insert id="addUser2" parameterType="map">
insert into mybatis.user (id,name,pwd) values (#{userid},#{username},#{password});
</insert>
</mapper>
三.3 测试类
package com.example.mybatistest;
import com.example.mybatistest.bean.User;
import com.example.mybatistest.dao.UserDao;
import com.example.mybatistest.util.MybatisUntils;
import org.apache.ibatis.session.SqlSession;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.HashMap;
import java.util.List;
import java.util.Objects;
@SpringBootTest
class MybatisTestApplicationTests {
@Test
void contextLoads() {
// 获取用户数据列表
// 第一步 获取SqlSession对象
SqlSession sqlSession = MybatisUntils.getSqlSession();
// 执行sql
// 方式一: getMapper
UserDao userDao = sqlSession.getMapper(UserDao.class);
List<User> userList = userDao.getUserList();
for (User user:userList
) {
System.out.println(user);
}
// 关闭sqlSession会话
sqlSession.close();
}
// 通过id查询用户对象
@Test
public void getUserById(){
SqlSession sqlSession = MybatisUntils.getSqlSession();
UserDao mapper= sqlSession.getMapper(UserDao.class);
User user = mapper.getUserById(1);
System.out.println(user);
sqlSession.close();
}
// 增加用户
@Test
void addUserTest(){
SqlSession sqlSession = MybatisUntils.getSqlSession();
UserDao mapper = sqlSession.getMapper(UserDao.class);
User user01 = new User(4,"用户4","password4");
mapper.addUser(user01);
List<User> userList = mapper.getUserList();
for (User user:userList
) {
System.out.println(user);
}
sqlSession.close();
}
// 测试map形式插入数据
@Test
void mapTest(){
SqlSession sqlSession = MybatisUntils.getSqlSession();
UserDao mapper = sqlSession.getMapper(UserDao.class);
HashMap<String, Object> map = new HashMap<>();
map.put("userid",5);
map.put("username","用户5");
map.put("password","password5");
mapper.addUser2(map);
sqlSession.commit();
sqlSession.close();
}
}
三.4 运行失败的原因
- 标签匹配错误
- resource绑定mapper,Mybatis核心配置文件中注册需要使用路径(不能使用 点)
- NullPointerException,没有找到注册资源
三.5 参数
- Map传递参数,直接在sql中取出key。
- 对象传递参数,直接在SQL中取出对象的属性。
- 一个参数,直接在SQL中取到,多个参数时使用set。
三.6 模糊查询注意
mybatis中的#{value}和${value}的区别:
- #{value}将传入的数据都当成一个字符串,会对自动传入的数据加一个双引号。
- ${value}将传入的数据直接显示生成在sql中。
- #{value}方式能够很大程度防止sql注入。
- ${value}方式无法防止Sql注入。
- ${value}方式一般用于传入数据库对象,例如传入表名.
一般能用#{value}的就别用value.[MyBatis)排序时使用orderby动态参数时需要注意,用{value}.
[MyBatis)排序时使用order by 动态参数时需要注意,用value.[MyBatis)排序时使用orderby动态参数时需要注意,用{value}而不是#{value}
字符串替换
默认情况下,使用#{value}格式的语法会导致MyBatis创建预处理语句属性并以它为背景设置安全的值。这样做很安全,很迅速也是首选做法,有时你只是想直接在SQL语句中插入一个不改变的字符串。
注意:接受从用户输出的内容并提供给语句中不变的字符串,这样做是不安全的。这会导致潜在的SQL注入攻击,因此你不应该允许用户输入这些字段,或者通常自行转义并检查。
四. 核心配置
mybatis-config.xml
Mybatis的配置文件中包含了Mybatis行为的设置和属性信息。
<!--配置 -->
<configuration>
</configuration>
<!--属性 -->
<properties>
</properties>
<!--设置 -->
<settings>
</settings>
<!--类型别名 -->
<typeAliases>
</typeAliases>
<!--对象工厂-->
<objectFactory>
</objectFactory>
<!--插件 -->
<plugins>
</plugins>
<!--环境配置 -->
<environments>
<!--环境变量 -->
<environment>
<!--事务管理器 -->
<transactionManager>
</transactionManager>
<!--数据源 -->
<dataSOurce>
</dataSource>
</environment>
</environments>
<!--数据库厂商标识 -->
<databaseIdProvider>
</databaseIdProcider>
<!--映射器 -->
<mappers>
</mappers>
四.1 环境配置(environments)
- Mybatis可以配置成适应多种环境。
- 尽管可以配置多个环境,但每个SqlSessionFactory实例只能选择一种环境。
配置多个环境:
mybatis 默认事务管理器(transactionManeger): JDBC
默认数据源datasource:POOLED
四.2 属性(Properties)
通过Properties文件实现引用配置文件
这些属性可以在外部进行配置,并可以进行动态配置。你既可以在典型的Java属性文件中配置这些属性,也可以在properties元素的子元素中设置。(db.properties)
编写配置文件
driver = com.cj.jdbc.Driver
url = jdbc:mysql://localhost:3306/mybatis?useSSL =true&useUncide=true&characterEncoding=UTF-8;
usename =root
password=123456
在核心配置文件中引入
<!-- 引入外部文件-->
<properties resource="db.properties">
<property name="username" value="root"/>
<property name="pwd" value="root"/>
</properties>
可以直接引入外部文件
可以在标签内增加一些属性配置
如果外部properties文件和标签有相同字段,会优先使用外部properties文件。
四.3 类型别名
类名别名时Java中的短名字
主要作用就是减少冗余,方便使用。
<!--给类起别名-->
<typeAliases>
<typeAlias type="com.example.bean.User" alias="user"/>
</typeAliases>
也可以至指定一个包名,mybatis会在包名下搜索需要的Java Bean,扫描实体类的包,就是这个类的类名,但是首字母小写。
<!--给类起别名-->
<typeAliases>
<typeAlias type="com.example.bean.User"/>
</typeAliases>
当实体类较少的时候使用第一种,实体类多的时候使用第二种。
第一种可以自定义命名,第二种需要借助实体类增加注解,而且需要mapper.xml文件有的所有实体类都需要改名。
@Alias
public class User{
private int id;
private String name;
private String pwd;
public User(){
}
}
常见的Java类型内建的类型别名。他们不区分大小写的
别名 | 映射的类型 |
---|---|
_byte | byte |
_char | (since 3.5.10) char |
_character | (since 3.5.10) char |
_long | long |
_short | short |
_int | int |
_integer | int |
_double | double |
四.4 设置(setting)
设置名 | 描述 | 有效值 | 默认值 |
---|---|---|---|
logImpl | 指定 MyBatis 所用日志的具体实现,未指定时将自动查找。 | SLF4J --LOG4J(3.5.9 起废弃) – LOG4J2 – JDK_LOGGING --COMMONS_LOGGING – STDOUT_LOGGING – NO_LOGGING | 未设置 |
cacheEnabled | 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。 | true – false | true |
lazyLoadingEnabled | 延迟加载的全局开关。当开启时,所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。 | true – false | false |
四.5 其他设置
- typeHandlers: 类型处理器
- objectFactory: 对象工厂
- plugins:插件
mybatis-generator
mybatis-plus
通用mapper
四.6 映射器
定义了SQL映射语句,相当于告诉Mybatis到哪里去找映射文件
方式一:
<!-- 每一个Mapper.xml都需要在MyBatis核心配置文件中注册-->
<!-- 使用相对于类路径的资源引用 -->
<mappers>
<mapper resource="com/hwt/dao/UserMapper.xml"/>
</mappers>
方式二:
<!-- 使用映射器接口实现类的完全限定类名 -->
<mappers>
<mapper class="com/hwt/dao/UserMapper.xml"/>
</mappers>
方式三
<!-- 将包内的映射器接口全部注册为映射器 -->
<mappers>
<package name="com.hwt.dao"/>
</mappers>
方式二和方式三需要注意:
- 接口和Mapper配置文件必须同名
- 接口和Mapper配置文件必须在同一个包下。
四.8 生命周期和作用域
作用域和生命周期是至关重要的,因为错误的使用会导致非常严重的并发问题。
执行流程:
SqlSessionFactory
- SqlSessionFactory一旦被创建就应该在应用期间一直存在,没有任何理由丢弃它或重新创建另一个实例。使用SqlSessionFactory的最佳实践是在应用期间不再重复创建多次,多次重建。
- SqlSession被视为一种代码的”坏习惯“.。因此SqlSessionFactory的最佳作用域是应用作用域。
- 有很多方法可以做到。最简单的方式就是使用单例模式或者静态单例模式,保证全局只有一份变量。
- 说白了SqlSessionFactory可以看作是一个连接池。
SqlSession
- 每个线程都应该有它自己的SqlSession实例。SqlSession的实例不是线程安全的,因此是不能被共享的,所以他的最佳的作用域是亲求或方法作用域。绝对不能将SqlSessionn实例的应用放在一个类的静态域,甚至一个类的实例变量也不行。
- 用完之后必须关闭,否则会导致资源占用。
- 每一个Mapper都是为了一个具体的业务。