掌握@ControllerAdvice配合RequestBodyAdvice/ResponseBodyAdvice使用，让你的选择不仅仅只有拦截器【享学Spring MVC】(上)

@RestControllerAdvice
public class MyControllerAdvice {
    @InitBinder
    public void initBinder(WebDataBinder binder) {
        //binder.setDisallowedFields("name");
        binder.registerCustomEditor(String.class, new StringTrimmerEditor());
    }
}

// @since 3.2
@Target(ElementType.TYPE) // 只能标注在类上
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component // 派生有组件注解的功能
public @interface ControllerAdvice {
  @AliasFor("basePackages")
  String[] value() default {};
  @AliasFor("value")
  String[] basePackages() default {};
  Class<?>[] basePackageClasses() default {};
  Class<?>[] assignableTypes() default {};
  Class<? extends Annotation>[] annotations() default {};
}

HandlerTypePredicate：
    // 这是packages属性本文：有一个判空的过滤器
    public Builder basePackage(String... packages) {
      Arrays.stream(packages).filter(StringUtils::hasText).forEach(this::addBasePackage);
      return this;
    }
    // packageClasses最终都是转换为了addBasePackage
    // 只是它的pachage值是：ClassUtils.getPackageName(clazz)
    // 说明：ClassUtils.getPackageName(String.class) --> java.lang
    public Builder basePackageClass(Class<?>... packageClasses) {
      Arrays.stream(packageClasses).forEach(clazz -> addBasePackage(ClassUtils.getPackageName(clazz)));
      return this;
    }
    private void addBasePackage(String basePackage) {
      this.basePackages.add(basePackage.endsWith(".") ? basePackage : basePackage + ".");
    }

HandlerTypePredicate：
  @Override
  public boolean test(Class<?> controllerType) {
    // 1、若所有属性一个都没有指定，那就是default情况-->作用于所有的Controller
    if (!hasSelectors()) {
      return true;
    } else if (controllerType != null) {
      // 2、注意此处的basePackage只是简单的startsWith前缀匹配而已~~~
      // 说明：basePackageClasses属性最终都是转为它来匹配的，
      // 如果写了一个Controller类匹配上了，那它所在的包下所有的都是匹配的（因为同包嘛）
      for (String basePackage : this.basePackages) {
        if (controllerType.getName().startsWith(basePackage)) {
          return true;
        }
      }
      // 3、指定具体的Class类型，只会匹配数组里面的这些类型，精确匹配。
      for (Class<?> clazz : this.assignableTypes) {
        if (ClassUtils.isAssignable(clazz, controllerType)) {
          return true;
        }
      }
      // 4、根据类上的注解类型来匹配（若你想个性化灵活配置，可以使用这种方式）
      for (Class<? extends Annotation> annotationClass : this.annotations) {
        if (AnnotationUtils.findAnnotation(controllerType, annotationClass) != null) {
          return true;
        }
      }
    }
    return false;
  }

RequestMappingHandlerAdapter：
  @Override
  public void afterPropertiesSet() {
    // Do this first, it may add ResponseBody advice beans
    initControllerAdviceCache();
    ...
  }
  private void initControllerAdviceCache() {
    // 因为它需要通过它去容器内找到所有标注有@ControllerAdvice注解的Bean们
    if (getApplicationContext() == null) {
      return;
    }
    // 关键就是在findAnnotatedBeans方法里：传入了容器上下文
    List<ControllerAdviceBean> adviceBeans = ControllerAdviceBean.findAnnotatedBeans(getApplicationContext());
    // 注意此处是有个排序的~~~~
    AnnotationAwareOrderComparator.sort(adviceBeans);
    ...
    // 注意：找到这些标注有@ControllerAdvice后并不需要保存下来。
    // 而是一个一个的找它们里面的@InitBinder/@ModelAttribute 以及 RequestBodyAdvice和ResponseBodyAdvice
    // 说明：异常注解不在这里解析，而是在`ExceptionHandlerMethodResolver`里~~~
    for (ControllerAdviceBean adviceBean : adviceBeans) {
      ...
    }
  }
ControllerAdviceBean：
  // 找到容器内（包括父容器）所有的标注有@ControllerAdvice的Bean们~~~
  public static List<ControllerAdviceBean> findAnnotatedBeans(ApplicationContext context) {
    return Arrays.stream(BeanFactoryUtils.beanNamesForTypeIncludingAncestors(context, Object.class))
        .filter(name -> context.findAnnotationOnBean(name, ControllerAdvice.class) != null)
        .map(name -> new ControllerAdviceBean(name, context))
        .collect(Collectors.toList());
  }