休息服务需要针对json模式验证所有传入的json数据。 json模式是公共可访问的，可以通过http请求检索。
我正在使用jackson -framwork来编组java和json之间的编组和解组。到目前为止，我找不到任何使用jackson验证数据的方法。
我还尝试了JsonTools框架，它明显提出了这样的验证功能。但不幸的是，我无法让验证工作。 Why JsonTool schema validation isn't working?
我该如何进行此类验证？
答案 0 :(得分：16)
我搜索了对传入的json数据进行RESTful服务验证的最佳实践。我的建议是使用MessageBodyReader在readFrom方法中执行验证。下面是一个消息体阅读器示例，为简单起见，它是非通用的。
我也很想找到进行json数据验证的最佳框架。因为我使用jackson框架（版本1.8.5）在json和java之间进行编组和解组，所以如果这个框架提供json数据验证功能会很好。不幸的是我找不到与杰克逊这样做的可能性。最后，我使用了https://github.com处提供的 json-schema-validator 。我使用的版本是2.1.7
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import javax.servlet.ServletContext;
import javax.ws.rs.Consumes;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.MessageBodyReader;
import javax.ws.rs.ext.Provider;
import org.codehaus.jackson.map.ObjectMapper;
import at.fhj.ase.dao.data.Address;
import at.fhj.ase.xmlvalidation.msbreader.MessageBodyReaderValidationException;
import com.fasterxml.jackson.databind.JsonNode;
import com.github.fge.jackson.JsonLoader;
import com.github.fge.jsonschema.exceptions.ProcessingException;
import com.github.fge.jsonschema.main.JsonSchemaFactory;
import com.github.fge.jsonschema.main.JsonValidator;
import com.github.fge.jsonschema.report.ProcessingReport;
@Provider
@Consumes(MediaType.APPLICATION_JSON)
public class AddressJsonValidationReader implements MessageBodyReader<Address> {
private final String jsonSchemaFileAsString;
public AddressJsonValidationReader(@Context ServletContext servletContext) {
this.jsonSchemaFileAsString = servletContext
.getRealPath("/json/Address.json");
}
@Override
public boolean isReadable(Class<?> type, Type genericType,
Annotation[] annotations, MediaType mediaType) {
if (type == Address.class) {
return true;
}
return false;
}
@Override
public Address readFrom(Class<Address> type, Type genericType,
Annotation[] annotations, MediaType mediaType,
MultivaluedMap<String, String> httpHeaders, InputStream entityStream)
throws IOException, WebApplicationException {
final String jsonData = getStringFromInputStream(entityStream);
System.out.println(jsonData);
InputStream isSchema = new FileInputStream(jsonSchemaFileAsString);
String jsonSchema = getStringFromInputStream(isSchema);
/*
* Perform JSON data validation against schema
*/
validateJsonData(jsonSchema, jsonData);
/*
* Convert stream to data entity
*/
ObjectMapper m = new ObjectMapper();
Address addr = m.readValue(stringToStream(jsonData), Address.class);
return addr;
}
/**
* Validate the given JSON data against the given JSON schema
*
* @param jsonSchema
* as String
* @param jsonData
* as String
* @throws MessageBodyReaderValidationException
* in case of an error during validation process
*/
private void validateJsonData(final String jsonSchema, final String jsonData)
throws MessageBodyReaderValidationException {
try {
final JsonNode d = JsonLoader.fromString(jsonData);
final JsonNode s = JsonLoader.fromString(jsonSchema);
final JsonSchemaFactory factory = JsonSchemaFactory.byDefault();
JsonValidator v = factory.getValidator();
ProcessingReport report = v.validate(s, d);
System.out.println(report);
if (!report.toString().contains("success")) {
throw new MessageBodyReaderValidationException(
report.toString());
}
} catch (IOException e) {
throw new MessageBodyReaderValidationException(
"Failed to validate json data", e);
} catch (ProcessingException e) {
throw new MessageBodyReaderValidationException(
"Failed to validate json data", e);
}
}
/**
* Taken from <a href=
* "http://www.mkyong.com/java/how-to-convert-inputstream-to-string-in-java/"
* >www.mkyong.com</a>
*
* @param is
* {@link InputStream}
* @return Stream content as String
*/
private String getStringFromInputStream(InputStream is) {
BufferedReader br = null;
StringBuilder sb = new StringBuilder();
String line;
try {
br = new BufferedReader(new InputStreamReader(is));
while ((line = br.readLine()) != null) {
sb.append(line);
}
} catch (IOException e) {
e.printStackTrace();
} finally {
if (br != null) {
try {
br.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
return sb.toString();
}
private InputStream stringToStream(final String str) throws UnsupportedEncodingException {
return new ByteArrayInputStream(str.getBytes("UTF-8"));
}
}
答案 1 :(得分：9)
import com.github.fge.jsonschema.core.report.ProcessingReport;
import com.github.fge.jsonschema.main.JsonSchema;
import com.github.fge.jsonschema.main.JsonSchemaFactory;
import com.github.fge.jackson.JsonLoader;
import com.fasterxml.jackson.databind.JsonNode;
public class ValidationJSON {
public static void main(String[] arr){
String jsonData = "{\"name\": \"prem\"}";
String jsonSchema = ""; //Schema we can generate online using http://jsonschema.net/
final JsonNode data = JsonLoader.fromString(jsonData);
final JsonNode schema = JsonLoader.fromString(jsonSchema);
final JsonSchemaFactory factory = JsonSchemaFactory.byDefault();
JsonValidator validator = factory.getValidator();
ProcessingReport report = validator.validate(schema, data);
System.out.println(report.isSuccess());
}
}
答案 2 :(得分：0)
尽管您似乎是默认选择，但您似乎并不依赖JSONSchema。口味有所不同，但通常看起来比它还复杂。此外，就个人而言，我也希望将数据和验证规则都放在同一位置。当在Java代码而不是任何类型的配置文件中使用自定义验证器时，可以说似乎更自然。
这是这种方法的外观。假设您有以下json对象，表示某些付款（无论是请求还是响应），但为了简洁起见，仅包含discount块：
{
"discount":{
"valid_until":"2032-05-04 00:00:00+07",
"promo_code":"VASYA1988"
}
}
这是验证码的样子：
/*1 */ public class ValidatedJsonObjectRepresentingRequestOrResponse implements Validatable<JsonObjectRepresentingRequestOrResponse>
{
private String jsonString;
private Connection dbConnection;
/*6 */ public ValidatedJsonObjectRepresentingRequestOrResponse(String jsonString, Connection dbConnection)
{
this.jsonString = jsonString;
this.dbConnection = dbConnection;
}
@Override
/*13*/ public Result<JsonObjectRepresentingRequestOrResponse> result() throws Exception
{
return
/*16*/ new FastFail<>(
/*17*/ new WellFormedJson(
/*18*/ new Unnamed<>(Either.right(new Present<>(this.jsonRequestString)))
/*19*/ ),
/*20*/ requestJsonObject ->
/*21*/ new UnnamedBlocOfNameds<>(
List.of(
/*23*/ new FastFail<>(
/*24*/ new IsJsonObject(
/*25*/ new Required(
/*26*/ new IndexedValue("discount", requestJsonObject)
)
),
/*29*/ discountObject ->
/*30*/ new NamedBlocOfNameds<>(
/*31*/ "discount",
/*32*/ List.of(
/*33*/ new PromoCodeIsNotExpired(
/*34*/ new AsString(
/*35*/ new Required(
/*36*/ new IndexedValue("valid_until", discountObject)
)
)
),
/*40*/ new PromoCodeIsNotAlreadyRedeemed(
/*41*/ new PromoCodeContainsBothLettersAndDigits(
/*42*/ new Required(
/*43*/ new IndexedValue("promo_code", discountObject)
)
),
/*46*/ this.dbConnection
)
),
/*49*/ Discount.class
)
)
),
/*53*/ JsonObjectRepresentingRequestOrResponse.class
)
)
.result();
}
}
让我们逐行查看发生的事情：
Line 1 ValidatedJsonObjectRepresentingRequestOrResponse的声明。
Line 6其构造函数接受原始json字符串。它可能是传入的请求或收到的响应，或者几乎是其他任何东西。
Line 13：调用此方法时，验证开始。
Lines 16：更高级别的验证对象是FastFail块。如果第一个参数无效，则会立即返回错误。
Lines 17-19：检查json是否格式正确。如果是后者，则验证会很快失败并返回相应的错误。
Line 20：如果json格式正确，则调用闭包，并将json数据作为其单个参数传递。
Line 21：已验证json数据。它的结构是一个未命名的已命名块。它对应于JSON对象。
Line 26：第一个（也是唯一的）块称为discount。
Line 25：这是必需的。
Line 24：它必须是json对象。
Line 23：如果不是，则错误将立即返回，因为它是FailFast对象。
Line 29：否则，将调用闭包。
Line 30：Discount块是由其他命名条目（对象或标量）组成的命名块。
Line 36：第一个称为valid_until
Line 35：这是必需的。
Line 34：如果确实是字符串，则表示为字符串。如果不是，将返回错误。
Line 33：最后，检查它是否未过期。
Line 43：第二个参数称为promo_code。
Line 42：这也是必需的。
Line 41：必须同时包含字母和数字。
Line 40：而且它不应该已经被赎回。这个事实肯定会保留在我们的数据库中，因此...
Line 46：…this.dbConnection参数。
Line 49：如果所有先前的验证检查都成功，那么将创建类Discount的对象。
Line 53：最后，创建并返回JsonObjectRepresentingRequestOrResponse。
验证成功后，调用代码的外观如下：
Result<JsonObjectRepresentingRequestOrResponse> result = new ValidatedJsonObjectRepresentingRequestOrResponse(jsonRequestString).result();
result.isSuccessful();
result.value().raw().discount().promoCode(); // VASYA1988
此示例摘自here。在这里您可以找到完整的json request validation example。