将 HttpResponseMessage 的内容转换为对象
Converting the content of HttpResponseMessage to object
我的问题:我该怎么做?
所以,直到这周,我已经有大约 6 年没有接触过任何 .Net 了。有很多东西我已经忘记了,甚至还有更多我不知道的东西,虽然我喜欢 async/await 关键字的想法,但我在为客户的 API 实现实现以下要求时遇到了一个小问题:
-
ServerAPI
class 每个 API 方法都有一个方法,采用适当的输入参数(例如方法 Login
接受一个 id
和 password
,进行 API 调用并将结果 return 发送给调用者)。
- 我想抽象掉 JSON 以便我的 API 方法 return 您正在获取的实际对象(例如上面的
Login
方法 return是一个 User
对象,其中包含您的身份验证令牌、uid 等)
- 一些API方法return 204成功或没有有意义的内容(在我的用例中没有意义也许我只关心success/failure),对于这些我想return 布尔值(
true
= 成功)或状态代码。
- 我想保留 async/await(或等效)设计,因为到目前为止它似乎确实运行良好。
- 对于某些方法,我可能只需要 return
HttpResponseMessage
对象并让调用者处理它。
这就是我目前所掌握的大致情况,我不确定如何使其符合上述要求,或者我是否正确地做到了这一点。任何指导表示赞赏(但不是燃烧)。
// 200 (+User JSON) = success, otherwise APIError JSON
internal async Task<User> Login (string id, string password)
{
LoginPayload payload = new LoginPayload() { LoginId = id, Password = password};
var request = NewRequest(HttpMethod.Post, "login");
JsonPayload<LoginPayload>(payload, ref request);
return await Execute<Account>(request, false);
}
// 204: success, anything else failure
internal async Task<Boolean> LogOut ()
{
return await Execute<Boolean>(NewRequest(HttpMethod.Delete, "login"), true);
}
internal async Task<HttpResponseMessage> GetRawResponse ()
{
return await Execute<HttpResponseMessage>(NewRequest(HttpMethod.Get, "raw/something"), true);
}
internal async Task<Int32> GetMeStatusCode ()
{
return await Execute<Int32>(NewRequest(HttpMethod.Get, "some/intstatus"), true);
}
private async Task<RESULT> Execute<RESULT>(HttpRequestMessage request, bool authenticate)
{
if (authenticate)
AuthenticateRequest(ref request); // add auth token to request
var tcs = new TaskCompletionSource<RESULT>();
var response = await client.SendAsync(request);
// TODO: If the RESULT is just HTTPResponseMessage, the rest is unnecessary
if (response.IsSuccessStatusCode)
{
try
{
// TryParse needs to handle Boolean differently than other types
RESULT result = await TryParse<RESULT>(response);
tcs.SetResult(result);
}
catch (Exception e)
{
tcs.SetException(e);
}
}
else
{
try
{
APIError error = await TryParse<APIError>(response);
tcs.SetException(new APIException(error));
}
catch (Exception e)
{
tcs.SetException(new APIException("Unknown error"));
}
}
return tcs.Task.Result;
}
这是 APIError
JSON 结构(它是状态代码 + 自定义错误代码)。
{
"status": 404,
"code":216,
"msg":"User not found"
}
我更愿意继续使用 System.Net
,但这主要是因为我不想切换所有代码。如果我想要的东西用其他方式更容易完成,那么显然值得额外的工作。
谢谢。
这是我如何使用 MVC API 2 作为后端来完成它的示例。如果凭据正确,我的后端 returns 会得到 json 结果。 UserCredentials
class 是与 json 结果完全相同的模型。您将不得不使用 System.Net.Http.Formatting
,它可以在 Microsoft.AspNet.WebApi.Client
NugetPackage
中找到
public static async Task<UserCredentials> Login(string username, string password)
{
string baseAddress = "127.0.0.1/";
HttpClient client = new HttpClient();
var authorizationHeader = Convert.ToBase64String(Encoding.UTF8.GetBytes("xyz:secretKey"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", authorizationHeader);
var form = new Dictionary<string, string>
{
{ "grant_type", "password" },
{ "username", username },
{ "password", password },
};
var Response = await client.PostAsync(baseAddress + "oauth/token", new FormUrlEncodedContent(form));
if (Response.StatusCode == HttpStatusCode.OK)
{
return await Response.Content.ReadAsAsync<UserCredentials>(new[] { new JsonMediaTypeFormatter() });
}
else
{
return null;
}
}
你还需要 Newtonsoft.Json
包。
public class UserCredentials
{
[JsonProperty("access_token")]
public string AccessToken { get; set; }
[JsonProperty("token_type")]
public string TokenType { get; set; }
[JsonProperty("expires_in")]
public int ExpiresIn { get; set; }
//more properties...
}
所以,首先要解决你需要Newtonsoft.Json
的评论,我真的还没有觉得有必要。到目前为止,我发现内置支持运行良好(在我原来的问题中使用 APIError
Json:
[DataContract]
internal class APIError
{
[DataMember (Name = "status")]
public int StatusCode { get; set; }
[DataMember (Name = "code")]
public int ErrorCode { get; set; }
}
我还定义了一个 JsonHelper
class 来(反)序列化:
public class JsonHelper
{
public static T fromJson<T> (string json)
{
var bytes = Encoding.Unicode.GetBytes (json);
using (MemoryStream mst = new MemoryStream(bytes))
{
var serializer = new DataContractJsonSerializer (typeof (T));
return (T)serializer.ReadObject (mst);
}
}
public static string toJson (object instance)
{
using (MemoryStream mst = new MemoryStream())
{
var serializer = new DataContractJsonSerializer (instance.GetType());
serializer.WriteObject (mst, instance);
mst.Position = 0;
using (StreamReader r = new StreamReader(mst))
{
return r.ReadToEnd();
}
}
}
}
以上内容我已经在使用了。至于基于预期结果类型处理每个请求执行的单一方法,同时它使 更改 我处理事情(如错误等)的方式更容易,它还增加了我的代码的复杂性和可读性。我最终创建了单独的方法(原始问题中 Execute
方法的所有变体:
// execute and return response.StatusCode
private static async Task<HttpStatusCode> ExecuteForStatusCode (HttpRequestMessage request, bool authenticate = true)
// execute and return response without processing
private static async Task<HttpResponseMessage> ExecuteForRawResponse(HttpRequestMessage request, bool authenticate = true)
// execute and return response.IsSuccessStatusCode
private static async Task<Boolean> ExecuteForBoolean (HttpRequestMessage request, bool authenticate = true)
// execute and extract JSON payload from response content and convert to RESULT
private static async Task<RESULT> Execute<RESULT>(HttpRequestMessage request, bool authenticate = true)
我可以将未经授权的响应(无论如何我当前的代码现在都无法处理)移动到一个新方法 CheckResponse
中,该方法将(例如)在收到 401 时注销用户。
我会使用解串器。
HttpResponseMessage response = await client.GetAsync("your http here");
var responseString = await response.Content.ReadAsStringAsync();
[Your Class] object= JsonConvert.DeserializeObject<[Your Class]>(responseString.Body.ToString());
我的问题:我该怎么做?
所以,直到这周,我已经有大约 6 年没有接触过任何 .Net 了。有很多东西我已经忘记了,甚至还有更多我不知道的东西,虽然我喜欢 async/await 关键字的想法,但我在为客户的 API 实现实现以下要求时遇到了一个小问题:
-
ServerAPI
class 每个 API 方法都有一个方法,采用适当的输入参数(例如方法Login
接受一个id
和password
,进行 API 调用并将结果 return 发送给调用者)。 - 我想抽象掉 JSON 以便我的 API 方法 return 您正在获取的实际对象(例如上面的
Login
方法 return是一个User
对象,其中包含您的身份验证令牌、uid 等) - 一些API方法return 204成功或没有有意义的内容(在我的用例中没有意义也许我只关心success/failure),对于这些我想return 布尔值(
true
= 成功)或状态代码。 - 我想保留 async/await(或等效)设计,因为到目前为止它似乎确实运行良好。
- 对于某些方法,我可能只需要 return
HttpResponseMessage
对象并让调用者处理它。
这就是我目前所掌握的大致情况,我不确定如何使其符合上述要求,或者我是否正确地做到了这一点。任何指导表示赞赏(但不是燃烧)。
// 200 (+User JSON) = success, otherwise APIError JSON
internal async Task<User> Login (string id, string password)
{
LoginPayload payload = new LoginPayload() { LoginId = id, Password = password};
var request = NewRequest(HttpMethod.Post, "login");
JsonPayload<LoginPayload>(payload, ref request);
return await Execute<Account>(request, false);
}
// 204: success, anything else failure
internal async Task<Boolean> LogOut ()
{
return await Execute<Boolean>(NewRequest(HttpMethod.Delete, "login"), true);
}
internal async Task<HttpResponseMessage> GetRawResponse ()
{
return await Execute<HttpResponseMessage>(NewRequest(HttpMethod.Get, "raw/something"), true);
}
internal async Task<Int32> GetMeStatusCode ()
{
return await Execute<Int32>(NewRequest(HttpMethod.Get, "some/intstatus"), true);
}
private async Task<RESULT> Execute<RESULT>(HttpRequestMessage request, bool authenticate)
{
if (authenticate)
AuthenticateRequest(ref request); // add auth token to request
var tcs = new TaskCompletionSource<RESULT>();
var response = await client.SendAsync(request);
// TODO: If the RESULT is just HTTPResponseMessage, the rest is unnecessary
if (response.IsSuccessStatusCode)
{
try
{
// TryParse needs to handle Boolean differently than other types
RESULT result = await TryParse<RESULT>(response);
tcs.SetResult(result);
}
catch (Exception e)
{
tcs.SetException(e);
}
}
else
{
try
{
APIError error = await TryParse<APIError>(response);
tcs.SetException(new APIException(error));
}
catch (Exception e)
{
tcs.SetException(new APIException("Unknown error"));
}
}
return tcs.Task.Result;
}
这是 APIError
JSON 结构(它是状态代码 + 自定义错误代码)。
{
"status": 404,
"code":216,
"msg":"User not found"
}
我更愿意继续使用 System.Net
,但这主要是因为我不想切换所有代码。如果我想要的东西用其他方式更容易完成,那么显然值得额外的工作。
谢谢。
这是我如何使用 MVC API 2 作为后端来完成它的示例。如果凭据正确,我的后端 returns 会得到 json 结果。 UserCredentials
class 是与 json 结果完全相同的模型。您将不得不使用 System.Net.Http.Formatting
,它可以在 Microsoft.AspNet.WebApi.Client
NugetPackage
public static async Task<UserCredentials> Login(string username, string password)
{
string baseAddress = "127.0.0.1/";
HttpClient client = new HttpClient();
var authorizationHeader = Convert.ToBase64String(Encoding.UTF8.GetBytes("xyz:secretKey"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", authorizationHeader);
var form = new Dictionary<string, string>
{
{ "grant_type", "password" },
{ "username", username },
{ "password", password },
};
var Response = await client.PostAsync(baseAddress + "oauth/token", new FormUrlEncodedContent(form));
if (Response.StatusCode == HttpStatusCode.OK)
{
return await Response.Content.ReadAsAsync<UserCredentials>(new[] { new JsonMediaTypeFormatter() });
}
else
{
return null;
}
}
你还需要 Newtonsoft.Json
包。
public class UserCredentials
{
[JsonProperty("access_token")]
public string AccessToken { get; set; }
[JsonProperty("token_type")]
public string TokenType { get; set; }
[JsonProperty("expires_in")]
public int ExpiresIn { get; set; }
//more properties...
}
所以,首先要解决你需要Newtonsoft.Json
的评论,我真的还没有觉得有必要。到目前为止,我发现内置支持运行良好(在我原来的问题中使用 APIError
Json:
[DataContract]
internal class APIError
{
[DataMember (Name = "status")]
public int StatusCode { get; set; }
[DataMember (Name = "code")]
public int ErrorCode { get; set; }
}
我还定义了一个 JsonHelper
class 来(反)序列化:
public class JsonHelper
{
public static T fromJson<T> (string json)
{
var bytes = Encoding.Unicode.GetBytes (json);
using (MemoryStream mst = new MemoryStream(bytes))
{
var serializer = new DataContractJsonSerializer (typeof (T));
return (T)serializer.ReadObject (mst);
}
}
public static string toJson (object instance)
{
using (MemoryStream mst = new MemoryStream())
{
var serializer = new DataContractJsonSerializer (instance.GetType());
serializer.WriteObject (mst, instance);
mst.Position = 0;
using (StreamReader r = new StreamReader(mst))
{
return r.ReadToEnd();
}
}
}
}
以上内容我已经在使用了。至于基于预期结果类型处理每个请求执行的单一方法,同时它使 更改 我处理事情(如错误等)的方式更容易,它还增加了我的代码的复杂性和可读性。我最终创建了单独的方法(原始问题中 Execute
方法的所有变体:
// execute and return response.StatusCode
private static async Task<HttpStatusCode> ExecuteForStatusCode (HttpRequestMessage request, bool authenticate = true)
// execute and return response without processing
private static async Task<HttpResponseMessage> ExecuteForRawResponse(HttpRequestMessage request, bool authenticate = true)
// execute and return response.IsSuccessStatusCode
private static async Task<Boolean> ExecuteForBoolean (HttpRequestMessage request, bool authenticate = true)
// execute and extract JSON payload from response content and convert to RESULT
private static async Task<RESULT> Execute<RESULT>(HttpRequestMessage request, bool authenticate = true)
我可以将未经授权的响应(无论如何我当前的代码现在都无法处理)移动到一个新方法 CheckResponse
中,该方法将(例如)在收到 401 时注销用户。
我会使用解串器。
HttpResponseMessage response = await client.GetAsync("your http here");
var responseString = await response.Content.ReadAsStringAsync();
[Your Class] object= JsonConvert.DeserializeObject<[Your Class]>(responseString.Body.ToString());