>  기사  >  Java  >  원하는 모든 Java 주석이 여기에 있습니다. 살펴보세요.

원하는 모든 Java 주석이 여기에 있습니다. 살펴보세요.

php是最好的语言
php是最好的语言원래의
2018-07-30 11:57:471595검색

기사 시작 부분에 사진을 소개하세요.

원하는 모든 Java 주석이 여기에 있습니다. 살펴보세요.

Annotation은 중국어로 주석과 주석을 뜻합니다. Java에서 Annotation은 매우 중요한 지식 포인트이지만 초보자가 이해하기 어려운 경우가 많습니다.

저는 개인적으로 열악한 기술 문서의 주요 특징 중 하나가 전문 용어를 사용하여 전문 용어를 소개하는 것이라고 생각합니다.

예:

Java 주석은 Java 코드에 대한 메타데이터를 제공하는 데 사용됩니다. 메타데이터로서 주석은 코드 실행에 직접적인 영향을 미치지 않지만 실제로 이 목적으로 사용할 수 있는 몇 가지 유형의 주석이 있습니다. Java 주석은 Java5부터 Java에 추가되었습니다.

이것은 대부분의 웹사이트에 있는 Java 주석입니다. 설명은 실제로 정확하지만 솔직히 처음 배웠을 때 마음이 멍했습니다. 이게 뭔가요? 마치 그는 아무 것도 듣지 못한 것 같았습니다. 개념이 너무 추상적이기 때문에 초보자가 이해하기가 정말 어렵습니다. 그러다가 자신의 개발 과정에서 계속해서 연습을 강화하면 천천히 올바른 이해가 형성됩니다.

이 글을 쓰면서 생각했어요. 나 또는 독자들이 어떻게 주석의 개념을 보다 직관적으로 이해할 수 있습니까? 공식 문서의 지침을 번역하시겠습니까? 나는 즉시 이 답변을 거부했습니다.

나중에 저는 잉크가 증발하여 다양한 색상을 가질 수 있다는 것을 생각해냈습니다. 이는 설명하고 주석을 달기에 적합합니다.

그런데 계속 고민한 끝에 잉크를 대신할 수 있는 것이 생각났는데 그게 바로 도장이었습니다. 도장은 다양한 잉크나 잉크 패드에 ​​담글 수 있으며, 원하는 경우 도장의 텍스트나 패턴을 맞춤 설정할 수도 있습니다.

그런데 계속해서 다양하게 고민하다가 씰을 대신할 수 있는 게 더 좋을 것 같다는 생각이 들었고, 그게 바로 라벨이었습니다. 라벨은 편리한 종이 조각으로 라벨에 적힌 내용을 자유롭게 정의할 수 있습니다. 일반적인 예로는 선반의 제품 가격 태그, 도서관의 도서 코딩 태그, 실험실의 화학 물질 이름 카테고리 태그 등이 있습니다.

그리고 더 추상적으로 말하면 라벨은 반드시 종이 한 장일 필요는 없으며 사람과 사물에 대한 속성 평가일 수 있습니다. 즉, 레이블에는 추상적인 것에 대한 설명이 있습니다.

원하는 모든 Java 주석이 여기에 있습니다. 살펴보세요.

그래서 이를 바탕으로 지식 업그레이드를 완료했고, 주석을 설명하기 위해 라벨을 사용하기로 했습니다.

주석은 태그와 같습니다

블로그 게시물 처음으로 돌아가기 특정 뉴스 클라이언트의 댓글에는 새 건물을 짓는 습관이 있어서 "일은 휴대폰을 재정의했고, 뤄용호는 어리석은 X를 재정의했습니다"가 자주 등장했습니다. 바닥이 매우 깔끔하게 정리되어 있으며 대다수의 네티즌들은 오랫동안 이 동작을 즐겨왔습니다. 이는 실제로 라벨링과 동일합니다.

일부 네티즌의 눈에는 뤄용하오가 멍청함의 대명사가 되었습니다.

네티즌 대다수는 나용호를 "멍청하다"라고 낙인찍고 있는데, 이는 나용하오를 직접적이고 빠르게 평가할 수 있도록 돕고, 이를 바탕으로 저녁 식사 후 나용하오가 화제가 될 수 있다는 것. 이것이 레이블의 힘이다.

인터넷 반대편에서 라오뤄는 그의 카리스마로 자연스럽게 많은 충성스러운 팬을 확보했고, 그들은 라오뤄에게 또 다른 라벨을 붙였습니다.
원하는 모든 Java 주석이 여기에 있습니다. 살펴보세요.

