SpringBoot自定义切面注解-权限拦截以及校验

背景

实际开发中，对以及基础用法往往是举一反三的。需求想要一个拦截一些重要的controller控制器来达到权限校验或者一些安全操作，但是又仅限于控制器的操作，一般在控制器肯定是越少的代码操作越好，我们重点除了放在项目的整体架构上，还会侧重项目的业务处理。因此，除非必要，为了代码简洁，通常通过Aspect来达到切面抽离实现对全部或者部分控制器进行拦截操作。

依赖

        <!-- 切面配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

自定义注解类

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAspectAnnotation{
}

实现切面

import com.personloger.system.models.beans.AdminToken;
import com.personloger.system.models.beans.CommonResult;
import com.personloger.system.service.base.PerssionAuthService;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;

@Aspect
@Component
@Order(1) // 一个项目切面可能会很多，order就是执行顺序设定
public class MyAspectAdvice{
    private static final Logger log = LoggerFactory.getLogger(MyAspectAdvice.class);


    // 这里就是我们上面定义的注解类的路径 找到这个类即可
    @Pointcut("@annotation(com.xxx.xxx.xxx.MyAspectAnnotation)")
    private void advice() {
    }

    @Around("advice()")
    public Object adviceCheck(ProceedingJoinPoint joinPoint) throws Throwable {
        ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = requestAttributes.getRequest();
        String token = request.getHeader("请求头你需要的属性值");
       // 业务逻辑的判断
        if (不符合条件) {
             // 返回什么自己定义 反正是Object
        }
        // 如果通过你设定的条件，那么才开始执行控制器后续的方法（业务逻辑）
        return joinPoint.proceed();

    }
}

注解使用

    @MyAspectAnnotation()
    @RequestMapping(value = "/test/api", method = RequestMethod.GET)
    @ResponseBody
    @ApiOperation(value = "接口测试")
    public CommonResult testApi() {
        return new CommonResult(ServerEnums.SUCCESS, "(*Φ皿Φ*)");
    }

详细解释 引用其他博主总结

上面只是通过小案例来学习一波自定义切面注解的使用，实际开发中，可能需求多种多样，我们在使用的过程可能需要对一些基础内容要了解，不然模仿别人可能往往并不能自己想要的效果，反而还啐了一口，“垃圾！！！”

深入理解Java：注解（Annotation）自定义注解入门

常用注解

1.@Target
2.@Retention
3.@Documented
4.@Inherited

@Target

• 使用含义： @Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
• 取值范围

1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

@Target(ElementType.TYPE)
public @interface Table {
    /**
     * 数据表名称注解，默认值为类名称
     * @return
     */
    public String tableName() default "className";
}

@Target(ElementType.FIELD)
public @interface NoDBColumn {

}

@Retention

• 使用含义：@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
• 使用范围
  1.SOURCE:在源文件中有效（即源文件保留）
  2.CLASS:在class文件中有效（即class保留）
  3.RUNTIME:在运行时有效（即运行时保留）

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}

@Inherited

• 使用含义：@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

@Inherited
public @interface Greeting {
    public enum FontColor{ BULE,RED,GREEN};
    String name();
    FontColor fontColor() default FontColor.GREEN;
}

自定义注解类创建

• 使用含义：
  使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。
• 定义注解格式 ：public @interface 注解名 {定义体}

package annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;


@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
    String value() default "";
}