Skip to content

Latest commit

 

History

History
261 lines (180 loc) · 15.2 KB

README.md

File metadata and controls

261 lines (180 loc) · 15.2 KB
Raw

검색어 추천이 있는 검색 창 구현

배포 페이지

과제 설명

폴더 구조

src
├── index.tsx
├── react-app-env.d.ts
├── reportWebVitals.ts
├── setupTests.ts
├── global.d.ts
├── assets
│   └── svgs
│       ├── clock.svg
│       ├── headerLogo.svg
│       ├── human.svg
│       ├── index.ts
│       └── search.svg
├── components
│   ├── Layout
│   │   ├── Footer
│   │   │   ├── Footer.module.scss
│   │   │   └── index.tsx
│   │   ├── Header
│   │   │   ├── Header.module.scss
│   │   │   └── index.tsx
│   │   ├── Layout.module.scss
│   │   └── index.tsx
│   └── Modal
│       ├── Modal.module.scss
│       └── index.tsx
├── hooks
│   ├── index.ts
│   ├── useAppDispatch.ts
│   ├── useAppSelector.ts
│   ├── useDebounce.ts
│   └── useFilteredQuery.ts
├── routes
│   ├── SearchPage
│   │   ├── Search
│   │   │   ├── Dropdown
│   │   │   │   ├── ConditionalDropdown.tsx
│   │   │   │   ├── Dropdown.module.scss
│   │   │   │   ├── RecommendItem.tsx
│   │   │   │   ├── SearchLogItem.tsx
│   │   │   │   └── index.tsx
│   │   │   ├── Search.module.scss
│   │   │   ├── SearchForm
│   │   │   │   ├── SearchForm.module.scss
│   │   │   │   └── index.tsx
│   │   │   └── index.tsx
│   │   ├── SearchPage.module.scss
│   │   └── index.tsx
│   └── index.tsx
├── services
│   ├── getDiseaseData.ts
│   ├── getDiseaseDataFiltered.ts
│   └── index.ts
├── states
│   ├── dropdown.ts
│   ├── index.ts
│   ├── modal.ts
│   └── search.ts
├── styles
│   ├── base
│   │   ├── _fonts.scss
│   │   ├── _more.scss
│   │   └── _reset.scss
│   ├── constants
│   │   └── _colors.scss
│   ├── index.scss
│   └── index.ts
├── types
│   └── types.d.ts
└── utils
    ├── fuzzyMathcingRegExp.ts
    ├── index.ts
    ├── koreanCharAt.ts
    ├── makeMarkedString.ts
    └── sortFuzzyData.ts

동작

image

May-22-2022 13-06-34

  • 검색어를 입력할 때마다 Debouncing을 통해 시간차를 두어 데이터를 요청하고, 응답이 들어오면 Fuzzy Matching 알고리즘을 바로 적용하여 필터링 및 하이라이트된 데이터를 드랍다운에 출력해 주었습니다.

May-22-2022 13-08-00

  • 방향키를 이용하여 드랍다운에서 검색어를 선택할 수 있고, 엔터키 입력 또는 버튼 클릭으로 검색 결과를 모달로 출력해 주었습니다.

image

  • 검색어가 존재하지 않을 경우 로컬 스토리지에 저장한 검색 기록을 불러내어 출력합니다.

구현 방법과 이유, 사용한 기술

컴포넌트 / 레이아웃 구성

  • react-router-dom의 Outlet을 이용하여 페이지 레이아웃을 꾸미고, SearchPage 컴포넌트를 가운데에 배치해 주었습니다.

  • SearchPage 컴포넌트는 아래의 SearchForm, Dropdown 컴포넌트를 포함합니다.

  • 스타일링은 scss와 css module을 사용하였습니다.

  • 단일 페이지 어플리케이션이라, 추가적인 라우팅 없이 루트 링크만을 사용하였습니다.

SearchForm (검색어 입력 창)

  • 입력값을 받아오기 위해 onChange 이벤트 핸들러를 설정하였습니다. 입력값을 지웠거나 빈 문자열만 존재할 때엔 여타 검색 엔진 웹과 같이 지금까지의 검색 결과를 보여주도록 전역 상태값을 이용하여 제어해 주었습니다.

  • input 태그에 onKeyDown 이벤트 핸들러를 설정하여, 핸들러에서 상하 방향키 이벤트가 발생하였을 경우 드랍다운 상의 검색어들을 선택할 수 있도록 구현하였습니다. 또한, 드랍다운에서 선택한 추천 검색어에 따라 입력창의 값 (value) 도 바뀔 수 있도록 하였습니다.

    • 상하 방향키로 focusedIndex 상태값을 변경하는 방식으로 어떤 인덱스가 선택되었는지 판단하고, 각 인덱스의 검색어를 하이라이트해 주었습니다. 또한 드랍다운에 보이는 검색어에 한해서만 방향키 이동이 가능하도록 최대 / 최소 인덱스에 제한을 두었습니다.

    • 상하 키 입력 시에 데이터 재요청이 이루어지지 않고 현재의 검색 결과 그대로 커서만 이동해야 하므로, 전역 상태값을 이용하여 데이터 요청을 막고 드랍다운 내의 선택한 요소에 포커싱을 주었습니다.

    • Tab 키는 기본적으로 keyboard accessibility를 담당하므로, 기본 focus 기능을 유지해 주었습니다.

  • 드랍다운은 input 태그가 포커싱되었을 때만 출력해 주어야 하므로, isFocus 상태값을 onFocus, onBlur 이벤트 발생 시마다 재설정하는 방식으로 관리하였습니다.

