Constant 패키지란

스프링에서 도메인 패키지를 구성하는 과정에서 Constant 패키지를 만들어서 enum type으로 클래스를 생성하는데 이것에 대해서 자세히 알지 못해서 이번에 알아보려고 공부를 하게 되었다. 

 

constant 패키지 활용

 

---

Constant 패키지란

constant 패키지란 주로 상수 값을 정의하는 용도로 사용하는 패키지이다.

이 패키지는 공통적으로 사용되는 상수들을 모아놓고, 여러 클래스에서 재사용되는 값을 중앙관리 처리하는 일을 한다

 

상수 값은 일반적으로 변경되지 않는 값이고 코드의 가독성을 높이며 중복 방지를 위해 사용된다.

상수 값을 한 곳에서 관리하게 되면 값이 변경되는 경우 해당 상수만 수정하면 모든 사용처에 즉시 적용이 가능하므로 상당히 유용하다.

 

public class AppConstants {
    public static final int MAX_USERS = 100;
    public static final String DEFAULT_TIMEZONE = "UTC";
    public static final String API_BASE_URL = "/api/v1";
}

 

public class DatabaseConnection {
    public void connect() {
        // 최대 재시도 횟수를 사용하여 연결 시도
        for (int i = 0; i < AppConstants.MAX_RETRY_COUNT; i++) {
            // 연결 시도 로직
        }
    }
}

 

이런 식으로 DatabaseConnection 클래스에서 최대 재시도 횟수를 상수 값으로 사용하여 연결 시도를 반복할 수 있다.

---

Constant 패키지의 장점과 단점

 

- 장점 -

1. 중앙 집중된 상수 관리 : 상수 값을 중앙 집중적으로 관리할 수 있는 장점이 있다. 상수 값을 한 곳에 모아두면 코드의 가독성과 유지 보수성을 향상시킬 수 있다.

 

2. 가독성 향상 : 상수값들은 의미 있는 이름으로 정의되어있어 코드의 가독성을 향상한다.

 

3. 재사용성 : 정의된 상수 값들은 여러 곳에서 재사용될 수 있다. 동일한 상수값이 여러 곳에서 발생되는 경우 constant 패키지에 정의하고 필요한 곳에서 참조해서 코드의 중복을 피할 수 있다.

 

4. 유지 보수 용이성 : 여러곳에서 사용되는 값을 constant 패키지에서만 수정을 하면 된다. 이건 전체 코드베이스에서 해당 상수 값을 일일이 찾아 수정할 필요가 없게 만든다.

 

 

 

- 단점 -

1. 패키지 크기 관리 : 여러 상수 값이 포함될 수 있어서 패키지의 크기가 커질 수 있다. 이렇게 되면 프로젝트 규모가 커질수록 패키지 관리의 어려움이 생길 수 있다.

 

2. 중복 정의 : 상수 값이 여러 패키지에서 동일하게 사용되다 보니 중복적으로 정의되는 상황이 발생할 수 있다. 그래서 패키지 간 상수 값 공유 방식을 고려해야 한다

 

3. 컴파일 시간 영향 :  상수 값이 많은 경우, 컴파일 시간이 증가할 수 있고 빌드 시간이 늘어날 수 있다. 이를 고려하여 프로젝트의 빌드 및 배포과정을 최적화해야 한다

 

---

상수 값 변경에 대한 중앙 집중 관리 예시

 

public class ErrorCodes {
    public static final String INVALID_REQUEST = "ERR001";
    public static final String MISSING_PARAMETER = "ERR002";
    // ...
}

public class ErrorHandler {
    public void handleError(String errorCode) {
        if (errorCode.equals(ErrorCodes.INVALID_REQUEST)) {
            // 유효하지 않은 요청 처리
        } else if (errorCode.equals(ErrorCodes.MISSING_PARAMETER)) {
            // 누락된 매개변수 처리
        } else {
            // 기타 오류 처리
        }
    }
}

이렇게 ErrorHandler 클래스에서 오류 코드를 상수 값으로 사용하여 오류 처리를 수행한다. 이를 통해서 오류 처리 로직을 단순화하고 상수 값 변경 시에도 constant 패키지에서 한 번만 수정하면 모든 사용처에 즉시 적용된다.

 

---

예시 코드

 

public class AppConstants {
    public static final String DEFAULT_USERNAME = "admin";
    public static final String DEFAULT_PASSWORD = "1234";
}

public class UserService {
    public void login(String username, String password) {
        if (username.equals(AppConstants.DEFAULT_USERNAME) && password.equals(AppConstants.DEFAULT_PASSWORD)) {
            // 로그인 성공
        } else {
            // 로그인 실패
        }
    }
}

public class Main {
    public static void main(String[] args) {
        UserService userService = new UserService();
        userService.login("admin", "1234");
    }
}

 

AppConstant 클래스에서 사용자 이름과 비밀번호를 상수 값으로 정의하고 UserService 클래스에서 로그인 처리를 수행한다.

 

---

Enum 타입 constant, 패키지

 

constant 패키지를 enum 타입으로 변경하는 이유

1. 가독성 : 각 상수 값을 명확하게 표현 가능

2. 안정성 : 컴파일 시점에서 상수 값의 유효성 검사 가능

3. 타입 안정성 : 자체적 타입이 있기 때문에 잘못된 타입으로 상수 값을 사용하는 실수 방지

4. 추가 기능 : 자체적으로 메서드를 정의 가능 이를 활용하여 상수 간의 비교, 연산 등의 기능 추가 가능

 

 

public enum Constants {
    MAX_RETRY_COUNT(3),
    DEFAULT_TIMEOUT(5000),
    ERROR_MESSAGE("An error occurred"),
    DEFAULT_LANGUAGE(Language.ENGLISH);

    private final Object value;

    Constants(Object value) {
        this.value = value;
    }

    public Object getValue() {
        return value;
    }
}

public enum Language {
    ENGLISH,
    KOREAN,
    SPANISH,
    FRENCH
}

Constants라는 'enum'타입을 사용해서 상수 값을 정의했다. 그리고 getValue() 메서드를 통해 상수 값에 접근할 수 있다. 

그리고 Language라는 enum 타입을 사용해서 언어 상수 값을 정의했다.

 

public class ExampleClass {
    public void doSomething() {
        int maxRetryCount = (int) Constants.MAX_RETRY_COUNT.getValue();
        long defaultTimeout = (long) Constants.DEFAULT_TIMEOUT.getValue();
        String errorMessage = (String) Constants.ERROR_MESSAGE.getValue();
        Language defaultLanguage = (Language) Constants.DEFAULT_LANGUAGE.getValue();

        //...
    }
}

이런 식으로 Constants를 사용하여 각 상수 값을 참조할 수 있다. 

enum 타입을 사용하여 constant 패키지를 구현하면 상수 값을 더 명확하고 안전하게 사용할 수 있다.

또한 enum은 상수 값을 정의하기에 적합한 자료형이며 enum 타입을 활용하여 코드의 가독성과 유지보수성을 높일 수 있다.