이펙티브 자바 #item41 정의하려는 것이 타입이면 마커 인터페이스를 사용해라

마커 인터페이스란?

마커 인터페이스는 아무 메서드도 정의하지 않고 단순히 타입을 정의하기 위해 사용하는 인터페이스이다. 예를 들면 Cloneable과 Serializable 등을 들 수 있다. 이들은 특정 메서드를 정의하지 않았지만 이를 구현한 클래스는 해당 타입의 하위 타입임을 명시해 줌으로써 타입을 인식하고 특정 동작을 처리할 수 있도록 한다.

마커 어노테이션

마커 어노테이션은 특정한 변수나 정의 없이 마커 인터페이스와 마찬가지로 특정 상태임을 명시할 때 사용한다. 마커 어노테이션의 경우 클래스, 인터페이스 뿐만 아니라 메서드 필드 등 다양하게 사용할 수 있는 특징이 있다.(어노테이션 특징)

마커 인터페이스 vs 마커 어노테이션

어떤 상황일 때 마커 인터페이스와 마커 어노테이션을 사용하면 좋을까?

책에서는 다음과 같이 사용하라고 한다.

메서드 추가 없이 단순히 타입을 정의하는 것이 목적이라면 마커 인터페이스를 선택하는 것이 효율적이다. 그런 것이 아니라 프레임워크 일부로 마커를 편입시켜야 한다거나 타입이 아닌 방식으로 특정 상태를 표현해야 하는 경우 마커 어노테이션을 사용하는 것이 적절하다.

1. 메타 인터페이스를 사용할 예

만약 특정 클래스를 json 직렬화를 해야한다고 가정하자. 보통 java spring에서는 기본으로 jackson 라이브러리를 사용한다. 그렇다면 직렬화하는 클래스로 StdSerializer를 활용할 수 있는 데 해당 클래스는 제네릭 매개변수 타입을 받고 해당 타입을 json 직렬화 로직을 구현할 수 있도록 제공하는 abstract class 이다.

핵심은 타입을 받는다는 것인데 나는 원시 래핑 객체를 직렬화시 내부 변수만 직렬화되게 하고 싶다. 그렇다면 매번 타입마다 StdSerializer<T>를 만들어줘야 한다. 이는 굉장히 번거로운 작업이다. 이를 Wrapper 이런식으로 마커 인터페이스를 지정해주면 Serializer는 하나만 만들면 되고 해당 타입인 경우 처리해주면 된다. 이렇게 여러 타입이 공통적인 특징이 있고 특정한 타입이 필요하다면 마커 인터페이스를 사용하는 것이 적절하다.

@Embeddable
@EqualsAndHashCode
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Getter
public class Id implements Serializable, Wrapper, Comparable<Id> {

	private static final long serialVersionUID = -2772995063676474658L;

	private UUID uuid;

	public Id(UUID uuid) {
		this.uuid = uuid;
	}

	public Id(String uuid) {
		this.uuid = UUID.fromString(uuid);
	}

	public static Id generateNextId() {
		Ulid ulid = UlidCreator.getMonotonicUlid();
		return new Id(ulid.toUuid());
	}

	@Override
	public String toString() {
		return uuid.toString();
	}

	@Override
	public int compareTo(Id o) {
		return this.uuid.compareTo(o.uuid);
	}
}

public class WrapperSerializer extends StdSerializer<Wrapper> {

	protected WrapperSerializer() {
		this(null);
	}

	protected WrapperSerializer(Class<Wrapper> t) {
		super(t);
	}

	@Override
	public void serialize(Wrapper value, JsonGenerator gen, SerializerProvider provider) throws IOException {
		Class<?> clazz = value.getClass();
		Field[] fields = Stream.of(clazz.getDeclaredFields()).filter(this::isPurePropertyField).toArray(Field[]::new);
		if (fields.length != 1) {
			throw new IllegalStateException("It has not one property" + "property numbers: " + fields.length);
		}
		Field field = fields[0];
		field.setAccessible(true);
		makeJsonByFieldType(value, gen, field);
	}
}

2. 마커 어노테이션을 사용하는 예

주로 프레임워크의 지원을 받아야하는 경우 사용한다. 또는 단순 타입 정의를 넘어서서 특정 속성임을 표현해야 할 때 사용한다.

java에 junit @Test 어노테이션을 살펴보자. @Test 어노테이션은 메서드에 사용가능하며 메서드에 붙일시 해당 메서드는 테스트로써 사용가능한 코드가 된다. 내부적으로는 JUnit 프레임워크가 해당 어노테이션을 인식해서 동작한다.

결론

단순 타입 정의면 마커 인터페이스를 사용하자. 그런 경우가 아니라면 어노테이션을 사용한다. 그 이유는 인터페이스는 컴파일러가 확인 가능하고 IDE 도움을 받을 수 있다. 제네릭 매개변수 타입으로 받는 경우는 특히 인터페이스 사용이 더 적절하다. 그런 경우가 아니면 어노테이션을 사용하자. 하지만 어노테이션의 경우 리플렉션에서 동적으로 가져와서 확인하기 때문에 메타 어노테이션을 제외한 컴파일러의 도움을 받기 쉽지 않다. 어노테이션 프로세서를 활용하는 경우 도움을 받을 수 있기는 개발하면서 보통 이런 부분까지 직접 구현하는 경우는 매우 적고 난이도가 높다.