냉장고 가계부 프로젝트 39

식품명을 등록하는 부분에 자동완성 기능을 제공하면 사용자가 식품명을 입력할 때 좀 더 편리하게 사용할 수 있다.

위 스크린샷처럼 식품명을 한글자씩 입력할 때마다, 입력한 키워드로 시작하는 단어들을 제공한다.

냉장고 가계부 프로젝트에서는 단지 식품명을 입력하는데 도움을 주는 기능을 제공하므로, 사전에 준비된 키워드 목록을 제공한다. javascript는 bootstrap3-typeahead를 사용한다.

키워드를 검색하기 위한 fridge-search 프로젝트를 새로 생성한다.
키워드 목록의 빠른 검색을 위해 Trie 알고리즘을 사용한다.
Trie 알고리즘을 구현한 Apache Commons Collection4 라이브러리를 사용하기위해 pom.xml 에 다음과 같이 의존성을 추가한다.

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-collections4</artifactId>
</dependency>

Apache Commons Collections의 Trie 인터페이스를 구현한 구현클래스 PatriciaTrie 를 사용하여 자동완성 기능을 구현한다.
내부적으로 Map 인터페이스를 구현하고 있기때문에 데이터의 추가는 put, 삭제는 remove 메서드를 사용하며, prefixMap 이라는 메서드는 주어진 key 값을 접두사로 갖는 데이터들을 SortedMap 타입으로 리턴한다.

식품명 자동완성을 위해 ProductNameTrie 클래스를 다음과 같이 구현했다.

@Component
public class ProductNameTrie {
    private Trie<String, Long> trie = new PatriciaTrie<>();
    
    private static final int MAX_SIZE = 10;

    public synchronized Long put(String key, long value) {
        return trie.put(key, value);
    }
    
    public String[] search(String query) {
        return prefixMap(query)
                .entrySet().stream()
                .filter(entry -> {
                    return !entry.getKey().equals(query);
                })
                .sorted((e1, e2) -> e2.getValue().compareTo(e1.getValue()))
                .limit(MAX_SIZE)
                .map(entry -> {
                    return entry.getKey();
                })
                .collect(Collectors.toList())
                .toArray(new String[0]);
    }
    
    SortedMap<String, Long> prefixMap(String key) {
        return UnmodifiableSortedMap.unmodifiableSortedMap(trie.prefixMap(key));
    }

    public synchronized Long increaseScore(String key) {
        if(trie.containsKey(key)) {
            return trie.put(key, trie.get(key) + 1);
        }
        return null;
    }
    
}

멤버 변수 trie에 PatriciaTrie 클래스를 생성하고 할당한다. 변수타입은 Trie<K, V> 인터페이스이며, 키 타입은 String, 벨류 타입은 Long 타입을 가진다. 키값으로 키워드 문자열을 넣고, 벨류값으로 Score 값을 넣어서 Score값을 기준으로 추천목록을 정렬할 것이다.
Score값이 크면 자동완성 목록의 상단으로 정렬되며, Score값이 작으면 반대의 경우가 된다.
정적 변수 MAX_SIZE는 자동완성 목록의 최대값을 나타낸다.

put 메서드는 trie에 새로운 키워드를 추가한다. 파라미터로 키워드값을 나타내는 String key, 점수값을 나타내는 long value를 받는다. 리턴타입은 Long 타입이며 주어진 key값이 없을경우 Null을 반환하고, 이미 존재하는 키 일경우 기존 키에 대한 value값을 리턴한다.

prefixMap 메서드는 key 문자열을 파라미터로 전달받는데 주어진 key문자열을 접두사로 하는 모든 데이터를 SortedMap 타입으로 반환한다. 이렇게 반환된 값을 UnmodifiableSortedMap 클래스의 팩토리메서드 unmodifiableSortedMap 메서드에 파라미터로 전달하면 수정불가능한 SortedMap 객체를 반환한다.

search 메서드는 prefix 메서드를 호출해서 반환받은 불변 SortedMap 객체를 String 배열타입으로 변환해서 리턴한다. 메서드 내부는 다음과 같은 순서로 변환한다.

1. 저장된 키워드와 동일한 데이터는 필터로 제외한다.
2. Value 값(Score)을 기준으로 내림차순 정렬을 한다.
3. entry 개수를 MAX_SIZE 정적변수로 제한한다.
4. Key값으로 이뤄진 List 타입으로 변환한다.
5. Collection 타입을 배열타입으로 변환한다.

 increaseScore 메서드는 문자열 키워드를 파라미터로 전달받는데 trie 데이터에 키워드가 존재할 경우, 해당 키워드의 Value(Score) 값을 1 증가시키고, 증가시키기 이전의 score값을 반환한다. trie 데이터에 키워드가 존재하지 않을 경우 Null을 반환한다.

