最简单的springboot自定义注解

本篇是自己在写自定义注解的时候遇到一些问题，故写下一个最简单就生效的案例。

首先定义一个自己的注解类：

package com.shenjian.user.annotation;

import java.lang.annotation.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.METHOD})
public @interface CheckAuth {

}

第一个注解@Documented 可以省略，其它两个必须要有。

然后再定义一个切面方法来使你的注解类可以被使用：

package com.shenjian.user.Aspect;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class CheckAuth {

    private static Logger logger = LoggerFactory.getLogger(CheckAuth.class);

    @Pointcut("@annotation(com.shenjian.user.annotation.CheckAuth)")
    public void checkAuthAnnotation(){
        logger.info("this is checkAuthAnnotation.........");
    }

    @Before("checkAuthAnnotation()")
    public void beforeCut(JoinPoint joinPoint){
        logger.info("this is beforeCut.............");
    }

    @After("checkAuthAnnotation()")
    public void afterCut(){
        logger.info("this is afterCut.............");
        System.out.println("????");
    }

    @Around("checkAuthAnnotation()")
    public Object aroundCut(ProceedingJoinPoint joinPoint){
        logger.info("this is aroundCut.............");
        Object result = null;
        try {
            logger.info("this is before proceed.............");
            result = joinPoint.proceed();
            logger.info("this is after proceed.............");
        } catch (Throwable e) {
            e.printStackTrace();
        }
        return result;
    }

    @AfterReturning("checkAuthAnnotation()")
    public void afterReturnCut(JoinPoint joinPoint){
        logger.info("this is afterReturnCut.............");
    }

    @AfterThrowing(value = "checkAuthAnnotation()",throwing = "e")
    public void afterThrowCut(JoinPoint joinPoint,Exception e){
        logger.info("this is afterThrowCut.............");
    }


}

 首先两个注解不能漏了

其次 

@Pointcut("@annotation(com.shenjian.user.annotation.CheckAuth)") 是指向你刚刚创建的自定义注解的。这个在现在可以直接使用方法名checkAuthAnnotation() 来作为参数使用。

然后一定要注意的是 @Around("checkAuthAnnotation()") 这个Around是最麻烦的。首先，它的参数和其它方法就不一样，它是 ProceedingJoinPoint ，因为要调用它的process方法。普通的JoinPoint 是没有这个方法的。其次这个类一定要有返回值。之前我看网上有些文章是没有返回值的，所以我也就没写。但是运行的使用一直会卡住，找了好久才发现是这个方法没返回。(之前方法返回设置的是void所以编译没问题)。

最后还有个要注意的就是 @AfterThrowing(value = "checkAuthAnnotation()",throwing = "e")

这个一定要加上 throwing = "e"，和 public void afterThrowCut(JoinPoint joinPoint,Exception e)是配对的，不然就会报错。

定义好这两个配置，接下来就是使用了。只需要在你的controller的方法上加上你的注解就可以了

我定义的注解名是 CheckAuth，所以只需要加上@CheckAuth

下面看下实际效果。