라오뤄는 여전히 라오뤄이지만 사람들이 그에게 다른 꼬리표를 붙이기 때문에 그에 대한 견해도 매우 다릅니다. 그를 좋아하지 않는 사람들은 하루 종일 인터넷에서 그를 비난하고 조롱합니다. 그를 존경하고 감사하는 사람들은 기꺼이 돈을 벌어 스마티산 휴대폰 출시 컨퍼런스 티켓을 살 것입니다.

저는 이 두 가지 행동을 평가할 생각이 없습니다. 다른 예를 들어보겠습니다.

'치파숴'는 최근 인터넷에서 매우 인기 있는 토론 프로그램으로, 그 속에서 토론자 천밍은 다른 토론자 마웨이웨이에게 "우주의 중심에 서서 사랑을 외치고 있다"며 공격을 당했다. "라고 말한 뒤 'Chicken Soup Man'이라는 큰 라벨을 게시했습니다. 이후 시청자들이 Chen Ming을 다시 보았을 때 가장 먼저 떠오른 것은 'Chicken Soup Man'이라는 세 인물이었습니다. 사실 Chen Ming 자신은 그는 매우 훌륭하고 다른 사람들의 롤 모델이며 품위 있는 스타일과 품위 있는 대화와 행동을 가지고 있지만 인터넷에서는 오락 중심의 환경으로 인해 사람들은 모든 것을 오락적인 사고 방식으로 인식하려는 경향이 더 많기 때문에 " 치킨 수프 사나이'는 천밍 자신이 말했듯이 불멸의 인물이 됐다. 라벨.

레이블은 특정 관점에서 사물의 동작을 평가하고 설명하는 추상적인 요약을 만들 수 있습니다.

이제 드디어 이 글의 주인공을 소개할 수 있게 되었습니다.

초보자는 주석을 이런 식으로 이해할 수 있습니다. 코드가 살아 있고 주석이 코드의 일부 살아있는 개인에 부착된 레이블이라고 상상해 보세요. 단순화하기 위해 주석은 레이블과 같습니다.

주석의 특정 구문을 배우기 전에 주석을 레이블로 생각할 수 있습니다. 이는 일반적인 기능을 빠르게 이해하는 데 도움이 됩니다. 초보자가 학습 과정에서 머리가 비어 있다면 당황하지 말고 스스로에게 다음과 같이 말하십시오.

주석, 라벨. 주석, 라벨.

Annotation 구문

일반적인 개발에서는 드물기 때문에 Annotation의 상태가 높지 않다고 생각하시는 분들이 많을 거라 믿습니다. 실제로 클래스 및 인터페이스와 마찬가지로 주석도 유형에 속합니다. Java SE 5.0 버전에서 도입된 개념이다.

주석 정의

주석은 @interface 키워드를 통해 정의됩니다.

public @interface TestAnnotation {}
  • 1

  • 2

형태는 인터페이스와 매우 유사하지만 앞에 @ 기호가 있습니다. 위 코드는 TestAnnotation이라는 주석을 생성합니다.

TestAnnotation이라는 라벨을 만든다고 간단히 이해하시면 됩니다.

Annotation 적용

위에서 Annotation을 생성했는데, Annotation을 사용하는 방법은 무엇인가요?

@TestAnnotationpublic class Test {}
  • 1

  • 2

  • 3

Test 클래스를 만든 다음 @TestAnnotation을 클래스 정의에 추가하여 이 클래스에 TestAnnotation 주석을 답니다.

Test 클래스에 TestAnnotation 라벨을 붙이면 간단히 이해하실 수 있습니다.

그러나 주석이 제대로 작동하려면 메타 주석이라는 새로운 개념을 도입해야 합니다.

원 주석

원 주석은 무엇을 의미하나요?

Meta-annotation은 Annotation에 Annotation을 추가할 수 있는 Annotation입니다. 즉, Meta-annotation은 기본 Annotation이지만 다른 Annotation에도 적용이 가능합니다.

이해하기 어렵다면 이렇게 이해하시면 됩니다. 메타 주석도 태그이지만 다른 일반 태그를 설명하는 기능과 목적이 있는 특수 태그입니다.

메타 태그에는 @Retention, @Documented, @Target, @Inherited 및 @Repeatable의 5가지 유형이 있습니다.

@Retention

Retention은 영어로 Retention을 의미합니다. @Retention이 주석에 적용되면 주석이 유지되는 기간을 설명합니다.