Dropdown (드랍다운)

  • Dropdown 컴포넌트는 입력 값이 바뀔 때마다 / 검색 기록을 보여줄 때마다 데이터를 불러와 필터링 및 정렬 후 출력합니다.

  • 검색 결과와 최근 검색 기록 중 무엇을 렌더링할지는 searchForm 의 입력값에 따라 결정되므로 전역 상태 category로 제어하였습니다.

  • 키보드 입력 제어는 searchForm 컴포넌트에서 담당하므로, 이벤트 발생 시에 어떤 요소가 선택되었는지 정보 (focusedIndex) 를 전역 상태값으로 가져와 해당 요소에 하이라이트 디자인을 적용하였습니다. 또한 선택한 커서가 바뀔 때마다 실제 검색 창처럼 input 태그 내의 값이 바뀌도록 하였습니다.

모달

  • 검색 후 결과를 실제 검색 페이지처럼 보여주기 위하여 모달을 삽입하였습니다.

  • react portal을 이용하여 root 태그 바깥에 위치한 태그에 포탈을 연결하고, root 태그 내부의 컴포넌트 조작으로 모달을 제어하였습니다.

  • 모달 제어는 여러 컴포넌트에서 이루어져야 했기에 모달 열림 / 닫힘 조건과 모달에서 보여줄 데이터를 redux를 사용하여 전역으로 관리하였습니다.

  • input이 submit될 때 모달이 열릴 수 있도록 구현하였고, 입력 값을 업데이트 시켜주었습니다.

데이터 요청

  • react-query를 이용하여 같은 키를 가진 쿼리에 대하여 캐싱을 수행하였습니다.

  • API의 속도가 많이 느린 편이고, Fuzzy Matching을 구현하기 위해서는 이미 존재하는 검색어 목록에서 사용자의 검색어를 예측할 수 밖에 없어 제공받은 xml 데이터를 JSON으로 변환하여 사용하였습니다.

  • 쿼리 키에는 검색어 (searchValue) 를 포함시켜, 같은 검색어에 대하여 같은 쿼리로 판단하고 불필요한 데이터 요청을 막았습니다.

  • 데이터를 받아오는 함수 getDiseaseDataFiltered는 Fuzzy Matching 알고리즘으로 필터링을 진행한 데이터를 반환하므로, 모든 데이터가 캐싱되지 않고 필터링된 데이터가 캐싱되어 같은 키에 대해 필터링 과정 또한 생략할 수 있도록 하였습니다.

  • 검색어를 입력하는 input에서 onChange 이벤트가 발생할 때마다 요청을 보내는 것이 아닌, Debounce 훅을 구현하여 특정 시간마다 한 번씩만 전역 상태값으로 저장하고, useQuery 훅에서 전역 상태값의 변화를 감지할 때마다 요청을 수행하는 방식으로 API 요청 횟수를 줄였습니다.

  • 서버에서 데이터를 받아오지 않고 JSON을 읽어들이는 방식을 사용했기 때문에, 서버에서의 값에 변동이 없다고 판단하고 cacheTime을 Infinity로 설정하였습니다. 따라서 캐시는 페이지 내에서 무한 지속됩니다.

  • enabled 속성으로 searchValue가 빈 문자열이 아니거나, API 요청이 필요할 때만 요청을 보낼 수 있도록 조건을 추가하여 필요한 요청만 보낼 수 있도록 하였습니다.

  • 응답이 돌아올 때마다 fetched 문구를 콘솔에 출력하여 쉽게 볼 수 있도록 하였습니다.

Fuzzy Matching 알고리즘

  • 검색어와 정확히 일치하는 결과가 아닌, 검색어와 유사한 결과값들을 도출하기 위해 Fuzzy Matching을 도입하였습니다.

  • Fuzzy Matching으로 1차 필터링을 거치고, 이 결과값을 정해진 규칙에 따라 정렬해서 보여주었으며, 초성 검색은 검색어 종류 (질환명) 특성상 많이 사용되지 않을 것으로 예상되어 제외하였습니다.

  • 자세한 구현 방법은 다음과 같습니다.

    1. 글자 사이에 다른 글자가 배치될 수 있도록 정규식을 만듭니다.

      /(a).*?(b).*?(c)/

