java-自定义日志注解

💖简介

创建自定义日志注解，对相关接口记录请求日志。

📖环境

SpringBoot

⭐实现

🌟注解定义

定义注解类

package com.zk.app.annotation;

import com.zk.app.enums.UserLogTypeEnum;

import java.lang.annotation.*;

/**
 * @program: ZK
 * @description: 操作日志注解
 * @author: zk
 * @create: 2024-07-16 15:42
 **/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OperationLog {
    String operation() default "";

    UserLogTypeEnum operationType() default UserLogTypeEnum.OTHER;

    boolean isSaveIp() default true;

    boolean isSavePath() default true;

    boolean isSaveRequestData() default true;

    boolean isSaveUserId() default true;
}

@Target和@Retention是元注解，用来指定自定义注解的作用目标（比如类、方法）及其生命周期（源码级、编译期或运行时）。
ElementType.METHOD 指定注解可以应用于方法
RetentionPolicy.RUNTIME 注解在运行时可用

UserLogTypeEnum日志类型

package com.zk.app.enums;

/**
 * @program: ZK
 * @description: 用户操作日志类型
 * @author: zk
 * @create: 2024-07-16 14:36
 **/
public enum UserLogTypeEnum {
    /**
     * 登录
     */
    LOGIN("登录"),
    /**
     * 登出
     */
    LOGOUT("登出"),
    /**
     * 注册
     */
    REGISTER("注册"),
    /**
     * 查询
     */
    SELECT("查询"),
    /**
     * 插入
     */
    INSERT("插入"),
    /**
     * 更新
     */
    UPDATE("更新"),
    /**
     * 删除
     */
    DELETE("删除"),
    /**
     * 其他
     */
    OTHER("其他");

    private String desc;

    UserLogTypeEnum(String desc) {
        this.desc = desc;
    }

    public String getDesc() {
        return desc;
    }
}

🌟添加依赖

添加aop依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

🌟定义切面

定义切面

package com.zk.app.aop;

import com.zk.app.annotation.OperationLog;
import com.zk.app.constants.StringConstant;
import com.zk.app.entity.UserLog;
import com.zk.app.service.UserLogService;
import com.zk.app.utils.IpUtil;
import com.zk.app.utils.UserThreadLocalUtil;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.util.Objects;

/**
 * @program: ZK
 * @description: 操作日志aop
 * @author: zk
 * @create: 2024-07-16 16:52
 **/
@Aspect
@Component
public class OperationLogAop {
    @Autowired
    private UserLogService userLogService;

    @Pointcut("@annotation(com.zk.app.annotation.OperationLog)")
    public void operationLogCheck() {
    }

    @Around("operationLogCheck()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        Method method =methodSignature.getMethod();
        OperationLog operationLog = method.getAnnotation(OperationLog.class);
        Object proceed = joinPoint.proceed();
        if(Objects.isNull(operationLog)){
            return proceed;
        }
        UserLog userLog = new UserLog();
        if(operationLog.isSaveIp() || operationLog.isSaveRequestData()){
            // 获取HttpServletRequest对象
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
            if(operationLog.isSaveIp()){
                userLog.setLogIp(IpUtil.getIpAddr(request));
            }
            if(operationLog.isSaveRequestData()){
                userLog.setLogContent(StringUtils.join(joinPoint.getArgs(), StringConstant.COMMA));
            }
        }
        userLog.setLogTitle(operationLog.operation());
        userLog.setLogType(operationLog.operationType());
        if(operationLog.isSavePath()){
            userLog.setLogPath(method.getDeclaringClass().getName() + StringConstant.HASH + method.getName());
        }
        if(operationLog.isSaveUserId()){
            userLog.setUserId(UserThreadLocalUtil.getUserId());
        }
        userLogService.saveUserLog(userLog);
        return proceed;
    }
}

@Around注解用于指定环绕通知，即在方法执行前后都进行操作

🌟日志入库

这里将操作记录及入参拆为主子表

@Transactional
public UserLog saveUserLog(UserLog userLog) {
        userLogMapper.insert(userLog);
        if(userLog.getId()>0 && Objects.nonNull(userLog.getLogContent())){
            UserLogExt userLogExt = new UserLogExt();
            Date userLogCreateTime = userLogMapper.selectById(userLog.getId()).getCreateTime();
            userLogExt.setLogId(userLog.getId());
            userLogExt.setCreateDate(userLogCreateTime);
            userLogExt.setLogContent(StringUtil.textStringCheck(userLog.getLogContent()));
            userLogExtService.save(userLogExt);
        }
        return userLog;
    }

🌟数据表

操作日志表

CREATE TABLE `zk_user_log` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMENT '自增id',
  `user_id` bigint NOT NULL DEFAULT '0' COMMENT '操作用户',
  `log_ip` varchar(255) NOT NULL DEFAULT '' COMMENT '操作ip',
  `log_path` varchar(255) NOT NULL DEFAULT '' COMMENT '操作路径',
  `log_type` varchar(255) NOT NULL COMMENT '日志类型',
  `log_title` varchar(255) NOT NULL COMMENT '日志描述',
  `log_status` int NOT NULL DEFAULT '0' COMMENT '日志状态:0正常;1禁用',
  `create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `create_user_id` bigint NOT NULL DEFAULT '0' COMMENT '创建人',
  `update_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
  `update_user_id` bigint NOT NULL DEFAULT '0' COMMENT '修改人',
  `is_delete` tinyint(1) NOT NULL DEFAULT '0' COMMENT '是否删除:0否;1是',
  `remarks` varchar(255) NOT NULL DEFAULT '' COMMENT '备注',
  `version` bigint NOT NULL DEFAULT '0' COMMENT '版本号',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='操作日志表';

