SpringBoot自定義注解如何解決公共字段填充問題

更新時間：2025年03月10日 10:29:20 作者：今天的接口寫完了嗎？

本文介紹了在系統(tǒng)開發(fā)中,如何使用AOP切面編程實現(xiàn)公共字段自動填充的功能,從而簡化代碼,通過自定義注解和切面類,可以統(tǒng)一處理創(chuàng)建時間和修改時間,以及創(chuàng)建人和修改人的賦值操作

1.1 問題分析

在新增員工或者新增菜品分類時需要設(shè)置創(chuàng)建時間、創(chuàng)建人、修改時間、修改人等字段，在編輯員工或者編輯菜品分類時需要設(shè)置修改時間、修改人等字段。

這些字段屬于公共字段，也就是也就是在我們的系統(tǒng)中很多表中都會有這些字段，如下：

序號	字段名	含義	數(shù)據(jù)類型
1	create_time	創(chuàng)建時間	datetime
2	create_user	創(chuàng)建人id	bigint
3	update_time	修改時間	datetime
4	update_user	修改人id	bigint

而針對于這些字段，我們的賦值方式為：

1). 在新增數(shù)據(jù)時, 將createTime、updateTime 設(shè)置為當(dāng)前時間, createUser、updateUser設(shè)置為當(dāng)前登錄用戶ID。

2). 在更新數(shù)據(jù)時, 將updateTime 設(shè)置為當(dāng)前時間, updateUser設(shè)置為當(dāng)前登錄用戶ID。

目前,在我們的項目中處理這些字段都是在每一個業(yè)務(wù)方法中進(jìn)行賦值操作,如下:

新增員工方法：

	/**
     * 新增員工
     *
     * @param employeeDTO
     */
    public void save(EmployeeDTO employeeDTO) {
        //.......................
		//
        //設(shè)置當(dāng)前記錄的創(chuàng)建時間和修改時間
        employee.setCreateTime(LocalDateTime.now());
        employee.setUpdateTime(LocalDateTime.now());

        //設(shè)置當(dāng)前記錄創(chuàng)建人id和修改人id
        employee.setCreateUser(BaseContext.getCurrentId());//目前寫個假數(shù)據(jù)，后期修改
        employee.setUpdateUser(BaseContext.getCurrentId());
		///
        employeeMapper.insert(employee);
    }

編輯員工方法：

	/**
     * 編輯員工信息
     *
     * @param employeeDTO
     */
    public void update(EmployeeDTO employeeDTO) {
       //........................................
	   ///
        employee.setUpdateTime(LocalDateTime.now());
        employee.setUpdateUser(BaseContext.getCurrentId());
       ///

        employeeMapper.update(employee);
    }

新增菜品分類方法：

	/**
     * 新增分類
     * @param categoryDTO
     */
    public void save(CategoryDTO categoryDTO) {
       //....................................
       //
        //設(shè)置創(chuàng)建時間、修改時間、創(chuàng)建人、修改人
        category.setCreateTime(LocalDateTime.now());
        category.setUpdateTime(LocalDateTime.now());
        category.setCreateUser(BaseContext.getCurrentId());
        category.setUpdateUser(BaseContext.getCurrentId());
        ///

        categoryMapper.insert(category);
    }

修改菜品分類方法：

	/**
     * 修改分類
     * @param categoryDTO
     */
    public void update(CategoryDTO categoryDTO) {
        //....................................
        
		//
        //設(shè)置修改時間、修改人
        category.setUpdateTime(LocalDateTime.now());
        category.setUpdateUser(BaseContext.getCurrentId());
        //

        categoryMapper.update(category);
    }

如果都按照上述的操作方式來處理這些公共字段, 需要在每一個業(yè)務(wù)方法中進(jìn)行操作, 編碼相對冗余、繁瑣，那能不能對于這些公共字段在某個地方統(tǒng)一處理，來簡化開發(fā)呢？

答案是可以的，我們使用AOP切面編程，實現(xiàn)功能增強，來完成公共字段自動填充功能。

1.2 實現(xiàn)思路

在實現(xiàn)公共字段自動填充，也就是在插入或者更新的時候為指定字段賦予指定的值，使用它的好處就是可以統(tǒng)一對這些字段進(jìn)行處理，避免了重復(fù)代碼。

在上述的問題分析中，我們提到有四個公共字段，需要在新增/更新中進(jìn)行賦值操作, 具體情況如下:

序號	字段名	含義	數(shù)據(jù)類型	操作類型
1	create_time	創(chuàng)建時間	datetime	insert
2	create_user	創(chuàng)建人id	bigint	insert
3	update_time	修改時間	datetime	insert、update
4	update_user	修改人id	bigint	insert、update

實現(xiàn)步驟：

1). 自定義注解 AutoFill，用于標(biāo)識需要進(jìn)行公共字段自動填充的方法

2). 自定義切面類 AutoFillAspect，統(tǒng)一攔截加入了 AutoFill 注解的方法，通過反射為公共字段賦值

3). 在 Mapper 的方法上加入 AutoFill 注解

若要實現(xiàn)上述步驟，需掌握以下知識(之前課程內(nèi)容都學(xué)過)

**技術(shù)點：**枚舉、注解、AOP、反射

1.3 代碼開發(fā)

按照上一小節(jié)分析的實現(xiàn)步驟依次實現(xiàn)，共三步。

1.3.1 步驟一

自定義注解 AutoFill

