程序包 cn.taketoday.test.web.servlet.result

类 JsonPathResultMatchers

java.lang.Object

cn.taketoday.test.web.servlet.result.JsonPathResultMatchers

public class JsonPathResultMatchers
extends Object

Factory for assertions on the response content using JsonPath expressions.

An instance of this class is typically accessed via MockMvcResultMatchers.jsonPath(String, Object...).

从以下版本开始:

4.0

作者:

Rossen Stoyanchev, Craig Andrews, Sam Brannen, Brian Clozel

字段概要

字段

修饰符和类型	字段	说明
private final JsonPathExpectationsHelper	jsonPathHelper
private String	prefix

构造器概要

构造器

限定符	构造器	说明
protected	JsonPathResultMatchers(String expression, Object... args)	Protected constructor.

方法概要

修饰符和类型	方法	说明
ResultMatcher	doesNotExist()	Evaluate the JSON path expression against the response content and assert that a non-null value does not exist at the given path.
ResultMatcher	doesNotHaveJsonPath()	Evaluate the JSON path expression against the supplied content and assert that a value, including null values, does not exist at the given path.
ResultMatcher	exists()	Evaluate the JSON path expression against the response content and assert that a non-null value, possibly an empty array or map, exists at the given path.
private String	getContent(MvcResult result)
ResultMatcher	hasJsonPath()	Evaluate the JSON path expression against the response content and assert that a value, possibly null, exists.
ResultMatcher	isArray()	Evaluate the JSON path expression against the response content and assert that the result is an array.
ResultMatcher	isBoolean()	Evaluate the JSON path expression against the response content and assert that the result is a Boolean.
ResultMatcher	isEmpty()	Evaluate the JSON path expression against the response content and assert that an empty value exists at the given path.
ResultMatcher	isMap()	Evaluate the JSON path expression against the response content and assert that the result is a Map.
ResultMatcher	isNotEmpty()	Evaluate the JSON path expression against the response content and assert that a non-empty value exists at the given path.
ResultMatcher	isNumber()	Evaluate the JSON path expression against the response content and assert that the result is a Number.
ResultMatcher	isString()	Evaluate the JSON path expression against the response content and assert that the result is a String.
JsonPathResultMatchers	prefix(String prefix)	Configures the current JsonPathResultMatchers instance to verify that the JSON payload is prepended with the given prefix.
ResultMatcher	value(Object expectedValue)	Evaluate the JSON path expression against the response content and assert that the result is equal to the supplied value.
<T> ResultMatcher	value(org.hamcrest.Matcher<? super T> matcher)	Evaluate the JSON path expression against the response content and assert the resulting value with the given Hamcrest Matcher.
<T> ResultMatcher	value(org.hamcrest.Matcher<? super T> matcher, Class<T> targetType)	An overloaded variant of value(Matcher) that also accepts a target type for the resulting value that the matcher can work reliably against.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

jsonPathHelper

private final JsonPathExpectationsHelper jsonPathHelper

prefix

@Nullable
private String prefix

构造器详细资料

JsonPathResultMatchers

protected JsonPathResultMatchers(String expression,
 Object... args)

Protected constructor.

Use MockMvcResultMatchers.jsonPath(String, Object...) or MockMvcResultMatchers.jsonPath(String, Matcher).

参数:

expression - the JsonPath expression; never null or empty

args - arguments to parameterize the JsonPath expression with, using formatting specifiers defined in String.format(String, Object...)

方法详细资料

prefix

public JsonPathResultMatchers prefix(String prefix)

Configures the current JsonPathResultMatchers instance to verify that the JSON payload is prepended with the given prefix.

Use this method if the JSON payloads are prefixed to avoid Cross Site Script Inclusion (XSSI) attacks.

参数:

prefix - the string prefix prepended to the actual JSON payload

value

public <T> ResultMatcher value(org.hamcrest.Matcher<? super T> matcher)

Evaluate the JSON path expression against the response content and assert the resulting value with the given Hamcrest Matcher.

另请参阅:

• value(Matcher, Class)
• value(Object)

value

public <T> ResultMatcher value(org.hamcrest.Matcher<? super T> matcher,
 Class<T> targetType)

An overloaded variant of value(Matcher) that also accepts a target type for the resulting value that the matcher can work reliably against.

This can be useful for matching numbers reliably — for example, to coerce an integer into a double.

另请参阅:

• value(Matcher)
• value(Object)

value

public ResultMatcher value(@Nullable
 Object expectedValue)

Evaluate the JSON path expression against the response content and assert that the result is equal to the supplied value.

另请参阅:

• value(Matcher)
• value(Matcher, Class)

exists

public ResultMatcher exists()

Evaluate the JSON path expression against the response content and assert that a non-null value, possibly an empty array or map, exists at the given path.

If the JSON path expression is not definite, this method asserts that the value at the given path is not empty.

doesNotExist

public ResultMatcher doesNotExist()

Evaluate the JSON path expression against the response content and assert that a non-null value does not exist at the given path.

If the JSON path expression is not definite, this method asserts that the value at the given path is empty.

isEmpty

public ResultMatcher isEmpty()

Evaluate the JSON path expression against the response content and assert that an empty value exists at the given path.

For the semantics of empty, consult the Javadoc for ObjectUtils.isEmpty(Object).

另请参阅:

• isNotEmpty()
• exists()
• doesNotExist()

isNotEmpty

public ResultMatcher isNotEmpty()

Evaluate the JSON path expression against the response content and assert that a non-empty value exists at the given path.

For the semantics of empty, consult the Javadoc for ObjectUtils.isEmpty(Object).

另请参阅:

• isEmpty()
• exists()
• doesNotExist()

hasJsonPath

public ResultMatcher hasJsonPath()

Evaluate the JSON path expression against the response content and assert that a value, possibly null, exists.

If the JSON path expression is not definite, this method asserts that the list of values at the given path is not empty.

另请参阅:

• exists()
• isNotEmpty()

doesNotHaveJsonPath

public ResultMatcher doesNotHaveJsonPath()

Evaluate the JSON path expression against the supplied content and assert that a value, including null values, does not exist at the given path.

If the JSON path expression is not definite, this method asserts that the list of values at the given path is empty.

另请参阅:

• doesNotExist()
• isEmpty()

isString

public ResultMatcher isString()

Evaluate the JSON path expression against the response content and assert that the result is a String.

isBoolean

public ResultMatcher isBoolean()

Evaluate the JSON path expression against the response content and assert that the result is a Boolean.

isNumber

public ResultMatcher isNumber()

Evaluate the JSON path expression against the response content and assert that the result is a Number.

isArray

public ResultMatcher isArray()

Evaluate the JSON path expression against the response content and assert that the result is an array.

isMap

public ResultMatcher isMap()

Evaluate the JSON path expression against the response content and assert that the result is a Map.

getContent

private String getContent(MvcResult result)
                   throws UnsupportedEncodingException

抛出:

UnsupportedEncodingException