快捷導(dǎo)航

MyBatis攔截器如何自動設(shè)置創(chuàng)建時間和修改時間

更新時間：2025年02月11日 11:09:36 作者：倫敦城下的小鞋匠

文章介紹了如何通過實現(xiàn)MyBatis的Interceptor接口,在實體類中自動設(shè)置創(chuàng)建時間和修改時間,從而提高開發(fā)效率

前言

在日常的插入和修改的時候要頻繁的插入時間，浪費時間，可以通過實現(xiàn)mybatis的 Intercepts注解來實現(xiàn)，獲取實體，并且在實體里面插入日期

一、實現(xiàn)Interceptor接口，并寫相關(guān)邏輯

package com.ruoyi.common.filter;

import com.ruoyi.common.core.domain.BaseEntity;
import com.ruoyi.common.exception.base.BaseException;
import com.ruoyi.common.utils.SecurityUtils;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.SqlCommandType;
import org.apache.ibatis.plugin.*;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.Properties;


/**
 *  Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)   攔截執(zhí)行器的方法
	ParameterHandler (getParameterObject, setParameters)	攔截參數(shù)的處理
	ResultSetHandler (handleResultSets, handleOutputParameters)	攔截結(jié)果集的處理
	StatementHandler (prepare, parameterize, batch, update, query) 攔截Sql語法構(gòu)建的處理
 * @author Administrator
 *
 */
@Intercepts({@Signature(type = Executor.class,method = "update",args = {MappedStatement.class,Object.class})})
@Component
public class HandleTimeInterceptor implements Interceptor {

	@Override
	public Object intercept(Invocation invocation) throws Throwable {
		 Object[] args = invocation.getArgs();
		 MappedStatement mappedStatement = (MappedStatement) args[0];
		 SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();
		 if(sqlCommandType== SqlCommandType.UPDATE) {
			 if(args[1] instanceof BaseEntity) {
				BaseEntity baseEntity = (BaseEntity) args[1];
				baseEntity.setUpdateTime(new Date());
				String userId="";
				 try
				 {
					 userId= SecurityUtils.getUserId().toString();
				 }catch (Exception e){
					// throw new BaseException("當(dāng)前沒有登錄人");

				 }
				baseEntity.setUpdateBy(userId);
			 }
		 }else if(sqlCommandType==SqlCommandType.INSERT) {
			 if(args[1] instanceof BaseEntity) {
				BaseEntity baseEntity = (BaseEntity) args[1];
				baseEntity.setCreateTime(new Date());
				String userId="";
				try
				{
				 userId= SecurityUtils.getUserId().toString();
				}catch (Exception e){
					//throw new BaseException("當(dāng)前沒有登錄人");
				}
				baseEntity.setCreateBy(userId);
			}
		 }

		return invocation.proceed();
	}

	@Override
	public Object plugin(Object target) {
		return Plugin.wrap(target, this);
	}

	@Override
	public void setProperties(Properties properties) {
	}
}

二、將插件注冊到mybatis 的配置文件 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>
    <!-- 全局參數(shù) -->
    <settings>
        <!-- 使全局的映射器啟用或禁用緩存 -->
        <setting name="cacheEnabled"             value="true"   />
        <!-- 允許JDBC 支持自動生成主鍵 -->
        <setting name="useGeneratedKeys"         value="true"   />
        <!-- 配置默認的執(zhí)行器.SIMPLE就是普通執(zhí)行器;REUSE執(zhí)行器會重用預(yù)處理語句(prepared statements);BATCH執(zhí)行器將重用語句并執(zhí)行批量更新 -->
        <setting name="defaultExecutorType"      value="SIMPLE" />
		<!-- 指定 MyBatis 所用日志的具體實現(xiàn) -->
        <setting name="logImpl"                  value="SLF4J"  />
        <!-- 使用駝峰命名法轉(zhuǎn)換字段 -->
		 <setting name="mapUnderscoreToCamelCase" value="true"/>
	</settings>
    <plugins>
        <plugin interceptor="com.ruoyi.common.filter.HandleTimeInterceptor"></plugin>

    </plugins>
</configuration>