Spring注解--@AliasFor--使用/实例

爱被打了一巴掌 2023-09-29 14:44 4阅读 0赞

原文网址：[Spring注解--@AliasFor--使用/实例\_IT利刃出鞘的博客-CSDN博客][Spring_--_AliasFor--_IT_-CSDN]

### 简介 ###

本文用示例介绍Spring的@AliasFor（别名）注解的用法。

## **用法1：注解的属性互为别名** ##

### 简介 ###

它可以注解到自定义注解的两个属性上，表示这两个互为别名，也就是说这两个属性其实同一个含义。

1.  其中一个属性名必须是"value"
2.  无论指明设置哪个属性名设置属性值，另一个属性名也是同样属性值，也可以缺省属性名。
3.  若两个都指明属性值，要求值必须相同，否则会报错。
4.  使用简洁。这样使用之后，@MyAnno(location="shanghai")可以直接写为：@MyAnno("shanghai");

这个功能产生的原因：

若自定义注解有一个属性，且该属性命名上为了体现其含义，调用方必须每次使用自定义注解的时候，都必须写明属性 ，然后设置，这样稍微麻烦。

### 实例 ###

**注解**

package com.example.annotation;
    
    import org.springframework.core.annotation.AliasFor;
    
    import java.lang.annotation.*;
    
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.METHOD, ElementType.TYPE})
    @Documented
    @Inherited
    public @interface MyAnnotation {
        @AliasFor(attribute = "location")
        String value() default "";
        
        @AliasFor(attribute = "value")
        String location() default "";
    }

**控制器**

package com.example.controller;
    
    import com.example.annotation.MyAnnotation;
    import org.springframework.core.annotation.AnnotationUtils;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/hello")
    public class HelloController {
    
        @MyAnnotation(value = "location")
        /*//下边这两种写法结果与上边是相同的
        @MyAnnotation("location")
        @MyAnnotation(location = "location")*/
        @RequestMapping("/test1")
        public String test1() {
            MyAnnotation myAnnotation = null;
            try {
                myAnnotation = AnnotationUtils.getAnnotation(this.getClass().getMethod("test1"), MyAnnotation.class);
            } catch (NoSuchMethodException e) {
                e.printStackTrace();
            }
    
            return  "value:" + myAnnotation.value() + ";loation:" + myAnnotation.location();
        }
    }

**测试**

前端访问：[http://localhost:8080/hello/test1][http_localhost_8080_hello_test1]

前端结果（value和location都是同一个值）

value:location;loation:location

## **用法2.继承父注解的属性，不重写属性名** ##

上边是文章的部分内容，为便于维护，全文已转移到此网址：[Spring注解-@AliasFor的使用 - 自学精灵][Spring_-_AliasFor_ -]

[Spring_--_AliasFor--_IT_-CSDN]: https://knife.blog.csdn.net/article/details/124813465
[http_localhost_8080_hello_test1]: http://localhost:8080/hello/test1
[Spring_-_AliasFor_ -]: https://learn.skyofit.com/archives/2287