Java - 열거형, 애너테이션

📚 열거형 (Enum)

enum Seasons { SPRING, SUMMER, FALL, WINTER }
enum Frameworks { DJANGO, SPRING, NEST, EXPRESS }

• 여러 상수들을 보다 편리하게 선언하고 관리할 수 있게 해 준다.
• 상수명의 중복을 피할 수 있다.
• 타입에 대한 안정성을 보장한다.
• 간결하고 가독성이 좋다.
• switch문에서도 사용 가능하다.

리턴 타입	메서드(매개변수)	설명
String	name()	열거 객체가 가지고 있는 문자열을 리턴하며, 리턴되는 문자열은 열거타입을 정의할 때 사용한 상수 이름과 동일하다.
int	ordinal()	열거 객체의 순번(0부터 시작)을 리턴한다.
int	compareTo(비교값)	주어진 매개값과 비교해서 순번 차이를 리턴한다.
열거 타입	valueOf(String name)	주어진 문자열의 열거 객체를 리턴한다.
열거 배열	values()	모든 열거 객체들을 배열로 리턴한다.

enum Level {
  LOW, // 0
  MEDIUM, // 1
  HIGH // 2
}

public class EnumTest {
    public static void main(String[] args) {
        Level level = Level.MEDIUM;

        Level[] allLevels = Level.values();
        for(Level x : allLevels) {
            System.out.printf("%s=%d%n", x.name(), x.ordinal());
        }

        Level findLevel = Level.valueOf("LOW");
        System.out.println(findLevel);
        System.out.println(Level.LOW == Level.valueOf("LOW"));

        switch(level) {
            case LOW:
                System.out.println("낮은 레벨");
                break;
            case MEDIUM:
                System.out.println("중간 레벨");
                break;
            case HIGH:
                System.out.println("높은 레벨");
                break;
        }
    }
}

//출력값
LOW=0
MEDIUM=1
HIGH=2
LOW
true
중간 레벨

 

📚 애너테이션 (Annotation)

주석은 코드를 읽는 '사람'에게 정보를 제공하고, 애너테이션은 특정 코드를 사용하는 '프로그램'에게 정보를 전달한다.

 

📘 애너테이션의 종류

📄 표준 애너테이션

자바에서 기본적으로 제공하는 애너테이션

표준 애너테이션	설명
@Override	컴파일러에게 메서드를 오버라이딩하는 것이라고 알린다.
@Deprecated	앞으로 사용하지 않을 대상임을 알린다.
@FunctionalInterface	함수형 인터페이스라는 것을 알린다.
@SuppressWarning	컴파일러가 경고메세지를 나타내지 않게 한다.

📄 메타 애너테이션

• 애너테이션에 붙이는 애너테이션
• 애너테이션을 정의하는 데 사용된다.

메타 애너테이션	설명
@Target	애너테이션을 정의할 때 적용 대상을 지정하는데 사용한다.
@Documented	애너테이션 정보를 javadoc으로 작성된 문서에 포함시킨다.
@Inherited	애너테이션이 하위 클래스에 상속되도록 한다.
@Retention	애너테이션이 유지되는 기간을 정하는데 사용한다.
@Repeatable	애너테이션을 반복해서 적용할 수 있게 한다.

📄 사용자 정의 애너테이션

사용자가 직접 정의하는 애너테이션

 

📘 표준 애너테이션

📄 @Override

상위 클래스의 메서드를 오버라이딩하는 메서드라는 것을 컴파일러에게 알려준다.

• 메서드명 오타 방지

📄 @Deprecated

새로운 것으로 대체되었으니 기존의 것을 사용하지 않을 것을 권장하는 데 사용한다.

• 컴파일 경고

📄 @SuppressWarnings

컴파일 경고 메시지가 나타나지 않도록 한다.

