如何从Android调用RESTful Web服务?

时间:2011-05-18 15:09:39

标签: java android web-services rest authorization

我使用Jersey Framework和Java在Netbean IDE中编写了一个REST Web服务。

对于用户需要提供用户名和密码的每个请求,我知道此身份验证不是最佳做法(使用curl命令,如:curl -u username:password -X PUT http://localhsot:8080/user)。

现在我想从Android类调用REST Web服务。

我该怎么办?

我有一个使用DefaultHttpClientCredentialUsernameAndPassword的Android类,但是当我在Eclipse中运行它时,有时会遇到运行时异常或SDK异常。

11 个答案:

答案 0 :(得分:19)

这是一个示例restclient类

public class RestClient
{
    public enum RequestMethod
    {
        GET,
        POST
    }
    public int responseCode=0;
    public String message;
    public String response;
    public void Execute(RequestMethod method,String url,ArrayList<NameValuePair> headers,ArrayList<NameValuePair> params) throws Exception
    {
        switch (method)
        {
            case GET:
            {
                // add parameters
                String combinedParams = "";
                if (params!=null)
                {
                    combinedParams += "?";
                    for (NameValuePair p : params)
                    {
                        String paramString = p.getName() + "=" + URLEncoder.encode(p.getValue(),"UTF-8");
                        if (combinedParams.length() > 1)
                            combinedParams += "&" + paramString;
                        else
                            combinedParams += paramString;
                    }
                }
                HttpGet request = new HttpGet(url + combinedParams);
                // add headers
                if (headers!=null)
                {
                    headers=addCommonHeaderField(headers);
                    for (NameValuePair h : headers)
                        request.addHeader(h.getName(), h.getValue());
                }
                executeRequest(request, url);
                break;
            }
            case POST:
            {
                HttpPost request = new HttpPost(url);
                // add headers
                if (headers!=null)
                {
                    headers=addCommonHeaderField(headers);
                    for (NameValuePair h : headers)
                        request.addHeader(h.getName(), h.getValue());
                }
                if (params!=null)
                    request.setEntity(new UrlEncodedFormEntity(params, HTTP.UTF_8));
                executeRequest(request, url);
                break;
            }
        }
    }
    private ArrayList<NameValuePair> addCommonHeaderField(ArrayList<NameValuePair> _header)
    {
        _header.add(new BasicNameValuePair("Content-Type","application/x-www-form-urlencoded"));
        return _header;
    }
    private void executeRequest(HttpUriRequest request, String url)
    {
        HttpClient client = new DefaultHttpClient();
        HttpResponse httpResponse;
        try
        {
            httpResponse = client.execute(request);
            responseCode = httpResponse.getStatusLine().getStatusCode();
            message = httpResponse.getStatusLine().getReasonPhrase();
            HttpEntity entity = httpResponse.getEntity();

            if (entity != null)
            {
                InputStream instream = entity.getContent();
                response = convertStreamToString(instream);
                instream.close();
            }
        }
        catch (Exception e)
        { }
    }

    private static String convertStreamToString(InputStream is)
    {
        BufferedReader reader = new BufferedReader(new InputStreamReader(is));
        StringBuilder sb = new StringBuilder();
        String line = null;
        try
        {
            while ((line = reader.readLine()) != null)
            {
                sb.append(line + "\n");
            }
            is.close();
        }
        catch (IOException e)
        { }
        return sb.toString();
    }
}

答案 1 :(得分:14)

最近发现第三方库 - Square Retrofit可以很好地完成这项工作。


定义REST端点

public interface GitHubService {
   @GET("/users/{user}/repos")
   List<Repo> listRepos(@Path("user") String user,Callback<List<User>> cb);
}

获得具体服务

RestAdapter restAdapter = new RestAdapter.Builder()
    .setEndpoint("https://api.github.com")
    .build();
GitHubService service = restAdapter.create(GitHubService.class);

调用REST端点

List<Repo> repos = service.listRepos("octocat",new Callback<List<User>>() { 
    @Override
    public void failure(final RetrofitError error) {
        android.util.Log.i("example", "Error, body: " + error.getBody().toString());
    }
    @Override
    public void success(List<User> users, Response response) {
        // Do something with the List of Users object returned
        // you may populate your adapter here
    }
});

库为您处理json序列化和deserailization。您也可以自定义序列化和反序列化。

Gson gson = new GsonBuilder()
    .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
    .registerTypeAdapter(Date.class, new DateTypeAdapter())
    .create();

RestAdapter restAdapter = new RestAdapter.Builder()
    .setEndpoint("https://api.github.com")
    .setConverter(new GsonConverter(gson))
    .build();

答案 2 :(得分:6)

我将这个REST Client用于我的机器人。这看起来很酷。卢克的好作品。

http://lukencode.com/2010/04/27/calling-web-services-in-android-using-httpclient/

答案 3 :(得分:6)

停止你正在做的事情! :)

RESTful客户端实现为服务,并将密集型网络内容委托给与活动无关的组件:SERVICE。

观看此精彩视频 http://www.youtube.com/watch?v=xHXn3Kg2IQE Virgil Dobjanschi正在解释他对这一挑战的态度......

答案 4 :(得分:1)

我使用OkHttpClient来调用restful Web服务。这很简单。

OkHttpClient httpClient = new OkHttpClient();
Request request = new Request.Builder()
                .url(url)
                .build();

Response response = httpClient.newCall(request).execute();
String body = response.body().string()

答案 5 :(得分:1)

