记录使用java自定义注解结合AOP输出日志

正文

注解是一种能被添加到java源代码中的元数据，方法、类、参数和包都可以用注解来修饰。注解可以看作是一种特殊的标记，可以用在方法、类、参数和包上，程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理。
声明一个注解要用到的东西

• 修饰符

访问修饰符必须为public,不写默认为pubic；

• 关键字

关键字为@interface；

• 注解名称

注解名称为自定义注解的名称，使用时还会用到；

• 注解类型元素

注解类型元素是注解中内容，可以理解成自定义接口的实现部分；

public @interface MyLog {

}

因为要结合AOP输出日志，获取是调用了哪个方法，写一个AOP类

/**
 * @ClassName MyLogAspect
 * @Description: TODO
 * @Author 
 * @Date 2020/8/5
 * @Version V1.0
 **/

@Aspect // 1.表明这是一个切面类
@Component
public class MyLogAspect {
    // 2. PointCut表示这是一个切点，@annotation表示这个切点切到一个注解上，后面带该注解的全类名
    // 切面最主要的就是切点，所有的故事都围绕切点发生
    // logPointCut()代表切点名称
    @Pointcut("@annotation(com.example.demo.Annotation.MyLog)")
    public void logPointCut(){};

    // 3. 环绕通知
    @Around("logPointCut()")
    public void logAround(ProceedingJoinPoint joinPoint){
        // 获取方法名称
        String methodName = joinPoint.getSignature().getName();
        // 获取入参
        Object[] param = joinPoint.getArgs();

        StringBuilder sb = new StringBuilder();
        for(Object o : param){
            sb.append(o + "; ");
        }
        System.out.println("进入[" + methodName + "]方法,参数为:" + sb.toString());

        // 继续执行方法
        try {
            joinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        System.out.println(methodName + "方法执行结束");

    }
}

解释：@Pointcut("@annotation(com.example.demo.Annotation.MyLog)")这句话是最重要的，有使用mylog注解的类，都会被做为切面，监控当前类。

测试：

编写一个controller类

/**
 * @ClassName sourceC
 * @Description: TODO
 * @Author 
 * @Date 2020/8/5
 * @Version V1.0
 **/
@Controller
public class sourceC {

    @MyLog
    @GetMapping("/sourceC/{source_name}")
    public String sourceC(@PathVariable("source_name") String sourceName){
        return "你正在访问sourceC资源";
    }

    @MyLog
    @GetMapping("/sourceB/{source_name}")
    public String sourceB(@PathVariable("source_name") String sourceName){
        return "你正在访问sourceB资源";
    }
}

执行结果如下：

使用POSTMAN发送

总结：

在写的过程中也借鉴了一些其它博客的内容，第一次用自定义注解，感觉很方便，希望以后会多多使用，记录一下，做个标注。