Springboot @AliasFor使用

场景1:在同一个注解内,对两个不同的属性一起使用,互为别名,比如@RequestMapping中path和value成对使用,互为别名。

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
    String name() default "";

    @AliasFor("path") // 此时path和value值是一样的,如果不一样会报错
    String[] value() default {};

    @AliasFor("value") // 此时path和value值是一样的,如果不一样会报错
    String[] path() default {};
    ... 其它略 ....
}

使用如下:

// 正解:path和value都为"/getbaidu"
@RequestMapping(path="/getbaidu", method=RequestMethod.GET)
// 正解:path和value都为"/getbaidu"
@RequestMapping(value="/getbaidu", method=RequestMethod.GET)
// 正解:path和value都为"/getbaidu"
@RequestMapping(path="/getbaidu", value="/getbaidu", method=RequestMethod.GET)
// 错误:因为path和value已经绑定,互为别名,因此值必须一样
@RequestMapping(path="/getbaidu", value="/getgoogle", method=RequestMethod.GET)
  • 此外,注意一点,因为互为别名,因此path和value的默认值,即default值必须一样

场景2:为其它注解别名

  • 还是以@RequestMapping为例,我们为@RequestMapping换个名称:NewRM
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
@RequestMapping // 这个地方不能少,不知道为什么????
public @interface NewRM {

    @AliasFor(value="path", annotation = RequestMapping.class)
    String[] ph() default {};
    @AliasFor(value="method", annotation = RequestMapping.class)
    RequestMethod[] md() default {};
    ... 其它略 ....
}
  • 这样设置以后,下面两种方式就变成完全等价的了:
// 这两行注解是完全等价的
    @RequestMapping(path="/getbaidu", method=RequestMethod.GET)
    @NewRM(ph="/getbaidu", md = RequestMethod.GET)

场景3:传递别名(跟场景2很类似):再来看NewRM:

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
@RequestMapping // 这个地方不能少,不知道为什么????
public @interface NewRM {

    @AliasFor(value="path", annotation = RequestMapping.class)
    String[] ph() default {};
    @AliasFor(value="method", annotation = RequestMapping.class)
    RequestMethod[] md() default {};
    // 这里用了attribute传递,而在AliasFor中,attribute与value是相通的,因此ph2等价于ph
    @AliasFor(attribute="path", annotation = RequestMapping.class)
    String[] ph2() default {};
    ... 其它略 ....
}
  • 因此,下面三种方式是等价的:
// 这三行注解是完全等价的
    @RequestMapping(path="/getbaidu", method=RequestMethod.GET)
    @NewRM(ph="/getbaidu", md = RequestMethod.GET)
    @NewRM(ph2="/getbaidu", md = RequestMethod.GET)

更加深层次的介绍,参见这里:https://www.jianshu.com/p/869ed7037833

相关文章
相关标签/搜索