首页 > 其他分享 >若依Cloud操作日志

若依Cloud操作日志

时间：2024-07-22 13:57:40浏览次数：12  
标签：String operLog private 若依 import 日志 com public Cloud

能耗管理平台

新增功能操作日志

操作日志

1.表结构实体类

package com.mgiot.infra.entity.log;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;

import java.io.Serializable;
import java.time.LocalDateTime;

@Data
@TableName("oper_log")
@Schema(defaultValue = "OperLog对象", description = "")
public class OperLog extends Model<OperLog> {

    private static final long serialVersionUID = 1L;

    @Schema(defaultValue = "日志主键")
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    @Schema(defaultValue = "模块标题")
    private String title;

    @Schema(defaultValue = "业务类型（0其它 1新增 2修改 3删除）")
    private Integer businessType;

    @Schema(defaultValue = "方法名称")
    private String method;

    @Schema(defaultValue = "请求方式")
    private String requestMethod;

    @Schema(defaultValue = "操作类别（0其它 1后台用户 2手机端用户）")
    private Integer operatorType;

    @Schema(defaultValue = "操作人员")
    private String operName;

    @Schema(defaultValue = "部门名称")
    private String deptName;

    @Schema(defaultValue = "请求URL")
    private String operUrl;

    @Schema(defaultValue = "主机地址")
    private String operIp;

    @Schema(defaultValue = "操作地点")
    private String operLocation;

    @Schema(defaultValue = "请求参数")
    private String operParam;

    @Schema(defaultValue = "返回参数")
    private String jsonResult;

    @Schema(defaultValue = "操作状态（0正常 1异常）")
    private String status;

    @Schema(defaultValue = "错误消息")
    private String errorMsg;

    @Schema(defaultValue = "操作时间")
    private LocalDateTime operTime;

    @Schema(defaultValue = "消耗时间")
    private Long costTime;
}

2.创建自定义注解@Log

a.目录结构

b.相关代码(按目录结构)

annotation

package com.mgiot.infra.processor.annotation;

import com.mgiot.infra.processor.enums.BusinessType;
import com.mgiot.infra.processor.enums.OperatorType;

import java.lang.annotation.*;

/**
 * 自定义操作日志记录注解
 */
