Android学习笔记：HttpClient和HttpURLConnection

在Android开发中网络请求是最常用的操作之一，Android SDK中对HTTP(超文本传输协议)也提供了很好的支持，这里包括两种接口：
（1）标准Java接口(java.NET)——HttpURLConnection，可以实现简单的基于URL请求、响应功能；
（2）Apache接口(org.apache.http)——HttpClient，使用起来更方便更强大；

一、HttpClient

HttpClient是Apache Jakarta Commons下的子项目，可以用来提供高效的、最新的、功能丰富的支持HTTP协议的客户端编程工具包，并且它支持HTTP协议最新的版本和建议。

由于HttpClient存在的API数量过多、扩展困难等缺点，Android团队越来越不建议我们使用这种方式。终于在Android6.0系统中，HttpClient的功能被完全移除了，标志着此功能正式被弃用。Google建议使用HttpURLConnection进行网络访问操作。

Android SDK中包含了HttpClient。Android6.0版本直接删除了HttpClient类库。如果仍想使用它，解决方法就是在相应moudle下的build.gradle中加入如下代码：

android{
	useLibrary 'org.apache.http.legacy'
}

1、使用步骤

1、创建HttpClient对象。
2、创建请求方法的实例，并指定请求URL。如果需要发送GET请求，创建HttpGet对象；如果需要发送POST请求，创建HttpPost对象。
3、如果需要发送请求参数，可调用HttpGet、HttpPost共同的setParams(HttpParams params)方法来添加请求参数；对于HttpPost对象而言，也可调用setEntity(HttpEntity entity)方法来设置请求参数。
4、调用HttpClient对象的execute(HttpUriRequest request)发送请求，该方法返回一个HttpResponse。
5、调用HttpResponse的getAllHeaders()、getHeader(String name)等方法可获取服务器的响应头；调用HttpResponse的getEntity()方法可以获取HttpEntity对象，该对象包装了服务器的响应内容。程序可通过该对象获取服务器的响应内容。
6、释放连接。无论方法是否成功，都必须释放连接。

2、HttpClientDemo

项目简介：使用HttpClient访问聚合API，查询手机归属地
项目地址：https://github.com/ambition-hb/HttpClientDemo
项目图示：

部分代码如下：

/** * 使用HttpClient访问聚合API，查询手机归属地 */

public class MainActivity extends AppCompatActivity implements View.OnClickListener{

    private Button btn_get;
    private Button btn_post;
    private TextView tv;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        btn_get = (Button)findViewById(R.id.btn_get);
        btn_post = (Button)findViewById(R.id.btn_post);
        tv = (TextView)findViewById(R.id.tv);
        btn_get.setOnClickListener(this);
        btn_post.setOnClickListener(this);
    }

    @Override
    public void onClick(View v) {
        switch(v.getId()){
            case R.id.btn_get:
                new Thread(new Runnable() {
                    @Override
                    public void run() {
                        useHttpClientGet("http://apis.juhe.cn/mobile/get?phone=13429667914&key=fef8795fcfa0a1977582d8c31b529112");
                    }
                }).start();
                break;
            case R.id.btn_post:
                new Thread(new Runnable() {
                    @Override
                    public void run() {
                        useHttpClientPost("http://apis.juhe.cn/mobile/get?");
                    }
                }).start();
                break;
            default:
                break;
        }
    }

    private HttpClient createHttpClient(){
        HttpParams mDefaultHttpParams = new BasicHttpParams();
        //设置连接超时
        HttpConnectionParams.setConnectionTimeout(mDefaultHttpParams,15000);
        //设置请求超时
        HttpConnectionParams.setSoTimeout(mDefaultHttpParams, 15000);
        HttpConnectionParams.setTcpNoDelay(mDefaultHttpParams, true);
        HttpProtocolParams.setVersion(mDefaultHttpParams, HttpVersion.HTTP_1_1);
        HttpProtocolParams.setContentCharset(mDefaultHttpParams, HTTP.UTF_8);
        //持续握手
        HttpProtocolParams.setUseExpectContinue(mDefaultHttpParams, true);
        HttpClient mHttpClient = new DefaultHttpClient(mDefaultHttpParams);
        return mHttpClient;
    }

    //HttpClient的GET方法
    private void useHttpClientGet(String url){
        HttpGet mHttpGet = new HttpGet(url);
        mHttpGet.addHeader("Connection", "Keep-Alive");
        try{
            HttpClient mHttpClient = createHttpClient();
            HttpResponse mHttpResponse = mHttpClient.execute(mHttpGet);
            HttpEntity mHttpEntity = mHttpResponse.getEntity();
            int code = mHttpResponse.getStatusLine().getStatusCode();
            if(null != mHttpEntity){
                InputStream mInputStream = mHttpEntity.getContent();
                String response = converStreamToString(mInputStream);
                showResponse(response);
                Log.d("useHttpClientGet: ", "请求状态吗：" + code + "\n请求结果：\n" + response);
                mInputStream.close();
            }
        }catch (Exception e){
            e.printStackTrace();
        }
    }

    //HttpClient的POST方法
    private void useHttpClientPost(String url){
        HttpPost mHttpPost = new HttpPost(url);
        mHttpPost.addHeader("Connection", "Keep-Alive");
        try{
            HttpClient mHttpClient = createHttpClient();
            List<NameValuePair> postParams = new ArrayList<>();
            //要传递的参数
            //phone=18856842651&key=fef8795fcfa0a1977582d8c31b529112
            postParams.add(new BasicNameValuePair("phone", "18856842651"));
            postParams.add(new BasicNameValuePair("key", "fef8795fcfa0a1977582d8c31b529112"));
            mHttpPost.setEntity(new UrlEncodedFormEntity(postParams));
            HttpResponse mHttpResponse = mHttpClient.execute(mHttpPost);
            HttpEntity mHttpEntity = mHttpResponse.getEntity();
            int code = mHttpResponse.getStatusLine().getStatusCode();
            if (null != mHttpEntity){
                InputStream mInputStream = mHttpEntity.getContent();
                String respose = converStreamToString(mInputStream);
                showResponse(respose);
                Log.d("useHttpClientPost: ", "请求状态吗：" + code + "\n请求结果：\n" + respose);
                mInputStream.close();
            }
        }catch (IOException e){
            e.printStackTrace();
        }
    }

    //将字节流转换为字符流
    private String converStreamToString(InputStream is) throws IOException{
        BufferedReader reader = new BufferedReader(new InputStreamReader(is));
        StringBuffer sb = new StringBuffer();
        String line = null;
        while((line = reader.readLine()) != null){
            sb.append(line + "\n");
        }
        String response = sb.toString();
        return response;
    }

    //将response结果展示展示出来
    private void showResponse(final String response){
        //Activity不允许在子线程中进行UI操作
        //通过该方法可以将线程切换到主线程，然后再更新UI元素
        new Thread(new Runnable() {
            @Override
            public void run() {
                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        tv.setText(response);
                    }
                });
            }
        }).start();
    }
}

