掌握 Java 注解,一夜陆地神仙

一、注解简介

Java注解用于为Java代码提供元数据。

元数据是指用来描述数据的数据,通俗一点,就是描述代码间关系,或者代码与其它资源(例如数据库表)之间内在联系的数据。在一些技术框架中,如Struts、hibernate就不知不觉用到了元数据。对于Struts来说,元数据指的是struts-config.xml;对hibernate来说就是hbm文件。以上阐述的几种元数据都是基于xml文件的或者其他形式的单独配置文件。这样表示有些不便之处。1、与被描述的文件分离,不利于一致性的维护;2、所有这样的文件都是ASCII文件,没有显式的类型支持。基于元数据的广泛使用,JDK5.0引入了Annotation的概念来描述元数据。在Java中,元数据以标签的形式存在于Java代码中,元数据标签的存在并不影响程序代码的编译和执行。简而言之,言而总之,注解就是标签的意思。

二、如何创建注解

JDK5.0出来后,Java语言中就有了四种类型,即类class、枚举enum、接口interface、注解@interface,它们处于同一级别,Java就是通过注解来表示元数据的。

package com.guor.ClientNew; 
  
public @interface MyAnnotation { 
    // 定义公共的final静态属性 
    int age = 25; 
  
    // 定义公共的抽象方法 
    String name(); 
} 

Java注解本质上就是接口,是继承了Annotation接口的接口。

三、元注解

元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,它能够应用到其它的注解上面。

元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

1、@Retention

Retention,中文释义保留期的意思

当@Retention应用到注解上的时候,它解释说明了这个注解的生命周期。

  • RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
  • RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到JVM中。
  • RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载到JVM中。

2、@Documented

顾名思义,这个元注解肯定和文档有关。它的作用是能够将注解中的元素包含到Javadoc中去。

3、@Target

标明注解运用的地方。

  • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
  • ElementType.CONSTRUCTOR 可以给构造方法进行注解
  • ElementType.FIELD 可以给属性进行注解
  • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
  • ElementType.METHOD 可以给方法进行注解
  • ElementType.PACKAGE 可以给一个包进行注解
  • ElementType.PARAMETER 可以给一个方法内的参数进行注解
  • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举

4、@Inherited

lnherited是继承的意思。

如果一个超类被@Inherited注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。

代码实例

掌握 Java 注解,一夜陆地神仙 

5、@Repeatable

Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的,所以算是一个新的特性。

什么样的注解会多次应用呢?通常是注解的值可以同时取多个。

在生活中一个人往往是具有多种身份,如果我把每种身份当成一种注解该如何使用???

先声明一个Persons类用来包含所有的身份

@Target(ElementType.TYPE)   
@Retention(RetentionPolicy.RUNTIME) 
public @interface Persons { 
  Person[] value(); 
} 

这里@Target是声明Persons注解的作用范围,参数ElementType.Type代表可以给一个类型进行注解,比如类,接口,枚举。

@Retention是注解的有效时间,RetentionPolicy.RUNTIME是指程序运行的时候。

Person注解:

@Repeatable(Persons.class) 
public @interface Person{ 
  String role() default ""; 
} 

@Repeatable括号内的就相当于用来保存该注解内容的容器。

声明一个Man类,给该类加上一些身份。

@Person(role="CEO") 
@Person(role="husband") 
@Person(role="father") 
@Person(role="son") 
public class Man { 
  String name=""; 
} 

在主方法中访问该注解:

public static void main(String[] args) { 
    Annotation[] annotations = Man.class.getAnnotations();   
    System.out.println(annotations.length); 
    Persons p1=(Persons) annotations[0]; 
    for(Person t:p1.value()){ 
        System.out.println(t.role()); 
    } 
} 

下面的代码结果输出相同,但是可以先判断是否是相应的注解,比较严谨。

if(Man.class.isAnnotationPresent(Persons.class)) { 
    Persons p2=Man.class.getAnnotation(Persons.class); 
    for(Person t:p2.value()){ 
        System.out.println(t.role()); 
    } 
 } 

运行结果:

掌握 Java 注解,一夜陆地神仙

 

四、注解的属性

注解的属性也叫做成员变量,注解只有成员变量,没有方法。注解的成员变量在注解的定义中以“无参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。

@Target(ElementType.TYPE) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface TestAnnotation { 
    int id(); 
    String msg(); 
} 

上面代码中定义了TestAnnotation这个注解中拥有id和msg两个属性。在使用的时候,我们应该给他们进行赋值。

赋值的方式是在注解的括号内以value=“”形式,多个属性之前用,隔开。

@TestAnnotation(id=3,msg="hello annotation") 
public class Test { 
} 

