ErrorCode를 어떤 방식으로 정의하는 게 좋을까요?? (Enum vs. Lazy-Holder)

[wch-os]

#61 PR과 관련하여, ErrorCode의 정의 방식에 대해 다른 분들의 의견을 듣고 싶어 Discussion을 열었습니다.

현재 논의되고 있는 ErrorCode는 /common 패키지에 정의되어 공통 인터페이스인 ErrorCode 자체가 아닌, 각 기능에서 이를 구현하여 사용하는 개별 ErrorCode를 의미합니다. (ex. BoardCommandErrorCode, BoardQueryErrorCode 등)

---

아래의 첨부된 코드와 함께 각 방식의 장단점을 정리하였습니다.
추가로 공유하고 싶은 내용이 있으시면 코멘트 남겨주시면 감사하겠습니다🙏

1. Enum 방식

public enum BoardCommandErrorCode implements ErrorCode {
    BOARD_NOT_FOUND("게시물을 찾을 수 없습니다.", HttpStatus.NOT_FOUND),
    BOARD_GONE("더 이상 존재하지 않는 게시물입니다.", HttpStatus.GONE),
    BOARD_FORBIDDEN("권한이 없습니다.", HttpStatus.FORBIDDEN);

    private final String message;
    private final HttpStatus httpStatus;

    BoardCommandErrorCode(String message, HttpStatus httpStatus) {
        this.message = message;
        this.httpStatus = httpStatus;
    }

장점

• enum은 자바에서 자동으로 싱글톤을 보장합니다. (thread-safe)
• 가독성이 좋으며, 유지보수에도 용이합니다.

단점

• 모든 Enum 값이, 애플리케이션 실행 시점에 메모리에 할당됩니다.

2. Lazy-Holder 방식

public class BoardErrorCodeLazyHolder implements ErrorCode {
    private final String name;
    private final String message;
    private final HttpStatus httpStatus;

    public BoardErrorCodeLazyHolder(String name, String message, HttpStatus httpStatus) {
        this.name = name;
        this.message = message;
        this.httpStatus = httpStatus;
    }

    private static class NotFoundHolder {
        private static final BoardErrorCodeLazyHolder INSTANCE =
                new BoardErrorCodeLazyHolder("BOARD_NOT_FOUND", "게시글을 찾을 수 없습니다.", HttpStatus.NOT_FOUND);
    }

    private static class GoneHolder {
        private static final BoardErrorCodeLazyHolder INSTANCE =
                new BoardErrorCodeLazyHolder("BOARD_GONE", "더 이상 존재하지 않는 게시물입니다.", HttpStatus.GONE);
    }

    private static class ForbiddenHolder {
        private static final BoardErrorCodeLazyHolder INSTANCE =
                new BoardErrorCodeLazyHolder("BOARD_FORBIDDEN", "게시글에 권한이 없습니다.", HttpStatus.FORBIDDEN);
    }

    public static BoardErrorCodeLazyHolder BOARD_NOT_FOUND() {
        return NotFoundHolder.INSTANCE;
    }

    public static BoardErrorCodeLazyHolder BOARD_GONE() {
        return GoneHolder.INSTANCE;
    }

