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

Java 주석은 코드에 대한 일부 정보를 제공하지만 주석이 달린 코드의 내용에 직접적인 영향을 주지는 않습니다. 이 튜토리얼에서는 Java 주석, 주석을 사용자 정의하는 방법, 주석의 사용 및 리플렉션을 통해 주석을 구문 분석하는 방법을 배웁니다.

Java 1.5에는 현재 Hibernate, Jersey, Spring 등 많은 Java 프레임워크에서 널리 사용되는 주석이 도입되었습니다. 주석은 프로그램의 메타데이터로 프로그램에 포함됩니다. 주석은 일부 구문 분석 도구나 컴파일 도구로 구문 분석할 수 있습니다. 컴파일이나 실행 중에 영향을 미치도록 주석을 선언할 수도 있습니다.

Annotation을 사용하기 전에는 프로그램 소스 데이터가 Java Annotation과 javadoc을 통해서만 전달됐지만 Annotation이 제공하는 기능은 이를 훨씬 뛰어넘는다. 주석은 메타데이터를 포함할 뿐만 아니라 프로그램 실행 중에도 사용될 수 있습니다. 주석 해석기는 주석을 통해 프로그램의 실행 순서를 결정할 수 있습니다. 예를 들어 Jersey 웹 서비스에서는 URI 문자열 형식의 **PATH** 주석을 메소드에 추가한 다음 프로그램 실행 중에 Jersey 인터프리터가 지정된 URI를 호출할 메소드를 결정합니다.

Java 사용자 정의 주석 생성

사용자 정의 주석 생성은 인터페이스 생성과 유사하지만 주석의 인터페이스 키워드는 @ 기호로 시작해야 합니다. 주석에 대한 메서드를 선언할 수 있습니다. 먼저 주석의 예를 살펴본 다음 주석의 몇 가지 기능에 대해 논의하겠습니다.

package com.journaldev.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Documented
@Target(ElementType.METHOD)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
   public @interface MethodInfo{
   String author() default 'Pankaj';
   String date();
   int revision() default 1;
   String comments();
}

• 주석 메소드는 매개변수를 가질 수 없습니다.

• 주석 메소드 반환 값 유형은 기본 유형, 문자열, 열거형, 주석 또는 배열로 제한됩니다. 이러한 유형 중

• 주석 메소드에는 다른 주석을 추가하는 데 사용되는 메타 주석이 포함될 수 있습니다. .

• 메타 주석에는 네 가지 유형이 있습니다.

1. @Documented - 이 주석이 있는 요소가 javadoc과 같은 도구로 문서화될 수 있음을 나타냅니다. 이 유형은 주석이 달린 요소를 사용하여 클라이언트 선언에 영향을 미치는 유형에 주석을 다는 데 사용해야 합니다. 선언에 Documented라는 주석이 달린 경우 이 유형의 주석은 주석이 달린 프로그램 멤버의 공용 API로 사용됩니다.

2. @Target - 이 유형의 주석을 달 수 있는 프로그램 요소의 범위를 나타냅니다. 이 메타 주석의 값은 TYPE, METHOD, CONSTRUCTOR, FIELD 등이 될 수 있습니다. Target 메타 주석이 없으면 정의된 주석을 프로그램의 모든 요소에 적용할 수 있습니다.

3. @Inherited - 주석 유형이 자동으로 상속됨을 나타냅니다. 사용자가 현재 클래스에서 이 메타 주석 유형을 쿼리하고 현재 클래스의 선언에 이 메타 주석 유형이 포함되어 있지 않으면 현재 클래스의 상위 클래스에도 자동으로 쿼리되어 상속된 메타가 있는지 확인합니다. -annotation. 이 작업은 해당 주석 유형이 발견되거나 최상위 상위 클래스가 쿼리될 때까지 반복적으로 실행됩니다.

4.@Retention - 주석이 보존되는 기간을 지정합니다. RetentionPolicy의 값은 SOURCE, CLASS, RUNTIME입니다.

Java 내장 주석

Java는 세 가지 내장 주석을 제공합니다.

1. @Override - 상위 클래스의 메서드를 재정의하려면 이 주석을 사용하여 이 메서드를 재정의하겠다고 컴파일러에 알려야 합니다. 이러한 방식으로 컴파일러는 부모 클래스의 메서드가 제거되거나 변경될 때 오류 메시지를 표시합니다.