값은 다음과 같습니다.
- RetentionPolicy.SOURCE 주석은 소스 코드 단계에서만 유지되며 컴파일 시 컴파일러에 의해 삭제되고 무시됩니다.
- RetentionPolicy.CLASS 주석은 컴파일이 진행될 때까지만 유지되며 JVM에 로드되지 않습니다.
- RetentionPolicy.RUNTIME 주석은 프로그램이 실행될 때까지 유지될 수 있으며 JVM에 로드되므로 프로그램이 실행될 때 얻을 수 있습니다.

이렇게 하면 @Retention이 라벨을 설명할 때 라벨이 게시되는 시간을 지정하여 이해를 깊게 할 수 있습니다. @Retention은 레이블에 타임스탬프를 찍는 것과 동일하며 타임스탬프는 레이블이 게시된 기간을 나타냅니다.

@Retention(RetentionPolicy.RUNTIME)public @interface TestAnnotation {}
  • 1

  • 2

  • 3

위 코드에서는 프로그램 실행 주기 동안 TestAnnotation을 얻을 수 있도록 지정했기 때문에 수명 주기가 매우 깁니다.

@Documented

이름에서 알 수 있듯이 이 메타 주석은 확실히 문서와 관련이 있습니다. 그 기능은 주석의 요소를 Javadoc에 포함시키는 것입니다.

@Target

Target은 대상을 의미하고 @Target은 주석이 사용되는 위치를 지정합니다.

이렇게 이해하면 @Target으로 주석을 달면 주석이 사용 시나리오로 제한됩니다.

태그와 유사합니다. 원래 태그는 원하는 곳에 게시할 수 있지만 @Target의 존재로 인해 게시되는 위치가 매우 구체적입니다. 예를 들어 메소드, 클래스 및 메소드에만 게시할 수 있습니다. 매개변수 등 @Target에는 다음 값이 있습니다. ​​

  • ElementType.ANNOTATION_TYPE은 주석을 달 수 있습니다.

  • ElementType.CONSTRUCTOR는 생성자에 주석을 달 수 있습니다.

  • ElementType.FIELD는 속성에 주석을 달 수 있습니다.

  • Element .LOCAL_VARIABLE 유형은 로컬에 주석을 달 수 있습니다. 변수

  • ElementType.METHOD는 메소드에 주석을 달 수 있습니다

  • ElementType.PACKAGE는 패키지에 주석을 달 수 있습니다

  • ElementType.PARAMETER는 메소드 내의 매개변수에 주석을 달 수 있습니다

  • ElementType.TYPE은 class, interface, enumeration

@Inherited

Inherited는 상속을 의미하지만 주석 자체가 상속될 수 있다는 의미는 아니지만 슈퍼 클래스에 @Inherited 주석이 달린 경우 해당 하위 클래스가 어떤 주석도 적용되지 않은 경우 이 하위 클래스는 슈퍼클래스의 주석을 상속합니다.
아주 추상적이에요. 설명하기 위한 코드입니다. ㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋ 7

  • 8

  • 9

  • 10

  • 11

注解 Test 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A,类 B 也拥有 Test 这个注解。

可以这样理解:

老子非常有钱,所以人们给他贴了一张标签叫做富豪。

老子的儿子长大后,只要没有和老子断绝父子关系,虽然别人没有给他贴标签,但是他自然也是富豪。

老子的孙子长大了,自然也是富豪。

这就是人们口中戏称的富一代,富二代,富三代。虽然叫法不同,好像好多个标签,但其实事情的本质也就是他们有一张共同的标签,也就是老子身上的那张富豪的标签。

@Repeatable

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

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

举个例子,一个人他既是程序员又是产品经理,同时他还是个画家。

@interface Persons {
    Person[]  value();
}@Repeatable(Persons.class)@interface Person{
    String role default "";
}@Person(role="artist")@Person(role="coder")@Person(role="PM")public class SuperMan{}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

  • 12

  • 13

  • 14

  • 15

  • 16

  • 17

  • 18

  • 19

注意上面的代码,@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解。

什么是容器注解呢?就是用来存放其它注解的地方。它本身也是一个注解。

我们再看看代码中的相关容器注解。

@interface Persons {
    Person[]  value();
}
  • 1

  • 2

  • 3

按照规定,它里面必须要有一个 value 的属性,属性类型是一个被 @Repeatable 注解过的注解数组,注意它是数组。