    public static BoardErrorCodeLazyHolder BOARD_FORBIDDEN() {
        return ForbiddenHolder.INSTANCE;
    }
}

장점

• 내부 정적 클래스를 사용하여 싱글톤을 보장합니다.
• 실제로 사용되는 시점에만, 인스턴스를 생성하여 메모리 효율적으로 동작합니다.

단점

• enum에 비해 가독성과 유지보수성이 떨어집니다.
• new BoardErrorCodeLazyHolder(...)와 같이 동적으로 객체를 만들 수 있는 여지를 줄 수 있습니다. (개발 도중, 실수 발생 가능성)

---

[merge-simpson]

안녕하세요, @wch-os 님!
좋은 사례를 제공해서 모두에게 좋은 공부가 되었던 것 같습니다.
부연설명을 위해 논의로 올려 주셔서 감사합니다.

Index.

• 에러코드 구현 방식 비교: Enum vs. Lazy Holder
• Enum 에러코드 구현을 선호하는 이유
• 번외: 추상 클래스로 Lazy Holder 방식 보강하기

🌱 Enum vs. Lazy Holder for ErrorCodes

• E ≈ L 확장성
  우리는 인터페이스를 사용하므로, 두 방식에서 유사한 확장성을 얻습니다.
• E ≤ L 메모리 효율
  유사하지만 lazy holder 방식이 조금 더 좋습니다. 열거상수를 사용하는 방식은 사용하지 않는 열거상수를 많이 만들 때 메모리 효율이 감소합니다.
• E > L 편의성
  구현은 Enum 열거 상수 방식이 더욱 간단합니다.

👀 Enum 에러코드 구현을 선호하는 이유

앞서 언급한 특징으로 인해서도 enum 구현을 더 선호할 만하다고 도출할 수 있습니다.
덧붙이는 이유는 다음과 같습니다.

• 메모리 낭비 거의 없음: 대부분의 ErrorCode는 실제로 사용할 항목입니다. 따라서 클래스 로드타임에 모든 열거 상수를 메모리에 미리 올리더라도 불필요한 로드가 아닙니다.
• 리플렉션 방어: 리플렉션은 클래스 설계를 많이 침투하곤 합니다. 열거상수는 이러한 침투로부터 일반 클래스보다 안전합니다.
  • 애초에 리플렉션 사용을 지양하는 코드 문화에서 도드라지는 특징은 아닙니다.

Enum의 효능 ~ 🌷

• 컴파일타임 보장: (1) 완전한 고유성, (2) 완전한 Non-null 객체임을 컴파일타임에 보장합니다. (3) 열거상수 목록 또한 컴파일타임에 결정합니다.
  • 열거 상수: 완전 보장으로, 컴파일타임에도 열거 상수를 사용할 수 있습니다. (ex: 애노테이션의 속성 값 등)
  • 열거 상수의 멤버 변수 및 메서드: 논리적으로 보장하더라도 컴파일타임 사용까지 보장하지는 않습니다.
• 런타임 보장: 열거상수 목록을 런타임에 임의로 추가할 수 없습니다. (컴파일타임에 결정)
  • Lazy holder 방식은 리플렉션 등으로 우회하면 추가 객체를 생성할 수 있습니다. (리플렉션은 일반적으로 적폐처럼 불립니다.)
  • 열거상수는 리플렉션을 사용해도 런타임에 추가 객체를 생성할 수 없습니다. (언어적으로 보장)

➕ 번외: 추상 클래스로 Lazy Holder 방식 보강하기

반복적인 구현 대신 하나의 상위 클래스에서 인터페이스의 모든 추상 메서드를 구현합니다.

// 의도에 따라 추상 클래스로 할 수도 있고, 일반 클래스로 할 수도 있습니다. (예시는 추상 클래스)
public abstract class ErrorCodeLazy implements ErrorCode {
    // 이곳에 ErrorCode 인터페이스의 모든 필요 기능을 구현합니다.
}

이하는 이 추상 클래스를 사용해 Lazy Holder 베이스로 에러코드를 구현하는 코드 예시입니다.

public final class BoardErrorCodeLazy extends ErrorCodeLazy {
    // private 생성자로 외부에서 인스턴스를 추가할 수 없도록 합니다. (마치 enum처럼 이곳에서 제공하는 것만 이용)
    private BoardErrorCodeLazy(/* 여기에 필요한 매개변수를 입력합니다. */) {
        super(/* 여기에 필요한 매개변수를 전달합니다. */);
    }

    // 제공할 에러코드를 반환하는 정적 메서드 목록을 작성합니다.
    public static BoardErrorCodeLazy BOARD_NOT_FOUND() {
        // BoardNotFoundHolder 클래스는 이 메서드가 처음 호출될 때 처음으로 사용됩니다. (이때 클래스 로드)
        return BoardNotFoundHolder.INSTANCE;
    }

    // 제공할 에러코드를 품은 Lazy Holder 클래스를 내부 클래스로 '각각' 작성합니다.
    // 자바는 클래스 로드타임에 동시성을 보장하므로, 이 홀더의 INSTANCE는 고유성을 안전하게 보장합니다.
    private static class BoardNotFoundHolder {
        private static final BoardErrorCodeLazy INSTANCE = new BoardErrorCodeLazy(/* 여기에 필요한 매개변수를 입력합니다. */);
    }
}

더 궁금한 게 있는 분들은 리서치를 해 보시거나
따로 물어봐 주세요!