increaseScore 메서드는 자동완성을 통해 검색된 키워드를 식품 추가하기를 통해 등록될 경우, 해당 키워드의 점수를 1점 추가하는 기능을 제공한다. 이를통해 Score점수가 높은 키워드는 사용자들이 많이 등록하는 키워드라는 의미를 가지며, 높은 우선순위를 가지는 키워드를 상단에 배치함으로써 사용자 편의성을 제공할 수 있다.

자동완성 기능을 위해 별도의 ElasticSearch 서버를 마련하거나, 검색 키워드들의 저장소로 NoSQL 서버들을 마련하기에는 너무 과한 인프라 구성이라고 생각된다. 지금도 마이크로서비스를 위한 Spring Boot 프로젝트가 별도로 구성되어 있지만, 초기에는 하나의 서버로 구성된 Monolithic 방식으로 시작하는게 좋다. 지금의 냉장고 가계부 프로젝트는 학습의 의미로 여러개 서버로 나뉘어져있지만, 실제로 CloudFoundry에 올릴때는 하나로 뭉쳐서 올릴 계획이다.

그래서, 키워드 데이터들을 일단 RDBMS에 저장하고 관리하기 위해 ProductName 테이블과 엔티티를 생성한다.

CREATE TABLE Product_name (
    name VARCHAR(100) NOT NULL,
    score BIGINT DEFAULT 0,
    PRIMARY KEY (name)
);

Product_name 테이블은 name, score 두 컬럼으로 이뤄져있다. 이 테이블과 매핑되는 엔티티 클래스는 다음과 같다.

@NoArgsConstructor
@Data
@Entity
public class ProductName {
    @Id
    private String name;
    private long score;
    
    @Builder
    public ProductName(String name, long score) {
        this.name = name;
        this.score = score;
    }

}

ProductName 클래스는 단순해서 별 다른 설명이 필요없을 것 같다. JpaRepository를 상속하는 ProductNameRepository 인터페이스를 생성하면 Persistence 쪽은 준비가 끝난다.
ProductNameController 클래스는 UI서버에서 들어오는 입력 query값을 받는 endpoint 역할을 하는 searchProductName 메서드와, UI서버에서 식품이 추가되었을때, 식품명을 전달받아서 키워드의 점수를 증가시키는 increaseScore 메서드로 구성된다.

@RestController
@Slf4j
@RequiredArgsConstructor
public class ProductNameController {
    private final ProductNameTrie trie;
    private final ProductNameRepository productNameRepository;
    
    @GetMapping("/searchProductName")
    public String[] searchProductName(String query) {
        log.info("search query: {}", query);
        return trie.search(query);
    }
    
    @PutMapping("/increaseScore")
    public ResponseEntity<Void> increaseScore(@RequestBody String query) {
        log.info("increase query: {}", query);
        Optional.ofNullable(trie.increaseScore(query))
            .ifPresent(score -> {
                productNameRepository.save(ProductName.builder()
                        .name(query)
                        .score(score + 1)
                        .build());
            });
        return ResponseEntity.noContent().build();
    }

}

searchProductName 메서드는 쿼리스트링 "query" 키에 대한 값을 입력파라미터로 전달받는다.
UI서버에서는 "http://fridge-search/searchProductName?query=사과" 와 같이 요청하게 된다.
그러면 ProductNameTrie 클래스의 search 메서드를 호출하는데 파라미터로 query값을 전달하게 되고, 해당 키워드를 prefix로 가지는 키워드들 집합이 문자열 배열형태로 응답된다.

increaseScore 메서드는 요청본문에 query 키워드가 전달되며, 이를 ProductNameTrie클래스의 increaseScore메서드를 호출하는데 파라미터로 query를 전달한다.
Optional클래스 팩토리메서드인 ofNullable은 파라미터로 전달되는 제너릭 T는 null을 리턴할 수도 있는 객체를 의미한다.
increaseScore메서드가 null이 아닌 값을 리턴할 경우(ifPresent) ProductName의 score를 1 증가시키고 저장한다.

UI서버의 코드는 크게 복잡한것 없이 Feign클라이언트로 fridge-search 서버의 API를 접근할 수 있도록 제공하고 FoodController에서 식품이 추가되면 increaseScore를 호출하도록 코드를 추가한다.

이전글: 냉장고 가계부 프로젝트 38
다음글: 냉장고 가계부 프로젝트 40