脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → MyBatis-Plus逻辑删除和字段自动填充

MyBatis-Plus逻辑删除和字段自动填充的实现

 更新时间：2022年08月09日 09:06:47   作者：Charge8  
本文主要介绍了MyBatis-Plus逻辑删除和字段自动填充的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

一、ID生成策略

1、使用@TableId注解

@TableId注解：主键注解

使用位置：实体类主键字段。

@Data
@ToString
@TableName("t_user")
public class UserDO {

	@TableId(value = "id", type = IdType.AUTO)
	private Long id;
    ...
}

2、全局ID生成策略

使用注解是针对一个POJO的。如果我们全局使用同样的 ID生成策略。那我们可以在全局配置文件中配置。就不需要在每个 POJO上使用 主键@TableId注解了。

mybatis-plus:
  global-config:
    db-config:
      id-type: auto

二、逻辑删除

官方文档-逻辑删除：https://baomidou.com/pages/6b03c5/

逻辑删除： 通常会在表里添加一个逻辑删除的字段，比如 enabled（1默认有效，0无效）。

MyBatis-Plus会在用户调用删除操作时将数据修改 UPDATE set enabled = 0， 在查询的时候会自动拼接只查 where enabled=1的数据。

1、全局配置

在YAML配置文件中添加全局配置

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

不推荐使用全局配置，使用 @TableLogic注解见名知意。

2、使用@TableLogic注解

@TableLogic注解：表字段逻辑处理注解（逻辑删除）。

1）表中添加 enabled字段

ALTER TABLE `t_user` 
ADD COLUMN `enabled` tinyint(1) NOT NULL DEFAULT 1 COMMENT '是否有效（1-有效，0-无效）';

2）在POJO实体类字段上加上 @TableLogic注解。

	/**
	 * 代表逻辑删除
	 * 	value:逻辑未删除值
	 * 	delval:逻辑删除值
	 */
	//@TableLogic
	@TableLogic(value = "1", delval = "0")
	private Integer enabled;

到此，逻辑删除就配置好了，接下来测试一下删除和查询。

	@Test
	public void testRemoveById() {
		System.out.println(("----- removeById method test ------"));
		boolean remove = userService.removeById(12L);
        
		System.out.println("remove = " + remove);
	}


	@Test
	public void testGetById() {
		System.out.println(("----- getById method test ------"));
		UserDO userDO = userService.getById(12L);

		System.out.println("userDO = " + userDO);
	}

三、字段自动填充

官方文档-自动填充功能：https://baomidou.com/pages/4c6bcf/

在项目中，一般我们都会定义 create_time和update_time字段。针对这两个字段，每次CRUD操作时，我们都需要手动赋值或者数据库默认值。MyBatis-Plus提供了给字段自动填充数据的功能。

