首页 > 代码库 > Android官方API翻译——HttpURLConnection

Android官方API翻译——HttpURLConnection

人工翻译,水平有限,欢迎指正交流

原文地址:http://developer.android.com/reference/java/net/HttpURLConnection.html

-------------------------------------------------------------------

继承自java.net.URLConnection

适用于HTTP(RFC 2616)的URLConnection,用于在网络上发送和接受数据。这个类可以用来发送或者接受那些事先不知道长度的流式数据。

可以采用如下方式使用这个类:

1.通过调用URL.openConnection()方法,再执行强制类型转换获取HttpURLConnection实例。

2.准备请求。一个网络请求的主要组成部分就是URI,请求头也可能包含凭证、首选内容类型、Session Cookies等数据。

3.请求体是可选的上传内容,一个HttpURLConnection对象要想携带请求体必须设置setDoOutput(true)。通过写入getOutputStream()返回的流来传输数据。

4.读取响应。响应数据的头部通常包含有例如数据内容类型、长度、修改日期以及Session Cookies等元数据。响应数据可以通过getInputStream()返回的流来读取。如果没有响应数据,这个方法会返回一个空的流。

5.断开连接。一旦返回的数据读取完毕,HttpURLConnection应该通过调用disconnect()被关闭。断开连接会释放连接使用的资源,以使这些资源被关闭或回收。

例如,获取http://www.android.com/的网页数据代码如下:

1 URL url = new URL("http://www.android.com/");2    HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection();3    try {4      InputStream in = new BufferedInputStream(urlConnection.getInputStream());5      readStream(in);6     finally {7      urlConnection.disconnect();8    }9  }

HTTPS安全通信

调用openConnection()时如果URL前缀是https可以获得一个HttpsURLConnection实例,可以重写默认的HostnameVerifier和SSLSocketFactory。一个应用程序提供的从SSLConext创建出的SSLSocketFactory可以提供一个自定义用于验证证书链的X509TrustManager和一个自定义用于提供终端证书的X509KeyManager。详细内容会在HttpsURLConnection中介绍。

处理响应

HttpURLConnection至多会支持五次HTTP重定向,能够跟随重定向从一个原始服务器指向另一个服务器。但是不支持从HTTPS到HTTP的重定向,反之亦然。

如果HTTP响应显示发生错误,getInputStream()会抛出IOException异常。通过getErrorStream()可以读取错误信息。头部数据通常可以通过getHeaderFields()读取。

发送数据

要上传数据到web服务器,需要通过setDoOutput(true)将connection设置为用于输出。

为了达到最佳的性能,你应该:

如果数据长度已知,设置setFixedLengthStreamingMode(int)

如果数据长度未知,设置setChunkStramingMode(int)

否则,HttpURLConnection会强制在传输数据前将整个请求体缓存于内存中,浪费(或有可能耗尽)堆空间并且增大延迟。

上传数据的示例代码如下:

 1 HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection(); 2    try { 3      urlConnection.setDoOutput(true); 4      urlConnection.setChunkedStreamingMode(0); 5  6      OutputStream out = new BufferedOutputStream(urlConnection.getOutputStream()); 7      writeStream(out); 8  9      InputStream in = new BufferedInputStream(urlConnection.getInputStream());10      readStream(in);11     finally {12      urlConnection.disconnect();13    }14  }

 性能

通过本类获取的输入和输出流不会被缓存。大多数调用时都应该通过BufferedInputStream或BufferedOutputStream来封装返回的原始流。批量读取或写入的调用或可忽略缓存。

当与服务器有大量数据传输时,应使用流来限制内存中同一时间内数据量。除非你需要一次性将所有数据存入内存,将其按照一整个流来处理(而不是将数据视为byte或字符串数组来排序)。

为了减少延迟,HttpURLConnection可以在处理多种请求/响应时使用相同的底层Socket。这导致的结果就是HTTP连接的开启时间可能会比需要的更长。调用disconnect()可能将这个socket返回至一个存有已连接Socket的池中。为了避免这种现象,可以在发出任何HTTP请求前将系统属性http.keepAlive设置为false。http.maxConnections可以用来控制针对每一个服务器会有多少闲置连接被保持。

默认情况下,HttpURLConnection的这种实现会要求服务器使用gzip压缩。所以,虽然getContentLength()能够返回传输的比特数,但你不应依赖这个方法来预计从getInputStream()可以获得的字节数。相反地,你应该一直从流中读取数据直到读完为止,也就是当read()返回-1时。Gzip压缩可以在请求头部的accept encoding出进行设置以禁用:

1 urlConnection.setRequestProperty("Accept-Encoding", "identity");

处理网络登录

有些Wi-Fi网络需要用户登录才能提供正常服务。此类登录页面通常通过HTTP重定向实现。你可以通过getURL()来测试你的连接是否被异常重定向。在请求的头部数据被接收到之前,这个方法是无效的,你可以通过getHeaderFields()或getInputStream()来触发头部数据被接收的操作。

下面是一段检测请求是否被重定向至其他主机的代码:

 1 HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection(); 2    try { 3      InputStream in = new BufferedInputStream(urlConnection.getInputStream()); 4      if (!url.getHost().equals(urlConnection.getURL().getHost())) { 5        // we were redirected! Kick the user out to the browser to sign on? 6       7      ... 8    } finally { 9      urlConnection.disconnect();10    }11  }

HTTP认证

HttpURLConnection支持Http基础认证。使用Authenticator来设置VM级的认证处理器:

   Authenticator.setDefault(new Authenticator() {     protected PasswordAuthentication getPasswordAuthentication() {       return new PasswordAuthentication(username, password.toCharArray());        }); }

除非与HTTPS搭配使用,这并不是一种安全的用户认证机制。特别需要注意的是,通过网络传输的用户名、密码、请求数据和响应数据都是未加密的。

-未完待续

Android官方API翻译——HttpURLConnection