一：MyBatis 进阶
动态 SQL 是 Mybatis 的强大特性之⼀，能够完成不同条件下不同的 sql 拼接。
1.1 if 标签
在注册用户的时候，可能会有这样⼀个问题，如下图所示：
注册分为两种字段：必填字段和非必填字段，那如果在添加用户的时候有不确定的字段传⼊，程序应该如何实现呢
这个时候就需要使用动态标签来判断了，比如添加的时候性别 gender 为非必填字段，具体实现如下：
- 接口定义:
Integer insertUserByCondition(UserInfo userInfo);
- Mapper.xml 实现:
<insert id="insertUserByCondition">
INSERT INTO userinfo (
username,
`password`,
age,
<if test="gender != null">
gender,
</if>
phone)
VALUES (
#{username},
#{age},
<if test="gender != null">
#{gender},
</if>
#{phone})
</insert>
或者使用注解方式(不推荐)
@Insert("<script>" +
"INSERT INTO userinfo (username,`password`,age," +
"<if test='gender!=null'>gender,</if>" +
"phone)" +
"VALUES(#{username},#{age}," +
"<if test='gender!=null'>#{gender},</if>" +
"#{phone})"+
"</script>")
Integer insertUserByCondition(UserInfo userInfo);
把上面 SQL (包括标签), 使用 < script >< /script > 标签括起来就可以
1.2 trim 标签
之前的插入用户功能，只是有⼀个 gender 字段可能是选填项，如果有多个字段，⼀般考虑使用标签结合标签，对多个字段都采取动态生成的方式。
标签中有如下属性：
- prefix：表示整个语句块，以prefix的值作为前缀
- suffix：表示整个语句块，以suffix的值作为后缀
- prefixOverrides：表示整个语句块要去除掉的前缀
- suffixOverrides：表示整个语句块要去除掉的后缀
以下是对这四个属性的详细解释和代码示例：
- - prefix：表示整个语句块，以
prefix的值作为前缀。
这个属性通常用于拼接查询结果中的字段值，添加一个固定的前缀。例如，如果数据库中有一个名为name的字段，值为John Doe，你可以使用prefix属性来添加一个前缀，比如Mr. ，使其变为Mr. John Doe。
<resultMap id="userMap" type="User">
<result property="name" column="name" prefix="Mr. " />
</resultMap>
- - suffix：表示整个语句块，以
suffix的值作为后缀。
与prefix相反，suffix属性可以用于在查询结果的字段值后面添加一个固定的后缀。例如，如果你希望将查询结果的age字段值后面添加一个单位years，你可以这样使用：
<resultMap id="userMap" type="User">
<result property="age" column="age" suffix=" years" />
</resultMap>
- - prefixOverrides：表示整个语句块要去除掉的前缀。
在某些情况下，数据库中的字段值可能已经包含了一个固定的前缀，而你希望在映射结果时去除这个前缀。这时就可以使用prefixOverrides属性。例如，假设name字段中的值是Mr. John Doe，而你只想得到John Doe，可以这样配置：
<resultMap id="userMap" type="User">
<result property="name" column="name" prefixOverrides="Mr. " />
</resultMap>
- - suffixOverrides：表示整个语句块要去除掉的后缀。
类似于prefixOverrides，suffixOverrides属性可以用于去除字段值的后缀部分。比如，如果字段值是30 years，但你只需要得到30，可以这样设置：
<resultMap id="userMap" type="User">
<result property="age" column="age" suffixOverrides=" years" />
</resultMap>
所以调整 Mapper.xml 的插入语句：
：
<insert id="insertUserByCondition">
INSERT INTO userinfo
<trim prefix="(" suffix=")" suffixOverrides=",">
<if test="username !=null">
username,
</if>
<if test="password !=null">
`password`,
</if>
<if test="age != null">
age,
</if>
<if test="gender != null">
gender,
</if>
<if test="phone != null">
phone,
</>
</trim>
VALUES
<trim prefix="(" suffix=")" suffixOverrides=",">
<if test="username !=null">
#{username},
</if>
<if test="password !=null">
#{password},
</if>
<if test="age != null">
#{age},
</if>
<if test="gender != null">
#{gender},
</if>
<if test="phone != null">
#{phone}
</if>
</trim>
</insert>
在以上 sql 动态解析时，会将第⼀个 部分做如下处理：
- 基于 prefix 配置，开始部分加上 (
- 基于 suffix 配置，结束部分加上 )
- 多个组织的语句都以 , 结尾，在最后拼接好的字符串还会以 , 结尾，会基于suffixOverrides 配置去掉最后⼀个 ,
- 注意 中的 username 是传入对象的属性
1.3 where 标签
看下面这个场景, 系统会根据我们的筛选条件, 动态组装 where 条件
这种如何实现呢?
需求: 传入的用户对象，根据属性做 where 条件查询，用户对象中属性不为 null 的，都为查询条件. 如 username 为 “a”，则查询条件为 where username=“a”
- 原有 SQL：
SELECT
*
FROM
userinfo
WHERE
age = 18
AND gender = 1
AND delete_flag =0
- 接口定义:
List<UserInfo> queryByCondition();
- Mapper.xml 实现：
<select id="queryByCondition" resultType="com.example.demo.model.UserInfo">
SELECT
id, username, age, gender, phone, delete_flag, create_time, update_time
FROM
userinfo
<where>
<if test="age != null">
AND age = #{age}
</if>
<if test="gender != null">
AND gender = #{gender}
</if>
<if test="deleteFlag != null">
AND delete_flag = #{deleteFlag}
</if>
</where>
</select>
where 只会在子元素有内容的情况下才插入 where 子句，而且会自动去除子句的开头的 AND 或 OR，以上标签也可以使用 < trim prefix=“where” prefixOverrides=“and” > 替换, 但是此种情况下, 当子元素都没有内容时, where 关键字也会保留
- 或者使用注解方式
@Select("<script>select id, username, age, gender, phone, delete_flag,
create_time, update_time" +
" from userinfo" +
" <where>" +
" <if test='age != null'> and age = #{age} </if>" +
" <if test='gender != null'> and gender = #{gender} </if>" +
" <if test='deleteFlag != null'> and delete_flag = #{deleteFlag} </if>" +
" </where>" +
"</script>")
List<UserInfo> queryByCondition(UserInfo userInfo);
1.4 set 标签
需求: 根据传入的用户对象属性来更新用户数据，可以使用标签来指定动态内容.
- 接口定义: 根据传入的用户 id 属性，修改其他不为 null 的属性
Integer updateUserByCondition(UserInfo userInfo);
- Mapper.xml
<update id="updateUserByCondition">
update userinfo
<set>
<if test="username != null">
username = #{username},
</if>
<if test="age != null">
age = #{age},
</if>
<if test="deleteFlag != null">
delete_flag = #{deleteFlag},
</if>
</set>
where id = #{id}
</update>
set ：动态的在 SQL 语句中插入 set 关键字，并会删掉额外的逗号. (用于update语句中)
以上标签也可以使用 < trim prefix=“set” suffixOverrides=“,” > 替换。
- 或者使用注解方式
@Update("<script>" +
"update userinfo " +
"<set>" +
"<if test='username!=null'>username=#{username},</if>" +
"<if test='age!=null'>age=#{age},</if>" +
"<if test='deleteFlag!=null'>delete_flag=#{deleteFlag},</if>" +
"</set>" +
"where id=#{id}" +
"</script>")
Integer updateUserByCondition(UserInfo userInfo);
1.5 foreach 标签
对集合进行遍历时可以使用该标签。标签有如下属性：
- collection：绑定方法参数中的集合，如 List，Set，Map或数组对象
- item：遍历时的每⼀个对象
- open：语句块开头的字符串
- close：语句块结束的字符串
- separator：每次遍历之间间隔的字符串
需求: 根据多个 userid, 删除用户数据
- 接口方法:
void deleteByIds(List<Integer> ids);
- ArticleMapper.xml 中新增删除 sql：
<delete id="deleteByIds">
delete from userinfo
where id in
<foreach collection="ids" item="id" separator="," open="(" close=")">
#{id}
</foreach>
</delete>
比如，如果 ids 集合中包含元素 1, 2, 3，那么生成的 SQL 语句将会是 delete from userinfo where id in (1, 2, 3)。这样就实现了根据传入的 ids 集合中的元素批量删除对应 ID 的记录。
- 或者使用注解方式:
@Delete("<script>" +
"delete from userinfo where id in" +
"<foreach collection='ids' item='id' separator=',' open='('close=')'>" +
"#{id}" +
"</foreach>" +
"</script>")
Integer deleteUser(Integer id);
1.6 include 标签
在 xm l映射文件中配置的 SQL，有时可能会存在很多重复的片段，此时就会存在很多冗余的代码
我们可以对重复的代码片段进行抽取，将其通过 sql 标签封装到⼀个 SQL 片段，然后再通过 include 标签进行引用。
- sql ：定义可重用的 SQL片段
- include ：通过属性 refid，指定包含的 SQL 片段
<sql id="allColumn">
id, username, age, gender, phone, delete_flag, create_time, update_time
</sql>
通过 include 标签在原来抽取的地方进行引用。操作如下：
<select id="queryAllUser" resultMap="BaseMap">
select
<include refid="allColumn"></include>
from userinfo
</select>
<select id="queryById" resultType="com.example.demo.model.UserInfo">
select
<include refid="allColumn"></include>
from userinfo where id= #{id}
</select>
这两段代码就相当于：
<select id="queryAllUser" resultMap="BaseMap">
select
id, username, age, gender, phone, delete_flag, create_time, update_time
from userinfo
</select>
<select id="queryById" resultType="com.example.demo.model.UserInfo">
select
id, username, age, gender, phone, delete_flag, create_time, update_time
from userinfo where id= #{id}
</select>
二： 案例练习
基于以上知识的学习, 我们就可以做⼀些简单的项目了
2.1 表白墙
前面的案例中, 我们写了表白墙, 但是⼀旦服务器重启, 数据仍然会丢失，要想数据不丢失, 需要把数据存储在数据库中. 接下来咱们借助 MyBatis 来实现数据的操作
2.1.1 数据准备
DROP TABLE IF EXISTS message_info;
CREATE TABLE `message_info` (
`id` INT ( 11 ) NOT NULL AUTO_INCREMENT,
`from` VARCHAR ( 127 ) NOT NULL,
`to` VARCHAR ( 127 ) NOT NULL,
`message` VARCHAR ( 256 ) NOT NULL,
`delete_flag` TINYINT ( 4 ) DEFAULT 0 COMMENT '0-正常, 1-删除',
`create_time` DATETIME DEFAULT now(),
`update_time` DATETIME DEFAULT now() ON UPDATE now(),
PRIMARY KEY ( `id` )
) ENGINE = INNODB DEFAULT CHARSET = utf8mb4;
ON UPDATE now(): 当数据发生更新操作时, 自动把该列的值设置为 now(),
2.1.2 引入 MyBatis 和 MySQL 驱动依赖
修改 pom 文件
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.3.1</version>
</dependency>
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<scope>runtime</scope>
</dependency>
或者使用插件 EditStarters 来引入依赖
2.1.3 配置 MySQL 账号密码
spring:
datasource:
url: jdbc:mysql://127.0.0.1:3306/mybatis_test?characterEncoding=utf8&useSSL=false
username: root
password: root
driver-class-name: com.mysql.cj.jdbc.Driver
mybatis:
configuration: # 配置打印 MyBatis⽇志
map-underscore-to-camel-case: true #配置驼峰⾃动转换
2.1.4 编写后端代码
- Model
import lombok.Data;
@Data
public class MessageInfo {
private Integer id;
private String from;
private String to;
private String message;
private Integer deleteFlag;
private Date createTime;
private Date updateTime;
}
- MessageInfoMapper
import com.example.demo.model.MessageInfo;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
import java.util.List;
@Mapper
public interface MessageInfoMapper {
@Select("select `id`, `from`, `to`, `message` from message_info where delete_flag=0")
List<MessageInfo> queryAll();
@Insert("insert into message_info (`from`,`to`, `message`) values(#{from},#{to},#{message})")
Integer addMessage(MessageInfo messageInfo);
}
- MessageInfoService
import com.example.demo.mapper.MessageInfoMapper;
import com.example.demo.model.MessageInfo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class MessageInfoService {
@Autowired
private MessageInfoMapper messageInfoMapper;
public List<MessageInfo> queryAll() {
return messageInfoMapper.queryAll();
}
public Integer addMessage(MessageInfo messageInfo) {
return messageInfoMapper.addMessage(messageInfo);
}
}
- MessageController
import com.example.demo.model.MessageInfo;
import com.example.demo.service.MessageInfoService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RequestMapping("/message")
@RestController
public class MessageController {
@Autowired
private MessageInfoService messageInfoService;
/**
* 获取留⾔列表
* @return
*/
@RequestMapping("/getList")
public List<MessageInfo> getList() {
return messageInfoService.queryAll();
}
/**
* 发表留⾔
* @param messageInfo
* @return
*/
@RequestMapping("/publish")
public boolean publish(MessageInfo messageInfo) {
System.out.println(messageInfo);
if (StringUtils.hasLength(messageInfo.getFrom())
&& StringUtils.hasLength(messageInfo.getTo())
&& StringUtils.hasLength(messageInfo.getMessage())) {
messageInfoService.addMessage(messageInfo);
return true;
}
return false;
}
}
2.1.5 测试
部署程序, 验证服务器是否能正确响应: http://127.0.0.1:8080/messagewall.html
输⼊留言信息, 点击提交, 发现页面列表显示新的数据, 并且数据库中也添加了⼀条记录.
重启服务, ⻚⾯显⽰不变.