操作日志扩展表
按日期进行分区，例如及时清理及减少碎片率
分区键以主表创建日期，便于跟进分区键查询

CREATE TABLE `zk_user_log_ext` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMENT '自增id',
  `log_id` bigint NOT NULL COMMENT '操作日志id',
  `log_content` mediumtext NOT NULL COMMENT '日志详细信息',
  `create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `create_date` date NOT NULL COMMENT '创建日期',
  `create_user_id` bigint NOT NULL DEFAULT '0' COMMENT '创建人',
  `update_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
  `update_user_id` bigint NOT NULL DEFAULT '0' COMMENT '修改人',
  `is_delete` tinyint(1) NOT NULL DEFAULT '0' COMMENT '是否删除:0否;1是',
  `remarks` varchar(255) NOT NULL DEFAULT '' COMMENT '备注',
  `version` bigint NOT NULL DEFAULT '0' COMMENT '版本号',
  PRIMARY KEY (`id`,`create_date`)
) ENGINE=InnoDB AUTO_INCREMENT=12 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci COMMENT='操作日志扩展表'
/*!50500 PARTITION BY RANGE  COLUMNS(create_date)
(PARTITION p20240722 VALUES LESS THAN ('2024-07-23') ENGINE = InnoDB,
 PARTITION p20240723 VALUES LESS THAN ('2024-07-24') ENGINE = InnoDB,
 PARTITION p20240724 VALUES LESS THAN ('2024-07-25') ENGINE = InnoDB,
 PARTITION p20240725 VALUES LESS THAN ('2024-07-26') ENGINE = InnoDB,
 PARTITION p20240726 VALUES LESS THAN ('2024-07-27') ENGINE = InnoDB,
 PARTITION p20240727 VALUES LESS THAN ('2024-07-28') ENGINE = InnoDB,
 PARTITION p20240728 VALUES LESS THAN ('2024-07-29') ENGINE = InnoDB,
 PARTITION p20240729 VALUES LESS THAN ('2024-07-30') ENGINE = InnoDB,
 PARTITION p20240730 VALUES LESS THAN ('2024-07-31') ENGINE = InnoDB,
 PARTITION p20240731 VALUES LESS THAN ('2024-08-01') ENGINE = InnoDB,
 PARTITION p20240801 VALUES LESS THAN ('2024-08-02') ENGINE = InnoDB,
 PARTITION p20240802 VALUES LESS THAN ('2024-08-03') ENGINE = InnoDB,
 PARTITION p20240803 VALUES LESS THAN ('2024-08-04') ENGINE = InnoDB,
 PARTITION p20240804 VALUES LESS THAN ('2024-08-05') ENGINE = InnoDB) */;

分区自动维护可见：
mysql分区自动维护(SpringBoot+MybatisPlus)

🌟工具类

IP工具类

package com.zk.app.utils;

import javax.servlet.http.HttpServletRequest;
import java.net.InetAddress;
import java.net.UnknownHostException;

/**
 * @program: ZK
 * @description: ip工具
 * @author: zk
 * @create: 2024-07-16 15:57
 **/
public class IpUtil {

    private static final String UNKNOWN = "unknown";
    private static final String LOCALHOST = "127.0.0.1";
    private static final String SEPARATOR = ",";

    /**
     * 获取当前请求ip地址
     *
     * @param request 请求对象
     * @return 返回当前ip
     */
    public static String getIpAddr(HttpServletRequest request) {
        String ipAddress;
        try {
            ipAddress = request.getHeader("x-forwarded-for");
            if (ipAddress == null || ipAddress.length() == 0 || UNKNOWN.equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getHeader("Proxy-Client-IP");
            }
            if (ipAddress == null || ipAddress.length() == 0 || UNKNOWN.equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getHeader("WL-Proxy-Client-IP");
            }
            if (ipAddress == null || ipAddress.length() == 0 || UNKNOWN.equalsIgnoreCase(ipAddress)) {
                ipAddress = request.getRemoteAddr();
                if (LOCALHOST.equals(ipAddress)) {
                    InetAddress inet = null;
                    try {
                        inet = InetAddress.getLocalHost();
                    } catch (UnknownHostException e) {
                        e.printStackTrace();
                    }
                    ipAddress = inet.getHostAddress();
                }
            }
            // 对于通过多个代理的情况，第一个IP为客户端真实IP,多个IP按照','分割
            // "***.***.***.***".length()
            if (ipAddress != null && ipAddress.length() > 15) {
                if (ipAddress.indexOf(SEPARATOR) > 0) {
                    ipAddress = ipAddress.substring(0, ipAddress.indexOf(","));
                }
            }
        } catch (Exception e) {
            ipAddress = "";
        }
        return ipAddress;
    }
}

✨应用注解

在对应方法上加上注解即可

@OperationLog(operation = "获取列表", operationType = UserLogTypeEnum.SELECT)

不同类型可根据枚举类配置

结束