将 HttpResponseMessage 的内容转换为对象

Question

我的问题：我该怎么做？

所以，直到本周，我在大约 6 年的时间里没有接触过任何 .Net。有很多我忘记了，甚至更多是我不知道的，虽然我喜欢 async/await 关键字的想法，但我在为客户端的 API 实现实现以下要求时遇到了一个小问题：

1. ServerAPI 类对每个 API 方法都有一个方法，采用适当的输入参数（例如，Login 方法接受 id 和 password，进行 API 调用并将结果返回给调用者）。
2. 我想抽象出 JSON，以便我的 API 方法返回您正在获取的实际对象（例如，上面的 Login 方法返回带有您的身份验证令牌、uid 等的 User 对象）
3. 某些 API 方法在成功或没有有意义的内容时返回 204（在我的用例中没有意义，也许我只关心成功/失败），对于这些我想返回布尔值（true = 成功）或状态码。
4. 我想保留 async/await（或等效的）设计，因为到目前为止它似乎确实运行良好。
5. 对于某些方法，我可能只需要返回 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，但这主要是因为我不想切换所有代码。如果我想要通过其他方式更容易完成，那么显然值得额外的工作。

谢谢。

Answer 1

这是我如何使用 MVC API 2 作为后端的示例。如果凭据正确，我的后端会返回 json 结果。 UserCredentials 类与 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...
    }

Answer 2

所以，首先要解决你需要Newtonsoft.Json cmets，我真的还没有感觉到需要。到目前为止，我发现内置支持运行良好（在我原来的问题中使用 APIError Json：

[DataContract]
internal class APIError
{
    [DataMember (Name = "status")]
    public int StatusCode { get; set; }
    [DataMember (Name = "code")]
    public int ErrorCode { get; set; }
}

我还定义了一个JsonHelper 类来（反）序列化：

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，它将（例如）注销用户。

Answer 3

我会使用反序列化器。

HttpResponseMessage response = await client.GetAsync("your http here");
            var responseString = await response.Content.ReadAsStringAsync();
[Your Class] object= JsonConvert.DeserializeObject<[Your Class]>(responseString.Body.ToString());