写点什么

Spring-boot 项目练习笔记(二)MybatisPlus 实现公共字段自动填充

作者:赵四司机
  • 2022 年 8 月 11 日
    广东
  • 本文字数:3288 字

    阅读完需:约 11 分钟

Spring-boot项目练习笔记(二)MybatisPlus实现公共字段自动填充


个人简介:


📦个人主页:赵四司机

🏆学习方向:JAVA 后端开发

📣种一棵树最好的时间是十年前,其次是现在!

⏰往期文章:SpringBoot项目整合微信支付

🧡喜欢的话麻烦点点关注喔,你们的支持是我的最大动力。


前言:


最近在跟着视频做 JAVA 入门项目,故开启这一系列的笔记,这也是我第一次进行系统性总结,我将会在这一系列的文章中记录我开发中遇到的问题,希望能帮到有遇到同样问题的人,当然如果有错的还请大家多多指教。

一:问题引入

在进行项目开发对数据库中进行插入更新操作时候,会涉及到一些公共字段的创建,比如创建时间,更新时间,创建人,更新人等。这时候我们可以考虑使用 MybatisPlus 提供的公共字段自动填充,也就是在插入或者更新时候为指定字段赋予指定的值,可以避免重复代码。

二:实现步骤

1.在实体类的属性上加入 @TableField 注释,指定自动填充的策略


package com.my.pro1.pojo;
import com.baomidou.mybatisplus.annotation.FieldFill;import com.baomidou.mybatisplus.annotation.TableField;import lombok.Data;import java.io.Serializable;import java.time.LocalDateTime;
/** * 员工实体 */@Datapublic class Employee implements Serializable {
private static final long serialVersionUID = 1L;
@TableField(fill = FieldFill.INSERT) //插入时填充 private LocalDateTime createTime;
@TableField(fill = FieldFill.INSERT_UPDATE) //插入及更新时填充 private LocalDateTime updateTime;
@TableField(fill = FieldFill.INSERT) private Long createUser;
@TableField(fill = FieldFill.INSERT_UPDATE) private Long updateUser;
}
复制代码


2.按照框架要求编写元数据对象处理器,在此类中统一为公共字段赋值,此类实现 MetaObjectHandler 接口


package com.my.reggie.common;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;import lombok.extern.slf4j.Slf4j;import org.apache.ibatis.reflection.MetaObject;import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
/** * 自定义元数据对象处理器 */@Slf4j@Componentpublic class MyMetaObjectHandler implements MetaObjectHandler { /** * 插入时处理 * @param metaObject */ @Override public void insertFill(MetaObject metaObject) { metaObject.setValue("createTime", LocalDateTime.now()); metaObject.setValue("updateTime", LocalDateTime.now()); }
/** * 更新时处理 * @param metaObject */ @Override public void updateFill(MetaObject metaObject) { metaObject.setValue("updateTime", LocalDateTime.now()); }}
复制代码


这时候就能解决时间自动填充问题,但是这时候发现一个新的问题,我们怎么获取当前登录用户的 id,即怎么设置当前执行创建或者修改操作的用户的 id 呢?因为前面我在 controller 类中设置当用户登录后将该用户的 id 保存在 session 中,这时候很自然就会想到我们可以通过 HttpServletRequest 来获取,但是这时候问题又来了,我们怎么获取 HttpServletRequest 呢?我们以前的做法是在响应 controller 类中加上 HttpServletRequest 参数,然后这时候就能通过 request.getsession().getAttribute()来获取 id。但是现在我们是实现 MetaObjectHandler 接口并对其方法进行了重写,显然我们不能通过参数获取 HttpServletRequest,这时候可能还会想到,Spring 不是可以实现自动装配吗?我们可以通过自动装配来取得 HttpServletRequest,进而得到 session 对象,这个想法应该是想得通的,但是我没有进行实验,因为我要通过另外一种方法来实现,那就是 JDK 提供的一个类----ThreadLocal,顺便借此机会熟悉一下 ThreadLocal。

三:原理

