今日分享开始啦,请大家多多指教~
本篇将通过几点来剖析Java注解:
- 注解就是标签,注解为了解释代码
- 注解的根本语法@interface
- 注解的元注解
- 注解的属性
- 注解次要给编译器及工具类型的软件用的
- 注解的提取要借助于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注解过的注解进行注解的话,那么如果它的子类没有被任何注解利用的话,那么这个子类就继承了超类的注解。
代码实例
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()); } }
运行后果:
四、注解的属性
注解的属性也叫做成员变量,注解只有成员变量,没有办法。注解的成员变量在注解的定义中以“无参的办法”模式来申明,其办法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。
@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、@SuppressWarnings
阻止正告的意思。
该批注的作用是给编译器一条指令,通知它对被批注的代码元素外部的某些正告放弃静默。
注:这个注解有很多参数,这里就不多做赘述了,如有须要,请自行百度!
4、@SafeVarargs
参数平安类型注解。
它的目标是揭示开发者不要用参数做一些不平安的操作,它的存在会阻止编译器产生unchecked这样的正告。
在申明具备含糊类型(比方:泛型)的可变参数的构造函数或办法时,Java编译器会报unchecked正告。鉴于这种状况,如果程序猿判定申明的构造函数和办法的主体no problem,可应用@SafeVarargs进行标记,这样Java编译器就不会报unchecked正告了!
先看看@SafeVarargs在Java SE中的申明:
package java.lang;import java.lang.annotation.*;@Documented@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.CONSTRUCTOR, ElementType.METHOD})public @interface SafeVarargs {}
由Java源代码申明咱们理解到:@SafeVarargs注解,只能用于标记构造函数和办法,因为保留策略申明为RUNTIME,所以此注解能够在运行时失效。
@SafeVarargs注解,只能用于static或final的办法。
代码实例:
泛型参数的办法,不加注解的状况:
package com.guor.ClientNew; public class SafeVarargsAnnotation<S> { private S[] args; public SafeVarargsAnnotation(S... args){ this.args = args; } public void loopPrintArgs(S... args){ for (S arg : args){ System.out.println(arg); } } public final void printSelfArgs(S... args){ for (S arg : this.args) { System.out.println(arg); } } public static <T> void loopPrintInfo(T... infos){ for(T info:infos){ System.out.println(info); } } public static void main(String[] args) { SafeVarargsAnnotation.loopPrintInfo("A","B","C"); }}
注解的正确应用形式:
package com.guor.ClientNew;public class SafeVarargsAnnotation<S> { private S[] args; //构造函数能够应用@SafeVarargs标记 @SafeVarargs public SafeVarargsAnnotation(S... args){ this.args = args; } //此处不能应用@SafeVarargs,因为此办法未声明为static或final办法, // 如果要克制unchecked正告,能够应用@SuppressWarnings注解 @SuppressWarnings("unchecked") public void loopPrintArgs(S... args){ for (S arg : args){ System.out.println(arg); } } //final办法能够应用@SafeVarargs标记 @SafeVarargs public final void printSelfArgs(S... args){ for (S arg : this.args) { System.out.println(arg); } } //static办法能够应用@SafeVarargs标记 @SafeVarargs public static <T> void loopPrintInfo(T... infos){ for(T info:infos){ System.out.println(info); } } public static void main(String[] args) { SafeVarargsAnnotation.loopPrintInfo("A","B","C"); }}
5、@FunctionalInterface
Java 8为函数式接口引入了一个新注解@FunctionalInterface,次要用于编译级谬误查看,加上该注解,当你写的接口不合乎函数式接口定义的时候,编译器会报错。
它们次要用在Lambda表达式和办法援用(实际上也可认为是Lambda表达式)上。
如定义了一个函数式接口如下:
@FunctionalInterfaceinterface GreetingService{void sayMessage(String message);}
那么就能够应用Lambda表达式来示意该接口的一个实现(注:JAVA 8 之前个别是用匿名类实现的):
GreetingService greetService1 = message -> System.out.println("Hello " + message);
浅谈lambda表达式<最通俗易懂的解说>
六、注解与反射
1、注解通过反射获取
首先能够通过 Class 对象的 isAnnotationPresent() 办法判断它是否利用了某个注解。
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
2、getAnnotations() 办法
public Annotation[] getAnnotations() {}
前一种办法返回指定类型的注解,后一种办法返回注解到这个元素上的所有注解。
3、代码实例:
① 没加注解的时候:
屁都没有!
② 加上注解
这个正是 TestAnnotation 中 id 和 msg 的默认值。
下面的例子只是检阅出了注解在类上的注解,其实属性、办法上的注解也是一样的。同样还是要假手与反射。
③ 属性和办法上的注解:
package com.guor.Annotation;import OSChina.ClientNew.Hero;import java.lang.annotation.Annotation;import java.lang.reflect.Field;import java.lang.reflect.Method;@TestAnnotation(msg="hello")public class Test { @Check(value="hi") int a; @Perform public void testMethod(){} @SuppressWarnings("deprecation") public void test1(){ Hero hero = new Hero(); hero.say(); hero.speak(); } public static void main(String[] args) { boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class); if ( hasAnnotation ) { TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class); //获取类的注解 System.out.println("id:"+testAnnotation.id()); System.out.println("msg:"+testAnnotation.msg()); } try { Field a = Test.class.getDeclaredField("a"); a.setAccessible(true); //获取一个成员变量上的注解 Check check = a.getAnnotation(Check.class); if ( check != null ) { System.out.println("check value:"+check.value()); } Method testMethod = Test.class.getDeclaredMethod("testMethod"); if ( testMethod != null ) { // 获取办法中的注解 Annotation[] ans = testMethod.getAnnotations(); for( int i = 0;i < ans.length;i++) { System.out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName()); } } } catch (NoSuchFieldException e) { // TODO Auto-generated catch block e.printStackTrace(); System.out.println(e.getMessage()); } catch (SecurityException e) { // TODO Auto-generated catch block e.printStackTrace(); System.out.println(e.getMessage()); } catch (NoSuchMethodException e) { // TODO Auto-generated catch block e.printStackTrace(); System.out.println(e.getMessage()); } }}
须要留神的是,如果一个注解要在运行时被胜利提取,那么 @Retention(RetentionPolicy.RUNTIME) 是必须的。
七、注解的应用场景
1、注解的官网释义
注解是一系列元数据,它提供数据用来解释程序代码,然而注解并非是所解释的代码自身的一部分。注解对于代码的运行成果没有间接影响。
2、注解有许多用途:
① 提供信息给编译器:编译器能够利用注解来探测谬误或正告信息
② 编译阶段时的解决:软件工具能够利用注解信息来生成代码、HTML文档或其它响应解决。
③ 运行时的解决:某些注解能够在程序运行时承受代码的提取。
值得注意的是,注解不是代码自身的一部分。
3、注解使用的中央太多了,比方JUnit测试框架,典型的应用办法
@Test 标记了要进行测试的办法 addition_isCorrect().
还有例如ssm框架等使用了大量的注解。
八、注解的利用实例
该注解Desc前减少了三个注解:Retention示意的是该注解的保留级别,Target示意的是注解能够标注在什么中央,@Inherited示意该注解会被主动继承。
下面程序申明了一个Bird抽象类,并且标注了Desc注解,形容鸟类的色彩是红色,而后编写一个麻雀Sparrow类,它有两个构造函数,一个是默认的构造函数,也就是咱们常常看到的麻雀是浅灰色的,另外一个构造函数是自定义麻雀的色彩,之后又定义了一个鸟巢(工厂办法模式),它是专门负责鸟类滋生的,它的生产办法reproduce会依据实现类注解信息生成不同色彩的麻雀。咱们编写一个客户端调用,代码如下:
会打印出什么呢?因为采纳了工厂办法模式,它次要的问题是bird比那里到底采纳了哪个构造函数来生成,如果独自看子类Sparrow,它没有任何正文,那工厂办法中bd变量应该就是null了,应该调用无参结构!
输入为什么会是红色呢?这是咱们增加到父类的色彩,why?这是因为咱们在注解上加了@Inherited注解,它示意的意思是咱们只有把注解@Desc加到父类Bird上,它的所有子类都会从父类继承@Desc注解。
小结:
Java注解(Annotation)亦叫Java标注,是JDK5.0开始引入的一种正文机制。 能够对包、类、接口、字段、办法参数、局部变量等进行注解。注解能够设置存在于不同的生命周期中,例如SOURCE(源码中),CLASS(Class文件中,默认是此保留级别),RUNTIME(运行期中)。
今日份分享已完结,请大家多多包涵和指导!