6-1 Enum과 @애너테이션을 사용하라.

# int 상수 대신 Enum을 사용하라.

Enum은 더 읽기 쉽고, 변경에 안전하고, 클래스처럼 기능이 강력하다.

만약 메서드가 상수의 값에 따라 다르게 동작한다면 switch(int) 대신에 상수별 메서드를 구현해서 사용하자.

enum Dog {
    SCHNAUZER {
        @Override
        public void bark() { System.out.println("멍멍멍멍멍"); }
    },

    POODLE {
        @Override
        public void bark() { System.out.println("멍멍"); }
    };

    // 사용할 추상 메서드를 아래에 선언해준다.
    abstract public void bark();
}

 

혹은 상수에 특정 값을 할당하고 싶다면, enum의 생성자와 필드를 이용하면 된다.

enum Cat {
    SCHNAUZER(20) {
        @Override
        public void bark() { System.out.println("멍멍멍멍멍"); }
    },

    HUSKY(10) { // 생성자만 바꾸면 뭐든지 가능. HUSKY(10,"Hello",10.5L)
        @Override
        public void bark() { System.out.println("왈왈"); }
    };

    private final int number;

    Cat(int num) {
        // Cat.values()를 이용해 Enum 에 할당된 모든 값 조회 가능.
        // Cat.values() == {10,20}        SCHNAUZER, HUSKY
        this.number = num;
    }

    abstract public void bark();

}

 

enum과 lambda를 활용하면 아래와 같은 강력한 기능을 가진 Enum을 만들 수도 있다.

public enum Operation {
    PLUS  ("+", (x, y) -> x + y), // 람다 함수를 인자로 전달
    MINUS ("-", (x, y) -> x - y),
    TIMES ("*", (x, y) -> x * y),
    DIVIDE("/", (x, y) -> x / y);

    private final String symbol;
    private final DoubleBinaryOperator op;

    Operation(String symbol, DoubleBinaryOperator op) {
        this.symbol = symbol;
        this.op = op;
    }
	
    // toString()을 이용해서 enum의 기본 출력값을 지정.
    @Override public String toString() { return symbol; }
	
    // 메서드를 이용해서 값으로 들고있는 람다 함수를 실행.
    public double apply(double x, double y) {
        return op.applyAsDouble(x, y);
    }
	
    // enum은 인터페이스와 비슷하게 static 메서드는 가질 수 있다.
    public static void main(String[] args) {
        double x = Double.parseDouble(args[0]);
        double y = Double.parseDouble(args[1]);
        
        for (Operation op : Operation.values())
            System.out.printf("%f %s %f = %f",
                               x, op, y, op.apply(x, y));
    }
}

 

 

# 비트 필드 대신 EnumSet을 사용하라.

비트 필드는 기존의 C언어 등에서 메모리를 효율적으로 사용하기 위해 종종 사용하고는 한다.

public class Text {
    public static final int A = 1 << 0;
    public static final int B = 1 << 1;
    public static final int C = 1 << 2;
    public static final int D = 1 << 3;
}

// 이런식으로 OR 연산을 사용해서 열거타입을 구현할 수 있다.
// [ABCD] = [0000], 만약 A와 C가 True라면 [1010] 으로 판별하는 셈.
text.applyStyles(STYLE_BOLD | STYLE_ITALIC)

 

하지만 자바에서는 이렇게 할 이유가 전혀 없다.

메모리 성능이 필요하다면 Enum을 Set에 넣어 사용하자. Enum의 기능을 사용하면서도 성능 최적화를 얻을 수 있다.

import java.util.Set;

public class Text{
    public enum Style{
        A, B, C, D;
    }
    
    // 사용하고자 하는 enum 값을 Set에 넣어서 인자로 전달하자.
    // 물론 필요하다면 Set이 아닌 다른 자료구조를 사용해도 상관없다.
    public void applyStyles(Set<Style> styles) {
        ...
    }
}

 

