Android 网络（二） HttpURLConnection用法解析

前言

前一篇文章中，我们了解了HTTP协议的必备知识，这一篇我们还是从基础入手，介绍一下Java的HttpURLConnection，它虽基础，但却很重要，许多网络框架都是基于它开发的，因此我们还是要好好的学一下关于HttpURLConnection的使用。

相关文章

Android 网络（一） HTTP协议
Android 网络（三） Volley使用解析
Android 网络（四） Volley源码解析
Android 网络（五） OkHttp用法解析
Android 网络（六） OkHttp源码解析
Android 网络（七） Retrofit用法解析
Android 网络（八） Retrofit源码解析

对HTTP协议相关知识如请求报头、请求数据、请求方法(POST和GET的区别)等有疑问的同学，建议先阅读Android 网络（一） HTTP协议，了解基础知识后，再阅读本文

HttpURLConnection简介

敲黑板！Google建议我们使用HttpURLConnection类发送HTTP请求，它的重要性，不用我多说了吧。
HttpURLConnection是URLConnection的子类，后者在Google官方文档中的定义是这样的

The abstract class URLConnection is the superclass of all classes that represent a communications link between the application and a URL. Instances of this class can be used both to read from and to write to the resource referenced by the URL.

简单说，URLConnection是一个抽象类，表示指向URL制定资源的活动链接，其本身依赖于Socket类实现网络连接。
而HttpURLConnection从字面上就能猜到它是干什么的了。没错，这个类用来实现基于HTTP URL的请求、响应功能，每个HttpURLConnection实例都可用于生成单个网络请求，支持GET、POST、PUT、DELETE等方式，最常用的也就是GET和POST，本文也将就这两种请求方式进行讲解。

Android SDK对HTTP的支持除了上面HttpURLConnection，原本还有另外一个常用的接口，Apache接口--HttpClient，但是优于其API数量过多、扩展困难等缺点，Google在Android 6.0(API 23)中移除了HttpClient，标志着Google正式启用此功能。

基本流程

1. 获取HttpURLConnection实例：调用URL.openConnection()，并进行转型。
2. 设置请求报头：最重要的部分是URI，同时也包括元数据，内容类型，cookies等。
3. 设置请求数据(POST方式时需要此步)：如果含有请求数据，那么实例需要调用setDoOutPut(true)。通过写入getOutputStream()返回的流来传输数据。
4. 读取响应数据：包括响应报头，以及响应报文。响应报文通过getInputStream()返回的流中读取。
5. 断开连接：disconnect()

当然，涉及到网络访问，我们需要在Manifest文件中添加网络访问权限

GET请求的使用方法

示例如下：