2. @Deprecated - 특정 메소드가 더 이상 사용되지 않음을 컴파일러에 알리고 싶을 때 이 주석을 사용해야 합니다. Java는 javadoc에서 이 주석을 사용할 것을 권장하며, 이 메서드가 더 이상 사용되지 않는 이유와 대안을 제공해야 합니다.

3. @SuppressWarnings - 제네릭의 기본 데이터 유형 사용과 같은 특정 경고 메시지를 무시하도록 컴파일러에 지시합니다. 보존 정책은 SOURCE(번역자 주: 소스 파일에서 유효함)이며 컴파일러에 의해 삭제됩니다.

위에서 언급한 Custom Annotation을 참고하여 Java 내장 Annotation의 예를 살펴보겠습니다.

package com.journaldev.annotations;

import java.io.FileNotFoundException;
import java.util.ArrayList;
import java.util.List;

public class AnnotationExample {

public static void main(String[] args) {
}

@Override
@MethodInfo(author = 'Pankaj', comments = 'Main method', date = 'Nov 17 2012', revision = 1)
public String toString() {
   return 'Overriden toString method';
}

@Deprecated
@MethodInfo(comments = 'deprecated method', date = 'Nov 17 2012')
public static void oldMethod() {
   System.out.println('old method, don't use it.');
}

@SuppressWarnings({ 'unchecked', 'deprecation' })
@MethodInfo(author = 'Pankaj', comments = 'Main method', date = 'Nov 17 2012', revision = 10)
public static void genericsTest() throws FileNotFoundException {
   List l = new ArrayList();
   l.add('abc');
   oldMethod();
}

}

저는 이 예가 설명이 필요 없으며 다양한 시나리오에 적용할 수 있다고 믿습니다.

Java 주석 구문 분석

Reflection 기술을 사용하여 Java 클래스의 주석을 구문 분석합니다. 그런 다음 주석의 RetentionPolicy를 RUNTIME으로 설정해야 합니다. 그렇지 않으면 실행 중에 Java 클래스의 주석 정보를 사용할 수 없으며 여기에서 주석 관련 데이터를 가져올 수 없습니다.

package com.journaldev.annotations;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

public class AnnotationParsing {

public static void main(String[] args) {
   try {
   for (Method method : AnnotationParsing.class
       .getClassLoader()
       .loadClass(('com.journaldev.annotations.AnnotationExample'))
       .getMethods()) {
       // checks if MethodInfo annotation is present for the method
       if (method.isAnnotationPresent(com.journaldev.annotations.MethodInfo.class)) {
           try {
       // iterates all the annotations available in the method
               for (Annotation anno : method.getDeclaredAnnotations()) {
                   System.out.println('Annotation in Method ''+ method + '' : ' + anno);
                   }
               MethodInfo methodAnno = method.getAnnotation(MethodInfo.class);
               if (methodAnno.revision() == 1) {
                   System.out.println('Method with revision no 1 = '+ method);
                   }

           } catch (Throwable ex) {
                   ex.printStackTrace();
                   }
       }
   }
   } catch (SecurityException | ClassNotFoundException e) {
           e.printStackTrace();
        }
   }

}

위 프로그램을 실행하면 다음과 같은 결과가 출력됩니다:

Annotation in Method 'public java.lang.String com.journaldev.annotations.AnnotationExample.toString()' : 
@com.journaldev.annotations.MethodInfo(author=Pankaj, revision=1, comments=Main method, date=Nov 17 2012)

Method with revision no 1 = public java.lang.String com.journaldev.annotations.AnnotationExample.toString()

Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.oldMethod()' : @java.lang.Deprecated()

Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.oldMethod()' : 
@com.journaldev.annotations.MethodInfo(author=Pankaj, revision=1, comments=deprecated method, date=Nov 17 2012)

Method with revision no 1 = public static void com.journaldev.annotations.AnnotationExample.oldMethod()

Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.genericsTest() throws java.io.FileNotFoundException' : 
@com.journaldev.annotations.MethodInfo(author=Pankaj, revision=10, comments=Main method, date=Nov 17 2012)

이것은 이 튜토리얼의 전체 내용입니다. 여기서 뭔가를 배울 수 있기를 바랍니다.

위 내용은 Java Annotation 튜토리얼 및 Custom Annotation 내용입니다. 더 많은 관련 내용은 PHP 중국어 홈페이지(www.php.cn)를 참고해주세요!