blocks|key|259486|text|如果我很了解你，|type|unstyled|depth|inlineStyleRanges|entityRanges|data|259487|然后，通常我认为在每个json响应中都有一个键(或者即使您的响应是XML)，这会降低流程的状态。这个字段可以称为status。|259488|因此，您返回的每个响应都应该有这个status字段，它的值应该指示在处理过程中发生了什么，以及调用方在响应中应该期望什么。|offset|length|style|CODE|259489|值可以是数字或文本消息，一些类似常量的消息也可以添加另一个字段，message，它包含一些状态代码的文本-desc。|259490|现在你必须列出一个可能的雕像名单，你的服务可能会发回。|259491|例：|259492|status:+0000+
message:+success

status:+0001+
message:+invalid_params

status:+0002+
message:+invalid_param_value

status:+0003+
message:+missing_param,
:
:
etc|code-block|syntax|javascript|259493|因此，您的json响应将始终包含这些字段。在应该返回的其他数据中。|259494|现在客户有责任处理这些反应。|259495|JSON示例：|259496|{
"status":"0000",
"message":"success",
"images":[+...+]
}

{
"status":"0003",
"message":"missing_param"
}|259497|正如您注意到的，在非0000状态下，没有其他数据被发送回。只是告诉客户我们有“这个问题”。|259498|或者，通过将:添加到错误消息常量中，告诉更多有关错误的信息，从而使其更具有信息性：|259499|前任，|259500|{
"status":"0003",
"message":"missing_param:album_id"
}|259501|告诉用户，缺少一个参数，它是album_id|259502|现在您可以编写所有可能的status响应，在那里，message将成为服务文档的一部分。|259503|entityMap^0|0|0|H|6|0|W|7|0|0|0|0|0|0|0|0|A|4|0|6|1|0|0|0|E|8|0|C|6|P|7|0^^$0|@$1|2|3|4|5|6|7|1G|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|1H|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|1I|8|@$F|1J|G|1K|H|I]]|9|@]|A|$]]|$1|J|3|K|5|6|7|1L|8|@$F|1M|G|1N|H|I]]|9|@]|A|$]]|$1|L|3|M|5|6|7|1O|8|@]|9|@]|A|$]]|$1|N|3|O|5|6|7|1P|8|@]|9|@]|A|$]]|$1|P|3|Q|5|R|7|1Q|8|@]|9|@]|A|$S|T]]|$1|U|3|V|5|6|7|1R|8|@]|9|@]|A|$]]|$1|W|3|X|5|6|7|1S|8|@]|9|@]|A|$]]|$1|Y|3|Z|5|6|7|1T|8|@]|9|@]|A|$]]|$1|10|3|11|5|R|7|1U|8|@]|9|@]|A|$S|T]]|$1|12|3|13|5|6|7|1V|8|@$F|1W|G|1X|H|I]]|9|@]|A|$]]|$1|14|3|15|5|6|7|1Y|8|@$F|1Z|G|20|H|I]]|9|@]|A|$]]|$1|16|3|17|5|6|7|21|8|@]|9|@]|A|$]]|$1|18|3|19|5|R|7|22|8|@]|9|@]|A|$S|T]]|$1|1A|3|1B|5|6|7|23|8|@$F|24|G|25|H|I]]|9|@]|A|$]]|$1|1C|3|1D|5|6|7|26|8|@$F|27|G|28|H|I]|$F|29|G|2A|H|I]]|9|@]|A|$]]|$1|1E|3|-4|5|6|7|2B|8|@]|9|@]|A|$]]]|1F|$]]

if i understand you well,

then , generally i think it's good to have a key in each json response (or even if your response is XML), that indecates the status of the process. this field could be called status. 

so each and every response you send back should have this <code>status</code> field, and it's value should indicate what happens while processing, and what should the caller expect in the response.

the value could be a number, or a text message, some constant-like message
also you can add another field, <code>message</code> that contains some text-desc of the status code.

now you have to make a list of possible statues that your service may send back.

ex:

<pre><code>status: 0000 
message: success

status: 0001 
message: invalid_params

status: 0002 
message: invalid_param_value

status: 0003 
message: missing_param,
:
:
etc
</code></pre>

so your json response will contain those fields always. among the other data supposed to be returned.

now it's the clients duty to handle those responses.

JSON example:

<pre><code>{
"status":"0000",
"message":"success",
"images":[ ... ]
}

{
"status":"0003",
"message":"missing_param"
}
</code></pre>

as you notice in case of non <code>0000</code> status, no other data is sent back.
just telling the client we have "this issue".

or you can make it more informative, by adding <code>:</code> to the error message constant, telling more info about the error:

ex,

<pre><code>{
"status":"0003",
"message":"missing_param:album_id"
}
</code></pre>

telling the user, there is a missing parameter, and it's <code>album_id</code>

now you can write all possible <code>status</code> responses, and there <code>message</code>
this will be part of your service documentation.

