すべてのプロパティ

spring_search_dart が spring.search の下で読むすべてのプロパティです。searchService Bean が生成されるときに一度だけバインドされるので、変更にはコンテキストの再起動が必要です (Flutter ではホットリロードがそれを再起動します)。

使う理由

検索のほとんどは設定です。ドキュメントがどこにあるか、フィールドがどう重み付けされるか、どれだけ寛容か、です。このページはすべてのキーを一か所に列挙します。パッケージのメタデータは、エディターのために同じキーを記述しています。

例

# lib/resources/application.yml
spring:
  search:
    enabled: true
    default-language: en
    operator: and
    fuzzy: 1
    max-hits: 20
    collapse-by: page
    fields:
      title: 8
      heading: 4
      body: 1
    analyzers:
      ja: standard
      fr: french          # french という名前の SearchAnalyzer Bean
    markdown:
      - location: resources:content/components/**/*.md
        exclude: ['**/contents*.md']
        link: /components/{path}
      - location: resources:content/docs/**/*.md
        exclude: ['**/contents*.md']
        link: /docs/{path}

spring.search

キー 型 デフォルト 意味 ページ
spring.search.enabled bool true false: SearchService Bean なし 概要
spring.search.default-language 言語タグ en 言語を指定しないドキュメントの言語、そして言語を指定しない検索や、ドキュメントのない言語を指定した検索の言語 ドキュメント
spring.search.operator and、or and and: ドキュメントはクエリのすべての単語を持つ。or: そのいずれか 検索
spring.search.fuzzy 数値 1 クエリの単語が持ちうるタイプミス: 五から七文字の単語では一つ、それより長い単語ではこの数まで。0: なし 検索
spring.search.max-hits 数値 20 検索が与えるヒットの最大数 (検索の limit: がそれを上書きする) 検索
spring.search.collapse-by 属性の名前 なし ヒットをグループ化する属性: 各値の最良のものだけが残る (page: ページごとに一つのセクション) 検索
spring.search.indexing first-search、start、background first-search インデックスを作るとき: 最初の検索 (または SearchService.prepare()) のとき、アプリケーションの起動中 (Flutter アプリのスプラッシュの裏)、または起動の直後にアプリが動いている間 検索
spring.search.prebuilt 真偽値 true ビルドが spring.search.markdown のインデックスを言語ごとに 1 ファイル lib/resources/spring_gen/search/(Flutter アセット)に書き、検索はページの代わりにそれを読みます 検索
spring.search.fields.<field> 数値 空: title 8、heading 4、body 1 各フィールドの重み。指定されないフィールドの重みは 1。いずれかのフィールドを設定するとデフォルトが置き換わる 検索
spring.search.analyzers.<language> アナライザーの名前 en では english、その他は standard 各言語のアナライザー (ja: standard) アナライザー
spring.search.markdown[n].location resources: または asset: のパターン 必須 Markdown ファイル (resources:content/**/*.md、asset:docs/**/*.md) ドキュメント
spring.search.markdown[n].exclude パターンのリスト なし 除外するファイル。その場所のディレクトリからの相対 (**/contents*.md) ドキュメント
spring.search.markdown[n].link {path} を含むテキスト /{path} ページのリンク: {path} はその場所のディレクトリからのファイルのパスで、.md、その言語、最後の index を除いたもの ドキュメント

関連項目