Skip to content

feat: add ValidationHandler to JSONSchema for fail-safe error collection, for issue #3912 #3968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jujn wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: add ValidationHandler to JSONSchema for fail-safe error collection, for issue #3912 #3968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c853001
feat: add ValidationHandler to JSONSchema for fail-safe error collect…
jujn Jan 28, 2026
75ff3fe
don't consider customError Message for now, make modifications later
jujn Jan 28, 2026
fd00d75
Fix customErrorMessage and support full custom error collection
jujn Jan 30, 2026
303d97b
add web request verification examples
jujn Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions core/src/main/java/com/alibaba/fastjson2/schema/AllOf.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,23 @@ public Type getType() {
}

@Override
protected ValidateResult validateInternal(Object value) {
protected ValidateResult validateInternal(Object value, ValidationHandler handler, String path) {
boolean totalSuccess = true;
ValidateResult firstFail = null;

for (JSONSchema item : items) {
ValidateResult result = item.validate(value);
ValidateResult result = item.validateInternal(value, handler, path);
if (!result.isSuccess()) {
return result;
if (handler == null || result.isAbort()) {
return result;
}

totalSuccess = false;
if (firstFail == null) {
firstFail = result;
}
}
}
return SUCCESS;
return totalSuccess ? SUCCESS : firstFail;
}
}
2 changes: 1 addition & 1 deletion core/src/main/java/com/alibaba/fastjson2/schema/Any.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public Type getType() {
}

@Override
protected ValidateResult validateInternal(Object value) {
protected ValidateResult validateInternal(Object value, ValidationHandler handler, String path) {
return SUCCESS;
}
}
8 changes: 4 additions & 4 deletions core/src/main/java/com/alibaba/fastjson2/schema/AnyOf.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ public Type getType() {
}