@Target({ ElementType.PARAMETER, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
    /**
     * 模块
     */
    public String title() default "";

    /**
     * 功能
     */
    public BusinessType businessType() default BusinessType.OTHER;

    /**
     * 操作人类别
     */
    public OperatorType operatorType() default OperatorType.MANAGE;

    /**
     * 是否保存请求的参数
     */
    public boolean isSaveRequestData() default true;

    /**
     * 是否保存响应的参数
     */
    public boolean isSaveResponseData() default true;

    /**
     * 排除指定的请求参数
     */
    public String[] excludeParamNames() default {};
}

aspect 

package com.mgiot.infra.processor.aspect;

import com.alibaba.fastjson2.JSON;
import com.mgiot.infra.constants.SecurityConstants;
import com.mgiot.infra.entity.log.OperLog;
import com.mgiot.infra.processor.annotation.Log;
import com.mgiot.infra.processor.enums.BusinessStatus;
import com.mgiot.infra.processor.filter.PropertyPreExcludeFilter;
import com.mgiot.infra.processor.service.AsyncLogService;
import com.mgiot.infra.util.AddressUtils;
import com.mgiot.infra.util.IpUtils;
import com.mgiot.infra.util.JwtUtils;
import com.mgiot.infra.util.ServletUtils;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.NamedThreadLocal;
import org.springframework.http.HttpMethod;
import org.springframework.stereotype.Component;
import org.springframework.validation.BindingResult;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.multipart.MultipartFile;

import java.util.Collection;
import java.util.Map;

/**
 * 操作日志记录处理
 */
@Aspect
@Component
public class LogAspect {
    private static final Logger            log                = LoggerFactory.getLogger(LogAspect.class);
    /**
     * 排除敏感属性字段
     */
    public static final  String[]          EXCLUDE_PROPERTIES = {"password", "oldPassword", "newPassword", "confirmPassword"};
    /**
     * 计算操作消耗时间
     */
    private static final ThreadLocal<Long> TIME_THREADLOCAL   = new NamedThreadLocal<Long>("Cost Time");

    @Autowired
    private OperLogService operLogService;

    /**
     * 处理请求前执行
     */
    @Before(value = "@annotation(controllerLog)")
    public void boBefore(JoinPoint joinPoint, Log controllerLog) {
        TIME_THREADLOCAL.set(System.currentTimeMillis());
    }

    /**
     * 处理完请求后执行
     *
     * @param joinPoint 切点
     */
    @AfterReturning(pointcut = "@annotation(controllerLog)", returning = "jsonResult")
    public void doAfterReturning(JoinPoint joinPoint, Log controllerLog, Object jsonResult) {
        handleLog(joinPoint, controllerLog, null, jsonResult);
    }

    /**
     * 拦截异常操作
     *
     * @param joinPoint 切点
     * @param e         异常
     */
    @AfterThrowing(value = "@annotation(controllerLog)", throwing = "e")
    public void doAfterThrowing(JoinPoint joinPoint, Log controllerLog, Exception e) {
        handleLog(joinPoint, controllerLog, e, null);
    }

    protected void handleLog(final JoinPoint joinPoint, Log controllerLog, final Exception e, Object jsonResult) {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        String token = request.getHeader(SecurityConstants.AUTHORIZATION_HEADER);
        try {
            // *========数据库日志=========*//
            OperLog operLog = new OperLog();
            operLog.setStatus(String.valueOf(BusinessStatus.SUCCESS.ordinal()));
            // 请求的地址
            String ip = IpUtils.getIpAddr();
            operLog.setOperIp(ip);
            String address = AddressUtils.getRealAddressByIP(ip);
            operLog.setOperLocation(address);
            operLog.setOperUrl(StringUtils.substring(ServletUtils.getRequest().getRequestURI(), 0, 255));
            String username = JwtUtils.getUserName(token);
            if (StringUtils.isNotBlank(username)) {
                operLog.setOperName(username);
            }

            if (e != null) {
                operLog.setStatus(String.valueOf(BusinessStatus.FAIL.ordinal()));
                operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
            }
            // 设置方法名称
            String className  = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            operLog.setMethod(className + "." + methodName + "()");
            // 设置请求方式
            operLog.setRequestMethod(ServletUtils.getRequest().getMethod());
            // 处理设置注解上的参数
            getControllerMethodDescription(joinPoint, controllerLog, operLog, jsonResult);
            // 设置消耗时间
            operLog.setCostTime(System.currentTimeMillis() - TIME_THREADLOCAL.get());
            // 保存数据库
            operLogService.saveOperLog(operLog);
        } catch (Exception exp) {
            // 记录本地异常日志
            log.error("异常信息:{}", exp.getMessage());
            exp.printStackTrace();
        } finally {
            TIME_THREADLOCAL.remove();
        }
    }

    /**
     * 获取注解中对方法的描述信息 用于Controller层注解
     *
     * @param log     日志
     * @param operLog 操作日志
     * @throws Exception
     */
    public void getControllerMethodDescription(JoinPoint joinPoint, Log log, OperLog operLog, Object jsonResult) throws Exception {
        // 设置action动作
        operLog.setBusinessType(log.businessType().ordinal());
        // 设置标题
        operLog.setTitle(log.title());
        // 设置操作人类别
        operLog.setOperatorType(log.operatorType().ordinal());
        // 是否需要保存request，参数和值
        if (log.isSaveRequestData()) {
            // 获取参数的信息，传入到数据库中。
            setRequestValue(joinPoint, operLog, log.excludeParamNames());
        }
        // 是否需要保存response，参数和值
        if (log.isSaveResponseData() && StringUtils.isNotEmpty((CharSequence) jsonResult)) {
            operLog.setJsonResult(StringUtils.substring(JSON.toJSONString(jsonResult), 0, 2000));
        }
    }

    /**
     * 获取请求的参数，放到log中
     *
     * @param operLog 操作日志
     * @throws Exception 异常
     */
    private void setRequestValue(JoinPoint joinPoint, OperLog operLog, String[] excludeParamNames) throws Exception {
        String    requestMethod = operLog.getRequestMethod();
        Map<?, ?> paramsMap     = ServletUtils.getParamMap(ServletUtils.getRequest());
        if (StringUtils.isEmpty((CharSequence) paramsMap) && (HttpMethod.PUT.name().equals(requestMethod) || HttpMethod.POST.name().equals(requestMethod))) {
            String params = argsArrayToString(joinPoint.getArgs(), excludeParamNames);
            operLog.setOperParam(StringUtils.substring(params, 0, 2000));
        } else {
            operLog.setOperParam(StringUtils.substring(JSON.toJSONString(paramsMap, excludePropertyPreFilter(excludeParamNames)), 0, 2000));
        }
    }

    /**
     * 参数拼装
     */
    private String argsArrayToString(Object[] paramsArray, String[] excludeParamNames) {
        String params = "";
        if (paramsArray != null && paramsArray.length > 0) {
            for (Object o : paramsArray) {
                if (StringUtils.isNotEmpty((CharSequence) o) && !isFilterObject(o)) {
                    try {
                        String jsonObj = JSON.toJSONString(o, excludePropertyPreFilter(excludeParamNames));
                        params += jsonObj.toString() + " ";
                    } catch (Exception e) {
                    }
                }
            }
        }
        return params.trim();
    }

    /**
     * 忽略敏感属性
     */
    public PropertyPreExcludeFilter excludePropertyPreFilter(String[] excludeParamNames) {
        return new PropertyPreExcludeFilter().addExcludes(ArrayUtils.addAll(EXCLUDE_PROPERTIES, excludeParamNames));
    }

    /**
     * 判断是否需要过滤的对象。
     *
     * @param o 对象信息。
     * @return 如果是需要过滤的对象，则返回true；否则返回false。
     */
    @SuppressWarnings("rawtypes")
    public boolean isFilterObject(final Object o) {
        Class<?> clazz = o.getClass();
        if (clazz.isArray()) {
            return clazz.getComponentType().isAssignableFrom(MultipartFile.class);
        } else if (Collection.class.isAssignableFrom(clazz)) {
            Collection collection = (Collection) o;
            for (Object value : collection) {
                return value instanceof MultipartFile;
            }
        } else if (Map.class.isAssignableFrom(clazz)) {
            Map map = (Map) o;
            for (Object value : map.entrySet()) {
                Map.Entry entry = (Map.Entry) value;
                return entry.getValue() instanceof MultipartFile;
            }
        }
        return o instanceof MultipartFile || o instanceof HttpServletRequest || o instanceof HttpServletResponse || o instanceof BindingResult;
    }
}

enums

package com.mgiot.infra.processor.enums;

/**
 * 操作状态
 */
public enum BusinessStatus {
    /**
     * 成功
     */
    SUCCESS,

    /**
     * 失败
     */
    FAIL,
}

package com.mgiot.infra.processor.enums;

/**
 * 业务操作类型
 */
public enum BusinessType {
    /**
     * 其它
     */
    OTHER,

    /**
     * 新增
     */
    INSERT,

    /**
     * 修改
     */
    UPDATE,

    /**
     * 删除
     */
    DELETE,

    /**
     * 授权
     */
    GRANT,

    /**
     * 导出
     */
    EXPORT,

    /**
     * 导入
     */
    IMPORT,

    /**
     * 强退
     */
    FORCE,

    /**
     * 生成代码
     */
    GENCODE,

    /**
     * 清空数据
     */
    CLEAN,
}

package com.mgiot.infra.processor.enums;

/**
 * 操作人类别
 */
public enum OperatorType {
    /**
     * 其它
     */
    OTHER,

    /**
     * 后台用户
     */
    MANAGE,

    /**
     * 手机端用户
     */
    MOBILE
}

filter

package com.mgiot.infra.processor.filter;

import com.alibaba.fastjson2.filter.SimplePropertyPreFilter;

/**
 * 排除JSON敏感属性
 */
public class PropertyPreExcludeFilter extends SimplePropertyPreFilter {
    public PropertyPreExcludeFilter() {
    }

    public PropertyPreExcludeFilter addExcludes(String... filters) {
        for (int i = 0; i < filters.length; i++) {
            this.getExcludes().add(filters[i]);
        }
        return this;
    }
}

service

package com.mgiot.infra.processor.service;

import com.mgiot.infra.constants.SecurityConstants;
import com.mgiot.infra.entity.log.OperLog;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;

/**
 * 异步调用日志服务
 */
@Service
public class AsyncLogService {

    @Autowired
    private OperLogService operLogService;

    /**
     * 保存系统日志记录
     */
    @Async
    public void saveSysLog(OperLog operLog) throws Exception {
        operLogService.saveLog(operLog);
    }

}
c.操作使用

在控制层方法上添加注解

@Log(title = "添加", businessType = BusinessType.INSERT)

标签：String,operLog,private,若依,import,日志,com,public,Cloud
From： https://blog.csdn.net/m0_69146489/article/details/140606907

相关文章

  • ABP vNext—审计日志使用
    ABPvNext—审计日志关于审计日志开启审计日志如何自定义审计日志关于审计日志审计跟踪（也称为审核日志）是一个安全相关的时间顺序记录，记录这些记录的目的是为已经影响在任何时候的详细操作，提供程序运行的证明文件记录、源或事件。ABP提供了能够为应用程序交互自动记......
  • Windows生产设备日志采集工具
    永久免费:前往Gitee最新版本更新内容Winform全部切换到.NetFramework4.0.更符合大部分的自动化设备.Web提供.NetFramework4.0的运行时环境安装包Web打开时,若当前IP为设备,直接显示设备信息介绍用途:定时全量或增量采集工控机,办公电脑文件以及日志.(SCADA,Io......
  • 如何从命令行设置日志记录级别
    我使用argparse从命令行获取日志记录级别，然后将其作为logging.basicConfig的输入传递。然而，我试图实现这一点的方式不起作用。有什么建议吗？期望的行为，来自命令行：pythonmain.py-log=DEBUG期望的输出DEBUG:__main__:Debugisworking代码importloggingimp......
  • 机械学习—零基础学习日志（高数08——函数周期性）
    零基础为了学人工智能，真的开始复习高数函数的性质，开始新的学习！周期性：周期函数的合理运用就是，确定了最小周期T，以这个周期T在函数f(x)里面任意位置夹住的面积是相同的。（个人不权威表述，大概这个意思）张宇老师没有讲解第一个结论的证明，但是我还是有点疑惑的。所以，自己写了一......
  • springcloud与dubbo分别基于什么实现的
    SpringCloud组件：服务注册与发现：Eureka：SpringCloud中的服务注册与发现组件，服务提供者将自身注册到Eureka中，服务消费者从Eureka中获取服务提供者的信息。负载均衡：Ribbon：客户端负载均衡组件，它可以在客户端实现负载均衡，通过扩展Eureka实现服务调用时的负载均衡。断路器：......
  • 苹果系统注入三码，避免封号，解锁iCloud/FaceTime/iMessage/随航！
    黑苹果遇到的问题多种多样，这是一篇比较简单直接的、适合大部分配置的教程，如果解决不了你的问题，请见谅。如果完成三码注入后iMessage和FaceTime仍不能正常工作，需要考虑主板NVRAM支持问题。随航功能（Sidecar）仅支持macOSCatalina及以上，基本开启要求参阅官网，其中特别需要说明的......
  • nginx日志切割定时任务
    目录nginx进行日志切割的好处：实现步骤：1.给access.log日志文件重命名，并备份2.编写定时日志脚本     3.运行日志切割脚本4.将日志切割脚本加入crontab定时任务crontab定时任务配置讲解nginx进行日志切割的好处：便于管理和查询：随着时间的推移，Nginx日志文......
  • SeleniumBase 示例失败 Cloudflare Turnstile
    我在尝试自动提交包含CloudflareTurnstileCAPTCHA的表单时遇到了SeleniumBase的问题。等待7秒后尝试查找iframe元素时，脚本失败并出现NoSuchElementException。https://github.com/seleniumbase/SeleniumBase/blob/master/examples/raw_form_turnstile.pyfr......
  • Libtorch与QTOpenCV 和 Point Cloud Library 一起使用时出现错误
    我正在尝试在项目中使用libtorch、qt小部件、点云库（pcl）和opencv。对于这个项目，我使用的是cmake列表。问题是当我同时使用所有四个库时，libtorch会抛出错误。如果我使用libtorch、opencv和qt，一切正常，如果我使用pclqt和opencv，一切也都很好。我得到的错误列在下面：/libto......
  • 玄机-第二章日志分析-mysql应急响应
    文章目录前言简介应急开始准备工作日志分析步骤1步骤2步骤3步骤4总结补充erro.log前言这里应急需要知道mysql提权的一些姿势，还有能够提权成功的前提。5金币就当复习一下了。这里考察的是mysql应急响应，我们应该是根据找flag的需求去就行，但是我做了之后发现......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99