Flutter アプリでの検索
Flutter アプリでは、SearchService は他と同じ Bean です。ウィジェットがそれを受け取り、キーを押すたびに検索し、一致箇所をハイライトしてヒットを表示します。ナビゲーションのスターターがあれば、ヒットのリンクがその画面を開き、アプリの言語がインデックスを選びます。ショートカットがどこからでも検索を開きます。今読んでいるサイトの検索は、この方法で作られています。
使う理由
インデックスはメモリー上にあり、一度だけ組み立てられるので、検索は一、二フレームのうちに、オフラインで、スマートフォンと同じくブラウザーでも応答します。Flutter のスターターには、その周りの部品がすでにあります。一致箇所のための HighlightedText、テーマの方法で変化する結果のための ThemeText、設定の中のショートカットです。
例
# lib/resources/application.yml
spring:
search:
collapse-by: page
markdown:
- location: resources:content/docs/**/*.md
exclude: ['**/contents*.md']
link: /docs/{path}
flutter:
shortcuts:
search.open: [primary+k, slash]
// ユーザーの入力に合わせた、クエリの結果。
class SearchPanel extends StatefulWidget {
const SearchPanel({super.key});
@override
State<SearchPanel> createState() => _SearchPanelState();
}
class _SearchPanelState extends State<SearchPanel> {
var _hits = <SearchHit>[];
Future<void> _search(String query) async {
final route = context.route;
final hits = await context.bean<SearchService>().search(
query,
language: route.language, // ナビゲーションがあれば、アドレスの言語
);
if (mounted) setState(() => _hits = hits);
}
@override
Widget build(BuildContext context) => Column(
children: [
TextField(autofocus: true, onChanged: _search),
for (final hit in _hits) _Result(hit),
],
);
}
class _Result extends StatelessWidget {
const _Result(this.hit);
final SearchHit hit;
@override
Widget build(BuildContext context) {
final snippet = hit.snippet('body', length: 140);
return GestureDetector(
onTap: () => context.route.go(hit.document.link!),
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text(hit.document.fields['heading'] ?? hit.document.title),
HighlightedText(
snippet.text,
highlights: [
for (final r in snippet.ranges) TextRange(start: r.start, end: r.end),
],
highlightStyle: TextStyle(color: SpringTheme.of(context).colorScheme.primary),
maxLines: 2,
),
],
),
);
}
}
// ⌘K、Ctrl+K、または / で、どの画面からでも検索を開く。
@Component()
class SearchActions {
@Shortcut('search.open')
Future<void> open(BuildContext context) => showSearchPanel(context);
}
補足
- 言語。
spring.flutter.navigation.languagesがあれば、context.route.languageはアドレスの言語で、name.ja.mdファイルは日本語で検索されます。ナビゲーションがなければ、アプリのロケール (Localizations.localeOf(context).languageCode) を渡してください。 - 入力に合わせて。 最後の単語は、空白が続くまで前方一致なので、
beaですでにbeanが見つかります。キーを押すたびの検索は軽く、最初の検索がインデックスを組み立てます。 - ハイライト。
hit.highlights['title']とスニペットのrangesは、HighlightedTextのための、または結果が変わるとテーマのテキストの変化を再生するThemeText(highlights:, changeKey: query)のためのTextRangeになります。 - Web での最初の検索 は、ビルドが
spring.search.markdownについて書いたインデックスを読みます。言語ごとに 1 ファイルの Flutter アセットで、1 秒足らずで読み込まれます (ビルドが書くインデックス)。lib/resources/spring_gen/search/をflutter: assets:に書いてください。最初のキー入力の前にファイルが届くよう、検索を開いたとき、またはスプラッシュの少し後にprepare(language: ...)を呼んでください。 - Web でのフォント。 日本語や中国語の結果には Flutter がダウンロードするフォントが必要です。Flutter のスターターの フォントのウォームアップ が、スプラッシュの背後でそれを取得します。