進(jìn)入到sky-server模塊，創(chuàng)建com.sky.annotation包。

package com.sky.annotation;

import com.sky.enumeration.OperationType;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定義注解，用于標(biāo)識某個方法需要進(jìn)行功能字段自動填充處理
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AutoFill {
    //數(shù)據(jù)庫操作類型：UPDATE INSERT
    OperationType value();
}

其中OperationType已在sky-common模塊中定義

package com.sky.enumeration;

/**
 * 數(shù)據(jù)庫操作類型
 */
public enum OperationType {

    /**
     * 更新操作
     */
    UPDATE,

    /**
     * 插入操作
     */
    INSERT
}

1.3.2 步驟二

自定義切面 AutoFillAspect

在sky-server模塊，創(chuàng)建com.sky.aspect包。

package com.sky.aspect;

/**
 * 自定義切面，實現(xiàn)公共字段自動填充處理邏輯
 */
@Aspect
@Component
@Slf4j
public class AutoFillAspect {

    /**
     * 切入點
     */
    @Pointcut("execution(* com.sky.mapper.*.*(..)) && @annotation(com.sky.annotation.AutoFill)")
    public void autoFillPointCut(){}

    /**
     * 前置通知，在通知中進(jìn)行公共字段的賦值
     */
    @Before("autoFillPointCut()")
    public void autoFill(JoinPoint joinPoint){
        /重要
        //可先進(jìn)行調(diào)試，是否能進(jìn)入該方法 提前在mapper方法添加AutoFill注解
        log.info("開始進(jìn)行公共字段自動填充...");

    }
}

完善自定義切面 AutoFillAspect 的 autoFill 方法

package com.sky.aspect;

import com.sky.annotation.AutoFill;
import com.sky.constant.AutoFillConstant;
import com.sky.context.BaseContext;
import com.sky.enumeration.OperationType;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
import java.time.LocalDateTime;

/**
 * 自定義切面，實現(xiàn)公共字段自動填充處理邏輯
 */
@Aspect
@Component
@Slf4j
public class AutoFillAspect {

    /**
     * 切入點
     */
    @Pointcut("execution(* com.sky.mapper.*.*(..)) && @annotation(com.sky.annotation.AutoFill)")
    public void autoFillPointCut(){}

    /**
     * 前置通知，在通知中進(jìn)行公共字段的賦值
     */
    @Before("autoFillPointCut()")
    public void autoFill(JoinPoint joinPoint){
        log.info("開始進(jìn)行公共字段自動填充...");

        //獲取到當(dāng)前被攔截的方法上的數(shù)據(jù)庫操作類型
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();//方法簽名對象
        AutoFill autoFill = signature.getMethod().getAnnotation(AutoFill.class);//獲得方法上的注解對象
        OperationType operationType = autoFill.value();//獲得數(shù)據(jù)庫操作類型

        //獲取到當(dāng)前被攔截的方法的參數(shù)--實體對象
        Object[] args = joinPoint.getArgs();
        if(args == null || args.length == 0){
            return;
        }

        Object entity = args[0];

        //準(zhǔn)備賦值的數(shù)據(jù)
        LocalDateTime now = LocalDateTime.now();
        Long currentId = BaseContext.getCurrentId();

        //根據(jù)當(dāng)前不同的操作類型，為對應(yīng)的屬性通過反射來賦值
        if(operationType == OperationType.INSERT){
            //為4個公共字段賦值
            try {
                Method setCreateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_CREATE_TIME, LocalDateTime.class);
                Method setCreateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_CREATE_USER, Long.class);
                Method setUpdateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_TIME, LocalDateTime.class);
                Method setUpdateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_USER, Long.class);

                //通過反射為對象屬性賦值
                setCreateTime.invoke(entity,now);
                setCreateUser.invoke(entity,currentId);
                setUpdateTime.invoke(entity,now);
                setUpdateUser.invoke(entity,currentId);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }else if(operationType == OperationType.UPDATE){
            //為2個公共字段賦值
            try {
                Method setUpdateTime = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_TIME, LocalDateTime.class);
                Method setUpdateUser = entity.getClass().getDeclaredMethod(AutoFillConstant.SET_UPDATE_USER, Long.class);

                //通過反射為對象屬性賦值
                setUpdateTime.invoke(entity,now);
                setUpdateUser.invoke(entity,currentId);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

1.3.3 步驟三

在Mapper接口的方法上加入 AutoFill 注解

以CategoryMapper為例，分別在新增和修改方法添加@AutoFill()注解，也需要EmployeeMapper做相同操作

package com.sky.mapper;

@Mapper
public interface CategoryMapper {
    /**
     * 插入數(shù)據(jù)
     * @param category
     */
    @Insert("insert into category(type, name, sort, status, create_time, update_time, create_user, update_user)" +
            " VALUES" +
            " (#{type}, #{name}, #{sort}, #{status}, #{createTime}, #{updateTime}, #{createUser}, #{updateUser})")
    @AutoFill(value = OperationType.INSERT)
    void insert(Category category);
    /**
     * 根據(jù)id修改分類
     * @param category
     */
    @AutoFill(value = OperationType.UPDATE)
    void update(Category category);

}

同時，將業(yè)務(wù)層為公共字段賦值的代碼注釋掉。

1). 將員工管理的新增和編輯方法中的公共字段賦值的代碼注釋。

2). 將菜品分類管理的新增和修改方法中的公共字段賦值的代碼注釋。