HangulSearch

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 33)

다양한 방식의 한글 검색을 지원하는 스위프트 라이브러리입니다.

HangulSearch Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# HangulSearch
[![stability-beta](https://img.shields.io/badge/stability-beta-33bbff.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#beta)

Swift에서 한글 검색을 구현할 때 바로 사용할 수 있는 라이브러리입니다.

## 설치

### Xcode (Swift Package Manager)

1. `File > Swift Packages > Add Package Dependency...`
2. 저장소 URL 입력: `https://github.com/Juhwa-Lee1023/HangulSearch`
3. 버전 규칙 선택 후 추가

## 기본 사용

```swift
import HangulSearch

struct Person {
    let name: String
    let age: Int
}

let people = [
    Person(name: "김철수", age: 25),
    Person(name: "이철수", age: 30),
    Person(name: "이영희", age: 22)
]

let engine = HangulSearch(
    items: people,
    searchMode: .combined,
    sortMode: .none,
    keySelector: { $0.name }
)

let results = engine.searchItems(input: "철수")
print(results.map(\.name))
```

## 검색 모드

사용 가능한 검색 모드:

- `.containsMatch`: 입력 문자열이 원문에 포함되면 매칭합니다. 일반적인 부분 문자열 검색에 사용합니다.
- `.chosungAndFullMatch`: 입력이 순수 초성(예: `ㅊㅅ`)이면 초성 검색으로, 그 외에는 일반 문자열 검색으로 동작합니다.
- `.autocomplete`: 입력 문자열을 자동완성 형태로 해석해 매칭합니다.
- `.combined`: `contains/chosung/autocomplete` 결과를 합쳐 반환합니다.

추천 사용 케이스:

1. `.none`: 서버 랭킹이나 원본 데이터 순서를 그대로 유지해야 하는 경우
2. `.hangulOrder`: 가나다순 목록 화면처럼 알파벳/한글 정렬이 필요한 경우
3. `.hangulOrderReversed`: 역순 목록(하단 문자부터)으로 탐색하는 화면
4. `.editDistance`: 오타가 많은 자유 입력 검색에서 유사도 중심 정렬이 필요한 경우
5. `.matchPosition`: 접두어 매칭(앞부분 일치) 결과를 우선 노출하고 싶은 경우

실전 예시:

```swift
let noneSorted = HangulSearch(
    items: people,
    searchMode: .containsMatch,
    sortMode: .none,
    keySelector: { $0.name }
).searchItems(input: "이")

let hangulSorted = HangulSearch(
    items: people,
    searchMode: .containsMatch,
    sortMode: .hangulOrder,
    keySelector: { $0.name }
).searchItems(input: "이")

let editDistanceSorted = HangulSearch(
    items: people,
    searchMode: .containsMatch,
    sortMode: .editDistance,
    keySelector: { $0.name }
).searchItems(input: "이쳘수")
```

## 옵션 API 사용

자주 쓰는 옵션:

- `mode`: 엔진 기본 모드 대신 이번 검색에만 모드를 덮어씁니다.
- `sortMode`: 엔진 기본 정렬 대신 이번 검색에만 정렬 기준을 덮어씁니다.
- `limit` / `offset`: 결과 개수 제한과 페이지네이션을 설정합니다.
- `minInputLength`: 너무 짧은 입력(예: 1글자)에서 검색을 제한할 수 있습니다.
- `normalizeToNFC`: 유니코드 정규화(NFC) 기준으로 입력/데이터를 맞춰 검색 안정성을 높입니다.
- `emptyQueryBehavior`: 빈 입력일 때 `[]` 또는 전체 결과 반환을 선택합니다.

HangulSearch

HangulSearch Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

HangulSearch

HangulSearch Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README