All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.anji.plus.gaea.log.aspect.GaeaAuditLogAspect Maven / Gradle / Ivy
package com.anji.plus.gaea.log.aspect;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.anji.plus.gaea.annotation.Permission;
import com.anji.plus.gaea.annotation.log.GaeaAuditLog;
import com.anji.plus.gaea.constant.GaeaConstant;
import com.anji.plus.gaea.holder.UserContentHolder;
import com.anji.plus.gaea.log.config.GaeaAuditLogProperties;
import com.anji.plus.gaea.log.event.AuditLogApplicationEvent;
import com.anji.plus.gaea.utils.ApplicationContextUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
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.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.multipart.MultipartFile;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Date;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
/**
* 操作日志切面处理
* Created by gaea on 2021/1/27.
*/
@Aspect
public class GaeaAuditLogAspect {
private static final Logger log = LoggerFactory.getLogger(GaeaAuditLogAspect.class);
@Autowired
private GaeaAuditLogProperties gaeaAuditLogProperties;
@Value("/${spring.application.projectCode:''}")
private String projectCode;
@Resource(name = "logRestTemplate")
private RestTemplate restTemplate;
@Resource(name = "threadPoolGaeaLogExecutor")
private ThreadPoolTaskExecutor threadPoolGaeaLogExecutor;
/**
* 统计请求的处理时间
*/
private ThreadLocal startTime = new ThreadLocal<>();
// 配置织入点
@Pointcut("@annotation(com.anji.plus.gaea.annotation.log.GaeaAuditLog)")
public void logPointCut() {
}
@Before("logPointCut()")
public void doBefore() {
startTime.set(System.currentTimeMillis());
}
/**
* 处理完请求后执行
*
* @param joinPoint 切点
*/
@AfterReturning(pointcut = "logPointCut()", returning = "jsonResult")
public void doAfterReturning(JoinPoint joinPoint, Object jsonResult) {
handleLog(joinPoint, null, jsonResult);
startTime.remove();
}
/**
* 拦截异常操作
*
* @param joinPoint 切点
* @param e 异常
*/
@AfterThrowing(value = "logPointCut()", throwing = "e")
public void doAfterThrowing(JoinPoint joinPoint, Exception e) {
handleLog(joinPoint, e, null);
startTime.remove();
}
protected void handleLog(final JoinPoint joinPoint, final Exception e, Object jsonResult) {
try {
// 获得注解
GaeaAuditLog tag = getAnnotationLog(joinPoint);
if (null == tag) {
return;
}
LogOperation operLog = new LogOperation();
//设置url
HttpServletRequest request = getRequest();
operLog.setTenantCode(UserContentHolder.getTenantCode());
operLog.setOrgCode(UserContentHolder.getOrgCode());
operLog.setTerminal(request.getHeader(GaeaConstant.SYS_CODE));
operLog.setLocale(request.getHeader(GaeaConstant.LOCALE));
operLog.setUserName(UserContentHolder.getUsername());
operLog.setCreateBy(UserContentHolder.getUsername());
operLog.setRequestUrl(projectCode + request.getRequestURI());
// 设置请求方式
operLog.setRequestMethod(request.getMethod());
operLog.setRequestTime(new Date(startTime.get()));
operLog.setResponseTime(new Date());
//获取ip
operLog.setSourceIp(request.getHeader(GaeaConstant.SOURCE_IP));
// 处理设置注解上的参数
getControllerMethodDescription(joinPoint, tag, operLog);
//log.info("--gaeaLog:request---url:{},param:{}", operLog.getRequestUrl(),operLog.getRequestParam());
//log.info("--gaeaLog:requestData--{}", operLog.getRequestParam());
//log.info("--gaeaLog:requestAllData--{}", JSON.toJSONString(operLog));
if (Objects.nonNull(auditLogHandler)) {
auditLogHandler.initLogInfo(request, operLog,jsonResult,e,tag);
}else {
// 返回参数
if (jsonResult != null) {
operLog.setResponseParam("" + jsonResult);
}
if (e != null) {
operLog.setResponseParam(e.getMessage());
}
}
if (gaeaAuditLogProperties.isPublishEvent()) {
ApplicationContextUtils.publishEvent(new AuditLogApplicationEvent(this, operLog));
}
//执行回调
if (!StringUtils.isEmpty(gaeaAuditLogProperties.getCallbackUrl())) {
threadPoolGaeaLogExecutor.execute(() -> {
restTemplateCallback(operLog, request);
});
}
} catch (Exception exp) {
// 记录本地异常日志
log.error("--gaeaLog:error--{}", e.getMessage(), exp);
}
}
/**
* 获取注解中对方法的描述信息 用于Controller层注解
*
* @param log 日志
* @param operLog 操作日志
* @throws Exception
*/
public void getControllerMethodDescription(JoinPoint joinPoint, GaeaAuditLog log,
LogOperation operLog) throws Exception {
// 设置标题
operLog.setPageTitle(log.pageTitle());
// 是否需要保存request，参数和值
if (log.isSaveRequestData()) {
// 获取参数的信息，传入到数据库中。
setRequestValue(joinPoint, operLog);
}
if (!log.isSaveResponseData()) {
operLog.setResponseParam(null);
}
}
/**
* 获取请求的参数，放到log中
*
* @param operLog 操作日志
* @throws Exception 异常
*/
private void setRequestValue(JoinPoint pjp, LogOperation operLog) throws Exception {
String requestMethod = operLog.getRequestMethod();
if (HttpMethod.PUT.name().equals(requestMethod) || HttpMethod.POST.name().equals(requestMethod)) {
String params = argsArrayToString(pjp.getArgs());
operLog.setRequestParam(params);
} else if (HttpMethod.GET.name().equals(requestMethod)) {
Map paramMap = getRequest().getParameterMap();
operLog.setRequestParam(JSON.toJSONString(paramMap));
} else {
Map paramsMap = (Map) getRequest().getAttribute("HandlerMapping" + ".uriTemplateVariables");
if (null != paramsMap) {
operLog.setRequestParam(paramsMap.toString());
}
}
String ts = getRequest().getHeader(GaeaConstant.REQUEST_TIMESTAMP);
operLog.setReqTimeStamp(ts);
// 方法上有 @Permission，pageTitle取值修改为:菜单名称-权限码名称
try {
Signature sig = pjp.getSignature();
MethodSignature ms = (MethodSignature) sig;
Object target = pjp.getTarget();
Method currMethod = target.getClass().getMethod(ms.getName(), ms.getParameterTypes());
Permission permission = target.getClass().getAnnotation(Permission.class);
if (Objects.nonNull(permission)) {
String m = permission.name();
String operation = "";
Permission[] arr = currMethod.getAnnotationsByType(Permission.class);
if (!ObjectUtils.isEmpty(arr)) {
operation = arr[0].name();
operLog.setPageTitle(m + "-" + operation);
}
}
} catch (Exception ignore) {
}
}
/**
* 是否存在注解，如果存在就获取
*/
private GaeaAuditLog getAnnotationLog(JoinPoint joinPoint) throws Exception {
Signature signature = joinPoint.getSignature();
MethodSignature methodSignature = (MethodSignature) signature;
Method method = methodSignature.getMethod();
if (method != null) {
return method.getAnnotation(GaeaAuditLog.class);
}
return null;
}
/**
* 参数拼装
*/
private String argsArrayToString(Object[] paramsArray) {
String params = "";
if (paramsArray != null && paramsArray.length > 0) {
for (int i = 0; i < paramsArray.length; i++) {
if (!isFilterObject(paramsArray[i])) {
try {
Object jsonObj = JSON.toJSON(paramsArray[i]);
params += jsonObj.toString() + " ";
} catch (Exception e) {
}
}
}
}
return params.trim();
}
/**
* 判断是否需要过滤的对象。
*
* @param o 对象信息。
* @return 如果是需要过滤的对象，则返回true；否则返回false。
*/
public boolean isFilterObject(final Object o) {
return o instanceof MultipartFile || o instanceof HttpServletRequest || o instanceof HttpServletResponse;
}
public static ServletRequestAttributes getRequestAttributes() {
RequestAttributes attributes = RequestContextHolder.getRequestAttributes();
return (ServletRequestAttributes) attributes;
}
/**
* 获取request
*/
public static HttpServletRequest getRequest() {
return getRequestAttributes().getRequest();
}
/**
* 微服务模式下，通过回调方法传输日志数据
*
* @param logOperation
*/
private void restTemplateCallback(LogOperation logOperation, HttpServletRequest request) {
String url = gaeaAuditLogProperties.getCallbackUrl();
if (auditLogHandler != null) {
auditLogHandler.push(url, logOperation);
return;
}
try {
log.info("--gaeaLog:callBack:url-{}--", url);
HttpHeaders headers_new = new HttpHeaders();
headers_new.setContentType(MediaType.APPLICATION_JSON);
headers_new.set("Accept", "application/json;charset=UTF-8");
headers_new.set("Authorization", request.getHeader(GaeaConstant.Authorization));
HttpEntity entity = new HttpEntity(logOperation, headers_new);
JSONObject responseBody = restTemplate.postForObject(url, entity, JSONObject.class);
log.info("--gaeaLog:callBack:response-{}", responseBody);
} catch (Exception e) {
log.error("--gaeaLog:callBack:error--{}", e.getMessage());
}
}
@Autowired(required = false)
private GaeaAuditLogHandler auditLogHandler;
}