二、HttpURLConnection

在JDK的java.net包中已经提供了访问HTTP协议的基本功能的类：HttpURLConnection。HttpURLConnection是Java的标准类，它继承自URLConnection，可用于向指定网站发送GET请求、POST请求。HttpURLConnection的压缩和缓存机制可以有效地减少网络访问的流量，在提升速度和省电方面也起到了较大的作用。

注：Android4.4之后的HttpUrlConnection的实现是基于OkHttp。

1、使用步骤

首先需要获取到HttpURLConnection的实例，一般只需要new出一个URL对象，并传入目标的网络地址，然后调用一下openConnection()方法即可，如下所示：

URL url = new URL("www.baidu.com");
HttpURLConnection connection = (HttpURLConnection) url.openConnection();

在得到了HttpURLConnection的实例之后，我们可以设置一下HTTP请求所使用的方法。常用的方法主要有两个：GET和POST。GET表示希望从服务器那里获取数据，POST表示希望提交数据给服务器 (既要提交数据又要获取数据则可以不写该条语句) 。GET方法写法如下：

connection.setRequestMethod("GET");//设置请求参数

如果想要提交数据给服务器，只需要将HTTP请求的方法改为POST，并在获取输入流之前把要提交的数据写出即可。(注意每条数据都要以键值对的形式存在，数据与数据之间用"&"符号隔开)，POST方法写法如下：

connection.setRequestMethod("POST");//设置请求参数
DataOutputStream out = new DataOutputStream(connection.getOutputStream());
out.writeBytes("username=admin&password=123456");

接下来进行一些自由定制，比如设置连接超时、读取超时的毫秒数，以及服务器希望得到的一些消息头等。这部分内容根据自己的实际情况进行编写，示例写法如下：

connection.setConnectTimeout(8000);//设置连接超时的毫秒数
connection.setReadTimeout(8000);//设置读取超时的毫秒数

之后再调用getInputStream()方法就可以获取到服务器返回的输入流了，剩下的任务就是对输入流进行读取，如下所示：

InputStream in = connection.getInputStream();

最后可以调用disconnect()方法将这个HTTP连接关闭掉，如下所示：

connection.disconnect();

2、HttpURLConnectionDemo

项目简介：使用HttpURLConnection访问聚合API，查询手机归属地
项目地址：https://github.com/ambition-hb/HttpURLConnectionDemo
项目图示：

部分代码如下：

public class MainActivity extends AppCompatActivity implements View.OnClickListener{

    private Button button;
    private TextView textView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        button = (Button)findViewById(R.id.btn_HUC);
        textView = (TextView)findViewById(R.id.tv);
        button.setOnClickListener(this);
    }

    @Override
    public void onClick(View v) {
        switch(v.getId()){
            case R.id.btn_HUC:
                sendRequestWithHttpURLConnection();
                break;
            default:
                break;
        }
    }

    private void sendRequestWithHttpURLConnection(){
        //开启线程发起网络请求
        new Thread(new Runnable() {
            @Override
            public void run() {
                HttpURLConnection connection = null;
                BufferedReader reader = null;
                try{
                    URL url = new URL("http://apis.juhe.cn/mobile/get?phone=13429667914&key=fef8795fcfa0a1977582d8c31b529112");
                    connection = (HttpURLConnection) url.openConnection();
                    connection.setRequestMethod("GET");
                    connection.setConnectTimeout(8000);
                    connection.setReadTimeout(8000);
                    InputStream in = connection.getInputStream();
                    //下面对获取到的输入流进行读取
                    reader = new BufferedReader(new InputStreamReader(in));
                    StringBuilder response = new StringBuilder();
                    String line;
                    while((line = reader.readLine()) != null){
                        response.append(line);
                    }
                    showResponse(response.toString());
                }catch (Exception e){
                    e.printStackTrace();
                }finally {
                    if (reader != null){
                        try{
                            reader.close();
                        }catch (IOException e){
                            e.printStackTrace();
                        }
                    }
                    if (connection != null){
                        connection.disconnect();
                    }
                }
            }
        }).start();
    }

    private void showResponse(final String response){
        //Android不允许在子线程中进行UI操作
        //需要通过该方法将线程切换到主线程，然后再更新UI元素
        runOnUiThread(new Runnable() {
            @Override
            public void run() {
                textView.setText(response);
            }
        });
    }
}