SpringBoot - Spring-自定义注解 - 《Java成长之路》

作用在类上
缓存注解

在下语言表达不顺畅感觉罗里吧嗦一大堆直接上代码注释都在代码上

作用在Filled属性上的注解

/*@Target  注解作用域 属性参数尚
@Target 定义注解的使用位置，用来说明该注解可以被声明在那些元素之前。
ElementType.TYPE：说明该注解只能被声明在一个类前。
ElementType.FIELD：说明该注解只能被声明在一个类的字段前。
ElementType.METHOD：说明该注解只能被声明在一个类的方法前。
ElementType.PARAMETER：说明该注解只能被声明在一个方法参数前。
ElementType.CONSTRUCTOR：说明该注解只能声明在一个类的构造方法前。
ElementType.LOCAL_VARIABLE：说明该注解只能声明在一个局部变量前。
ElementType.ANNOTATION_TYPE：说明该注解只能声明在一个注解类型前。
ElementType.PACKAGE：说明该注解只能声明在一个包名前
@Constraint 通过使用validatedBy来指定与注解关联的验证器
@Retention用来说明该注解类的生命周期。
RetentionPolicy.SOURCE: 注解只保留在源文件中
RetentionPolicy.CLASS : 注解保留在class文件中，在加载到JVM虚拟机时丢弃
RetentionPolicy.RUNTIME: 注解保留在程序运行期间，此时可以通过反射获得定义在某个类
@Retention 注解保留在运行期间
@Constraint 指定验证器类
验证器类需要实现ConstraintValidator接口*/
@Target( ElementType.FIELD )
@Retention( RetentionPolicy.RUNTIME )
@Constraint( validatedBy = ParamConstraintValidated.class)
public @interface BagCheck {
    /**
     * 合法的参数值
     * */
    String[] paramValues();
    /**
     * 提示信息 
      *默认提示 参数不为指定值
     * */
    String message() default "参数不为指定值";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}
//验证器类
//@ConstraintValidator 第一个泛型参数为BagCheck注解 第二个参数为Object；
//校验字段类型 需要实现initialize方法  isvalid为业务逻辑  initialize方法初始化工作
public class ParamConstraintValidated implements ConstraintValidator<BagCheck,Object> {
    //合法的参数值 从注解中获取
    private List <String>paramValues;
    @Override
    public void initialize(BagCheck constraintAnnotation) {
        //初始化时获取注解上的值
        paramValues = Arrays.asList(constraintAnnotation.paramValues());
    }
    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        //constraintValidatorContext
        if(paramValues.contains( o )){
            return true;
        }
        //不在指定的参数列表中
        return false;
    }
}
@Data
public class Users {
    private String name;
    @BagCheck( paramValues = {"man","woman"})
    private String sex;
}
@RestController
public class TestController {
    @GetMapping(value = "/api/test")
    public Object test(@Validated  Users user) {
        return "hello world";
    }
}
2019-09-16 16:02:11.468  WARN 13800 --- [nio-8080-exec-2] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors
Field error in object 'users' on field 'sex': rejected value [zhangsan]; codes [BagCheck.users.sex,BagCheck.sex,BagCheck.java.lang.String,BagCheck]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [users.sex,sex]; arguments []; default message [sex],[Ljava.lang.String;@454691f]; default message [参数不为指定值]]

作用在类上

//作用在类上
@Target( {ElementType.TYPE})
@Retention( RetentionPolicy.RUNTIME )
public @interface Check_Type {

    String resourceKey();
}


public class PermissionCheckInterceptor extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
                             Object handler) throws Exception {
        HandlerMethod handlerMethod = (HandlerMethod)handler;
        Check_Type permission = findPermissionCheck(handlerMethod);

        //如果没有添加权限注解则直接跳过允许访问
        if (permission == null) {
            return true;
        }

        //获取注解中的值
        String resourceKey = permission.resourceKey();

        //TODO 权限校验一般需要获取用户信息，通过查询数据库进行权限校验
        //TODO 这里只进行简单演示，如果resourceKey为testKey则校验通过，否则不通过
        if ("test".equals(resourceKey)) {
            return true;
        }

        return false;
    }

    /**
     * 根据handlerMethod返回注解信息
     *
     * @param handlerMethod 方法对象
     * @return PermissionCheck注解
     */
    private Check_Type findPermissionCheck(HandlerMethod handlerMethod) {
        //在方法上寻找注解
        Check_Type permission = handlerMethod.getMethodAnnotation(Check_Type.class);
        if (permission == null) {
            //在类上寻找注解
            permission = handlerMethod.getBeanType().getAnnotation(Check_Type.class);
        }

        return permission;
    }
}

//如果没有配置这个拦截地址 那么拦截是不会生效的
@Configuration(value = "securityConfig")
public class SecurityConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor( new PermissionCheckInterceptor() ).
                addPathPatterns( "/**").excludePathPatterns( getExecludeCommonPathPatterns().toString() );
    }

    public List<String>getExecludeCommonPathPatterns(){
       return Arrays.asList( "/api/test" );
    }
}

@RestController
@Check_Type( resourceKey = "test")
public class TestController {

    @GetMapping(value = "/api/test")
    public Object test() {
        return "hello world";
    }
}

缓存注解


//@Target作用在方法尚
//在运行时
@Target( ElementType.METHOD )
@Retention( RetentionPolicy.RUNTIME )
public @interface CustomCache {

    //缓存的键
    String keys();
}
@Aspect
@Component
public class CustomCacheAspect {

    /**
     * 在方法执行之前对注解进行处理
     *
     * @param pjd
     * @param customCache 注解
     * @return 返回中的值
     * */
    @Around("@annotation(com.example.spring_example.cache_example.CustomCache) && @annotation(customCache)")
    public Object dealProcess(ProceedingJoinPoint pjd, CustomCache customCache) {
        Object result = null;

        if (customCache.keys() == null) {
            //TODO throw error
        }

        // 业务场景可能会 查询缓存 没有的话则把返回数据存放到缓存中
        // 或者说 缓存中间有 直接走缓存中走  一系列的逻辑流程
         if ("testKey".equals(customCache.keys())) {
            return "hello word";
        }

        //执行目标方法
        try {
            result = pjd.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }

        return result;
    }
}


@RestController
@Check_Type( resourceKey = "test")
public class TestController {

    @GetMapping(value = "/api/test")
    @CustomCache( keys = "testKey")
    public Object test() {
        return "hello world";
    }
}


``

总结：上面举例说明了几种实现注解的方式  1.对属性实现注解的方式 2.对类或者方法实现全线控制 3.结合SpringAop切面的配合  实现缓存注解的定义