使用Spring for Android与RestTemplate https://spring.io/guides/gs/consuming-rest-android/

// The connection URL 
String url = "https://ajax.googleapis.com/ajax/" + 
    "services/search/web?v=1.0&q={query}";

// Create a new RestTemplate instance
RestTemplate restTemplate = new RestTemplate();

// Add the String message converter
restTemplate.getMessageConverters().add(new StringHttpMessageConverter());

// Make the HTTP GET request, marshaling the response to a String
String result = restTemplate.getForObject(url, String.class, "Android");

答案 6 :(得分:0)

后端是什么?如果是JAVA,那么你可以使用REST和Java(JAX-RS)使用Jersey。

在Android端,您可以使用这个简单的RestClient来处理该REST服务。

对于JSON&lt; - &gt;双方的对象映射(Android,Java后端)都可以使用GSON。

答案 7 :(得分:0)

也许已经很晚了或者你之前已经使用过了,但是还有一个名为ksoap并且非常惊人。它还包括超时并且可以有效地解析任何基于SOAP的Web服务。我也做了一些改动以适合我的解析..查一查

答案 8 :(得分:0)

按照以下步骤在android中使用RestFul。

<强>步骤1

创建一个android空白项目。

<强>第二步

需要互联网访问权限。在AndroidManifest.xml文件中编写以下代码。

 <uses-permission android:name="android.permission.INTERNET">
</uses-permission>

<强>步骤3

需要在另一台服务器或同一台机器上运行的RestFul网址。

<强>步骤4

创建一个将扩展AsyncTask的RestFul客户端。请参阅RestFulPost.java。

<强>步骤5

为RestFull请求和响应创建DTO类。

<强> RestFulPost.java

package javaant.com.consuming_restful.restclient;
import android.app.ProgressDialog;
import android.content.Context;
import android.os.AsyncTask;
import android.util.Log;
import com.google.gson.Gson;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import java.util.Map;
import javaant.com.consuming_restful.util.Util;
/**
 * Created by Nirmal Dhara on 29-10-2015.
 */
public class RestFulPost extends AsyncTask<map, void,="" string=""> {
    RestFulResult restFulResult = null;
    ProgressDialog Asycdialog;
    String msg;
    String task;
    public RestFulPost(RestFulResult restFulResult, Context context, String msg,String task) {
        this.restFulResult = restFulResult;
        this.task=task;
        this.msg = msg;
        Asycdialog = new ProgressDialog(context);
    }
    @Override
    protected String doInBackground(Map... params) {
        String responseStr = null;
        Object dataMap = null;
        HttpPost httpost = new HttpPost(params[0].get("url").toString());

        try {
            dataMap = (Object) params[0].get("data");
            Gson gson = new Gson();
            Log.d("data  map", "data map------" + gson.toJson(dataMap));
            httpost.setEntity(new StringEntity(gson.toJson(dataMap)));
            httpost.setHeader("Accept", "application/json");
            httpost.setHeader("Content-type", "application/json");
            DefaultHttpClient httpclient= Util.getClient();
            HttpResponse response = httpclient.execute(httpost);
            int statusCode = response.getStatusLine().getStatusCode();
            Log.d("resonse code", "----------------" + statusCode);

            if (statusCode == 200)
                responseStr = EntityUtils.toString(response.getEntity());
            if (statusCode == 404) {
                responseStr = "{\n" +
                        "\"status\":\"fail\",\n" +
                        " \"data\":{\n" +
                        "\"ValidUser\":\"Service not available\",\n" +
                        "\"code\":\"404\"\n" +
                        "}\n" +
                        "}";
            }

        } catch (Exception e) {
            e.printStackTrace();
        }
        return responseStr;
    }
    @Override
    protected void onPreExecute() {
        Asycdialog.setMessage(msg);
        //show dialog
        Asycdialog.show();
        super.onPreExecute();
    }
    @Override
    protected void onPostExecute(String s) {
        Asycdialog.dismiss();
        restFulResult.onResfulResponse(s,task);
    }
}

有关详细信息和完整代码,请访问http://javaant.com/consume-a-restful-webservice-in-android/#.VwzbipN96Hs

答案 9 :(得分:0)

这是我为简单的Web服务调用创建的库,

您可以通过添加一行gradle依赖项来使用它 -

compile 'com.scantity.ScHttpLibrary:ScHttpLibrary:1.0.0'

以下是使用的演示。

https://github.com/vishalchhodwani1992/httpLibrary

答案 10 :(得分:0)

有大量可用的库

Retrofit 取代了传统的AsyncTask,它具有自己的后台任务,因此您不必担心。相对于AsyncTask而言,性能也非常好。

在这里检查

http://square.github.io/retrofit/

可以在此处找到改造的完整示例,

https://futurestud.io/blog/retrofit-getting-started-and-android-client/

排球同样高效且易于使用。您可以在这里看看:

https://github.com/mcxiaoke/android-volley

网络上有很多有关如何使用它的资源:

http://www.androidhive.info/2014/05/android-working-with-volley-library-1

AsyncTask

或者您应该使用实现AsyncTask,然后重写方法doInTheBackground()-在这里可以实现REST调用。

然后,您可以使用onPostExecute()来让UI线程处理上一步中返回的结果。

此答案提供了有关如何实现AsyncTask的很好的示例。  参见AsyncTask Android example

下面每个Ruffles的评论,这是使用AsyncTask进行REST调用的一个更相关的示例:http://alvinalexander.com/android/android-asynctask-http-client-rest-example-tutorial