- android - 多次调用 OnPrimaryClipChangedListener
- android - 无法更新 RecyclerView 中的 TextView 字段
- android.database.CursorIndexOutOfBoundsException : Index 0 requested, 光标大小为 0
- android - 使用 AppCompat 时,我们是否需要明确指定其 UI 组件(Spinner、EditText)颜色
我正在尝试弄清楚如何以标准方式返回我的数据。我的意思是,当我返回 json 或 xml 时,最好为所有内容(成功和错误)使用一种格式。
假设我有以下 json 结果。
{
"person": {
"id": 12345,
"firstName": "John",
"lastName": "Doe",
"phones": {
"home": "800-123-4567",
"work": "888-555-0000",
"cell": "877-123-1234"
},
"email": [
"jd@example.com",
"jd@example.org"
],
"dateOfBirth": "1980-01-02T00:00:00.000Z",
"registered": true,
"emergencyContacts": [
{
"name": "",
"phone": "",
"email": "",
"relationship": "spouse|parent|child|other"
}
]
}
}
这一切都很好,但现在如果出现验证错误会发生什么
我可以使用内置方法 CreateErrorResponse
{
"Message": "The request is invalid.",
"ModelState": {
"item": [
"Required property 'Name' not found in JSON. Path '', line 1, position 14."
],
"item.Name": [
"The Name field is required."
],
"item.Price": [
"The field Price must be between 0 and 999."
]
}
}
*是的,我知道数据没有意义并且不同,但数据与结构无关。
现在如果我有错误会发生什么,在这种情况下它有一个自定义错误代码。
我可以返回这样的东西(使用 HttpError)
{
"Message": "My custom error message",
"CustomErrorCode": 37
}
现在您可以看到我返回了 3 种不同格式的 json。现在在客户端我必须这样做
我一直在使用 foursquare,他们似乎总是将相同的格式返回给用户,但我不知道如何在我这样做时得到同样的东西。
{
"meta": {
"code": 200,
...errorType and errorDetail...
},
"notifications": {
...notifications...
},
"response": {
...results...
}
}
我想做类似的事情
将是一个好的请求。
{
"meta": {
"code": 200,
"ModelState": {}
},
"response": {
"person": {
"id": 12345,
"firstName": "John",
"lastName": "Doe",
"phones": {
"home": "800-123-4567",
"work": "888-555-0000",
"cell": "877-123-1234"
},
"email": [
"jd@example.com",
"jd@example.org"
],
"dateOfBirth": "1980-01-02T00:00:00.000Z",
"registered": true,
"emergencyContacts": [
{
"name": "",
"phone": "",
"email": "",
"relationship": "spouse|parent|child|other"
}
]
}
}
}
服务器错误看起来像这样
{
"meta": {
"code": 500,
"message": "this is a server error",
"ModelState": {}
},
"response": {}
}
验证看起来像这样
{
"meta": {
"code": 400,
"message": "validation errors",
"Message": "The request is invalid.",
"ModelState": {
"item": [
"Required property 'Name' not found in JSON. Path '', line 1, position 14."
],
"item.Name": [
"The Name field is required."
],
"item.Price": [
"The field Price must be between 0 and 999."
]
}
},
"response": {}
}
但就像我说的那样,我不确定如何做这样的事情,也不能 100% 确定这仍然是最好的方法。至少应该是一种格式吧?
编辑@Erik飞利浦
当我只做 asp.net mvc 项目时,我会做这样的事情。
public readonly IValidation validation;
public PersonService(IValidation validation)
{
this.validation = validation;
}
public Person GetPerson(int id)
{
try
{
return FindPerson(id);
}
catch(Exception ex)
{
//log real error with elmah
validation.addError("internal", "Something went wrong");
}
}
public class PersonController
{
public readonly IPersonService personService;
public PersonController(IPersonService personService)
{
this.personService = personService;
}
public ActionResult GetPerson(int id)
{
personService.GetPerson(id);
if(personService.Validation.IsValid)
{
// do something
}
else
{
// do something else
}
return View();
}
}
我喜欢您的设置方式,但我希望保持这种方式。我不认为我可以使用界面,但我在想这样的事情
public PersonService()
{
}
public ResponseResult<Person> GetPerson(int id)
{
var result = ResponseResult<Person>();
try
{
return FindPerson(id);
}
catch(Exception ex)
{
result.Errorcode = 200;
result.Msg = "Failed";
}
}
public class PersonController
{
public readonly IPersonService personService;
public PersonController(IPersonService personService)
{
this.personService = personService;
}
public HttpResponseMessage GetPerson(int id)
{
var result = personService.GetPerson(id);
if(result.isValid)
{
Request.CreateResponse<ResponseResult<Person>>(HttpStatusCode.OK, result);
}
Request.CreateResponse<ResponseResult<Person>>(HttpStatusCode.BadRequest, result);
}
}
最佳答案
这是一个大问题,因为它是发送数据的设计,包含多个部分,但我相信这是一个相当简单、小巧且优雅的解决方案。
这不是我使用的,但它是一个很好的例子:
首先让我们构建一个模型来表示所有响应需要什么,或者可以在不需要结果数据时使用:
public class ResponseResult
{
public ResponseResult()
{
}
public ResponseResult(ModelStateDictionary modelState)
{
this.ModelState = new ModelStateResult (modelState);
}
// Is this request valid, in the context of the actual request
public bool IsValid { get; set; }
// Serialized Model state if needed
public ModelStateResult ModelState { get; set; }
}
接下来,可能要返回大量不同类型的结果,此时泛型就派上用场了:
public class ResponseResult<T> : ResponseResult
{
public ResponseResult() : base()
{
}
public ResponseResult(ModelStateDictionary modelState)
: base(modelState)
{
}
public ResponseResult(T Data, ModelStateDictionary modelState)
: base (modelState)
{
this.Data = Data;
}
public T Data { get; set; }
}
所以现在如果你需要返回一个Person
,你可以返回:
var result = ResponseResult<Person>();
result.Data = person;
//serialize result and send to client.
我的 API 可以被 Javascript 使用,所以我更改了 Http Status 代码,并给出了如何使用 jQuery 重定向和使用数据的示例。
request = $.ajax({
type: "POST",
url: url,
data: data,
success: function(data, textStatus, jqXHR)
{
processResponseResult(data);
}
complete: function(e, xhr, settings)
{
if(e.status === 401)
{
// login to
}
// else if (e.status == )
else
{
// unknown status code
}
)};
您可能希望扩展结果以供将来甚至可能不使用 http (WCF) 的客户端使用:
public class ResponseResult
{
....
....
public int ErrorCode { get; set; }
public string ErrorMessage { get; set; }
}
或者更进一步:
public class ResponseErrorBase
{
public int ErrorCode { get; set; }
public string ErrorMessage { get; set; }
}
public class ResponseResult
{
....
....
public ResponseErrorBase Error { get; set; }
}
因此您可以在将来添加更多错误类型/信息。
根据评论更新
评论 1:如果你有一群人,那么你就有..
List<Person> persons = new List<Person>();
var result = new ResponseResult<List<Person>>();
result.Data = persons;
评论2:有2个类..
如果您的 API 调用了 FileExists(fileName)
,那么您实际上不必返回对象,只要调用成功即可。
var result = new ResponseResult();
result.IsValid = FileExists(fileName);
如果您的 API 想要返回新的 Person
的 ID,您可以返回新的 ID。
var result = new ResponseResult<Guid?>();
result.IsValid = CreatePerson(personInfo);
if (result.IsValid)
{
result.Data = personInfo.ID;
}
或者您可以返回一个新的成功的 Person
对象,如果不成功则返回 null。
var result = new ResponseResult<Person>();
result.IsValid = CreatePerson(personInfo);
if (result.IsValid)
{
result.Data = Person;
}
根据评论更新
我推荐的是我之前写的,并在 ResponseResult 中包含 ResponseErrorBase
:
public class ResponseResult
{
public ResponseResult()
{
}
public ResponseResult(ModelStateDictionary modelState)
{
this.ModelState = new ModelStateResult (modelState);
}
public bool IsValid { get; set; }
public ModelStateResult ModelState { get; set; }
public ResponseErrorBase Error { get; set; }
}
然后将你的错误从基础推导到特定的东西:
// this isn't abstract because you may want to just return
// non-specific error messages
public class ResponseErrorBase
{
public int Code { get; set; }
public string Message { get; set; }
}
public class InternalResponseError : ResponseErrorBase
{
// A Property that is specific to this error but
// not for all Errors
public int InternalErrorLogID { get; set; }
}
然后返回它(返回值的示例,您需要更多逻辑):
var result = new ResponseResult<Person>();
try
{
result.Data = db.FindPerson(id);
}
catch (SqlException ex)
{
var error = ResponseErrorBase();
error.Code = 415;
error.Message = "Sql Exception";
}
catch (Exception ex)
{
var error = InternalResponseError();
error.InternalErrorLogID = Log.WriteException(ex);
error.Code = 500;
error.Message = "Internal Error";
}
// MVC might look like:
return this.Json(result);
关于c# - 如何以标准方式返回数据?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/16115049/
我一直在阅读有关汇编函数的内容,但对于是使用进入和退出还是仅使用调用/返回指令来快速执行,我感到很困惑。一种方式快而另一种方式更小吗?例如,在不内联函数的情况下,在汇编中执行此操作的最快(stdcal
我正在处理一个元组列表,如下所示: res = [('stori', 'JJ'), ('man', 'NN'), ('unnatur', 'JJ'), ('feel', 'NN'), ('pig',
最近我一直在做很多网络或 IO 绑定(bind)操作,使用线程有助于加快代码速度。我注意到我一直在一遍又一遍地编写这样的代码: threads = [] for machine, user, data
假设我有一个名为 user_stats 的资源,其中包含用户拥有的帖子、评论、喜欢和关注者的数量。是否有一种 RESTful 方式只询问该统计数据的一部分(即,对于 user_stats/3,请告诉我
我有一个简单的 api,它的工作原理是这样的: 用户创建一个请求 ( POST /requests ) 另一个用户检索所有请求 ( GET /requests ) 然后向请求添加报价 ( POST /
考虑以下 CDK Python 中的示例(对于这个问题,不需要 AWS 知识,这应该对基本上任何构建器模式都有效,我只是在这个示例中使用 CDK,因为我使用这个库遇到了这个问题。): from aws
Scala 中管理对象池的首选方法是什么? 我需要单线程创建和删除大规模对象(不需要同步)。在 C++ 中,我使用了静态对象数组。 在 Scala 中处理它的惯用和有效方法是什么? 最佳答案 我会把它
我有一个带有一些内置方法的类。这是该类的抽象示例: class Foo: def __init__(self): self.a = 0 self.b = 0
返回和检查方法执行的 Pythonic 方式 我目前在 python 代码中使用 golang 编码风格,决定移动 pythonic 方式 例子: import sys from typing imp
我正在开发一个 RESTful API。其中一个 URL 允许调用者通过 id 请求特定人员的记录。 返回该 id 不存在的记录的常规值是什么?服务器是否应该发回一个空对象或者一个 404,或者其他什
我正在使用 pathlib.Path() 检查文件是否存在,并使用 rasterio 将其作为图像打开. filename = pathlib.Path("./my_file-name.tif") 但
我正在寻找一种 Pythonic 方式来从列表和字典创建嵌套字典。以下两个语句产生相同的结果: a = [3, 4] b = {'a': 1, 'b': 2} c = dict(zip(b, a))
我有一个正在操裁剪理设备的脚本。设备有时会发生物理故障,当它发生时,我想重置设备并继续执行脚本。我有这个: while True: do_device_control() device
做组合别名的最pythonic和正确的方法是什么? 这是一个假设的场景: class House: def cleanup(self, arg1, arg2, kwarg1=False):
我正在开发一个小型客户端服务器程序来收集订单。我想以“REST(ful)方式”来做到这一点。 我想做的是: 收集所有订单行(产品和数量)并将完整订单发送到服务器 目前我看到有两种选择: 将每个订单行发
我知道在 Groovy 中您可以使用字符串调用类/对象上的方法。例如: Foo."get"(1) /* or */ String meth = "get" Foo."$meth"(1) 有没有办法
在 ECMAScript6 中,您可以使用扩展运算符来解构这样的对象 const {a, ...rest} = obj; 它将 obj 浅拷贝到 rest,不带属性 a。 有没有一种干净的方法可以在
我有几个函数返回数字或None。我希望我的包装函数返回第一个不是 None 的结果。除了下面的方法之外,还有其他方法吗? def func1(): return None def func2(
假设我想设计一个 REST api 来讨论歌曲、专辑和艺术家(实际上我就是这样做的,就像我之前的 1312414 个人一样)。 歌曲资源始终与其所属专辑相关联。相反,专辑资源与其包含的所有歌曲相关联。
这是我认为必须经常出现的问题,但我一直无法找到一个好的解决方案。假设我有一个函数,它可以作为参数传递一个开放资源(如文件或数据库连接对象),或者需要自己创建一个。如果函数需要自己打开文件,最佳实践通常
我是一名优秀的程序员,十分优秀!