需要注意的是,在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。

注解中属性可以有默认值,默认值需要用 default 关键值指定。比如:

@Target(ElementType.TYPE) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface TestAnnotation { 
    public int id() default -1; 
    public String msg() default "哪吒"; 
} 

TestAnnotation 中 id 属性默认值为 -1,msg 属性默认值为 哪吒。

它可以这样应用。

@TestAnnotation() 
public class Test {} 

因为有默认值,所以无需要再在 @TestAnnotation 后面的括号里面进行赋值了,这一步可以省略。

另外,还有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时,应用这个注解时可以直接将属性值填写到括号内。

public @interface Check { 
    String value(); 
} 

上面代码中,Check 这个注解只有 value 这个属性。所以可以这样应用。

@Check("hi") 
int a; 

这和下面的效果是一样的

@Check(value="hi") 
int a; 

最后,还需要注意的一种情况是一个注解没有任何属性。比如

public @interface Perform {} 

那么在应用这个注解的时候,括号都可以省略。

@Perform 
public void testMethod(){} 

五、Java自带的注解

学习了上面相关的知识,我们已经可以自己定义一个注解了。其实 Java 语言本身已经提供了几个现成的注解。

1、@Override

这个大家应该很熟悉了,提示子类要复写父类中被 @Override 修饰的方法

2、@Deprecated

加上这个注解之后,表示此方法或类不再建议使用,调用时会出现删除线,但不代表不能用,只是说,不推荐使用,因为有更好的方法可以调用。

那么直接删掉不就完了?

因为在一个项目中,工程比较大,代码比较多,而在后续的开发过程中,可能之前的某个方法实现的并不是很合理,这个时候要重新写一个方法,而之前的方法还不能随便删,因为别的地方可能在调用它,所以加上这个注解,就OK啦!

3、@SuppressWarning

阻止警告的意思。

该批注的作用是给编译器一条指令,告诉它对被批注的代码元素内部的某些警告保持静默。

4、@SafeVarargs

参数安全类型注解。

它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生unchecked这样的警告。

在声明具有模糊类型(比如:泛型)的可变参数的构造函数或方法时,Java编译器会报unchecked警告。鉴于这种情况,如果程序猿断定声明的构造函数和方法的主体no problem,可使用@SafeVarargs进行标记,这样Java编译器就不会报unchecked警告了!

5、@FunctionalInterface

Java 8为函数式接口引入了一个新注解@FunctionalInterface,主要用于编译级错误检查,加上该注解,当你写的接口不符合函数式接口定义的时候,编译器会报错。

它们主要用在Lambda表达式和方法引用(实际上也可认为是Lambda表达式)上。

如定义了一个函数式接口如下:

@FunctionalInterface 
interface GreetingService  
{ 
    void sayMessage(String message); 
} 

那么就可以使用Lambda表达式来表示该接口的一个实现(注:JAVA 8 之前一般是用匿名类实现的):

GreetingService greetService1  
= message -> System.out.println("Hello " + message); 

六、注解的使用场景

1、注解的官方释义

注解是一系列元数据,它提供数据用来解释程序代码,但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。

2、注解的用处

① 提供信息给编译器:编译器可以利用注解来探测错误或警告信息

② 编译阶段时的处理:软件工具可以利用注解信息来生成代码、HTML文档或其它响应处理。

③ 运行时的处理:某些注解可以在程序运行时接受代码的提取。

值得注意的是,注解不是代码本身的一部分。

3、注解的用法举例

public class ExampleUnitTest { 
    @Test 
    public void addition_isCorrect() throws Exception { 
        assertEquals(4, 2 + 2); 
    } 
} 

@Test 标记了要进行测试的方法 addition_isCorrect().

还有例如ssm框架等运用了大量的注解。

七、注解的本质

注解本质是一个继承了Annotation的特殊接口,其具体实现类是Java运行时生成的动态代理类。通过代理对象调用其自定义注解的方法,最终调用的是AnnotationInvocationHandler的invoke方法,该方法会从memberValues这个map中索引出对应的值,而memberValues的来源是Java常量池。

八、总结

1、注解就是标签,注解为了解释代码

2、注解的基本语法@interface

3、注解的元注解

4、注解的属性

5、注解主要给编译器及工具类型的软件用的

6、注解的提取要借助于Java的反射技术,反射比较慢,所以注解使用时也需要谨慎计较时间成本。

希望能对你有所帮助!

需要领取免费资料的小伙伴们,添加小助手vx:SOSOXWV  即可免费领取资料哦!

上一篇:用自定义IHttpModule实现URL重写


下一篇:6-2 线性探测法的查找函数