注解的作用

2023年9月3日 87次阅读
  1. 编译检查
    Annotation具有“让编译器进行编译检查的作用”。
    例如，@SuppressWarnings, @Deprecated和@Override都具有编译检查作用。
  2. 在反射中使用Annotation
    在反射的Class, Method, Field等函数中，有许多于Annotation相关的接口。
    这也意味着，我们可以在反射中解析并使用Annotation。
  3. 根据Annotation生成帮助文档
    通过给Annotation注解加上@Documented标签，能使该Annotation标签出现在javadoc中。
  4. 能够帮忙查看查看代码
    通过@Override, @Deprecated等，我们能很方便的了解程序的大致结构。
    另外，我们也可以通过自定义Annotation来实现一些功能。
    5.注解处理器
    如果没有用来读取注解的方法和工作，那么注解也就不会比注释更有用处了。使用注解的过程中，很重要的一部分就是创建于使用注解处理器。Java SE5扩展了反射机制的API，以帮助程序员快速的构造自定义注解处理器。
  5. 在框架中的作用
    在开发Java程序，尤其是Java EE应用的时候，总是免不了与各种配置文件打交道。以Java EE中典型的S(pring)S(truts)H(ibernate)架构来说，Spring、Struts和Hibernate这三个框架都有自己的XML格式的配置文件。这些配置文件需要与Java源代码保存同步，否则的话就可能出现错误。而且这些错误有可能到了运行时刻才被发现。把同一份信息保存在两个地方，总是个坏的主意。理想的情况是在一个地方维护这些信息就好了。其它部分所需的信息则通过自动的方式来生成。JDK 5中引入了源代码中的注解（annotation）这一机制。注解使得Java源代码中不但可以包含功能性的实现代码，还可以添加元数据。注解的功能类似于代码中的注释，所不同的是注解不是提供代码功能的说明，而是实现程序功能的重要组成部分。Java注解已经在很多框架中得到了广泛的使用，用来简化程序中的配置。
    因为注解大多都有自己的配置参数，而配置参数以名值对的方式出现，所以从某种角度来说，可以把注解看成是一个XML元素，该元素可以有不同的预定义的属性。    而属性的值是可以在声明该元素的时候自行指定的。在代码中使用注解，就相当于把一部分元数据从XML文件移到了代码本身之中，在一个地方管理和维护。
    上面两段话其实已经阐述了java注解的主要作用之一，就是跟踪代码依赖性，实现替代配置文件功能。比较常见的是Spring等框架中的基于注解配置。现在的框架很多都使用了这种方式来减少配置文件的数量。基本上秉持着这么一个原则，与具体场景相关的配置应该使用注解的方式与数据关联，与具体场景无关的配置放于配置文件中。在另一方面我们还可以在通过设置注解的@Retention 级别在运行时使用反射对不同的注解进行处理。

怎么使用呢？
例子：先利用反射，获取到注解，然后把利用注解实例化该类的对象
下面有一个例子：(自己写的哦)
定义一个注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
    /*供应商编号*/
    public int id() default -1;
    /*供应商名称*/
    public String name() default "";
    /*供应商地址*/
    public String address() default "";
}

对一个类使用注解

@FruitProvider(id = 1728, name = "why", address = "shenzhen")
public class Apple {
    private int appleID;
    private String appleProvidername;
    private String appleprovideraddress;

    public int getAppleID() {
        return appleID;
    }

    public void setAppleID(int appleID) {
        this.appleID = appleID;
    }

    public String getAppleProvidername() {
        return appleProvidername;
    }

    public void setAppleProvidername(String appleProvidername) {
        this.appleProvidername = appleProvidername;
    }

    public String getAppleprovideraddress() {
        return appleprovideraddress;
    }

    public void setAppleprovideraddress(String appleprovideraddress) {
        this.appleprovideraddress = appleprovideraddress;
    }
}

注解处理器

public class FruitInfoUtil {

    public static Apple getAApple(Class<?> clazz) throws Exception{
        FruitProvider fb = clazz.getAnnotation(FruitProvider.class);//通过反射获取处理注释
        //通过newInstance()生成Apple实例，利用反射的结果进行设置
        Apple ap = (Apple)clazz.newInstance();
        ap.setAppleID(fb.id());
        ap.setAppleProvidername(fb.name());
        ap.setAppleprovideraddress(fb.address());
        return ap;
    }
}
public class Main {

    public static void main(String[] args) throws  Exception{
        Apple a = FruitInfoUtil.getAApple(Apple.class);
        System.out.println("苹果商的ID为："+a.getAppleID());
        System.out.println("苹果商的名字为："+a.getAppleProvidername());
        System.out.println("苹果商的地址为:"+a.getAppleprovideraddress());
    }
}

这个实例就很好的说明，现在的框架很多都使用了这种方式来减少配置文件的数量。（因为配置就在代码里面了）。

部分来源：简书[ALEXIRC]

点赞