blocks|key|756657|text|如果您手动验证您的参数，您可以抛出一个特定的异常。然后，您可以将异常映射到特定的HTTP状态，例如糟糕的请求。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|756658|您可以使用Spring建议：http://spring.io/blog/2013/11/01/exception-handling-in-spring-mvc将异常映射到响应状态。|offset|length|756659|entityMap|0|LINK|mutability|MUTABLE|url|http://spring.io/blog/2013/11/01/exception-handling-in-spring-mvc^0|0|E|1T|0|0^^$0|@$1|2|3|4|5|6|7|N|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|O|8|@]|9|@$D|P|E|Q|1|R]]|A|$]]|$1|F|3|-4|5|6|7|S|8|@]|9|@]|A|$]]]|G|$H|$5|I|J|K|A|$L|M]]]]

I you manually validate your arguments, you could throw a specific exception. Then you can map your exception to a specific HTTP status, for instance BAD REQUEST. 

You can map your exception to a response status with Spring Controller Advice: <a href="http://spring.io/blog/2013/11/01/exception-handling-in-spring-mvc" rel="nofollow">http://spring.io/blog/2013/11/01/exception-handling-in-spring-mvc</a>.

blocks|key|3089522|text|您应该在应用程序的最外层验证参数，然后再将其传递到您的域中。此时，您仍然处于HTTP层，因此可以采取适当的操作，即返回400个错误的请求状态。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3089523|在此范围内，您可以完全控制如何将此信息传递给用户(或其他服务)。如果您只是记录它，或者设计您自己的描述错误的Json/Xml有效负载，那么纯文本就可以了。|3089524|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|F|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|G|8|@]|9|@]|A|$]]|$1|D|3|-4|5|6|7|H|8|@]|9|@]|A|$]]]|E|$]]

You should validate your parameters at the very outmost layer of your application before it gets handed off inside your domain. At this point you're still in the HTTP layer so can take the appropriate action which is to return a 400 BAD REQUEST status.

Within that you have complete control over how to relay this information to your users (or other services). Plain text is fine if you're just logging it, or design your own Json/Xml payload describing the error.

blocks|key|3089587|text|我正在使用jersey，这是一个简单的示例，它将使用hibernate+bean验证框架来验证bean。这是一个正在进行的工作，但你应该可以看到它将如何工作非常简单。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3089588|@Path("customers")
public+class+CustomerResource+{
++++@PUT
++++public+Response+createCustomer(Customer+customer)+{
++++++++BeanValidator.validate(customer);
++++++++final+String+rialtoId+=+customerProvider.createCustomer(customer);

++++++++return+Response.ok(rialtoId).build();
++++}
}|code-block|syntax|javascript|3089589|下面是我创建的一个处理bean验证的泛型类。|3089590|public+class+BeanValidator+{

++++/**
+++++*+Used+to+validate+an+order+request+and+all+the+attached+objects+that
+++++*+support+validation.
+++++*+
+++++*+@param+request
+++++*+@throws+ConstraintViolationException
+++++*/
++++public+static+<T>+void+validate(T+request)+throws+ConstraintViolationException+{
++++++++++++ValidatorFactory+factory+=+Validation.buildDefaultValidatorFactory();
++++++++++++Validator+validator+=+factory.getValidator();
++++++++++++Set<ConstraintViolation<T>>+constraintViolations+=+validator.validate(request);
++++++++++++if+(constraintViolations.size()+>+0)+{
++++++++++++++++++++throw+new+ConstraintViolationException(new+HashSet<ConstraintViolation<?>>(constraintViolations));
++++++++++++}
++++}
}


@XmlRootElement
public+class+Customer+{

++++@NotNull(message+=+"spCustomerID1+is+a+required+field")
++++@Size(max+=+60,+message+=+"spCustomerID1+has+a+max+length+of+60+characters")
++++private+String+spCustomerID1;

++++@Size(max+=+60,+message+=+"spCustomerID2+has+a+max+length+of+60+characters")
++++private+String+spCustomerID2;

++++@Size(max+=+60,+message+=+"spCustomerID3+has+a+max+length+of+60+characters")
++++private+String+spCustomerID3;

++++@NotNull(message+=+"customerName+is+a+required+field")
++++@Size(max+=+60)
++++private+String+customerName;

++++@Valid
++++@NotNull(message+=+"customerAddress+is+a+required+field")
++++private+PostalAddress+customerAddress;

++++@Valid
++++@NotNull(message+=+"customerContact+is+a+required+field")
++++private+ContactInfo+customerContact;

++++@Valid
++++@NotNull(message+=+"technicalContact+is+a+required+field")
++++private+ContactInfo+technicalContact;
++++...+/+Getters+and+Setters
}|3089591|下面是一个简单的ExceptionMapper，它将支持构造一个简单的响应，然后将其发送回客户机。注意，它将将响应类型设置为400+BAD_REQUEST，而不是500%2B服务器端错误。|3089592|public+class+ConstraintViolationExceptionMapper+implements+ExceptionMapper<ConstraintViolationException>+{

++++public+Response+toResponse(ConstraintViolationException+exception)+{

++++++++final+StringBuilder+strBuilder+=+new+StringBuilder();

++++++++for+(ConstraintViolation<?>+cv+:+exception.getConstraintViolations())+{
++++++++++++strBuilder.append(cv.getPropertyPath().toString()+%2B+"+"+%2B+cv.getMessage());
++++++++}

++++++++RestResponse+responseEntity+=+RestResponse.responseCode(ResponseCode.CONSTRAINT_VIOLATION).setResponseMessage(strBuilder.toString()).build();

++++++++return+Response.status(Response.Status.BAD_REQUEST).entity(responseEntity).build();
++++}
}|3089593|这段代码还没有经过测试，但它可能有助于获得一些如何进行验证的想法。在我看来，这是一种非常直接的rest服务验证方法，允许您报告精确的变量路径以及每个字段的自定义错误消息。|3089594|entityMap^0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|S|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|T|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|U|8|@]|9|@]|A|$]]|$1|I|3|J|5|D|7|V|8|@]|9|@]|A|$E|F]]|$1|K|3|L|5|6|7|W|8|@]|9|@]|A|$]]|$1|M|3|N|5|D|7|X|8|@]|9|@]|A|$E|F]]|$1|O|3|P|5|6|7|Y|8|@]|9|@]|A|$]]|$1|Q|3|-4|5|6|7|Z|8|@]|9|@]|A|$]]]|R|$]]

