cn.flood.log.aspect.AuditLogAspect Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flood-spring-cloud-starter-log Show documentation
The newest version!
package cn.flood.log.aspect;

import cn.flood.Func;
import cn.flood.UserToken;
import cn.flood.http.CustomSystemUtils;
import cn.flood.http.IPUtils;
import cn.flood.http.WebUtil;
import cn.flood.json.JsonUtils;
import cn.flood.log.annotation.AuditLog;
import cn.flood.log.model.Audit;
import cn.flood.log.properties.AuditLogProperties;
import cn.flood.log.services.IAuditService;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.core.DefaultParameterNameDiscoverer;
import org.springframework.expression.EvaluationContext;
import org.springframework.expression.Expression;
import org.springframework.expression.spel.standard.SpelExpressionParser;
import org.springframework.expression.spel.support.StandardEvaluationContext;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.io.Serializable;
import java.time.LocalDateTime;
import java.util.HashMap;
import java.util.Map;

/**
 * 审计日志切面
 *
 */
@Slf4j
@Aspect
@ConditionalOnClass({HttpServletRequest.class, RequestContextHolder.class})
public class AuditLogAspect {
    @Value("${spring.application.name}")
    private String applicationName;

    private AuditLogProperties auditLogProperties;
    private IAuditService auditService;

    public AuditLogAspect(AuditLogProperties auditLogProperties, IAuditService auditService) {
        this.auditLogProperties = auditLogProperties;
        this.auditService = auditService;
        log.info("================ AuditLogAspect ======================");
    }

    /**
     * 用于SpEL表达式解析.
     */
    private SpelExpressionParser spelExpressionParser = new SpelExpressionParser();
    /**
     * 用于获取方法参数定义名字.
     */
    private DefaultParameterNameDiscoverer nameDiscoverer = new DefaultParameterNameDiscoverer();

    @Before("@within(auditLog) || @annotation(auditLog)")
    public void beforeMethod(JoinPoint joinPoint, AuditLog auditLog) {
        //判断功能是否开启
        if (auditLogProperties.getEnabled()) {
            if (auditService == null) {
                log.warn("AuditLogAspect - auditService is null");
                return;
            }
            if (auditLog == null) {
                // 获取类上的注解
                auditLog = joinPoint.getTarget().getClass().getDeclaredAnnotation(AuditLog.class);
            }
            Audit audit = getAudit(auditLog, joinPoint);
            auditService.save(audit);
        }
    }

    /**
     * 解析spEL表达式
     */
    private String getValBySpEL(String spEL, MethodSignature methodSignature, Object[] args) {
        //获取方法形参名数组
        String[] paramNames = nameDiscoverer.getParameterNames(methodSignature.getMethod());
        if (paramNames != null && paramNames.length > 0) {
            Expression expression = spelExpressionParser.parseExpression(spEL);
            // spring的表达式上下文对象
            EvaluationContext context = new StandardEvaluationContext();
            // 给上下文赋值
            for(int i = 0; i < args.length; i++) {
                context.setVariable(paramNames[i], args[i]);
            }
            return expression.getValue(context).toString();
        }
        return null;
    }

    /**
     *
     * Title: getParam
     * Description: 
//     * @param joinPoint
//     * @return
     */
    private Map getParam(JoinPoint joinPoint){
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        String[] paramNames = methodSignature.getParameterNames();// 参数名
        Map params = null;
        if (paramNames != null && paramNames.length > 0) {
            Object[] args = joinPoint.getArgs();// 参数值
            params = new HashMap<>();
            for (int i = 0; i < paramNames.length; i++) {
                if(paramNames[i] instanceof Serializable){
                    params.put(paramNames[i], args[i]);
                }
            }
        }
        return params;
    }

    /**
     * 构建审计对象
     */
    private Audit getAudit(AuditLog auditLog, JoinPoint joinPoint) {
        Audit audit = new Audit();
        audit.setTimestamp(LocalDateTime.now());
        audit.setApplicationName(applicationName);

        MethodSignature methodSignature = (MethodSignature)joinPoint.getSignature();
        audit.setClassName(methodSignature.getDeclaringTypeName());
        audit.setMethodName(methodSignature.getName());

        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        audit.setActionType(auditLog.actionType());
        //获取请求参数
        String param = "";
        Map paramsMap = null;
        if (auditLog.isRequestParam()) {
            paramsMap = getParam(joinPoint);
            if(paramsMap != null){
                param = JsonUtils.toJSONString(paramsMap);
            }
        }
        audit.setParam(param);
        audit.setRequestIP(IPUtils.getRemoteAddr(request));
        audit.setHostIP(CustomSystemUtils.INTERNET_IP);
        UserToken userToken = (UserToken) request.getAttribute(WebUtil.REQUEST_TOKEN_NAME);
        if(Func.isNotEmpty(userToken)){
           audit.setUserId(userToken.getUserId());
           audit.setUserName(userToken.getUserInfo());
        }else {
            if(paramsMap!=null) {
                audit.setUserId(paramsMap.get("userId").toString());
            }
        }
        String clientId = request.getHeader(WebUtil.USER_AGENT_HEADER);
        audit.setClientId(clientId);
        String operation = auditLog.operation();
        if (operation.contains("#")) {
            //获取方法参数值
            Object[] args = joinPoint.getArgs();
            operation = getValBySpEL(operation, methodSignature, args);
        }
        audit.setOperation(operation);

        return audit;
    }
}