在学习 ThreadLocal 之前,我们需要先知道一个事情,就是客户端发送的每次 http 请求,对应在服务端都会分配一个新的线程来处理,在处理过程中涉及到下面类中的方法都是属于同一个线程:1)LoginFilter 中的 doFilter 方法(拦截器)2)controller 中的 update 中 update 方法 3)MyMetaObjectHandler 中的 updateFill、insertFill 方法此外,ThreadLocal 并不是一个 Thread,而是 Thread 的局部变量。当使用 ThreadLocal 维护变量时,ThreadLocal 为每个使用该变量的线程提供独立的副本,所以每个线程都可以独立地改变自己的副本,而不会影响到其他线程对应的副本,也就是线程之间的数据不是共享的,只有在线程内才能获得对应的值,而在线程外是不能访问的。


我们前面所说的三个方法都属于同一个线程,那么我们就可以通过 ThreadLocal 维护同一个变量从而能够在 MyMetaObjectHandler 中获取当前登录用户 id。ThreadLocal 中有两个常用的方法:public void set(T value) 设置当前线程局部变量的值 public T get() 返回当前线程所对应的线程局部变量的值


至此,我们要做的事就很明确了,在能获取到当前用户 id 的方法中通过 set 方法设置当前线程局部变量,在 MyMetaObjectHandler 中通过 get 方法获取当前线程局部变量 id 的值。上面提到的三个方法中前两个都是可以获取到当前用户 id 的,我们任选一个,我的程序是通过拦截器来实现登录拦截的,所以我在拦截器中设置 id,假如你是通过 SpringBoot 的过滤器来实现登录拦截,你可以在 controller 中设置 id。为了方便调用,提供一个 BaseContext 工具类,然后基于 ThreadLocal 进行封装。


package com.my.pro1.common;
/** * 基于ThreadLocal封装工具类,用户保存和获取当前登录用户id */public class BaseContext { private static final ThreadLocal<Long> threadLocal = new ThreadLocal<>();
/** * 设置id * @param id */ public static void setCurrentId(Long id){ threadLocal.set(id); }
/** * 获取id * @return */ public static Long getCurrentId(){ return threadLocal.get(); }}
复制代码


设置好工具类之后,在 filter 中调用 setCurrent 方法


        //4.判断是否已经登录        if(request.getSession().getAttribute("employee") != null){            // log.info("用户已登录");            //设置当前登录用户id            Long emId = (Long) request.getSession().getAttribute("employee");            BaseContext.setCurrentId(emId);
//放行 filterChain.doFilter(request,response); return; }
复制代码


然后我们就可以在 MyMetaObjectHandler 中通过 get 方法获取 id


package com.my.reggie.common;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;import lombok.extern.slf4j.Slf4j;import org.apache.ibatis.reflection.MetaObject;import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
/** * 自定义元数据对象处理器 */@Slf4j@Componentpublic class MyMetaObjectHandler implements MetaObjectHandler { /** * 插入时处理 * @param metaObject */ @Override public void insertFill(MetaObject metaObject) { metaObject.setValue("createTime", LocalDateTime.now()); metaObject.setValue("updateTime", LocalDateTime.now()); metaObject.setValue("createUser", BaseContext.getCurrentId()); metaObject.setValue("updateUser", BaseContext.getCurrentId()); }
/** * 更新时处理 * @param metaObject */ @Override public void updateFill(MetaObject metaObject) { metaObject.setValue("updateTime", LocalDateTime.now()); metaObject.setValue("updateUser", BaseContext.getCurrentId()); }}
复制代码


至此问题解决,当然这个方法不适用于分布式系统,针对分布式系统该怎么解决我也不是很清楚,有知道的大神还请指教一下,喜欢的话麻烦点个关注,蟹蟹!

发布于: 刚刚阅读数: 3
用户头像

赵四司机

关注

种一棵树最好的时间是十年前,其次是现在 2022.08.06 加入

有人做猪肉佬卖佐十几年猪肉,有人喺大润发汤佐十年鱼,而我只想做一只努力赚钱嘅程序员

评论

发布
暂无评论
Spring-boot项目练习笔记(二)MybatisPlus实现公共字段自动填充_Java web_赵四司机_InfoQ写作社区