@Override
protected ValidateResult validateInternal(Object value) {
protected ValidateResult validateInternal(Object value, ValidationHandler handler, String path) {
for (JSONSchema item : items) {
ValidateResult result = item.validate(value);
if (result == SUCCESS) {
if (item.validateInternal(value, null, path) == SUCCESS) {
return SUCCESS;
}
}
return FAIL_ANY_OF;

return handleError(handler, value, path, FAIL_ANY_OF);
}

public JSONObject toJSONObject() {
Expand Down
158 changes: 122 additions & 36 deletions core/src/main/java/com/alibaba/fastjson2/schema/ArraySchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,85 +143,137 @@ public Type getType() {
}

@Override
protected ValidateResult validateInternal(Object value) {
protected ValidateResult validateInternal(Object value, ValidationHandler handler, String path) {
if (value == null) {
return typed ? FAIL_INPUT_NULL : SUCCESS;
return typed ? handleError(handler, null, path, FAIL_INPUT_NULL) : SUCCESS;
}

if (encoded) {
if (value instanceof String) {
try {
value = JSON.parseArray((String) value);
} catch (JSONException e) {
return FAIL_INPUT_NOT_ENCODED;
return handleError(handler, value, path, FAIL_INPUT_NOT_ENCODED);
}
} else {
return FAIL_INPUT_NOT_ENCODED;
return handleError(handler, value, path, FAIL_INPUT_NOT_ENCODED);
}
}

if (value instanceof Object[]) {
final Object[] items = (Object[]) value;
return validateItems(value, items.length, i -> items[i]);
return validateItems(value, items.length, i -> items[i], handler, path);
}

if (value.getClass().isArray()) {
final int size = Array.getLength(value);
final Object finalValue = value;
return validateItems(finalValue, size, i -> Array.get(finalValue, i));
return validateItems(finalValue, size, i -> Array.get(finalValue, i), handler, path);
}

if (value instanceof Collection) {
final Collection<?> items = (Collection<?>) value;
final Iterator<?> iterator = items.iterator();
return validateItems(value, items.size(), i -> iterator.next());
return validateItems(value, items.size(), i -> iterator.next(), handler, path);
}

return typed ? FAIL_TYPE_NOT_MATCH : SUCCESS;
return typed ? handleError(handler, value, path, FAIL_TYPE_NOT_MATCH) : SUCCESS;
}

private ValidateResult validateItems(final Object value, final int size, IntFunction<Object> itemGetter) {
private ValidateResult validateItems(final Object value, final int size, IntFunction<Object> itemGetter, ValidationHandler handler, String path) {
boolean totalSuccess = true;
ValidateResult firstFail = null;

if (minLength >= 0 && size < minLength) {
return new ValidateResult(false, "minLength not match, expect >= %s, but %s", minLength, size);
ValidateResult raw = new ValidateResult(false, "minLength not match, expect >= %s, but %s", minLength, size);
ValidateResult r = handleError(handler, value, path, raw);
if (handler == null || r.isAbort()) {
return r;
}

totalSuccess = false;
if (firstFail == null) {
firstFail = r;
}
}

if (maxLength >= 0 && size > maxLength) {
return new ValidateResult(false, "maxLength not match, expect <= %s, but %s", maxLength, size);
ValidateResult raw = new ValidateResult(false, "maxLength not match, expect <= %s, but %s", maxLength, size);
ValidateResult r = handleError(handler, value, path, raw);
if (handler == null || r.isAbort()) {
return r;
}

totalSuccess = false;
if (firstFail == null) {
firstFail = r;
}
}

if (!additionalItems && size > prefixItems.length) {
return new ValidateResult(false, "additional items not match, max size %s, but %s", prefixItems.length, size);
ValidateResult raw = new ValidateResult(false, "additional items not match, max size %s, but %s", prefixItems.length, size);
ValidateResult r = handleError(handler, value, path, raw);
if (handler == null || r.isAbort()) {
return r;
}

totalSuccess = false;
if (firstFail == null) {
firstFail = r;
}
}

final boolean isCollection = value instanceof Collection;
Set<Object> uniqueItemsSet = null;
int containsCount = 0;
for (int index = 0; index < size; index++) {
Object item = itemGetter.apply(index);
String itemPath = path + "[" + index + "]";

boolean prefixMatch = false;
if (index < prefixItems.length) {
ValidateResult result = prefixItems[index].validate(item);
ValidateResult result = prefixItems[index].validateInternal(item, handler, itemPath);
if (!result.isSuccess()) {
return result;
if (handler == null || result.isAbort()) {
return result;
}

totalSuccess = false;
if (firstFail == null) {
firstFail = result;
}
}
prefixMatch = true;
} else if (isCollection && itemSchema == null && additionalItem != null) { // 只有 Collection 才会执行这部分校验
ValidateResult result = additionalItem.validate(item);
ValidateResult result = additionalItem.validateInternal(item, handler, itemPath);
if (!result.isSuccess()) {
return result;
if (handler == null || result.isAbort()) {
return result;
}

totalSuccess = false;
if (firstFail == null) {
firstFail = result;
}
}
}

if (!prefixMatch && itemSchema != null) {
ValidateResult result = itemSchema.validate(item);
ValidateResult result = itemSchema.validateInternal(item, handler, itemPath);
if (!result.isSuccess()) {
return result;
if (handler == null || result.isAbort()) {
return result;
}

totalSuccess = false;
if (firstFail == null) {
firstFail = result;
}
}
}

if (this.contains != null && (minContains > 0 || maxContains > 0 || containsCount == 0)) {
ValidateResult result = this.contains.validate(item);
ValidateResult result = this.contains.validateInternal(item, null, itemPath);
if (result == SUCCESS) {
containsCount++;
}
Expand All @@ -237,51 +289,85 @@ private ValidateResult validateItems(final Object value, final int size, IntFunc
}

if (!uniqueItemsSet.add(item)) {
return UNIQUE_ITEMS_NOT_MATCH;
ValidateResult r = handleError(handler, item, itemPath, UNIQUE_ITEMS_NOT_MATCH);
if (handler == null || r.isAbort()) {
return r;
}

totalSuccess = false;
if (firstFail == null) {
firstFail = UNIQUE_ITEMS_NOT_MATCH;
}
}
}
}

if (!isCollection || this.contains != null) {
ValidateResult containsError = null;
if (minContains >= 0 && containsCount < minContains) {
return new ValidateResult(false, "minContains not match, expect %s, but %s", minContains, containsCount);
containsError = new ValidateResult(false, "minContains not match, expect %s, but %s", minContains, containsCount);
} else if (maxContains >= 0 && containsCount > maxContains) {
containsError = new ValidateResult(false, "maxContains not match, expect %s, but %s", maxContains, containsCount);
} else if (this.contains != null && containsCount == 0 && minContains != 0) {
containsError = CONTAINS_NOT_MATCH;
}

if (isCollection) { // Collection 和 数组 的部分校验规则不一样
if (containsCount == 0 && minContains != 0) {
return CONTAINS_NOT_MATCH;
if (containsError != null) {
ValidateResult r = handleError(handler, value, path, containsError);
if (handler == null || r.isAbort()) {
return r;
}
} else if (this.contains != null && containsCount == 0) {
return CONTAINS_NOT_MATCH;
}

if (maxContains >= 0 && containsCount > maxContains) {
return new ValidateResult(false, "maxContains not match, expect %s, but %s", maxContains, containsCount);
totalSuccess = false;
if (firstFail == null) {
firstFail = containsError;
}
}
}

if (allOf != null) {
ValidateResult result = allOf.validate(value);
ValidateResult result = allOf.validateInternal(value, handler, path);
if (!result.isSuccess()) {
return result;
if (handler == null || result.isAbort()) {
return result;
}

totalSuccess = false;
if (firstFail == null) {
firstFail = result;
}
}
}

if (anyOf != null) {
ValidateResult result = anyOf.validate(value);
ValidateResult result = anyOf.validateInternal(value, handler, path);
if (!result.isSuccess()) {
return result;
if (handler == null || result.isAbort()) {
return result;
}

totalSuccess = false;
if (firstFail == null) {
firstFail = result;
}
}
}

if (oneOf != null) {
ValidateResult result = oneOf.validate(value);
ValidateResult result = oneOf.validateInternal(value, handler, path);
if (!result.isSuccess()) {
return result;
if (handler == null || result.isAbort()) {
return result;
}

totalSuccess = false;
if (firstFail == null) {
firstFail = result;
}
}
}

return SUCCESS;
return totalSuccess ? SUCCESS : (firstFail != null ? firstFail : new ValidateResult(false, "Array validation failed"));
}

@Override
Expand Down
7 changes: 4 additions & 3 deletions core/src/main/java/com/alibaba/fastjson2/schema/BooleanSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,17 @@ public Type getType() {
}

@Override
protected ValidateResult validateInternal(Object value) {
protected ValidateResult validateInternal(Object value, ValidationHandler handler, String path) {
if (value == null) {
return FAIL_INPUT_NULL;
return handleError(handler, null, path, FAIL_INPUT_NULL);
}

if (value instanceof Boolean) {
return SUCCESS;
}

return new ValidateResult(false, "expect type %s, but %s", Type.Boolean, value.getClass());
ValidateResult raw = new ValidateResult(false, "expect type %s, but %s", Type.Boolean, value.getClass());
return handleError(handler, value, path, raw);
}

@Override
Expand Down
7 changes: 4 additions & 3 deletions core/src/main/java/com/alibaba/fastjson2/schema/EnumSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public Type getType() {
}

@Override
protected ValidateResult validateInternal(Object value) {
protected ValidateResult validateInternal(Object value, ValidationHandler handler, String path) {
if (value instanceof BigDecimal) {
BigDecimal decimal = (BigDecimal) value;
value = decimal.stripTrailingZeros();
Expand All @@ -67,10 +67,11 @@ protected ValidateResult validateInternal(Object value) {

if (!items.contains(value)) {
if (value == null) {
return FAIL_INPUT_NULL;
return handleError(handler, null, path, FAIL_INPUT_NULL);
}

return new ValidateResult(false, "expect type %s, but %s", Type.Enum, value.getClass());
ValidateResult raw = new ValidateResult(false, "expect type %s, but %s", Type.Enum, value.getClass());
return handleError(handler, value, path, raw);
}

return SUCCESS;
Expand Down
Loading