SpringBoot开发秘籍 - 利用 AOP 记录日志

execution(方法修饰符返回类型方法所属的包.类名.方法名称(方法参数)
//com.ninesky.study.tiny.controller包中所有类的public方法都应用切面里的通知execution(public*com.ninesky.study.tiny.controller.*.*(..))
//com.ninesky.study.tiny.service包及其子包下所有类中的所有方法都应用切面里的通知execution(*com.ninesky.study.tiny.service..*.*(..))
//com.ninesky.study.tiny.service.PmsBrandService类中的所有方法都应用切面里的通知execution(*com.macro.ninesky.study.service.PmsBrandService.*(..))

publicclassWebLog {
/*** 操作描述*/privateStringdescription;
/*** 操作用户*/privateStringusername;
/*** 操作时间*/privateLongstartTime;
/*** 消耗时间*/privateIntegerspendTime;
/*** 根路径*/privateStringbasePath;
/*** URI*/privateStringuri;
/*** URL*/privateStringurl;
/*** 请求类型*/privateStringmethod;
/*** IP地址*/privateStringip;
/*** 请求参数*/privateObjectparameter;
/*** 请求返回的结果*/privateObjectresult;
//省略了getter,setter方法}

@Documented@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public@interfaceOperationLog {
Stringname();//调用接口的名称booleanintoDb() defaultfalse;//该条操作日志是否需要持久化存储}

@Aspect@Component@Order(1)
@Slf4jpublicclassWebLogAspect {
privatestaticfinalLoggercontrolLog=LoggerFactory.getLogger("tmall_control");
@Pointcut("execution(public * com.yee.walnut.*.*.*(..))")
publicvoidwebLog() {
    }
@Before(value="webLog()&& @annotation(OperationLog)")
publicvoiddoBefore(ControllerWebLogcontrollerWebLog) throwsThrowable {
    }
@AfterReturning(value="webLog()&& @annotation(OperationLog)", returning="ret")
publicvoiddoAfterReturning(Objectret, ControllerWebLogcontrollerWebLog) throwsThrowable {
    }
@Around(value="webLog()&& @annotation(OperationLog)")
publicObjectdoAround(ProceedingJoinPointjoinPoint, OperationLogoperationLog) throwsThrowable {
longstartTime=System.currentTimeMillis();
//获取当前请求对象ServletRequestAttributesattributes= (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequestrequest=attributes.getRequest();
//记录请求信息Object[] objs=joinPoint.getArgs();
WebLogwebLog=newWebLog();
Objectresult=joinPoint.proceed();//返回的结果，这是一个进入方法和退出方法的一个分界Signaturesignature=joinPoint.getSignature();
MethodSignaturemethodSignature= (MethodSignature) signature;
Methodmethod=methodSignature.getMethod();
longendTime=System.currentTimeMillis();
StringurlStr=request.getRequestURL().toString();
webLog.setBasePath(StrUtil.removeSuffix(urlStr, URLUtil.url(urlStr).getPath()));
webLog.setIp(request.getRemoteUser());
webLog.setMethod(request.getMethod());
webLog.setParameter(getParameter(method, joinPoint.getArgs()));
webLog.setResult(JSONUtil.parse(result));
webLog.setSpendTime((int) (endTime-startTime));
webLog.setStartTime(startTime);
webLog.setUri(request.getRequestURI());
webLog.setUrl(request.getRequestURL().toString());
controlLog.info("RequestAndResponse {}", JSONObject.toJSONString(webLog));
//必须有这个返回值。可以这样理解，Around方法之后，不再是被织入的函数返回值，而是Around函数返回值returnresult;
    }
/*** 根据方法和传入的参数获取请求参数*/privateObjectgetParameter(Methodmethod, Object[] args) {
List<Object>argList=newArrayList<>();
Parameter[] parameters=method.getParameters();
for (inti=0; i<parameters.length; i++) {
//将RequestBody注解修饰的参数作为请求参数RequestBodyrequestBody=parameters[i].getAnnotation(RequestBody.class);
if (requestBody!=null) {
argList.add(args[i]);
            }
//将RequestParam注解修饰的参数作为请求参数RequestParamrequestParam=parameters[i].getAnnotation(RequestParam.class);
if (requestParam!=null) {
Map<String, Object>map=newHashMap<>();
Stringkey=parameters[i].getName();
if (!StringUtils.isEmpty(requestParam.value())) {
key=requestParam.value();
                }
map.put(key, args[i]);
argList.add(map);
            } else {
argList.add(args[i]);
            }
        }
if (argList.size() ==0) {
returnnull;
        } elseif (argList.size() ==1) {
returnargList.get(0);
        } else {
returnargList;
        }
    }
}

@OperationLog(name="TurnOnOffStrategy")
publicStringdoOperation(GlobalDtoglobalDto, DeviceOperatordeviceOperator) {
}