TIL (20210817) - yml customizing, Map filter 하기

🌱 서론

• 개발자에겐 유지보수는 끝이 없는 것 같다. 끝이라고 생각했건만 끝나지 않았다.🤔
  (카톡알림톡 모듈은 언제만들라는거지 대체)

• 카테고리 모듈에 또 다른 요구사항이 들어왔다. naver 뉴스의 카테고리를 분류하는데, 내부 사정으로 몇가지 카테고리들이 DB에는 저장되어 있지만 프론트단에는 노출되지 않도록 해달라는 요구였다.

• 이를 위해서 stream의 filter기능을 다뤄보았는데, 많은 공부가 되어 포스팅하고자한다.

🗝 오늘 TIL의 키 포인트 : yml

• 필터링할 키워들을 어떻게 정리를 해서 넣을까 생각을 하다가 이번기회에 yml 설정 파일을 customizing해서 값으로 가져오는 것을 실습해기로 했다. 실무에서 실험하기

• 항상 느끼는 거지만 코드 스케치를 하고 코딩을 하자.

• 대략적인 코드 스케치

👉🏻 step 1. yml 파일에 filter로 걸러낼 키워드 세팅하기

application-category.yml

category.exclude:
  naver-news-category:
    - 뉴스홈
    - 속보
    - 오피니언
    - 포토
    - TV
    - 랭킹뉴스

• 어려울게 없다. 그냥 yml파일을 하나 만들고 (위치는 resources에 만들어야한다.) 그곳에 입맛대로 세팅해주면된다.

CategoryProperties.java

@Getter
@Setter
@Configuration
@ConfigurationProperties("category.exclude")
public class CategoryProperties {
    private List<String> naverNewsCategory;
}

• 자, 요놈이 이제 위에서 만든 yml파일과 매핑이 직접적으로 되는 놈이다.

• @configurationProperties는 매핑할 yml파일이 무엇인지 스프링에게 알려주는 역할을 한다.
  위의 yml파일을 보면 category.exclude라고 설정한 이름이 보이는가? 그 값이 그대로 이 어노테이션의 파라미터값으로 들어가는 것이다.

• 이 클래스에 딱 하나있는 필드인 naverNewsCategory는 눈치 챘겠지만 yml 파일에 있는 naver-news-category가 매핑된 것이다. List인 이유는 yml설정에서 있는 - 뉴스홈, 속보, 오피니언 - 등이다. 즉, 그 값들이 List로 들어가있다.

• yml을 커스트마이징해서 이렇게 설정으로 빼놓으면 나중에 값을 바꿀 때 매우 편하다.
  이 방법을 응용하면 이것저것 활용할 부분들이 다양하다.

👉🏻 step 2. stream에 filter 달기 (feat. 필살 메소드 신공)

CategoryDto.java

@Getter
@Setter
@NoArgsConstructor
public class CategoryDto extends CategoryNode {
    private Map<String, CategoryModifiedDto> children;
    public CategoryDto(Category entity) {
        this(entity, null);
    }
    public CategoryDto(Category entity, List<String> excludeCodes) {
        super(entity);
        children = new HashMap<>();
        this.children = entity.getChildrenCategory().stream()
  		.filter(category -> this.exclude(category, excludeCodes))
                .sorted(Comparator.comparing(Category::getId))
                .collect(Collectors.toMap
  		(Category::getCategoryName, CategoryModifiedDto::new, (x, y) -> x, LinkedHashMap::new));
    }
    private boolean exclude(Category category, List<String> excludeCodes) {
        return excludeCodes == null || !excludeCodes.contains(category.getCode());
    }
}

• CategoryDto(Category entity, List<String> excludeCodes)
velog에 연재했을 때만 해도 카테고리 코드들이 상당히 가벼웠는데 어느새 이렇게 무거워졌다.
  이번 요구사항으로 인해 DTO 파라미터가 또 하나 추가되었다.

• boolean exclude 메소드
  이 메소드가 핵심이다. 극한의 효율화를 했다.
  파라미터로 Category 엔티티와 걸러낼 키워드들의 list를 받는다.
  boolean타입으로 리턴하여 filter의 조건에 넣어준다.

• .filter(category -> this.exclude(category, excludeCodes))
filter는 true면 통과시키고, false이면 걸러내버린다.
  entity를 stream을 통해 얻어낸 category 와 파라미터로 받은 excludeCodes를 통해 boolean값을 반환한다.

• 해당 코드는 service 계층에서 사용될때, CategoryProperties클래스를 @RequiredArgsConstructor를 통해 의존성 주입을 한 후, 사용하여 넣어주고, Rest Controller에서 사용된다.

🙏 오늘의 TIL 을 마치며

• 오늘도 느꼈다. 갓갓 stream

• yml을 단순히 설정만 하는 용도라고 생각했던 분들이 이 글을 읽고나서는 활용법이 다양하다는 것을 아셨으면 좋겠다. 이 방법을 통한다면 고정되어있는 값이나 그로 인해 반복되는 코드들을 확 줄일 수 있을 것이다.

• 그럼 이만 ✋