如何从Android调用RESTful web服务？

Question

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

每个请求都需要用户提供用户名和密码，我知道这种身份验证不是最佳实践（使用类似于以下curl命令： curl -u username:password -X PUT http://localhsot:8080/user）。

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

我有一个使用DefaultHttpClient和CredentialUsernameAndPassword的Android类，但是当我在Eclipse中运行它时，有时会出现运行时异常或SDK异常。

- sudo

Answer 1

这是一个样例的Rest客户端类。

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();
    }
}

- Varghese John

---

如果没有注释或者总结每个部分正在发生什么，添加一个类的源代码会令像我这样对RESTful服务还不熟悉的人感到困惑。 - J. Schei

Answer 2

最近发现了一个第三方库 - 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的序列化和反序列化。您也可以自定义序列化和反序列化。

---

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();

- Tianhai

---

有没有关于这个的真实例子？我不太明白细节。 - Gatunox

Retrofit为您生成Restful Web服务客户端。您只需要使用一些注释定义接口即可。详情请参见http://square.github.io/retrofit/。 - Tianhai

我已经看过了，但我仍然不明白。这就是为什么我正在寻找一个真正的例子，而不仅仅是一些代码片段。 - Gatunox

https://github.com/square/retrofit/blob/master/samples/github-client/src/main/java/com/example/retrofit/GitHubClient.java - Tianhai

我已经使用 Retrofit 几个月了，在我的生涯中从未有过更好的 Java 库使用经验。我建议与之一起使用 Google 的 Gson 库，因为它可以使 JSON (反)序列化变得非常容易。 - Chris Cirefice

Answer 3

停止你正在做的事情！：）

将RESTful客户端实现为服务，并将密集的网络操作委托给与活动无关的组件：服务。

观看这个富有洞见的视频http://www.youtube.com/watch?v=xHXn3Kg2IQE，Virgil Dobjanschi在其中解释了他对这一挑战的方法...

- luigi7up

Answer 4

使用RestTemplate与Spring进行Android开发

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");

- Igor Vuković

---

那些给回答点踩的人应该解释一下这个答案有什么问题。 - jk7

Answer 5

我使用了 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()

- taynguyen

---

这不是安卓系统内置的组件。 - Czechnology

Answer 6

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

步骤1

创建一个空白的Android项目。

步骤2

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

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

步骤3

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

步骤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

- Nirmal Dhara

Answer 7

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

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

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

这里是使用示例。

https://github.com/vishalchhodwani1992/httpLibrary

- Vishal Chhodwani

Answer 8

什么是后端？如果是JAVA，您可以使用Jersey使用Java（JAX-RS）使用REST。

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

对于JSON <-->对象映射，在Android和Java后端上都可以使用GSON。

- Komal Nikhare

Answer 9

也许我来得有些晚，或者你以前已经用过了，但还有一个叫做ksoap的库非常棒。它包含超时机制，并且可以高效地解析任何基于SOAP的网络服务。我还对它进行了一些修改以适应我的解析需求。去查一下吧。

- Zuko