Java基础——注解

Posted 2020-10-08 ---江北

一、概述

　　　引自百度百科：

定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

二、JDK内置注解

　　Java提供了三种内建注解。

　　1. @Override——当我们想要复写父类中的方法时，我们需要使用该注解去告知编译器我们想要复写这个方法。这样一来当父类中的方法移除或者发生更改时编译器将提示错误信息。

　　2. @Deprecated——当我们希望编译器知道某一方法不建议使用时，我们应该使用这个注解。Java在javadoc 中推荐使用该注解，我们应该提供为什么该方法不推荐使用以及替代的方法。

　　3. @SuppressWarnings——这个仅仅是告诉编译器忽略特定的警告信息，例如在泛型中使用原生数据类型。它的保留策略是SOURCE（译者注：在源文件中有效）并且被编译器丢弃。

三、元注解

　　这里有四种类型的元注解：

　　1. @Documented —— 指明拥有这个注解的元素可以被javadoc此类的工具文档化。这种类型应该用于注解那些影响客户使用带注释的元素声明的类型。如果一种声明使用Documented进行注解，这种类型的注解被作为被标注的程序成员的公共API。

　　2. @Target——指明该类型的注解可以注解的程序元素的范围。该元注解的取值可以为TYPE,METHOD,CONSTRUCTOR,FIELD等。如果Target元注解没有出现，那么定义的注解可以应用于程序的任何元素。

　　3. @Inherited——指明该注解类型被自动继承。如果用户在当前类中查询这个元注解类型并且当前类的声明中不包含这个元注解类型，那么也将自动查询当前类的父类是否存在Inherited元注解，这个动作将被重复执行知道这个标注类型被找到，或者是查询到顶层的父类。

　　4.@Retention——指明了该Annotation被保留的时间长短。RetentionPolicy取值为SOURCE,CLASS,RUNTIME。

　　更多详细介绍与讲解，参见（推荐）：http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html    （包含注解处理器等，推荐！）

四、自定义注解

　　还是像之前一样，我们找到一个已经存在的注解来看看它怎么写的（例如：@SuppressWarnings）

　　1.定义：可以看到使用 @interface来声明一个注解

public @interface SuppressWarnings {

　　2.成员：注意定义的格式，后面需要带小括号,如果需要默认值，可以后接default ""等形式

 String[] value();

　　示例：

 

@Target({ ElementType.TYPE })//注解用在接口上
@Retention(RetentionPolicy.RUNTIME)//VM将在运行期也保留注释，因此可以通过反射机制读取注解的信息
@Component
public @interface RpcService {
    String value();
}

 

　　使用spring来使用自定义的注解：

@Component
public class MyServer implements ApplicationContextAware {
    @SuppressWarnings("resource")
    public static void main(String[] args) {
       new ClassPathXmlApplicationContext("spring2.xml");
    }
    public void setApplicationContext(ApplicationContext ctx)
            throws BeansException {
        Map<String, Object> serviceBeanMap = ctx
                .getBeansWithAnnotation(RpcService.class);
        for (Object serviceBean : serviceBeanMap.values()) {
            try {
                Method method = serviceBean.getClass().getMethod("hello", new Class[]{String.class});
                Object invoke = method.invoke(serviceBean, "bbb");
                System.out.println(invoke);
            } catch (Exception e) {
                e.printStackTrace();
            } 
        }
    }
}

 

 

　　　//完整的数据类型支持，请参见上文链接

　　　//之后使用的注解中也可以看到，如果注解只有一个成员且为 value，可以省略，不用写@RequestMapping(value = "/add")，可以简写为("/add")