如果不好理解的话,可以这样理解。Persons 是一张总的标签,上面贴满了 Person 这种同类型但内容不一样的标签。把 Persons 给一个 SuperMan 贴上,相当于同时给他贴了程序员、产品经理、画家的标签。

我们可能对于 @Person(role=”PM”) 括号里面的内容感兴趣,它其实就是给 Person 这个注解的 role 属性赋值为 PM ,大家不明白正常,马上就讲到注解的属性这一块。

注解的属性

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

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)public @interface TestAnnotation {

    int id();

    String msg();

}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

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

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

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

  • 2

  • 3

  • 4

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

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

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)public @interface TestAnnotation {

    public int id() default -1;    public String msg() default "Hi";

}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

TestAnnotation 中 id 属性默认值为 -1,msg 属性默认值为 Hi。
它可以这样应用。

@TestAnnotation()public class Test {}
  • 1

  • 2

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

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

public @interface Check {
    String value();
}
  • 1

  • 2

  • 3

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

@Check("hi")int a;
  • 1

  • 2

这和下面的效果是一样的

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

  • 2

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

public @interface Perform {}
  • 1

  • 2

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

@Performpublic void testMethod(){}
  • 1

  • 2

Java 预置的注解

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

@Deprecated

这个元素是用来标记过时的元素,想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告,告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

public class Hero {

    @Deprecated
    public void say(){
        System.out.println("Noting has to say!");
    }    public void speak(){
        System.out.println("I have a dream!");
    }


}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

  • 12

  • 13

  • 14

  • 15

定义了一个 Hero 类,它有两个方法 say() 和 speak() ,其中 say() 被 @Deprecated 注解。然后我们在 IDE 中分别调用它们。
원하는 모든 Java 주석이 여기에 있습니다. 살펴보세요.

可以看到,say() 方法上面被一条直线划了一条,这其实就是编译器识别后的提醒效果。

@Override

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

@SuppressWarnings

阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后,编译器会警告提醒,而有时候开发者会忽略这种警告,他们可以在调用的地方通过 @SuppressWarnings 达到目的。

@SuppressWarnings("deprecation")public void test1(){
    Hero hero = new Hero();
    hero.say();
    hero.speak();
}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

@SafeVarargs

参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。

@SafeVarargs // Not actually safe!
    static void m(List<String>... stringLists) {
    Object[] array = stringLists;
    List<Integer> tmpList = Arrays.asList(42);
    array[0] = tmpList; // Semantically invalid, but compiles without warnings
    String s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

上面的代码中,编译阶段不会报错,但是运行时会抛出 ClassCastException 这个异常,所以它虽然告诉开发者要妥善处理,但是开发者自己还是搞砸了。

Java 官方文档说,未来的版本会授权编译器对这种不安全的操作产生错误警告。

@FunctionalInterface

函数式接口注解,这个是 Java 1.8 版本引入的新特性。函数式编程很火,所以 Java 8 也及时添加了这个特性。

函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。

比如

@FunctionalInterfacepublic interface Runnable {
    /**
     * When an object implementing interface <code>Runnable</code> is used
     * to create a thread, starting the thread causes the object&#39;s
     * <code>run</code> method to be called in that separately executing
     * thread.
     * <p>
     * The general contract of the method <code>run</code> is that it may
     * take any action whatsoever.
     *
     * @see     java.lang.Thread#run()
     */
    public abstract void run();
}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

  • 12

  • 13

  • 14

  • 15

  • 16

我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口,上面源码可以看到它就被 @FunctionalInterface 注解。

可能有人会疑惑,函数式接口标记有什么用,这个原因是函数式接口可以很容易转换为 Lambda 表达式。这是另外的主题了,有兴趣的同学请自己搜索相关知识点学习。

注解的提取

博文前面的部分讲了注解的基本语法,现在是时候检测我们所学的内容了。

我通过用标签来比作注解,前面的内容是讲怎么写注解,然后贴到哪个地方去,而现在我们要做的工作就是检阅这些标签内容。 形象的比喻就是你把这些注解标签在合适的时候撕下来,然后检阅上面的内容信息。

要想正确检阅注解,离不开一个手段,那就是反射。

注解与反射。

注解通过反射获取。首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
  • 1

  • 2

然后通过 getAnnotation() 方法来获取 Annotation 对象。

 public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}
  • 1

  • 2

或者是 getAnnotations() 方法。

public Annotation[] getAnnotations() {}
  • 1

  • 2

前一种方法返回指定类型的注解,后一种方法返回注解到这个元素上的所有注解。