다만 Java11 기준으로 final Enum Set 같은건 없다. 필요하면 구글 Guava 라이브러리를 사용하는 방법도 있긴하다.

 

 

# Enum.ordinal( )은 사용하라고 만든 메서드가 아니다.

ordinal()는 Enum에서 제공하는 메서드 중 하나이다.

하지만 사용할 일도 없고, 사용해서는 안되는 메서드이다. 이는 EnumSet이나 EnumMap을 구현하는데 사용된다.

enum이 제공하는 메서드. ordinal은 레거시 코드의 하위 호환성을 위해 제공하는거지, 쓰라고 만든게 아니다.

그러니 위에서 본 예제처럼 DOG(10), CAT(11); 이런 방식의 EnumMap을 사용하자.

Enum.ordinal은 상수 순서를 바꾸면 오류가 나고, 애초에 사용해라고 만든게 아니다.

 

 

# 열거타입의 확장이 필요하다면 인터페이스를 사용하라.

enum은 상속받아 사용할 수 없다. 새로 만들어야한다.

하지만 위에서 보여준 예시처럼, enum 안에서 추상메서드를 구현하거나 interface를 구현하는건 가능하다.

개발자는 이 인터페이스를 이용하면 기존의 열거 타입을 사용하는 모든 곳을 변경하지 않아도 확장 가능하다.

public interface Animal {
	void bark();
}

// enum(열거타입) 확장해서 사용하기
public enum Dog implements Animal {
	SCHNAUZER {
		@Override
		public void bark() {
			System.out.println("멍멍멍멍멍");
		}
	},
	HUSKY {
		@Override
		public void bark() {
			System.out.println("왈왈");
		}
	},
	POODLE {
		@Override
		public void bark() {
			System.out.println("멍멍");
		}
	};
}

 

 

# 명명 패턴보다 애너테이션을 사용하라.

기존의 자바는 리플렉션이나 특별한 클래스를 만들고자 할 때 명명패턴을 많이 사용했었다.

testMethod, testService, HelloMBean, MyClassMBean

• 정확하게 동작하는지를 보장할 수 없다. 만약 tset로 오타가나서 클래스가 대상에서 제외되어 무시된다면?
• 메서드 이름만으로는 추가적인 설정값을 전달할 수 없다.
• 그냥 보기만해도 구리다. 메서드 이름이 강제되고 특정 메서드만 제외/적용하기 어렵다.

이제 좀 힙- 하게 애너테이션을 활용해서 만들도록 하자. 아무런 기능을 하지않더라도 애너테이션 (@Test 처럼) 을 이용해 마킹해놓는다면 나중에 처리하기 편해진다. 추가로 애너테이션에는 인자를 줄 수있으니 설정값을 추가하기도 좋고.

@ParameterizedTest
@ValueSource(strings = {"1", "a", "1a234567890123456"})
@DisplayName("요청 Body의 비밀번호 형식이 맞지 않은 경우 400 에러를 반환한다.")
void http_json_password_is_invalid(String args) throws Exception {
    // Arrange
    var request = new LoginAccountCommand();
    ...

 

+ [Item41. 정의하려는 것이 타입이라면 마커 인터페이스를 사용하라]

타입을 정의하려면 애노테이션과 빈 인터페이스를 적절하게 사용하는게 좋다...만 이건 API 개발자에게 유용한 정보.

예를 들어 직렬화 가능한 타입 Serializable등이 있겠다. 어노테이션은 특정 타입을 대상으로 만들 수는 없으니까.

 

 

# @Override는 멋으로 달아논게 아니다.

부모 메서드를 재정의했음을 컴파일러에게 알려줘서, 부모 메서드에 없는 함수라면 컴파일 오류를 띄워준다.

예를 들어보면 equals 메서드를 아래와 같이 재정의하면 오버로딩이 되어버린다. 반환타입이 다르니까.

//@Override 가 있었다면 컴파일러가 찾을 수 있는 오류가 된다.
public boolean equals(Hello other){ // 매개변수 타입이 Object가 아니라서 오버로딩 되어버림.
	...
}