// `abc`가 검색어일 때의 정규식

    2. 검색어가 한글일 때, 유니코드를 이용하여 한글을 인식할 수 있는 정규식을 만들어 줍니다.

      1. 글자의 유니코드에서 44032를 뺀 값을 28로 나눈 나머지가 0이 아니면, 종성이 포함된 글자이므로 다른 처리 없이 글자를 바로 반환합니다.

      2. 초성만 존재하는 경우를 제외하면, 한글의 유니코드 시작점은 44032로, 이는 가의 코드에 해당합니다.

        • 종성으로 들어갈 수 있는 글자의 개수가 27종류이고, 종성이 없는 경우를 포함하면 28종류의 코드가 나옵니다.

        • 예를 들면, 가를 입력했을 때, 가 부터 갛 까지의 모든 글자가 인식되어야 하므로 28종류의 글자가 반환되어야 합니다.

        • 따라서 입력된 글자에 종성이 존재하지 않을 경우, 모든 종성의 경우의 수를 구하기 위해 현재 글자의 유니코드부터 글자의 유니코드 + 27까지의 값을 반환합니다.

        • 모든 유니코드 경우의 수를 반환하는 정규식은 다음과 같습니다.

        입력한 글자\\u시작 유니코드 - \\u마지막 유니코드/
      • 위의 두 경우를 처리하는 함수가 koreanCharAt 입니다.

    3. 검색어 내에서 가장 유의미한 Fuzzy Matching 결과를 추출합니다.

      • 간염을 검색하여 인간의 간염 이라는 추천 검색어를 얻었을 때, 단순 Fuzzy Matching만 적용하면 인간의 간염 과 같이 멀리 떨어져 있는 결과가 매칭될 가능성이 생깁니다.

      • 만약 가염 과 같이 종성이 없는 글자를 검색할 경우, 종성이 있는 글자가 원본 글자와 정확하게 일치하지 않음에도 불구하고 우선순위가 더 높게 매칭될 수 있어 이를 방지하고자 매커니즘을 도입하였습니다.

      • DFS를 이용하여 구현하였으며, 검색한 글자와 정규식으로 일치하는 글자들이 포함된 위치를 전부 찾은 뒤 DFS로 각 글자 사이의 거리를 계산합니다.

    4. 위의 방법으로 글자 사이의 모든 거리를 계산한 후, 검색어와의 유사도 (정확성) 과 글자 간 거리를 기준으로 정렬하여, 가장 유의미한 결과를 상위에 배치합니다.

정렬 우선순위

  1. input에 입력된 글자와 가장 똑같은 글자를 많이 포함하는 검색어

    input = 가염

searchValues = [ "간염", "가염" ]

// 원본 문자열과 더 가까운 가염 이 간염 보다 우선순위가 더 높습니다.

  2. fuzzy matching으로 뽑아낸 글자들 사이의 최대 거리 중 가장 짧은 거리를 가진 검색어

    input = 염증

searchValues = [ "염증", "염색체증" ]

// 염증 이 염색체증 보다 더 가까이 붙어있으므로, 우선순위가 더 높습니다.

어려웠던 점

  • 키 이벤트를 적용할 때, input 태그의 값이 바뀌고 useQuery에 의해 데이터가 재요청되면서 추천 검색어가 잘못 표시되는 문제가 있었습니다. 검색창에 보여지는 inputValue 상태값은 변화하되 실제로 요청되는 검색어인 searchValue는 변하지 않도록 막아야 했기 때문에, isApiBlocked 상태값을 추가하여 불필요한 데이터 요청을 보내지 않도록 막아주는 방식으로 해결하였습니다.

  • 또한 방향키를 움직일 때, input 태그 내의 문자열 커서는 맨 오른쪽에 유지되기를 원했지만 위쪽 화살표를 누를 때마다 커서가 맨 왼쪽으로 이동하는 문제가 발생하였습니다. 처음에는 input 커서 제어까지 구현해야 할까 싶어 막막했지만, e.preventDefault() 로 간단히 해결되는 문제였습니다.

  • react-query를 본 과제에서 처음 사용하여 익숙해지는 데까지 시간이 조금 걸렸는데, 같은 검색어를 입력했음에도 검색어 캐싱이 되지 않아 끊임없이 재요청을 하는 문제가 있었습니다. 원인은 useQuery 훅의 요청 방식을 이해하지 못하고 useEffect 내에서 searchValue가 바뀔 때마다 refetch()를 시도했기 때문으로, refetch()를 사용하지 않고 cacheTime과 staleTime을 적절히 적용하여 캐싱에 성공하였습니다.

기여한 사람들

🌅 고은채 🌇 김형석 🌠 엄강우 🏙 최지윤