`create_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',

使用 MyBatis-Plus的自动填充功能，需要指定 fill类型，并且指定 自定义填充信息 MetaObjectHandler。

1、指定字段自动填充

在POJO中，指定 create_time和update_time字段为自动填充。

	 @TableField(value = "create_time", fill = FieldFill.INSERT)
	//@TableField(value = "create_time")
	private Date createTime;

	 @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
	//@TableField(value = "update_time")
	private Date updateTime;

fill类型的值如下：

注意：如果指定了 fill为后面三个时，必须显示设置值。否则为报错：Column 'create_time' cannot be null。如果我们不显示指定设置值，我们必须定义 MetaObjectHandler。

2、自定义MetaObjectHandler

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        /**
         *方法的四个个参数：<br/>
         *      MetaObject metaObject: metaObject对象 <br/>
         *      String fieldName：POJO字段 <br/>
         *      Class<T> fieldType：字段类型 <br/>
         *      E fieldVal：自动填充的字段值 <br/>
         */
        this.strictInsertFill(metaObject, "createTime", Date.class, new Date());
		//this.setFieldValByName("createTime", new Date(),metaObject);
        // 或者
        this.strictInsertFill(metaObject, "updateTime", () -> new Date(), Date.class);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.strictInsertFill(metaObject, "updateTime", () -> new Date(), Date.class);
    }
}

3、测试

1）测试保存

	@Test
	public void testSave() {
		System.out.println(("----- save method test ------"));
		UserDO userDO = new UserDO();
		userDO.setUserName("赵云save fill");
		userDO.setAge(20);
		userDO.setHeight(1.88);
		userDO.setEmail("zhaoyun@123.com");
		boolean save = userService.save(userDO);

		System.out.println("save = " + save);
		System.out.println("userDO = " + userDO);
	}

2）测试删除

	@Test
	public void testRemoveById() {
		System.out.println(("----- removeById method test ------"));
		boolean remove = userService.removeById(111L);
		System.out.println("remove = " + remove);
	}

四、执行SQL分析打印

生产环境不推荐使用，开发环境可以使用。

官方文档-自动填充功能：https://baomidou.com/pages/833fab/

引入 p6spy依赖：

    <!-- https://mvnrepository.com/artifact/p6spy/p6spy -->
    <dependency>
      <groupId>p6spy</groupId>
      <artifactId>p6spy</artifactId>
      <version>3.9.1</version>
    </dependency>

1、添加 spy.properties配置文件

#3.2.1以上使用
modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory
#3.2.1以下使用或者不配置
#modulelist=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定义日志打印
logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger
#日志输出到控制台
appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger
# 使用日志系统记录 sql
#appender=com.p6spy.engine.spy.appender.Slf4JLogger
# 设置 p6spy driver 代理
deregisterdrivers=true
# 取消JDBC URL前缀
useprefix=true
# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.
excludecategories=info,debug,result,commit,resultset
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 实际驱动可多个
#driverlist=org.h2.Driver
# 是否开启慢SQL记录
outagedetection=true
# 慢SQL记录标准 2 秒
outagedetectioninterval=2

2、修改数据源配置

修改驱动类和 url的前缀。

spring:
  ## 数据源配置
  datasource:
    driver-class-name: com.p6spy.engine.spy.P6SpyDriver # com.mysql.cj.jdbc.Driver
    # url: jdbc:mysql://localhost:3306/mybatis_db?useUnicode=true&characterEncoding=utf8&useSSL=true&serverTimezone=GMT
    url: jdbc:p6spy:mysql://localhost:3306/mybatis_db?useUnicode=true&characterEncoding=utf8&useSSL=true&serverTimezone=GMT
    username: root
    password: 123456

3、测试查询

多了红色的部分，其实我们使用 MyBatisLogFormat插件也是可以得到真实执行的SQL语句。

到此这篇关于MyBatis-Plus逻辑删除和字段自动填充的实现的文章就介绍到这了,更多相关MyBatis-Plus逻辑删除和字段自动填充内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • 简单总结Java的反射机制的运用

    简单总结Java的反射机制的运用

    这篇文章主要介绍了Java的反射机制的运用,对一些常用的类作了一些说明,需要的朋友可以参考下
    2015-11-11
  • SpringBoot2.0 整合 Dubbo框架实现RPC服务远程调用方法

    SpringBoot2.0 整合 Dubbo框架实现RPC服务远程调用方法

    这篇文章主要介绍了SpringBoot2.0 整合 Dubbo框架 实现RPC服务远程调用 ,本文给大家介绍的非常详细，具有一定的参考借鉴价值，需要的朋友可以参考下
    2019-07-07
  • Java JDK动态代理在拦截器和声明式接口中的应用小结

    Java JDK动态代理在拦截器和声明式接口中的应用小结

    Java动态代理技术通过反射机制在运行时动态生成代理类,实现对目标对象方法的拦截和增强,本文给大家介绍Java JDK动态代理在拦截器和声明式接口中的应用小结,感兴趣的朋友跟随小编一起看看吧
    2025-01-01
  • Java中值类型和引用类型的比较与问题解决

    Java中值类型和引用类型的比较与问题解决

    这篇文章主要给大家介绍了关于Java中值类型和引用类型的比较与问题解决方法，文中通过示例代码介绍的非常详细，对大家学习或者使用Java具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
    2019-12-12
  • SpringBoot开发项目,引入JPA找不到findOne方法的解决

    SpringBoot开发项目,引入JPA找不到findOne方法的解决

    这篇文章主要介绍了SpringBoot开发项目,引入JPA找不到findOne方法的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-11-11
  • MybatisPlus多表连接查询的具体实现

    MybatisPlus多表连接查询的具体实现

    MyBatis Plus是一款针对MyBatis框架的增强工具, 它提供了很多方便的方法来实现多表联查,本文主要介绍了MybatisPlus多表连接查询的具体实现,具有一定的参考价值,感兴趣的可以了解一下
    2023-10-10
  • visual studio2022 JNI开发流程的实现

    visual studio2022 JNI开发流程的实现

    本文主要介绍了通过IDEA创建Maven项目并生成JNI头文件,使用Visual Studio 2022构建DLL,最后在Java中加载并调用C++实现,具有一定的参考价值,感兴趣的可以了解一下
    2025-07-07
  • 详解Java volatile 内存屏障底层原理语义

    详解Java volatile 内存屏障底层原理语义

    为了保证内存可见性，java 编译器在生成指令序列的适当位置会插入内存屏障指令来禁止特定类型的处理器重排序。为了实现 volatile 内存语义，JMM 会分别限制这两种类型的重排序类型
    2021-09-09
  • Spring Security SecurityContextHolder组件示例说明

    Spring Security SecurityContextHolder组件示例说明

    SpringSecurity的SecurityContextHolder组件是存储当前安全上下文的地方,包括认证用户信息,它支持全局访问、线程局部存储和上下文传播,是SpringSecurity认证和授权的核心,文章通过示例展示了如何访问已认证用户的详细信息、手动设置认证信息以及使用认证信息保护方法
    2024-11-11
  • JavaEE实现基于SMTP协议的邮件发送功能

    JavaEE实现基于SMTP协议的邮件发送功能

    这篇文章主要为大家详细介绍了JavaEE实现基于SMTP协议的邮件发送功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2019-05-05

最新评论