如果获取到的 Annotation 如果不为 null,则就可以调用它们的属性方法了。比如

@TestAnnotation()public class Test {

    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());
        }

    }

}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

  • 12

  • 13

  • 14

  • 15

  • 16

  • 17

  • 18

程序的运行结果是:

id:-1msg:
  • 1

  • 2

  • 3

这个正是 TestAnnotation 中 id 和 msg 的默认值。

上面的例子中,只是检阅出了注解在类上的注解,其实属性、方法上的注解照样是可以的。同样还是要假手于反射。

@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());
        }



    }

}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

  • 12

  • 13

  • 14

  • 15

  • 16

  • 17

  • 18

  • 19

  • 20

  • 21

  • 22

  • 23

  • 24

  • 25

  • 26

  • 27

  • 28

  • 29

  • 30

  • 31

  • 32

  • 33

  • 34

  • 35

  • 36

  • 37

  • 38

  • 39

  • 40

  • 41

  • 42

  • 43

  • 44

  • 45

  • 46

  • 47

  • 48

  • 49

  • 50

  • 51

  • 52

  • 53

  • 54

  • 55

  • 56

  • 57

  • 58

  • 59

  • 60

  • 61

  • 62

  • 63

  • 64

  • 65

  • 66

  • 67

  • 68

  • 69

  • 70

它们的结果如下:

id:-1msg:hello
check value:himethod testMethod annotation:Perform
  • 1

  • 2

  • 3

  • 4

  • 5

需要注意的是,如果一个注解要在运行时被成功提取,那么 @Retention(RetentionPolicy.RUNTIME) 是必须的。

注解的使用场景

我相信博文讲到这里大家都很熟悉了注解,但是有不少同学肯定会问,注解到底有什么用呢?

对啊注解到底有什么用?

我们不妨将目光放到 Java 官方文档上来。

文章开始的时候,我用标签来类比注解。但标签比喻只是我的手段,而不是目的。为的是让大家在初次学习注解时能够不被那些抽象的新概念搞懵。既然现在,我们已经对注解有所了解,我们不妨再仔细阅读官方最严谨的文档。

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

注解有许多用处,主要如下:
 - 提供信息给编译器: 编译器可以利用注解来探测错误和警告信息
 - 编译阶段时的处理:  软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。
 - 运行时的处理:  某些注解可以在程序运行的时候接受代码的提取

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

如果难于理解,可以这样看。罗永浩还是罗永浩,不会因为某些人对于他“傻x”的评价而改变,标签只是某些人对于其他事物的评价,但是标签不会改变事物本身,标签只是特定人群的手段。所以,注解同样无法改变代码本身,注解只是某些工具的的工具。

还是回到官方文档的解释上,注解主要针对的是编译器和其它工具软件(SoftWare tool)。

当开发者使用了Annotation 修饰了类、方法、Field 等成员之后,这些 Annotation 不会自己生效,必须由开发者提供相应的代码来提取并处理 Annotation 信息。这些处理提取和处理 Annotation 的代码统称为 APT(Annotation Processing Tool)。

现在,我们可以给自己答案了,注解有什么用?给谁用?给 编译器或者 APT 用的。

如果,你还是没有搞清楚的话,我亲自写一个好了。

亲手自定义注解完成某个目的

我要写一个测试框架,测试程序员的代码有无明显的异常。

—— 程序员 A : 我写了一个类,它的名字叫做 NoBug,因为它所有的方法都没有错误。
—— 我:自信是好事,不过为了防止意外,让我测试一下如何?
—— 程序员 A: 怎么测试?
—— 我:把你写的代码的方法都加上 @Jiecha 这个注解就好了。
—— 程序员 A: 好的。

NoBug.java

package ceshi;import ceshi.Jiecha;public class NoBug {

    @Jiecha
    public void suanShu(){
        System.out.println("1234567890");
    }    @Jiecha
    public void jiafa(){
        System.out.println("1+1="+1+1);
    }    @Jiecha
    public void jiefa(){
        System.out.println("1-1="+(1-1));
    }    @Jiecha
    public void chengfa(){
        System.out.println("3 x 5="+ 3*5);
    }    @Jiecha
    public void chufa(){
        System.out.println("6 / 0="+ 6 / 0);
    }    public void ziwojieshao(){
        System.out.println("我写的程序没有 bug!");
    }

}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

  • 12

  • 13

  • 14

  • 15

  • 16

  • 17

  • 18

  • 19

  • 20

  • 21

  • 22

  • 23

  • 24

  • 25

  • 26

  • 27

  • 28

  • 29

  • 30

  • 31

  • 32