애너테이션	설명
@SuppressWarings(”all”)	모든 경고를 억제
@SuppressWarings(”deprecation”)	Deprecated 메서드를 사용한 경우 나오는 경고 억제
@SuppressWarings(”fallthrough”)	switch문에서 break 구문이 없을 때 경고 억제
@SuppressWarings(”finally”)	finally 관련 경고 억제
@SuppressWarings(”null”)	null 관련 경고 억제
@SuppressWarings(”unchecked”)	검증되지 않은 연산자 관련 경고 억제
@SuppressWarings(”unused”)	사용하지 않는 코드 관련 경고 억제

@SuppressWarnings({"deprecation", "unused", "null"})

• 여러 개도 가능하다.

📄 @FuntionalInterface

함수형 인터페이스의 선언이 바르게 선언되었는지 확인한다.

@FunctionalInterface
public interface Runnable {
	public abstract void run (); // 하나의 추상 메서드
}

• 함수형 인터페이스는 단 하나의 추상 메서드를 가져야 한다.

 

📘 메타 애너테이션

📄 @Target

애너테이션을 적용할 대상을 지정하는 데 사용한다.

대상 타입	적용범위
ANNOTATION_TYPE	애너테이션
CONSTRUCTOR	생성자
FIELD	필드(멤버변수, 열거형 상수)
LOCAL_VARIABLE	지역변수
METHOD	메서드
PACKAGE	패키지
PARAMETER	매개변수
TYPE	타입(클래스, 인터페이스, 열거형)
TYPE_PARAMETER	타입 매개변수
TYPE_USE	타입이 사용되는 모든 대상

import static java.lang.annotation.ElementType.*; 
//import문을 이용하여 ElementType.TYPE 대신 TYPE과 같이 간단히 작성할 수 있다.

@Target({FIELD, TYPE, TYPE_USE})	// 적용대상이 FIELD, TYPE, TYPE_USE
public @interface CustomAnnotation { }	// CustomAnnotation을 정의

@CustomAnnotation	// 적용대상이 TYPE인 경우
class Main {
    
    @CustomAnnotation	// 적용대상이 FIELD인 경우
    int i;
}

📄 @Documented

• 애너테이션의 정보를 javadoc으로 작성한 문서에 포함되게 한다.
• 표준 애너테이션과 메타 애너테이션 중 @Override와 @SuppressWarnings를 제외하고 모두 @Documented가 적용되어있다.

📄 @Inherited

하위 클래스가 애너테이션을 상속받게 한다.

📄 @Retention

애너테이션의 지속 시간을 지정한다.

유지 정책	설명
SOURCE	소스 파일에 존재, 클래스 파일에는 존재하지 않음
CLASS	클래스 파일에 존재, 실행 시에 사용불가, 기본값
RUNTIME	클래스 파일에 존재, 실행 시에 사용가능

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE) 
//오버라이딩이 제대로 되었는지 컴파일러가 확인하는 용도 
//클래스 파일에 남길 필요 없이 컴파일시에만 확인하고 사라짐
public @interface Override(){ }

 

📄 @Repeatable

애너테이션을 여러 번 붙일 수 있도록 허용한다.

@interface Works {  // 여러개의 Work애너테이션을 담을 컨테이너 애너테이션 Works
    Work[] value(); 
}

// Work 애너테이션을 여러 번 반복해서 쓸 수 있게 한다.
@Repeatable(Works.class) // 컨테이너 애너테이션 지정 
@interface Work {
	String value();
}

@Work("코드 업데이트")  
@Work("메서드 오버라이딩")  
class Main{  
	... 생략 ...
}

 

📘 사용자 애터네이션

사용자가 직접 애너테이션을 정의해서 사용하는 것

@interface 애너테이션명 { // 인터페이스 앞에 @기호만 붙이면 애너테이션을 정의할 수 있다. 
	타입 요소명(); // 애너테이션 요소를 선언
}

• 애너테이션은 java.lang.annotation 인터페이스를 상속받기 때문에 다른 클래스나 인터페이스를 상속받을 수 없다.