JsonPathStream - JSONPathでJSONの一部を取得

入力のJSONに対してJSONPath式を使用して、JSONの一部を出力します。

■ストリーム情報

入力フォーマットJSON
接続数1
出力フォーマットJSON

■コンポーネントプロパティ

名前プロパティ型マッピング説明
JSONPath式string入力＆出力 取得するJSONの部分を指定するJSONPath式を記述します。
式の中ではフロー変数などの各種変数が使用できます。
JSONPath式は、「JSONPath式エディタ」を使って指定することができます。 JSONPath式にマッチしなかった場合はエラーになります。

■ループ処理

JSONPath式の結果が複数になった場合、それぞれがループで出力されます。 

{
  "部署": [
    {
      "名前":"営業部",
      "従業員数": 10
    },
    {
      "名前":"開発部",
      "従業員数": 20
    }
  ]
}

上のような入力JSONに「$.部署[*]」という式を適用した場合、 

{
  "名前": "営業部",
  "従業員数": 10
}
      
{
  "名前": "開発部",
  "従業員数": 20
}

という2つのJSONがループで出力されます。

■トランザクション処理

コミット何もしません。
ロールバック何もしません。

■エラー処理

タイプパラメーターエラー処理フロー
へのストリーム		エラー
コード		説明
汎用 なし コンポーネントの入力ストリーム1JSONPath式が不正な場合
2JSONPath式にマッチしなかった場合

■JSONPath

JSONPathは、JSONデータ内の特定の要素や値にアクセスするためのパス指定方法です。 ファイルの階層をたどるように、目的のデータにアクセスできます。 詳細はJSONPathのRFCをご参照ください。

基本的な書き方

以下にJSONPathの基本的な文法を紹介します。
書き方意味例
$ルート（JSONの先頭）$
.子要素にアクセス$.user.name
[]配列やキーを指定$.items[0]
*ワイルドカード（すべての要素）$.items[*].name
?(@.<フィールド名>==<値>)条件式に一致する要素$.items[?(@.name=="製品A")]

例

以下にいくつかのJSONPathの例をご紹介します。 
{
  "ユーザー": {
    "名前": "太郎",
    "年齢": 30
  },
  "商品": [
    { "名前": "製品A", "価格": 1000 },
    { "名前": "製品B", "価格": 2000 }
  ]
}
取得したいデータJSONPath結果
ユーザー名$.ユーザー.名前"太郎"
最初の商品名$.商品[0].名前"製品A"
すべての商品名$.商品[*].名前["製品A", "製品B"]
すべての商品価格$.商品[*].価格[1000, 2000]
製品Aの商品価格$.商品[?(@.名前=="製品A")].価格1000

■変数の使用

JSONPath式の中ではフロー変数とシステム変数、外部変数セット、ストリーム変数が使用できます。
以下の様に条件式内に変数を埋め込むと、実際の値に置き替えてJSONPathを評価します。 

$.商品[?(@.名前==$flow.<フロー変数名>)].価格

使用できる変数
フロー変数$flow.<フロー変数名>
システム変数$system.<システム変数名>（英語名）
外部変数セット$exvar.<外部変数セット名>.<変数名>
ストリーム変数$stream.<ストリーム変数名>（英語名）

■JSONPath式エディタ

JSONPath式エディタはプロパティ値にJSONPath式を指定する場合にその入力をサポートするためのエディタです。ツリーからJSONフィールドを選択して、そこまでのJSONPath式をプロパティに設定することができます。
JSONPath式を指定するフィールドの右にある「...」をクリックすると起動します。

ツリー

ツリーにはJSONPath式の対象となるストリームのフィールド定義が表示されます。コンポーネントの入力側にリンクが繋がっていない場合や入力ストリームにフィールド定義がされていない場合は初期状態では何も表示されません。

「サンプル参照」ボタン

任意のJSONを読み込み、その構造をツリーに表示させることができます。

「保存する」チェックボックス

サンプル参照からJSONを読み込んでいる場合、［保存する］チェックボックスをオンにすると、読み込んだJSONがxfpファイル（プロジェクトファイル）に保存され、次回xfpファイルを開いたときに、同じサンプルを利用できるようになります。

注意：サンプルJSONはコンポーネントの実行に必要な情報ではありません。ファイルサイズの大きなJSONを保存するとxfpファイル（プロジェクトファイル）のファイルサイズが大きくなり、保存やコンパイルに時間がかかってしまいます。そのため、サンプルJSONの保存は開発やテストの段階のみ行うようにしてください 。

JSONPathの設定

ツリーでノードを選択すると、そのJSONPathが「選択パス」欄に表示されます。「↓」ボタンを押すとそのパスが「JSONPath」欄にコピーされます。 「JSONPath」欄は編集可能なテキストフィールドで、複雑なJSONPath式を指定する場合はそこに直接記述することができます。

変数の挿入

JSONPath式エディタの「カーソル位置への挿入」ボタンで変数タブで選択した変数を「JSONPath」欄のカーソル位置に追加する事が出来ます。

JSONPath式のテスト

テストボタンをクリックする事でJSONPath式のテストダイアログを開き、JSONPath式の動作をテストする事が出来ます。
実行ボタンをクリックすると、左側の「JSON」テキストエリアに入力されたJSONに対して、「JSONPath」欄に入力されたJSONPath式を評価した結果を確認する事ができます。
「JSONPath」欄は編集する事が出来、編集後は「適用」ボタンをクリックする事でJSONPath式エディタの「JSONPath」欄に反映する事が出来ます。