MyBatis速成笔记
Mybatis小白的速成笔记,这里课程是楠哥讲Java的【极简入门】4小时学会MyBatis,但是数据表不是他的数据表
具体可参考
> https://space.bilibili.com/434617924?spm_id_from=333.788.b_765f7570696e666f.2
一、准备
1、数据表
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、依赖
<?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.zangjiji</groupId>
<artifactId>MybatisProj1</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.15</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
<scope>provided</scope>
</dependency>
</dependencies>
</project>
二、原生接口
config.properties
<?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="userE">
<environment id="userE">
<!-- 配置JDBC事务管理 -->
<transactionManager type="JDBC"></transactionManager>
<!-- 配置JDBC连接池 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf8&useSSL=true&serverTimezone=GMT%2B8"/>
<property name="username" value="root"/>
<property name="password" value="zz19980722"/>
</dataSource>
</environment>
</environments>
<!-- 注册mapper -->
<mappers>
<mapper resource="Mapper.xml"></mapper>
</mappers>
</configuration>
Mapper.properties
<?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="Mapper">
<insert id="save" parameterType="User">
INSERT INTO `user`(`id`,`name`,`pwd`) VALUES (#{id},#{name},#{pwd})
</insert>
</mapper>
- namespace 通常设置为⽂件所在包+⽂件名的形式。
- insert 标签表示执⾏添加操作。
- select 标签表示执⾏查询操作。
- update 标签表示执⾏更新操作。
- delete 标签表示执⾏删除操作。
- id 是实际调⽤ MyBatis ⽅法时需要⽤到的参数。
- parameterType 是调⽤对应⽅法时参数的数据类型。
Test类
import org.apache.ibatis.builder.SqlSourceBuilder;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.InputStream;
public class Test {
public static void main(String[] args) {
InputStream resourceAsStream = Test.class.getClassLoader().getResourceAsStream("config.xml");
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory build = sqlSessionFactoryBuilder.build(resourceAsStream);
SqlSession sqlSession = build.openSession();
String statement = "Mapper.save";
User user = new User(4,"小莉莉","asasasasa");
sqlSession.insert(statement,user);
sqlSession.commit();
}
}
三、Mapper代理自定义接口
1、自定义接口
package Mapperzdy;
import java.util.List;
public interface userInterface {
public int save(User user);
public int update(User user);
public int deletebyId(int id);
public List<User> findAll();
public User getUserById(int id);
}
2、自定义Mapper
<?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="Mapperzdy.userInterface">
<insert id="save" parameterType="Mapperzdy.User">
INSERT INTO `user`(`id`,`name`,`pwd`) VALUES (#{id},#{name},#{pwd})
</insert>
<update id="update" parameterType="Mapperzdy.User">
UPDATE USER SET NAME=#{name} WHERE id = #{id}
</update>
<delete id="deletebyId" parameterType="int">
DELETE FROM USER WHERE id = #{id}
</delete>
<select id="findAll" resultType="Mapperzdy.User">
select * from user
</select>
<select id="getUserById" parameterType="int" resultType="Mapperzdy.User">
select * from user where id = #{id}
</select>
</mapper>
statement 标签可根据 SQL 执⾏的业务选择 insert、delete、update、select。
MyBatis 框架会根据规则⾃动创建接⼝实现类的代理对象。
规则:
- Mapper.xml 中 namespace 为接⼝的全类名。
- Mapper.xml 中 statement 的 id 为接⼝中对应的⽅法名。
- Mapper.xml 中 statement 的 parameterType 和接⼝中对应⽅法的参数类型⼀致。
- Mapper.xml 中 statement 的 resultType 和接⼝中对应⽅法的返回值类型⼀致。
3、注册mapper
<mapper resource="zdyMapper.xml"></mapper>
4、编写测试类
package Mapperzdy;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.InputStream;
import java.util.List;
public class Test {
public static void main(String[] args) {
InputStream resourceAsStream = Test.class.getClassLoader().getResourceAsStream("config.xml");
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory build = sqlSessionFactoryBuilder.build(resourceAsStream);
SqlSession sqlSession = build.openSession();
userInterface useri = sqlSession.getMapper(userInterface.class);
// User user = new User(1,"周慧雪","qwert");
// useri.save(user);
// sqlSession.commit();
// User user = new User(2,"丽丽","sqll");
// useri.update(user);
// sqlSession.commit();
useri.deletebyId(3);
List<User> all = useri.findAll();
for (User user:all) {
System.out.println(user);
}
User userById = useri.getUserById(4);
System.out.println(userById);
sqlSession.commit();
}
}
运行没问题
四、级联映射
User类
package RelationShip;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
private int id;
private String name;
private String pwd;
private Userp userp;
}
UserP类
package RelationShip;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.List;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Userp {
private int id;
private String hobby;
private User user;
}
一个爱好可以被很多人喜欢。
HobbyReposiry——自定义接口
package RelationShip;
import java.util.Collection;
import java.util.List;
public interface HobbyReposiry {
public List<User> findUserByName(String name);
}
mapper文件
<?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="RelationShip.HobbyReposiry">
<resultMap id="UserpMap" type="RelationShip.Userp">
<id property="id" column="id"></id>
<result column="hobby" property="hobby"></result>
<collection property="user" ofType="RelationShip.User">
<id property="id" column="id"></id>
<result column="name" property="name"></result>
<result property="pwd" column="pwd"></result>
</collection>
</resultMap>
<select id="findUserByName" parameterType="String" resultMap="UserpMap">
SELECT u.`id` ,u.`name`,p.`hobby` FROM user u ,userp p WHERE #{name} = p.hobby and u.id = p.id
</select>
</mapper>
测试类
package RelationShip;
import Mapperzdy.userInterface;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.InputStream;
import java.util.List;
public class Test {
public static void main(String[] args) {
InputStream resourceAsStream = Test.class.getClassLoader().getResourceAsStream("config.xml");
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory build = sqlSessionFactoryBuilder.build(resourceAsStream);
SqlSession sqlSession = build.openSession();
HobbyReposiry useri = sqlSession.getMapper(HobbyReposiry.class);
System.out.println(useri.findUserByName("basketball"));
}
}
五、逆向工程
MyBatis 框架需要:实体类、⾃定义 Mapper 接⼝、Mapper.xml
传统的开发中上述的三个组件需要开发者⼿动创建,逆向⼯程可以帮助开发者来⾃动创建三个组件,减
轻开发者的⼯作量,提⾼⼯作效率。
如何使用??
MyBatis Generator,简称 MBG,是⼀个专⻔为 MyBatis 框架开发者定制的代码⽣成器,可⾃动⽣成
MyBatis 框架所需的实体类、Mapper 接⼝、Mapper.xml,⽀持基本的 CRUD 操作,但是⼀些相对复
杂的 SQL 需要开发者⾃⼰来完成。
一、导入依赖
<?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.zangjiji</groupId>
<artifactId>MybatisProj2</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.15</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
</project>
二、创建 MBG 配置⽂件 generatorConfifig.xml
1、jdbcConnection 配置数据库连接信息。
2、javaModelGenerator 配置 JavaBean 的⽣成策略。
3、sqlMapGenerator 配置 SQL 映射⽂件⽣成策略。
4、javaClientGenerator 配置 Mapper 接⼝的⽣成策略。
5、table 配置⽬标数据表(tableName:表名,domainObjectName:JavaBean 类名)。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<context id="test" targetRuntime="Mybatis3">
<jdbcConnection
driverClass="com.mysql.cj.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2B8"
userId="root"
password="zz19980722"></jdbcConnection>
<javaModelGenerator targetPackage="com.entity" targetProject="./src/main/java"></javaModelGenerator>
<sqlMapGenerator targetPackage="resources" targetProject="./src/main/resources"></sqlMapGenerator>
<javaClientGenerator type="XMLMAPPER" targetPackage="com.reposiry" targetProject="./src/main/java"></javaClientGenerator>
<table tableName="user" domainObjectName="User"></table>
</context>
</generatorConfiguration>
三、创建执行类
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.exception.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;
import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
public class Test {
public static void main(String[] args) throws IOException, XMLParserException, InvalidConfigurationException, SQLException, InterruptedException {
List<String> warning = new ArrayList<String>();
boolean overite = true;
String Cig="/generatorConfig.xml";
File configFile = new File(Test.class.getResource(Cig).getFile());
ConfigurationParser configurationParser = new ConfigurationParser(warning);
Configuration configuration = configurationParser.parseConfiguration(configFile);
DefaultShellCallback defaultShellCallback = new DefaultShellCallback(overite);
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(configuration, defaultShellCallback, warning);
myBatisGenerator.generate(null);
}
}
六、缓存机制
使⽤缓存可以减少 Java 应⽤与数据库的交互次数,从⽽提升程序的运⾏效率。⽐如查询出 id = 1 的对
象,第⼀次查询出之后会⾃动将该对象保存到缓存中,当下⼀次查询时,直接从缓存中取出对象即可,
⽆需再次访问数据库。
缓存分类
一级缓存
SqlSession 级别,默认开启,并且不能关闭。
操作数据库时需要创建 SqlSession 对象,在对象中有⼀个 HashMap ⽤于存储缓存数据,不同的
SqlSession 之间缓存数据区域是互不影响的。
⼀级缓存的作⽤域是 SqlSession 范围的,当在同⼀个 SqlSession 中执⾏两次相同的 SQL 语句事,第⼀
次执⾏完毕会将结果保存到缓存中,第⼆次查询时直接从缓存中获取。
需要注意的是,如果 SqlSession 执⾏了 DML 操作(insert、update、delete),MyBatis 必须将缓存
清空以保证数据的准确性。
使用之前userinterface接口
package Mapperzdy;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.InputStream;
import java.util.List;
public class Test {
public static void main(String[] args) {
InputStream resourceAsStream = Test.class.getClassLoader().getResourceAsStream("config.xml");
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory build = sqlSessionFactoryBuilder.build(resourceAsStream);
SqlSession sqlSession = build.openSession();
userInterface useri = sqlSession.getMapper(userInterface.class);
User userById = useri.getUserById(3);
System.out.println(userById);
User user2 = useri.getUserById(3);
System.out.println(user2);
// sqlSession.commit();
sqlSession.close();
}
}
发现它虽然查询了两次但是由于是同一个session,调用了一级缓存,等于说只执行了一次sql语句。
二级缓存
Mapper 级别,默认关闭,可以开启。
使⽤⼆级缓存时,多个 SqlSession 使⽤同⼀个 Mapper 的 SQL 语句操作数据库,得到的数据会存在⼆
级缓存区,同样是使⽤ HashMap 进⾏数据存储,相⽐较于⼀级缓存,⼆级缓存的范围更⼤,多个
SqlSession 可以共⽤⼆级缓存,⼆级缓存是跨 SqlSession 的。
⼆级缓存是多个 SqlSession 共享的,其作⽤域是 Mapper 的同⼀个 namespace,不同的 SqlSession
两次执⾏相同的 namespace 下的 SQL 语句,参数也相等,则第⼀次执⾏成功之后会将数据保存到⼆级
缓存中,第⼆次可直接从⼆级缓存中取出数据。
首先我们开启二级缓存
<settings>
<setting name="logImpl" value="STDOUT_LOGGING"/>
<setting name="cacheEnabled" value="true"/>
</settings>
之后再Mapper中添加cache
<cache></cache>
之后再序列化接口
package Mapperzdy;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {
private int id;
private String name;
private String pwd;
}
进行测试
public class Test {
public static void main(String[] args) {
InputStream resourceAsStream = Test.class.getClassLoader().getResourceAsStream("config.xml");
SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory build = sqlSessionFactoryBuilder.build(resourceAsStream);
SqlSession sqlSession = build.openSession();
userInterface useri = sqlSession.getMapper(userInterface.class);
User userById = useri.getUserById(3);
System.out.println(userById);
sqlSession.close();
SqlSession sqlSession1 = build.openSession();
userInterface useri2 = sqlSession1.getMapper(userInterface.class);
User user2 = useri2.getUserById(3);
System.out.println(user2);
sqlSession1.close();
}
}
我们发现两个不同的sqlsession执行相同的查询操作。但是发现只执行了一次sql语句。
七、动态SQL
使⽤动态 SQL 可简化代码的开发,减少开发者的⼯作量,程序可以⾃动根据业务参数来决定 SQL 的组
成。
例子
我们再之前User的基础上定义一个getEqualUsers方法,传入一个User从数据库中找到与这个User具有相同属性的User。
mapper文件如下
<select id="getEqualUsers" parameterType="Mapperzdy.User" resultType="Mapperzdy.User">
select * from user where id = #{id} and name = #{name} and pwd = #{pwd}
</select>
但是这里便有一个问题,如果我们缺失了一个参数,比如说一个user、pwd为空,但是id和name都与数据库中的一样,我们希望它返回这个对象,但是这么写sql肯定是返回不了的。
1、if标签
<select id="getEqualUsers" parameterType="Mapperzdy.User" resultType="Mapperzdy.User">
select * from user where
<if test="id!=0">
id = #{id}
</if>
<if test="name!=null">
and name = #{name}
</if>
<if test="pwd!=null">
and pwd = #{pwd}
</if>
</select>
我们这样写语句就可了!
但是如果if等于0的话,sql语句where后面就直接连接and了,必然会报错,如何解决嘞?我们可以使用where标签
2、where标签
<select id="getEqualUsers" parameterType="Mapperzdy.User" resultType="Mapperzdy.User">
select * from user
<where>
<if test="id!=0">
id = #{id}
</if>
<if test="name!=null">
and name = #{name}
</if>
<if test="pwd!=null">
and pwd = #{pwd}
</if>
</where>
</select>
把sql语句中的where变成where标签即可。where 标签可以⾃动判断是否要删除语句块中的 and 关键字,如果检测到 where 直接跟 and 拼接,则⾃动删除 and,通常情况下 if 和 where 结合起来使⽤。
3、choose when标签
<select id="getEqualUsers" parameterType="Mapperzdy.User" resultType="Mapperzdy.User">
select * from user
<where>
<choose>
<when test="id!=0">
id = #{id}
</when>
<when test="name!=null">
and name = #{name}
</when>
<when test="pwd!=null">
and pwd = #{pwd}
</when>
</choose>
</where>
</select>
使用方法与if类似
4、trim标签
<select id="getEqualUsers" parameterType="Mapperzdy.User" resultType="Mapperzdy.User">
select * from user
<trim prefix="where" prefixOverrides="and">
<if test="id!=0">
id = #{id}
</if>
<if test="name!=null">
and name = #{name}
</if>
<if test="pwd!=null">
and pwd = #{pwd}
</if>
</trim>
</select>
trim 标签中的 prefifix 和 suffiffiffix 属性会被⽤于⽣成实际的 SQL 语句,会和标签内部的语句进⾏拼接,如
果语句前后出现了 prefifixOverrides 或者 suffiffiffixOverrides 属性中指定的值,MyBatis 框架会⾃动将其删
除。
5、set标签
这里我们改造下之前的一个update方法。
set 标签⽤于 update 操作,会⾃动根据参数选择⽣成 SQL 语句。
<update id="update" parameterType="Mapperzdy.User">
UPDATE USER
<set>
<if test="name!=null">
name = #{name},
</if>
</set>
WHERE id = #{id}
</update>
6、foreach标签
我们在user中定义一个整型集合,把集合中的所有用户返回到一个用户列表中。
package Mapperzdy;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {
private int id;
private String name;
private String pwd;
private List<Integer> a = new ArrayList<Integer>();
public User(int id, String name, String pwd) {
this.id = id;
this.name = name;
this.pwd = pwd;
}
}
这里通过foreach可以循环遍历collection中的元素。
<select id="getAll" parameterType="Mapperzdy.User" resultType="Mapperzdy.User">
select * from user
<where>
<foreach collection="a" open="id in (" close=")" separator="," item="id">
#{id}
</foreach>
</where>
</select>
collection:集合名字
open:参数前的语句
close:参数后的语句
seperator:参数的分隔符
item:循环体中的对象或属性
如果集合中的数字是1,2,3
这就相当于执行了以下语句
Constructor
@NoArgsConstructor
public class User implements Serializable {
private int id;
private String name;
private String pwd;
private List<Integer> a = new ArrayList<Integer>();
public User(int id, String name, String pwd) {
this.id = id;
this.name = name;
this.pwd = pwd;
}
}
这里通过foreach可以循环遍历collection中的元素。
<select id="getAll" parameterType="Mapperzdy.User" resultType="Mapperzdy.User">
select * from user
<where>
<foreach collection="a" open="id in (" close=")" separator="," item="id">
#{id}
</foreach>
</where>
</select>
collection:集合名字
open:参数前的语句
close:参数后的语句
seperator:参数的分隔符
item:循环体中的对象或属性
如果集合中的数字是1,2,3
这就相当于执行了以下语句
SELECT * FROM USER WHERE id IN (1,2,3)