Im using jersey and this is a simple example that will use the hibernate bean validation framework to validate your beans. This is a work in progress but you should can see how it will work very simply.

<pre><code>@Path("customers")
public class CustomerResource {
 @PUT
 public Response createCustomer(Customer customer) {
 BeanValidator.validate(customer);
 final String rialtoId = customerProvider.createCustomer(customer);

 return Response.ok(rialtoId).build();
 }
}
</code></pre>

Here is a generic class that I created that handles the bean validation.

<pre><code>public class BeanValidator {

 /**
 * Used to validate an order request and all the attached objects that
 * support validation.
 * 
 * @param request
 * @throws ConstraintViolationException
 */
 public static &lt;T&gt; void validate(T request) throws ConstraintViolationException {
 ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
 Validator validator = factory.getValidator();
 Set&lt;ConstraintViolation&lt;T&gt;&gt; constraintViolations = validator.validate(request);
 if (constraintViolations.size() &gt; 0) {
 throw new ConstraintViolationException(new HashSet&lt;ConstraintViolation&lt;?&gt;&gt;(constraintViolations));
 }
 }
}


@XmlRootElement
public class Customer {

 @NotNull(message = "spCustomerID1 is a required field")
 @Size(max = 60, message = "spCustomerID1 has a max length of 60 characters")
 private String spCustomerID1;

 @Size(max = 60, message = "spCustomerID2 has a max length of 60 characters")
 private String spCustomerID2;

 @Size(max = 60, message = "spCustomerID3 has a max length of 60 characters")
 private String spCustomerID3;

 @NotNull(message = "customerName is a required field")
 @Size(max = 60)
 private String customerName;

 @Valid
 @NotNull(message = "customerAddress is a required field")
 private PostalAddress customerAddress;

 @Valid
 @NotNull(message = "customerContact is a required field")
 private ContactInfo customerContact;

 @Valid
 @NotNull(message = "technicalContact is a required field")
 private ContactInfo technicalContact;
 ... / Getters and Setters
}
</code></pre>

Then here is a simple ExceptionMapper that will support constructing a simple response to be sent back to the client. Notice that it will set the Response type to a 400 BAD_REQUEST instead of a 500+ Server Side error.

<pre><code>public class ConstraintViolationExceptionMapper implements ExceptionMapper&lt;ConstraintViolationException&gt; {

 public Response toResponse(ConstraintViolationException exception) {

 final StringBuilder strBuilder = new StringBuilder();

 for (ConstraintViolation&lt;?&gt; cv : exception.getConstraintViolations()) {
 strBuilder.append(cv.getPropertyPath().toString() + " " + cv.getMessage());
 }

 RestResponse responseEntity = RestResponse.responseCode(ResponseCode.CONSTRAINT_VIOLATION).setResponseMessage(strBuilder.toString()).build();

 return Response.status(Response.Status.BAD_REQUEST).entity(responseEntity).build();
 }
}
</code></pre>

This code hasn't been tested yet but it might help to get some ideas of how to do the validation. This is a pretty straight forward way to do rest service validation in my opinion and allows you to report exact variable paths along with customized error messages for each field.

I offer a <code>REST</code> webservice using <code>spring</code> <code>@RestController</code>.

How should in general invalid parameter content be handled? I tried throwing a custom exception, but that will lead to a <code>HTTP 500</code> error on the client side and expose the stacktrace thereby.

Probably that is not the right way. But how should just simple error messages be returned? (the webservice will not be accessed manually by users. Just by other services connecting to the rest controller).

How to handle invalid parameters in REST service?

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

我使用REST @RestController提供一个webservice服务。一般来说，应该如何处理无效的参数内容？我尝试抛出一个自定义异常，但这将导致客户端出现HTTP 500错误，从而公开堆栈跟踪。也许这不是正确的方法。但是，如何返回简单的错误消息呢？(用户不会手动访问webservice。其他连接到rest控制...

问如何处理REST服务中的无效参数？
EN

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何处理REST服务中的无效参数？EN