パッケージ org.springframework.test.util

クラス JsonPathExpectationsHelper

java.lang.ObjectSE
org.springframework.test.util.JsonPathExpectationsHelper
public class JsonPathExpectationsHelper extends ObjectSE
JSON パス式を介してアサーションを適用するためのヘルパークラス。

JsonPath プロジェクトに基づく: バージョン 0.9 + が必要、1.1 + を強く推奨。

導入:
3.2
作成者:
Rossen Stoyanchev, Juergen Hoeller, Craig Andrews, Sam Brannen, Stephane Nicoll

  • コンストラクターの詳細

    • JsonPathExpectationsHelper

      public JsonPathExpectationsHelper(StringSE expression)
      デフォルト構成を使用して新しい JsonPathExpectationsHelper を構築します。
      パラメーター:
      expression - JsonPath 式。null または空にしない
      導入:
      6.2

    • JsonPathExpectationsHelper

      public JsonPathExpectationsHelper(StringSE expression, @Nullable com.jayway.jsonpath.Configuration configuration)
      新しい JsonPathExpectationsHelper を作成します。
      パラメーター:
      expression - JsonPath 式。null または空にしない
      configuration - 使用する Configuration またはデフォルト設定を使用する null 
      導入:
      6.2

    • JsonPathExpectationsHelper

      @DeprecatedSE(since="6.2", forRemoval=true) public JsonPathExpectationsHelper(StringSE expression, ObjectSE... args)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      String.formatted(Object...)SE に事前を呼び出すことを推奨
      新しい JsonPathExpectationsHelper を作成します。
      パラメーター:
      expression - JsonPath 式。null または空にしない
      args - String.format(String, Object...)SE で定義されたフォーマット指定子を使用して、JsonPath 式をパラメーター化する引数

  • メソッドの詳細

    • assertValue

      public <T> void assertValue(StringSE content, Matcher<? super T> matcher)
      提供された content に対して JSON パス式を評価し、指定された Matcher で結果の値をアサートします。
      パラメーター:
      content - JSON コンテンツ
      matcher - 結果をアサートするマッチャー

    • assertValue

      public <T> void assertValue(StringSE content, Matcher<? super T> matcher, ClassSE<T> targetType)
      結果の値のターゲット型も受け入れる assertValue(String, Matcher) のオーバーロードされたバリアント。これは、たとえば整数を double に強制するなど、数値を確実に照合できます。
      パラメーター:
      content - JSON コンテンツ
      matcher - 結果をアサートするマッチャー
      targetType - 結果の値の予想される型
      導入:
      4.3.3

    • assertValue

      public <T> void assertValue(StringSE content, Matcher<? super T> matcher, ParameterizedTypeReference<T> targetType)
      assertValue(String, Matcher) のオーバーロードされたバリアントであり、ジェネリクス型を定義できる結果の値のターゲット型も受け入れます。

      デフォルトではジェネリクス型を処理できないため、より複雑な MappingProvider を定義する Configuration で使用する必要があります。

      パラメーター:
      content - JSON コンテンツ
      matcher - 結果をアサートするマッチャー
      targetType - 結果の値の予想される型
      導入:
      6.2

    • assertValue

      public void assertValue(StringSE content, @Nullable ObjectSE expectedValue)
      提供された content に対して JSON パス式を評価し、結果が期待値と等しいことをアサートします。
      パラメーター:
      content - JSON コンテンツ
      expectedValue - 期待値

    • assertValueIsString

      public void assertValueIsString(StringSE content)
      提供された content に対して JSON パス式を評価し、結果の値が StringSE であることを表明します。
      パラメーター:
      content - JSON コンテンツ
      導入:
      4.2.1

    • assertValueIsBoolean

      public void assertValueIsBoolean(StringSE content)
      提供された content に対して JSON パス式を評価し、結果の値が BooleanSE であることを表明します。
      パラメーター:
      content - JSON コンテンツ
      導入:
      4.2.1

    • assertValueIsNumber

      public void assertValueIsNumber(StringSE content)
      提供された content に対して JSON パス式を評価し、結果の値が NumberSE であることを表明します。
      パラメーター:
      content - JSON コンテンツ
      導入:
      4.2.1

    • assertValueIsArray

      public void assertValueIsArray(StringSE content)
      提供された content に対して JSON パス式を評価し、結果の値が配列であることをアサートします。
      パラメーター:
      content - JSON コンテンツ

    • assertValueIsMap

      public void assertValueIsMap(StringSE content)
      提供された content に対して JSON パス式を評価し、結果の値が MapSE であることを表明します。
      パラメーター:
      content - JSON コンテンツ
      導入:
      4.2.1

    • exists

      public void exists(StringSE content)
      提供された content に対して JSON パス式を評価し、null 以外の値、おそらく空の配列またはマップが指定されたパスに存在することをアサートします。

      JSON パス式が明確でない場合、このメソッドは、指定されたパスの値のリストが空でないことをアサートすることに注意してください。

      パラメーター:
      content - JSON コンテンツ

    • doesNotExist

      public void doesNotExist(StringSE content)
      提供された content に対して JSON パス式を評価し、指定されたパスに null 以外の値が存在しないことをアサートします。

      JSON パス式が明確でない場合、このメソッドは、指定されたパスの値のリストが空であることを表明します。

      パラメーター:
      content - JSON コンテンツ

    • assertValueIsEmpty

      public void assertValueIsEmpty(StringSE content)
      提供された content に対して JSON パス式を評価し、指定されたパスに空の値が存在することをアサートします。

      空のセマンティクスについては、ObjectUtils.isEmpty(Object) の Javadoc を参照してください。

      パラメーター:
      content - JSON コンテンツ

    • assertValueIsNotEmpty

      public void assertValueIsNotEmpty(StringSE content)
      提供された content に対して JSON パス式を評価し、指定されたパスに空でない値が存在することをアサートします。

      空のセマンティクスについては、ObjectUtils.isEmpty(Object) の Javadoc を参照してください。

      パラメーター:
      content - JSON コンテンツ

    • hasJsonPath

      public void hasJsonPath(StringSE content)
      提供された content に対して JSON パス式を評価し、値（おそらく null）が存在することをアサートします。

      JSON パス式が明確でない場合、このメソッドは、指定されたパスの値のリストが空でないことをアサートします。

      パラメーター:
      content - JSON コンテンツ
      導入:
      5.0.3

    • doesNotHaveJsonPath

      public void doesNotHaveJsonPath(StringSE content)
      提供された content に対して JSON パス式を評価し、null 値を含む値が指定されたパスに存在しないことをアサートします。

      JSON パス式が明確でない場合、このメソッドは、指定されたパスの値のリストが空であることをアサートします。

      パラメーター:
      content - JSON コンテンツ
      導入:
      5.0.3

    • evaluateJsonPath

      @Nullable public ObjectSE evaluateJsonPath(StringSE content)
      JSON パスを評価し、結果の値を返します。
      パラメーター:
      content - 評価するコンテンツ
      戻り値:
      評価の結果
      例外:
      AssertionErrorSE - 評価が失敗した場合

    • evaluateJsonPath

      public <T> T evaluateJsonPath(StringSE content, ClassSE<T> targetType)
      ターゲット型を持つ evaluateJsonPath(String) のバリアント。

      これは、整数を倍精度数に強制変換する場合や、構成された MappingProvider がより複雑なオブジェクト構造を処理できる場合など、数値を確実に一致させるのに役立ちます。

      パラメーター:
      content - 評価するコンテンツ
      targetType - リクエストされたターゲット型
      戻り値:
      評価の結果
      例外:
      AssertionErrorSE - 評価が失敗した場合

    • evaluateJsonPath

      public <T> T evaluateJsonPath(StringSE content, ParameterizedTypeReference<T> targetType)
      ジェネリクスを持つターゲット型を持つ evaluateJsonPath(String) のバリアント。

      デフォルトではジェネリクス型を処理できないため、より複雑な MappingProvider を定義する Configuration で使用する必要があります。

      パラメーター:
      content - 評価するコンテンツ
      targetType - リクエストされたターゲット型
      戻り値:
      評価の結果
      例外:
      AssertionErrorSE - 評価が失敗した場合
      導入:
      6.2