spring_search_dart
spring_search_dart は、Spring for Dart のアプリケーション内の全文検索です。ドキュメントサイトのページ、ショップの商品、アプリのメモです。ドキュメントがどこから来るか (Markdown ファイル、または任意の Bean) を示し、SearchService Bean に問い合わせます。Dart VM、Flutter、Web で、純粋な Dart で動きます。サーバーもネイティブのコードもありません。
まだ pub.dev にはありません。フレームワークの git リポジトリから取得してください (セットアップ を参照)。
使う理由
検索ボックスは通常、検索サーバー (Elasticsearch、Algolia) やホストされたインデックスを意味し、そのコストとネットワークの往復が伴います。数千のドキュメントにはそれは過剰です。メモリー上のインデックスは、入力に合わせて、オフラインで、すべてのプラットフォームで応答します。このインデックスは、ユーザーが検索ボックスに期待することを行います。すべての単語、入力中の単語の前方一致、タイプミス、フレーズ、任意の文字体系 (辞書なしの日本語)、キャメルケースの名前、英語の語形、そして一致箇所がハイライトされたスニペットです。
セットアップ
# pubspec.yaml
dependencies:
spring_search_dart:
git:
url: https://github.com/farum-azula/spring_core_dart.git
path: spring_search_dart
dev_dependencies:
build_runner: ^2.17.0
spring_core_dart_generator: ^0.9.0
依存するのは spring_boot_dart だけなので、サーバーでも、コマンドラインのプログラムでも、Flutter アプリでも同じように動きます。ジェネレーターがその自動構成を見つけ、それが searchService Bean を宣言します。
import 'package:spring_search_dart/spring_search_dart.dart';
例
# lib/resources/application.yml
spring:
search:
markdown:
- location: resources:content/**/*.md
exclude: ['**/contents*.md']
link: /docs/{path}
collapse-by: page # ページごとに一つのヒット: その最良のセクション
@Service()
class DocsSearch {
DocsSearch(this.search);
final SearchService search;
Future<void> show(String query) async {
final hits = await search.search(query, language: 'en');
for (final hit in hits) {
final snippet = hit.snippet('body');
print('${hit.document.title} ${hit.document.link}: ${snippet.text}');
}
}
}
show('bean factry') は、タイプミスがあっても、Bean ファクトリーについての Markdown ファイルのセクションを最良のものから順に、それぞれのリンク (/docs/core/beans#bean-factory) と一致箇所の周りのテキストの断片とともに出力します。
見つけるもの
- BM25 でランク付けされた、クエリの すべての単語 (いずれか一つなら
spring.search.operator: or)。フィールドの重みはspring.search.fieldsが示すとおりです (デフォルトはtitle8、heading4、body1)。 - 長い単語の先頭としての、入力中の最後の単語:
beaはbeanを見つけます。 - タイプミスのある単語:
contxetはcontextを見つけます (spring.search.fuzzy)。 - フレーズ:
"bean factory"は、隣り合った二つの単語を見つけます。 - 任意の文字体系の単語。 中国語、日本語、韓国語は二文字ずつに区切られるので、
依存性は辞書なしで依存性注入を見つけます。 - キャメルケースの名前の部分:
contextはApplicationContextを見つけます。 - 英語では、単語の語形:
bindingはbindsを見つけます。
内容
- ドキュメント: Markdown ファイルと
SearchDocumentSourceBean、言語、インデックスの再構築。 - 検索: クエリ、ヒット、スコア、ハイライト、スニペット。
- アナライザーとランカー: 言語ごとにテキストがどのように語になるか、ランキングの変え方。
- Flutter アプリでの検索: ハイライトとキーボードショートカットを持つ、入力に合わせた検索ボックス。
- すべてのプロパティ:
spring.searchのすべてのキー。 - Spring との違い
Spring (Java) との対応
Spring には対応するものがありません。アプリケーションの中で、Hibernate Search や検索サーバーのクライアントの役割を果たします。