Groovyスクリプトガイド

概要

Groovyは Fess のデフォルトスクリプト言語です。 Java仮想マシン（JVM）上で動作し、Javaとの高い互換性を持ちながら、 より簡潔な構文でスクリプトを記述できます。

基本構文

変数宣言

// 型推論（def）
def name = "Fess"
def count = 100

// 明示的な型指定
String title = "Document Title"
int pageNum = 1

文字列操作

// 文字列補間（GString）
def id = 123
def url = "https://example.com/doc/${id}"

// 複数行文字列
def content = """
This is a
multi-line string
"""

// 置換
title.replace("old", "new")
title.replaceAll(/\s+/, " ")  // 正規表現

// 分割・結合
def tags = "tag1,tag2,tag3".split(",")
def joined = tags.join(", ")

// 大文字/小文字変換
title.toUpperCase()
title.toLowerCase()

コレクション操作

// リスト
def list = [1, 2, 3, 4, 5]
list.each { println it }
def doubled = list.collect { it * 2 }
def filtered = list.findAll { it > 3 }

// マップ
def map = [name: "Fess", version: "15.7"]
println map.name
println map["version"]

条件分岐

// if-else
if (data.status == "active") {
    return "有効"
} else {
    return "無効"
}

// 三項演算子
def result = data.count > 0 ? "あり" : "なし"

// エルビス演算子（null合体演算子）
def value = data.title ?: "無題"

// セーフナビゲーション演算子
def length = data.content?.length() ?: 0

ループ処理

// for-each
for (item in items) {
    println item
}

// クロージャ
items.each { item ->
    println item
}

// 範囲
(1..10).each { println it }

データストアスクリプト

データストア設定でのスクリプト例です。

注釈

データストアスクリプトでは、 フィールド名=式 の各行がそれぞれ独立した1つの式として評価されます。 そのため、 import 文・複数行にわたる def 変数宣言・複数フィールドをまとめて設定する複数行の制御構文（ if ブロックなど）は使用できません。 Javaクラスを利用する場合は完全修飾クラス名（FQCN）を用いて1つの式で記述し、条件分岐はフィールドごとに三項演算子で記述します（例: url=data.published ? data.url : null ）。 また、ここで使用している変数名 data は説明用の例であり、実際の変数名は利用するデータストアコネクタによって異なります。詳細は データストアクロール を参照してください。

基本的なマッピング

url=data.url
title=data.title
content=data.content
lastModified=data.updated_at

URLの生成

// ID基づくURL生成
url="https://example.com/article/" + data.id

// 複数フィールドの組み合わせ
url="https://example.com/" + data.category + "/" + data.slug + ".html"

// 条件付きURL
url=data.external_url ?: "https://example.com/default/" + data.id

コンテンツの加工

// HTMLタグの除去
content=data.html_content.replaceAll(/<[^>]+>/, "")

// 複数フィールドの結合
content=data.title + "\n" + data.description + "\n" + data.body

// 長さの制限
content=data.content.length() > 10000 ? data.content.substring(0, 10000) : data.content

日付の処理

// 日付のパース（FQCNを使用した単一式）
lastModified=new java.text.SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss").parse(data.date_string)

// エポック秒からの変換
lastModified=new Date(data.timestamp * 1000L)

利用可能なオブジェクト

スクリプトの実行コンテキストによって、利用可能なオブジェクトが異なります。

コンテキスト	オブジェクト	説明
全コンテキスト	container	DIコンテナ。 container.getComponent("...") でコンポーネントにアクセスする際に使用
スケジュールジョブ	executor	ジョブ実行制御（ JobExecutor ）。ジョブの停止サポートに必要
データストア	（コネクタ固有）	各データストアが提供するデータレコード変数。変数名はコネクタによって異なる
パスマッピング	url , matcher	変換対象のURL文字列と正規表現のマッチ結果（ Matcher ）。 groovy: 接頭辞付きの置換設定で利用可能
ドキュメントブースト	（ドキュメントフィールド）	対象ドキュメントの各フィールドが変数として利用可能（条件式・ブースト値式で使用）

スケジュールジョブスクリプト

