便携式类库HttpClient

时间:2014-06-26 11:06:04

标签: c# .net async-await dotnet-httpclient

对于我的一个项目,我想开发一个可以在不同平台(桌面,移动,表面等)中使用的库。因此选择了Porable Class Library。

我正在使用HttpClient开发一个用于调用不同API调用的类。我很困惑如何调用方法,响应和解决。这是我的代码: -

    public static async Task<JObject> ExecuteGet(string uri)
    {
        using (HttpClient client = new HttpClient())
        {
            // TODO - Send HTTP requests
            HttpRequestMessage reqMsg = new HttpRequestMessage(HttpMethod.Get, uri);
            reqMsg.Headers.Add(apiIdTag, apiIdKey);
            reqMsg.Headers.Add(apiSecretTag, ApiSecret);
            reqMsg.Headers.Add("Content-Type", "text/json");
            reqMsg.Headers.Add("Accept", "application/json");

            //response = await client.SendAsync(reqMsg);
            //return response;

            //if (response.IsSuccessStatusCode)
            //{
                string content = await response.Content.ReadAsStringAsync();
                return (JObject.Parse(content));
            //}
        }
    }

    // Perform AGENT LOGIN Process
    public static bool agentStatus() {
        bool loginSuccess = false;

        try
        {
            API_Utility.ExecuteGet("http://api.mintchat.com/agent/autoonline").Wait();
            // ACCESS Response, JObject ???
        }
        catch
        {
        }
        finally
        {
        }

与ExecuteGet类似,我也将为ExecutePost创建。我的查询来自ExecuteGet,如果(1)我在解析时只传递了JObject,只有IsSuccessStatusCode,那么我怎么知道任何其他错误或消息来通知用户。 (2)如果我通过了回复,那么我该如何在此处分配

response = API_Utility.ExecuteGet("http://api.mintchat.com/agent/autoonline").Wait();  

这是错误的。

处理这种情况的最佳方法是什么?我必须调用多个API,因此不同的API将具有不同的结果集。

此外,您能否确认以这种方式设计并添加PCL参考我将能够在多个项目中访问。

更新: - 如下面的2个答案所述,我已经更新了我的代码。正如提供的链接中所提到的,我正在调用另一个项目。这是我的代码: -

便携式类库: -

    private static HttpRequestMessage getGetRequest(string url)
    {
        HttpRequestMessage reqMsg = new HttpRequestMessage(HttpMethod.Get, url);
        reqMsg.Headers.Add(apiIdTag, apiIdKey);
        reqMsg.Headers.Add(apiSecretTag, ApiSecret);
        reqMsg.Headers.Add("Content-Type", "text/json");
        reqMsg.Headers.Add("Accept", "application/json");

        return reqMsg;
    }

    // Perform AGENT LOGIN Process
    public static async Task<bool> agentStatus() {
        bool loginSuccess = false;
        HttpClient client = null;
        HttpRequestMessage request = null;

        try
        {
            client = new HttpClient();
            request = getGetRequest("http://api.mintchat.com/agent/autoonline");
            response = await client.SendAsync(request).ConfigureAwait(false);

            if (response.IsSuccessStatusCode)
            {
                string content = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
                JObject o = JObject.Parse(content);
                bool stat = bool.Parse(o["status"].ToString());

                ///[MainAppDataObject sharedAppDataObject].authLogin.chatStatus = str;
                o = null;
            }
            loginSuccess = true;

        }
        catch
        {
        }
        finally
        {
            request = null;
            client = null;
            response = null;
        }

        return loginSuccess;
    }

在另一个WPF项目中,在btn click事件中,我将其称为: -

    private async void btnSignin_Click(object sender, RoutedEventArgs e)
   {
         /// Other code goes here
         // ..........

            agent = doLogin(emailid, encPswd);
            if (agent != null)
            {
                //agent.OnlineStatus = getAgentStatus();

                // Compile Error at this line
                bool stat = await MintWinLib.Helpers.API_Utility.agentStatus();

                ... 

我得到了这4个错误: -

Error   1   Predefined type 'System.Runtime.CompilerServices.IAsyncStateMachine' is not defined or imported D:\...\MiveChat\CSC 
Error   2   The type 'System.Threading.Tasks.Task`1<T0>' is defined in an assembly that is not referenced. You must add a reference to assembly 'System.Threading.Tasks, Version=1.5.11.0, Culture=neutral, PublicKeyToken=b03f5f7f89d50a3a'.   D:\...\Login Form.xaml.cs   97  21  
Error   3   Cannot find all types required by the 'async' modifier. Are you targeting the wrong framework version, or missing a reference to an assembly?   D:\...\Login Form.xaml.cs   97  33  
Error   4   Cannot find all types required by the 'async' modifier. Are you targeting the wrong framework version, or missing a reference to an assembly?   D:\...\Login Form.xaml.cs   47  28  

我尝试仅从PCL库添加System.Threading.Tasks,这会产生7种不同的错误。我哪里错了?该怎么做才能使这个工作?

请指导我。花了很多时间来最好地开发一个可以访问桌面应用程序的库。赢得手机应用。 任何帮助都非常感激。感谢。

2 个答案:

答案 0 :(得分:5)

如果在进行http调用时调用async api,则还应该向用户公开该异步端点,而不是使用Task.Wait阻止请求。

此外,在创建第三方库时,建议在调用代码尝试访问Result属性或Wait方法时使用ConfigureAwait(false)来避免死锁。您还应该遵循指南并使用Async标记任何异步方法,因此应该调用该方法ExecuteStatusAsync

public static Task<bool> AgentStatusAsync() 
{
    bool loginSuccess = false;

    try
    {
        // awaiting the task will unwrap it and return the JObject
        var jObject = await API_Utility.ExecuteGet("http://api.mintchat.com/agent/autoonline").ConfigureAwait(false);

    }
    catch
    {
    }
}

ExecuteGet内:

response = await client.SendAsync(reqMsg).ConfigureAwait(false);
string content = await response.Content.ReadAsStringAsync().ConfigureAwait(false);

如果IsSuccessStatusCode为false,您可以向调用代码抛出异常以显示出错的地方。为此,您可以使用HttpResponseMessage.EnsureSuccessStatusCode,如果状态代码!= 200 OK,则会引发异常。

就个人而言,如果ExecuteGet是公共API方法,我肯定不会将其公开为JObject,而是强类型。

答案 1 :(得分:2)

如果您想要任务的结果,则需要使用Result属性:

var obj = API_Utility.ExecuteGet("http://api.mintchat.com/agent/autoonline").Result;

但是,同步等待异步方法完成通常不是一个好主意,因为它可能导致死锁。更好的方法是await方法:

var obj = await API_Utility.ExecuteGet("http://api.mintchat.com/agent/autoonline");

请注意,您还需要调用方法async

public static async Task<bool> agentStatus()

同步和异步代码不能很好地协同播放,因此异步往往会在整个代码库中传播。