private void useGet(String requestUrl) {
        try {
            //接收响应报文
            textShow = new StringBuilder("This is 'GET' " + "\n");
            //URL对象
            URL url = new URL(requestUrl);
            //获取HttpURLConnection实例
            mConnection = (HttpURLConnection) url.openConnection();
            //设置GET请求方法
            mConnection.setRequestMethod(METHOD_GET);
            //建立连接
            mConnection.connect();
            //根据响应码判断连接是否成功
            if (mConnection.getResponseCode() == HttpURLConnection.HTTP_OK){
                //将响应流转换成字符串
                BufferedReader reader = new BufferedReader(new InputStreamReader(mConnection.getInputStream()));
                String line = "";
                while ((line = reader.readLine())!=null){
                    textShow.append(line);
                }
            }
            //子线程更新UI的其中一种方式
            runOnUiThread(new Runnable() {
                @Override
                public void run() {
                    mTextView.setText(textShow);
                }
            });
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

注意事项：

• HttpURLConnection是同步的请求，必须放在子线程
• 对请求行、请求报头的设置必须放在connection.connect()前
• connection.getInputStream()得到一个流对象，而不是数据；从这个流对象中只能读取一次数据，第二次读取时将会得到空数据
• 子线程不能直接更新UI，需要借助一些手段，如runOnUiThread()、Handler、HanderThread等

POST请求的使用方法

示例如下：

private void usePostParams(String requestUrl){
        try {
            URL url = new URL(requestUrl);
            mConnection = (HttpURLConnection) url.openConnection();
            //设置链接超时时间
            mConnection.setConnectTimeout(10000);
            //设置读取超时时间
            mConnection.setReadTimeout(15000);
            //设置请求方法
            mConnection.setRequestMethod(METHOD_POST);
            //添加Header
            mConnection.setRequestProperty("Connection","keep-Alive");
            //接受输入流
            mConnection.setDoInput(true);

            //有请求数据时，必须开启此项！
            mConnection.setDoOutput(true);
            //POST不支持缓存
            mConnection.setUseCaches(false);

            mConnection.connect();

            //传输'请求数据'
            String body = "userName=whdalive&password=123456";
            BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(mConnection.getOutputStream(),"UTF-8"));
            writer.write(body);
            writer.flush();
            writer.close();

            textShow = new StringBuilder("This is 'POST with PARAMS' " + "\n");
            if (mConnection.getResponseCode() == HttpURLConnection.HTTP_OK){
                InputStream inputStream = mConnection.getInputStream();
                BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream));
                String line = "";
                while ((line=reader.readLine())!=null){
                    textShow.append(line);
                }
            }
            runOnUiThread(new Runnable() {
                @Override
                public void run() {
                    mTextView.setText(textShow);
                }
            });
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

注意事项：

• POST请求和GET请求有很多相似，除了上面提到的GET方法的注意事项以外，还需要注意连接之前额外加入的一些设置，如：

  • POST方式不支持缓存，必须调用mConnection.setUseCaches(false)
  • 有请求数据时，必须调用mConnection.setDoInput(true)

• POST传输JSON数据：在请求头中设置参数类型是JSON格式，并传入JSON格式的字符串到body即可。

• POST上传文件：在请求头中设置参数类型是FILE类型，并将文件封装成一个流传入body即可。

• POST同时上传参数和文件：原理和上述无二，只不过由于没有直接同时上传参数和文件的API，需要我们手动完成数据的封装。

• POST方式传递参数/JSON/文件等数据的本质：从连接中得到一个输出流，通过输出流把相应数据(键值对参数/JSON/文件等)写到服务器

应用举例-下载图片

示例如下：

 private void downloadPic(String requestUrl){
      try {
          //获取网络图片的URL
          URL url = new URL(requestUrl);
          //获取HttpURLConnection实例
          mConnection = (HttpURLConnection) url.openConnection();
          //设置POST方式
          //下载图片这个场景中，POST和GET都可以
          mConnection.setRequestMethod(METHOD_POST);
          //接受输入流
          mConnection.setDoInput(true);

          mConnection.setDoOutput(true);
          //POST方式不支持缓存
          mConnection.setUseCaches(false);
          //建立连接
          mConnection.connect();
          //获取响应流
          InputStream in = mConnection.getInputStream();
          //将响应流转换成Bitmap
          final Bitmap bitmap = BitmapFactory.decodeStream(in);
          //子线程更新UI，显示图片
          runOnUiThread(new Runnable() {
              @Override
              public void run() {
                mImageView.setImageBitmap(bitmap);
              }
          });
      }catch (Exception e){
          e.printStackTrace();
      }
    }

注意事项：

• 下载图片和其他类型数据本质是一样的：
  得到响应流，从流中读出数据，对不同类型数据采取不同处理方式
• 建议自己动手实践一下，体会各个应用场景下不同数据的处理方式。

---

总结

• 本文详细介绍了HttpURLConnection的使用。
• 笔者水平有限，如有错漏，欢迎指正。
• 接下来我将持续推出Android网络相关的一系列文章，包括HttpURLConnection、Volley、OkHttp3、Retrofit2的使用等，有兴趣可以关注whd_Alive的Android开发笔记

---

欢迎关注whd_Alive的

• 不定期分享Android开发相关的技术干货，期待与你的交流，共勉。