Mybatis 实现批量插入和批量删除源码实例
Posted Yan Yang
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Mybatis 实现批量插入和批量删除源码实例相关的知识,希望对你有一定的参考价值。
学习内容:
准备工作
-
需求
使用 mybatis 对 mysql 数据库批量插入和删除数据(按项目结构把相应代码拷贝就好,其中穿插了一些知识点代码,看看就好) -
整体项目结构如下
1、数据库新建表
- 新建数据库 web_test,在新建表如下:
CREATE TABLE `user` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`username` varchar(255) DEFAULT NULL,
`password` varchar(255) DEFAULT NULL,
PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
2、新建 Maven 项目和设置编译版本及添加依赖
<?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>org.example</groupId>
<artifactId>maven-test03</artifactId>
<version>1.0.0</version>
<packaging>war</packaging>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
</properties>
<dependencies>
<!-- 配置 servlet-api 依赖 -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.0.1</version>
<!-- 记得一定配置 -->
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.45</version>
<scope>runtime</scope><!-- 运行阶段使用 -->
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope><!-- 测试阶段才用 -->
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.22</version>
<scope>provided</scope><!-- 编译阶段和测试阶段才使用 -->
</dependency>
</dependencies>
</project>
3、新建 db.properties
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/web_test?characterEncoding=utf-8
username=root
password=admin
4、新建 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>
<properties resource="db.properties"/>
<typeAliases>
<package name="com.yy.homework.domain"/>
</typeAliases>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/yy/homework/mapper/UserMapper.xml"/>
</mappers>
</configuration>
5、新建 log4j.properties
log4j.rootLogger=ERROR, stdout
log4j.logger.com.yy.homework=TRACE
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
代码编写
1、编写实体类
package com.yy.homework.domain;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;
@Setter
@Getter
@ToString
@NoArgsConstructor
public class User {
private Long id;
private String username;
private String password;
public User(String username, String password) {
this.username = username;
this.password = password;
}
}
2、编写 UserMapper.xml
2.1、MyBatis 的 # 和 $
- 相同点
都可以获取对象(Map 对象或者 JavaBean 对象)的信息; - 不同点
1)使用 # 传递的参数会先转换为字符串,无论传递是什么类型数据都会带一个单引号;使用 $ 传递的参数,直接把值作为 SQL 语句的一部分。 if test 判断取值相当于使用 $
2)使用 # 支持把简单类型(八大基本数据类型及其包装类、String、BigDecimal 等等)参数作为值;使用 $ 不支持把简单类型参数作为值,所以 $ 一般使用 @Param注解传值,或者通过对象传值(Map 对象或者 JavaBean 对象)。
3)使用 # 好比使用 PrepareStatement,没有 SQL 注入的问题,相对比较安全;使用 $ 好比使用Statement,可能会有 SQL 注入的问题,相对不安全。
注意:知道 # $ 区别,熟记其应用场景
1)只要是取列名, 使用 $ 取值, 常见在 order by group by 子句
2)其他非取列名, 使用 # 取值, 常见在 where 子句
2.2、MyBatis 的参数处理问题
例1:登录需要2个参数,一个用户名,一个密码,MybatisMapper.xml 语句如下
<select id="login" resultType="User">
SELECT id, username, password FROM user WHERE username = #{username} AND password = #{password}
</select>
- 使用 Map 集合传递参数
把需要传的值封装成 Map 集合解决,以下是伪代码
Map<String, String> map = new HashMap<>();
map.put(String key, String value)
// 传递参数是直接传 map 就行
User login(map);
- 使用 对象 传递参数
User user = new User("username","password")
// 传递参数是直接传 user 就行
User login(user);
- 使用 @Param 注解传递参数
@Param 注解的本质相当于构建了一个 Map 对象,key 为注解 @Param 的值,value 为参数的值
// 本质相当于构建一个 Map 对象,key 为注解 @Param 的值,value 为参数的值。
User login(@Param("username")String username, @Param("password")String password);
例2:批量删除时需要传入一个 Long 类型的数组,MybatisMapper.xml 语句如下
<delete id="delete">
delete
from user
where id in
<!--
collection 表示遍历的数组或者集合,填写对应 key 的值
item 遍历元素
separator 每遍历元素拼接字符串
open 遍历开始拼接的字符串
close 遍历结束拼接字符串
index 遍历索引
例如本条 SQL 语句,假设传入的集合ids为({1,2,3})拼接后的结果为:
delete from user where id in(1, 2, 3)
-->
<foreach collection="ids" item="id" open="(" close=")" separator=",">
#{id}
</foreach>
</delete>
- 使用 @Param 注解解决集合/数组参数问题
当传递一个 List 对象或数组对象参数给 MyBatis 时,MyBatis 会自动把它包装到一个 Map 中,此时:
List 对象会以 list 作为 key,数组对象会以 array 作为 key,也可以使用注解 @Param 设置 key 名。
void delete(@Param("ids") Long[] id);
2.3、动态 SQL 之 set
问题:传入的对象某个属性值为 null,则会造成更新丢失数据。
<update id="update">
UPDATE employee
<set>
<if test="name != null">
name = #{name},
</if>
<if test="sn != null">
sn = #{sn},
</if>
<if test="salary != null">
salary = #{salary},
</if>
<if test="deptId != null">
deptId = #{deptId}
</if>
</set>
WHERE id = #{id}
</update>
2.4、动态 SQL 之 foreach
动态 SQL 的另外一个常用的操作需求是对一个集合进行遍历,通常是在构建 IN 这个条件语句的时候,这里就会使用到 foreach 元素。
例如:批量地根据用户 id 删除用户。
<delete id="delete">
delete from user
where id in
<!--
collection 表示遍历的数组或者集合,填写对应 key 的值
item 遍历元素
separator 每遍历元素拼接字符串
open 遍历开始拼接的字符串
close 遍历结束拼接字符串
index 遍历索引
例如本条 SQL 语句,假设传入的集合ids为({1,2,3})拼接后的结果为:
delete from user where id in(1, 2, 3)
-->
<foreach collection="ids" item="id" open="(" close=")" separator=",">
#{id}
</foreach>
</delete>
2.5、编写 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">
<mapper namespace="com.yy.homework.mapper.UserMapper">
<insert id="insert" useGeneratedKeys="true" keyProperty="id">
insert into user(username, password)
values
<foreach collection="users" item="user" separator=",">
(#{user.username}, #{user.password})
</foreach>
</insert>
<delete id="delete">
delete
from user
where id in
<!--
collection:表示遍历的数组或者集合,填写对应 key 的值
item:集合中被遍历的元素名,自己随意起的名字
separator:每次遍历元素后用于拼接字符串
open:遍历开始拼接的字符串
close:遍历结束拼接字符串
index:遍历索引
例如本条 SQL 语句,假设传入的集合ids为({1,2,3})拼接后的结果为:
delete from user where id in(1, 2, 3)
-->
<foreach collection="ids" item="id" open="(" close=")" separator=",">
#{id}
</foreach>
</delete>
<update id="update">
update user
<set>
<!-- test 判断取值相当于使用 $ -->
<if test="username != null">
username = #{username},
</if>
<if test="password != null">
password = #{password},
</if>
</set>
where id = #{id}
</update>
<select id="selectByIds" resultType="User">
select *
from user
<where>
<!-- test 判断取值相当于使用 $ -->
<if test="ids != null">
and id in
<foreach collection="ids" item="id" open="(" close=")" separator=",">
#{id}
</foreach>
</if>
<if test="username != null">
and username like concat('%', #{username}, '%')
</if>
</where>
</select>
<!-- ${} 取值直接把该值转化成 SQL 语句的一部分 -->
<select id="selectAll" resultType="User">
select *
from user
order by ${id} desc
</select>
</mapper>
3、编写 MybatisUtil.java 工具类
作用:创建 SqlSession 对象。
package com.yy.homework;
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;
public abstract class MybatisUtil {
private static SqlSessionFactory factory;
static {
try {
factory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsReader("mybatis-config.xml"));
} catch (IOException e) {
e.printStackTrace();
}
}
public static SqlSession creatSession() {
return factory.openSession();
}
}
4、编写 UserMapper.java 接口
4.1 Mapper 接口和原理
-
之前代码问题
1)namespace.id 使用的是 String 类型(第一个参数),一旦编写错误,只有等到运行代码才能报错;
2)传入的实际参数类型不被检查,因为第二个参数类型是 Object。 -
使用注意:
1)类似之前的 DAO,在接口中定义 CRUD 等操作方法。Mapper 组件 = Mapper 接口 + Mapper XML文件。
2)接口的命名为实体名 Mapper,一般和其对应 XML 文件放一起(只要编译之后字节码文件和 XML文件在一起);
3)XML 命名空间用其对应接口的全限定名;
4)Mapper 接口的方法名要和 Mapper XML 文件元素(select | update | delete | insert) id 值一样;
5)方法的返回类型对应 SQL 元素中定义的 resultType / resultMap 类型;
6)方法的参数类型对应 SQL 元素中定义的 paramterType 类型(一般不写)。 -
Mapper 接口的原理
1)通过打印接接口,发现打印的是:class com.sun.proxy.$Proxy5,底层使用的是动态代理,生成 Mapper 接口的实现类。
2)接口是规范,实质做的实现还是要由实现类对象来做,而这个实现类不需要我们写,实现类对象也不由我们创建,这些都 MyBatis 使用动态代理帮我们做了;我们只需提供 Mapper 接口对应 Mapper XML 文件,获取实现类对象的时候传入 Mapper 接口就可以了(不然 MyBatis 也不知道你要获取哪个 Mapper 接口的实现类对象);
3)至于实现类中操作方式底层还是和之前的一样,因为 Mapper XML 命名空间是使用 Mapper 接口的全限定名,方法名又与对应 XML 元素 id 一致,所以可以通过获取调用方法所在 Mapper 接口的权限名和方法名,拼接出 namespace + id,再配合调用方法的实参就可以像之前一样操作了。
4.2 Mapper 接口的编写
package com.yy.homework.mapper;
import com.yy.homework.domain.User;
import org.apache.ibatis.annotations.Param;
import java.util.List;
public interface UserMapper {
void insert(@Param("users") List<User> usersmybatis批量查询-插入-删除