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

切点（Pointcut）

切点定义了通知功能被应用的范围。比如日志切面的应用范围就是所有接口，即所有 controller 层的接口方法。

切面（Aspect）

切面是通知和切点的结合，定义了何时、何地应用通知功能。

引入（Introduction）

在无需修改现有类的情况下，向现有的类添加新方法或属性。

织入（Weaving）

把切面应用到目标对象并创建新的代理对象的过程。

Spring 中使用注解创建切面

相关注解

• @Aspect：用于定义切面

• @Before：通知方法会在目标方法调用之前执行

• @After：通知方法会在目标方法返回或抛出异常后执行

• @AfterReturning：通知方法会在目标方法返回后执行

• @AfterThrowing：通知方法会在目标方法抛出异常后执行

• @Around：通知方法会将目标方法封装起来

• @Pointcut：定义切点表达式

切点表达式

指定了通知被应用的范围，表达式格式：

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.*(…))

实战应用-利用AOP记录日志

---

从传统行业转行，以前都没想过打日志埋点，第一份工作，真的应该选择一个好的平台比较重要。

定义日志信息封装

用于封装需要记录的日志信息，包括操作的描述、时间、消耗时间、url、请求参数和返回结果等信息

public class WebLog {

/**

• 操作描述

*/

private String description;

/**

• 操作用户

*/

private String username;

/**

• 操作时间

*/

private Long startTime;

/**

• 消耗时间

*/

private Integer spendTime;

/**

• 根路径

*/

private String basePath;

/**

• URI

*/

private String uri;

/**

• URL

*/

private String url;

/**

• 请求类型

*/

private String method;

/**

• IP地址

*/

private String ip;

/**

• 请求参数

*/

private Object parameter;

/**

• 请求返回的结果

*/

private Object result;

//省略了getter,setter方法

}

定义注解,通过注解减少代码量

@Documented

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.METHOD)

public @interface OperationLog {

String name();//调用接口的名称

boolean intoDb() default false;//该条操作日志是否需要持久化存储

}

统一日志处理切面

@Aspect

@Component

@Order(1)

@Slf4j

public class WebLogAspect {

private static final Logger controlLog = LoggerFactory.getLogger(“tmall_control”);

@Pointcut(“execution(public * com.yee.walnut...*(…))”)

public void webLog() {

}

@Before(value = “webLog()&& @annotation(OperationLog)”)

public void doBefore(ControllerWebLog controllerWebLog) throws Throwable {

}

@AfterReturning(value = “webLog()&& @annotation(OperationLog)”, returning = “ret”)

public void doAfterReturning(Object ret, ControllerWebLog controllerWebLog) throws Throwable {

}

@Around(value = “webLog()&& @annotation(OperationLog)”)

public Object doAround(ProceedingJoinPoint joinPoint, OperationLog operationLog) throws Throwable {

long startTime = System.currentTimeMillis();

//获取当前请求对象

ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();

HttpServletRequest request = attributes.getRequest();

//记录请求信息

Object[] objs = joinPoint.getArgs();

WebLog webLog = new WebLog();

Object result = joinPoint.proceed();//返回的结果，这是一个进入方法和退出方法的一个分界

Signature signature = joinPoint.getSignature();

MethodSignature methodSignature = (MethodSignature) signature;

Method method = methodSignature.getMethod();

long endTime = System.currentTimeMillis();

String urlStr = 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函数返回值

return result;

}

/**

• 根据方法和传入的参数获取请求参数

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
D-1715074366998)]

[外链图片转存中…(img-BXrYVnvS-1715074366999)]

[外链图片转存中…(img-BTysQ80G-1715074367000)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！