上面的代码,有些方法上面运用了 @Jiecha 注解。

这个注解是我写的测试软件框架中定义的注解。

package ceshi;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;@Retention(RetentionPolicy.RUNTIME)public @interface Jiecha {}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

然后,我再编写一个测试类 TestTool 就可以测试 NoBug 相应的方法了。

package ceshi;import java.lang.reflect.InvocationTargetException;import java.lang.reflect.Method;public class TestTool {

    public static void main(String[] args) {        // TODO Auto-generated method stub

        NoBug testobj = new NoBug();

        Class clazz = testobj.getClass();

        Method[] method = clazz.getDeclaredMethods();        //用来记录测试产生的 log 信息
        StringBuilder log = new StringBuilder();        // 记录异常的次数
        int errornum = 0;        for ( Method m: method ) {            // 只有被 @Jiecha 标注过的方法才进行测试
            if ( m.isAnnotationPresent( Jiecha.class )) {                try {
                    m.setAccessible(true);
                    m.invoke(testobj, null);

                } catch (Exception e) {                    // TODO Auto-generated catch block
                    //e.printStackTrace();
                    errornum++;
                    log.append(m.getName());
                    log.append(" ");
                    log.append("has error:");
                    log.append("\n\r  caused by ");                    //记录测试过程中,发生的异常的名称
                    log.append(e.getCause().getClass().getSimpleName());
                    log.append("\n\r");                    //记录测试过程中,发生的异常的具体信息
                    log.append(e.getCause().getMessage());
                    log.append("\n\r");
                } 
            }
        }


        log.append(clazz.getSimpleName());
        log.append(" has  ");
        log.append(errornum);
        log.append(" error.");        // 生成测试报告
        System.out.println(log.toString());

    }

}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

  • 12

  • 13

  • 14

  • 15

  • 16

  • 17

  • 18

  • 19

  • 20

  • 21

  • 22

  • 23

  • 24

  • 25

  • 26

  • 27

  • 28

  • 29

  • 30

  • 31

  • 32

  • 33

  • 34

  • 35

  • 36

  • 37

  • 38

  • 39

  • 40

  • 41

  • 42

  • 43

  • 44

  • 45

  • 46

  • 47

  • 48

  • 49

  • 50

  • 51

  • 52

  • 53

  • 54

  • 55

  • 56

  • 57

  • 58

  • 59

  • 60

测试的结果是:

12345678901+1=111-1=03 x 5=15chufa has error:

  caused by ArithmeticException

/ by zero

NoBug has  1 error.
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

  • 12

提示 NoBug 类中的 chufa() 这个方法有异常,这个异常名称叫做 ArithmeticException,原因是运算过程中进行了除 0 的操作。

所以,NoBug 这个类有 Bug。

这样,通过注解我完成了我自己的目的,那就是对别人的代码进行测试。

所以,再问我注解什么时候用?我只能告诉你,这取决于你想利用它干什么用。

注解应用实例

注解运用的地方太多了,因为我是 Android 开发者,所以我接触到的具体例子有下:

JUnit

JUnit 这个是一个测试框架,典型使用方法如下:

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

  • 2

  • 3

  • 4

  • 5

  • 6

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

ButterKnife

ButterKnife 是 Android 开发中大名鼎鼎的 IOC 框架,它减少了大量重复的代码。

public class MainActivity extends AppCompatActivity {

    @BindView(R.id.tv_test)
    TextView mTv;    @Override
    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        ButterKnife.bind(this);
    }
}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

  • 12

  • 13

Dagger2

也是一个很有名的依赖注入框架。

Retrofit

很牛逼的 Http 网络访问框架

public interface GitHubService {
  @GET("users/{user}/repos")
  Call<List<Repo>> listRepos(@Path("user") String user);
}

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .build();

GitHubService service = retrofit.create(GitHubService.class);
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

当然,还有许多注解应用的地方,这里不一一列举。

总结

  1. 如果注解难于理解,你就把它类同于标签,标签为了解释事物,注解为了解释代码。

  2. 注解的基本语法,创建如同接口,但是多了个 @ 符号。

  3. 注解的元注解。

  4. 注解的属性。

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

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

相关文章:

Java自定义注解

Java 주석 튜토리얼 및 사용자 정의 주석

관련 동영상:

종합 Java 주석 분석

위 내용은 원하는 모든 Java 주석이 여기에 있습니다. 살펴보세요.의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.