スケジュールジョブで使用するGroovyスクリプトの例です。 スケジュールジョブでは container と executor が利用可能です。 executor をジョブの execute() メソッドに渡すことで、ジョブの停止制御が有効になります。

注釈

スケジュールジョブスクリプトは、スクリプト全体が1つのGroovyスクリプトとして評価されます。 このため、データストアスクリプトとは異なり、 import 文・複数行の def 宣言・複数行の制御構文を使用できます。 以降の「Javaクラスの使用」「Fessコンポーネントへのアクセス」「エラーハンドリング」「デバッグとログ出力」の例も、この完全なスクリプトのコンテキストを前提としています。

クロールジョブの実行

return container.getComponent("crawlJob").logLevel("info").gcLogging().execute(executor);

条件付きクロール

import java.util.Calendar

def cal = Calendar.getInstance()
def hour = cal.get(Calendar.HOUR_OF_DAY)

// 業務時間外のみクロール
if (hour < 9 || hour >= 18) {
    return container.getComponent("crawlJob").logLevel("info").gcLogging().execute(executor)
}
return "Skipped during business hours"

複数のジョブを順番に実行

def results = []

// サジェスト更新
results << container.getComponent("suggestJob").logLevel("info").sessionId("SUGGEST").execute(executor)

// クロール実行
results << container.getComponent("crawlJob").logLevel("info").gcLogging().execute(executor)

return results.join("\n")

Javaクラスの使用

Groovyスクリプト内では、Javaの標準ライブラリやFessのクラスを使用できます。

日付・時刻

import java.time.LocalDateTime
import java.time.format.DateTimeFormatter

def now = LocalDateTime.now()
def formatted = now.format(DateTimeFormatter.ISO_LOCAL_DATE_TIME)

ファイル操作

import java.nio.file.Files
import java.nio.file.Paths

def content = new String(Files.readAllBytes(Paths.get("/path/to/file.txt")))

HTTP通信

import java.net.URL

def url = new URL("https://api.example.com/data")
def response = url.text

警告

外部リソースへのアクセスはパフォーマンスに影響するため、 必要最小限に抑えてください。

Fessコンポーネントへのアクセス

container を使用してFessのコンポーネントにアクセスできます。

システムヘルパー

def systemHelper = container.getComponent("systemHelper")
def currentTime = systemHelper.getCurrentTimeAsLong()

設定値の取得

def fessConfig = container.getComponent("fessConfig")
def indexName = fessConfig.getIndexDocumentUpdateIndex()

検索の実行

def searchHelper = container.getComponent("searchHelper")
// 検索パラメーターを設定して検索実行

エラーハンドリング

import 文はスクリプトの先頭に記述する必要があります（ try-catch などのブロック内には記述できません）。 try-catch で例外を捕捉し、ジョブのエラーを制御できます。

import org.apache.logging.log4j.LogManager

def logger = LogManager.getLogger("script")

try {
    return container.getComponent("crawlJob").logLevel("info").gcLogging().execute(executor)
} catch (Exception e) {
    logger.error("Failed to execute crawl job: {}", e.message, e)
    return "Error: " + e.message
}

デバッグとログ出力

ログ出力

import org.apache.logging.log4j.LogManager

def logger = LogManager.getLogger("script")

logger.debug("Debug message: {}", value)
logger.info("Processing: {}", title)
logger.warn("Warning: {}", message)
logger.error("Error: {}", e.message, e)

デバッグ用の出力

// コンソール出力（開発時のみ）
println "data.id = ${data.id}"
println "data.title = ${data.title}"

ベストプラクティス

1. シンプルに保つ: 複雑なロジックは避け、読みやすいコードを心がける

2. nullチェック: ?. 演算子や ?: 演算子を活用

3. 例外処理: 適切なtry-catchで予期しないエラーに対応

4. ログ出力: デバッグしやすいようにログを出力

5. パフォーマンス: 外部リソースアクセスを最小化

参考情報

• Groovy公式ドキュメント

• スクリプティング概要 - スクリプティング概要

• データストアクロール - データストア設定ガイド

• スケジューラ - スケジューラー設定ガイド