今天菜品：
编写一个自动记录Controller层请求记录的注解。
起因
俗话说，懒惰是程序员的第一生产力。为了偷懒不在每一个Controller层方法上都编写记录日志的代码，我想到了利用AOP（面向切面编程）的方式，通过一个自定义注解来自动实现记录日志的功能。
解决方案
我们将上述需求分解一下，形成需要解决的问题点，如下：
- 编写注解，注解应该作用于方法上，并可以在运行时通过反射获取到。
- 编写注解处理器，注解处理器应该是一个切面类，并定义在任何由RequestLog注解标注的类进行切入。
- 通过反射获取到要注入的方法，再获取到方法的参数和返回值，利用日志将方法的参数和返回值按指定格式输出（或保存到数据库、redis等）。
编写注解
将注解命名为RequestLog，示例代码如下：
/**
* 用于记录请求参数的日志
*
* @author G. Seinfeld
* @since 2021/04/28
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestLog {
/**
* 所属模块，不赋值将使用Controller的全名代替
*/
String module() default "";
}
在编写注解时，使用@Target元注解规定当前注解所标注的对象，常见值包括：
- TYPE->类
- FIELD->属性
- METHOD->方法
- PARAMETER->方法的参数
- CONSTUCTOR->构造器
- LOCAL_VARIABLE->局部变量
- ANNOTATION_TYPE->注解
- PACKAGE->包
使用@Retention元注解规定当前注解的生命周期，常见值包括：
- SOURCE->源代码级别
- CLASS->class文件级别
- RUNTIME->虚拟机运行时级别
注解中定义了一个可配置项，即请求的Controller所属的模块。我们还可以根据实际需要增加其他配置项。
编写注解处理器
org.springframework.boot
spring-boot-starter-aop
2.3.2.RELEASE
先在pom.xml文件中引用aop处理所需依赖包，由于是spring boot项目，这里直接使用starter的方式快捷引入。
/**
* @author G. Seinfeld
* @since 2021/04/28
*/
@Aspect
@Component
public class RequestLogHandler {
@Pointcut("@annotation(cn.gsein.annotations.RequestLog)")
public void logPointcut() {
}
}
在Spring-Aop中，我们使用@Aspect注解定义一个切面类，使用@Pointcut注解标注在一个空方法上，用于定义一个切入点。在本需求中，我们希望定义的切入点是被注解标注的方法，因此，我们将切入点的表达式声明为：
@annotation(xxx.xxx.xxx.RequestLog)
更多的切入点表达式写法请自行查阅文档。
编写记录日志的逻辑
接下来我们在RequestLogHandler类中编写具体处理记录日志逻辑的方法，示例代码如下：
@AfterReturning(value = "logPointcut()", returning = "result")
public void doAfterRequest(JoinPoint joinPoint, Object result) {
try {
// 切面所属对象
final Object instance = joinPoint.getTarget();
// 对象对应的class对象
final Class instanceClass = instance.getClass();
// 根据class对象获取logger
Logger logger = LoggerFactory.getLogger(instanceClass);
// 获取方法名
final MethodSignature signature = (MethodSignature) joinPoint.getSignature();
final Method method = signature.getMethod();
final String methodName = method.getName();
// 获取注解
final RequestLog annotation = method.getAnnotation(RequestLog.class);
// 获取模块名
String moduleName = annotation.module();
if (StringUtils.isEmpty(moduleName)) {
moduleName = instanceClass.getSimpleName();
}
// 拼接请求参数
final Object[] args = joinPoint.getArgs();
StringBuilder sb = new StringBuilder();
int i = 0;
for (Object arg : args) {
sb.append("arg").append(i++).append(":");
sb.append(JSON.toJSONString(arg)).append(",");
}
if (sb.length() > 0) {
sb.deleteCharAt(sb.length() - 1);
}
logger.info("请求{}模块的{}接口，请求参数为{}，返回结果为{}", moduleName, methodName, sb.toString(), JSON.toJSONString(result));
} catch (Exception e) {
e.printStackTrace();
}
}
spring-aop给我们提供了几种切面增强的方式：
- @Around：环绕增强，即在切入方法前后都进行处理
- @AfterReturning：后置增强，即方法返回时处理
- @Before：前置增强，即进入方法前处理
- @AfterThrowing：异常抛出增强，即方法抛出异常时处理
- @After: 不管是抛出异常或者正常退出都会执行
示例代码中我们使用了后置增强的方式，即在方法返回时进行处理，这样可以同时获得方法的参数和返回值，符合我们的需求。@AfterReturning的value配置项配置的是切入点，这里直接使用上面方法定义的切入点。returning配置项指的是将返回值绑定到哪个对象上，这里指定的是方法参数中的对象。
我们可以根据切入点的jointPoint对象，通过反射获取到切入方法的method对象、所属Controller类的实例、方法参数等，再按照相应的规则对这些对象进行拼接和组合，并通过logger进行记录。
最后的说明
- 本文提供的只是demo级别的代码，重点在于介绍思路和相关知识。如需在生产中使用，请根据实际需求自行修改和完善。
- 如果在方法发生异常时也需要记录日志，需要在额外编写一个@AfterThrowing标注的处理方法。
- 本文代码中的异常处理比较粗糙，请根据实际情况自行完善。