빈번하게 변경되지 않는 게시글 카테고리를 Enum으로 관리

NOW 프로젝트를 진행하면서 기록한 글입니다.

게시글의 카테고리를 DB에서 관리하다

하나의 게시글을 DB에 저장한다고 하면,
해당 글이 공지 글인지, 커뮤니티 글인지, 사진 글인지, 문의 글인지 구분해야합니다.

게시글 테이블의 카테고리 컬럼을 추가해서 해결할 수도 있겠지만,
게시글 카테고리에 한정하지 않고, 서비스 내에서 사용할 카테고리성 데이터에도 사용할 수 있도록 테이블을 설계해야 한다고 생각했습니다.

다음과 같은 용도로요.

출처: 우아한기술블로그(https://techblog.woowahan.com/2527/)

따라서,
현재 초기 프로젝트의 테이블 구조입니다.

게시글 카테고리에 사용할 데이터를 코드 그룹(tb_code_group)과 하위 코드 테이블(tb_sub_code)에서 다음과 같이 관리했습니다.

게시글 작성

그렇다면, 사용자의 요청으로부터 게시글이 작성되는 흐름에 대해서 확인해보겠습니다.

아래와 같이 문의 게시글 작성 요청을 받는 Post 컨트롤러의 핸들러 메서드가 있습니다.

@PostMapping("/api/inquiry")
public ResponseEntity<Void> registerInquiryPost(@RequestAttribute("id") String userId,
                                                @RequestBody
                                                @Validated(PostValidationGroup.register.class) Inquiry inquiry) {
    log.debug("registerInquiryPost 호출, userId : {}, inquiry : {}", userId, inquiry);

    postService.registerInquiryPost(inquiry.updateAuthorId(userId));
    return ResponseEntity.status(HttpStatus.CREATED).build(); // Status Code 201
}

클라이언트는 다음과 같은 JSON 형식으로 요청을 하고, 서버에서는 Inquiry 객체에 mapping합니다.

{
    "subCode": "GRP004-001",
    "title": "테스트 제목",
    "content": "테스트 내용",
    "secret": "true"
}

다음으로는,
postService 객체의 registerInquiryPost 메서드를 호출했습니다.

서비스 객체에서는 다음과 같이 코드를 나눌 수 있습니다.

• 사용자 확인
• 전달받은 하위 카테고리로 문의 카테고리 그룹인지 확인
• DB에 저장하기 위해 하위 카테고리를 하위 카테고리 테이블의 고유 식별자로 변환
• DB 저장

전달받은 하위 카테고리로 문의 카테고리 그룹인지 확인하는 쿼리입니다.

<select id="checkInquiryGroupCode" resultType="java.lang.Boolean">
    SELECT COUNT(*) > 0
    FROM tb_code_group cg
                JOIN tb_sub_code sc ON sc.code_group_idx = cg.code_group_idx
    WHERE cg.code = 'GRP004' AND sc.code = #{subCode}
</select>

그렇다면, 문의 게시글 뿐만 아니라, 공지, 커뮤니티, 사진 .. 게시글 또한, 위와 같은 쿼리문이 별도로 있어야한다는 의미이고, 매번 카테고리 고유 식별자로 변환해야합니다.

…

저는 이러한 상황에서 다음과 같은 고민을 하게되었습니다.

현재 코드 테이블의 문제

• 카테고리의 수정 및 삭제가 빈번할까?
• 굳이 복잡하게 DB에서 관리해야하는 이점이 뭘까?

"굳이 DB에서 관리할 필요가 없다" 라는게 결론이었습니다..

저는 이러한 문제를 Enum으로 해결할 수 있겠다고 생각했습니다.

따라서, 게시글 카테고리 데이터를 Enum으로 전환하게 되었습니다.

관리 주체를 기존 DB에서 Enum으로

Java의 Enum은 결국 클래스인 점을 이용하여, Enum 상수에 카테고리 문자열 리스트를 갖도록 하였습니다.
각 Enum 상수들은 본인들이 갖고 있는 문자열들을 확인하여 문자열 인자값이 어느 Enum 상수에 포함되어있는지 확인할 수 있게 되었습니다.

기존에 DB에게 물어봤던 내용을, 앞으로는 PostGroup에게 물어보면 됩니다.

모든 테스트는 성공합니다.

여기까지 진행 후 Enum의 코드를 보니 해결하지 못한 문제가 있다는 것을 확인했습니다.

그것은..카테고리의 데이터 타입이 String(문자열) 이라는 것입니다.

DB 테이블의 카테고리 컬럼에 잘못된 문자열을 등록하거나,
파라미터로 전달된 값이 잘못되었을 경우가 있을 때 전혀 관리가 안됩니다.

그래서 이 카테고리 역시 Enum으로 전환하였습니다.

이렇게 Enum으로 카테고리를 만들고, PostGroup에서 이를 사용하도록 하겠습니다.

이렇게, 타입 안전성까지 확보하여 PayGroup에서 관련된 처리를 진행할 수 있게 되었습니다.

그렇다면 테스트 코드가 아닌 실제로 사용되는 코드에 대해서 소개해드리고 마무리하겠습니다.

개선된 게시글 등록

우선, 클라이언트에서 JSON 형태로 다음과 같이 요청할 수 있습니다.

고려해야할 사항으로는
스프링에서 제공하는 기능 중 요청 본문에 포함된 데이터를 객체로 매핑해주는 객체 바인딩 에서 Enum은 자동적으로 진행하지 않다는 점입니다.

따라서,
Enum을 매핑하기 위해서는 추가적인 작업이 필요합니다.

저는, Enum 값을 JSON으로 변환하거나 JSON 값을 Enum으로 변환하기 위해 Jackson 라이브러리에서 제공하는 @JsonValue와 @JsonCreator 어노테이션을 사용했습니다.

아래와 같이 문의 게시글 작성 요청을 받는 Post 컨트롤러의 핸들러 메서드가 있습니다.

다음으로는,
postService 객체의 registerInquiryPost 메서드를 호출했습니다.

마무리

이렇게 기존에 DB에서 관리하는 데이터를 Enum으로 관리하는 데이터로 변경해보았습니다.

무조건적으로 "카테고리는 Enum으로 관리해야해." 는 아니지만,

빈번하게 변경되지도 않는 데이터를 굳이 DB에서 관리할 필요가 있을까? 라는 고민이 생겼고, 해결한 경험이 하나 생겼다는 것에 만족합니다.

앞으로도, 위와 같은 상황이 찾아온다면 Enum을 적극적으로 사용할 것입니다.

하지만, 무조건적으로 Enum을 사용하는 것은 아니고, 여러가지 문제를 따져보고 해야하곘지만요.

긴 글 읽어주셔서 감사합니다.

참고

1) Java Enum 활용기: https://techblog.woowahan.com/2527/