本文翻译自android官方文档,经验证整理如下。
HttpURLConnection是继承抽象类URLConnection的一个子抽象类,一个HTTP协议通信的URLConnection能够在网络上发送和接收数据,数据类型不受限制。HttpURLConnection也可以接受或发送长度未知的数据流。
HttpURLConnection进行HTTP通信的步骤如下:
URL.openConnection()
获取HTTPURLConncetion实例,当然这需要强制转换为该实例,会抛出IOException异常;setDoOutput(true)
配置。通过getOutputStream()
将数据发送。 setRequestMethod()
设置,常用的方法为GET
和POST
。GET
表示从服务器中获取数据,POST
表示向服务器提交数据。默认情况为GET
,而通过setDoOutput(true)
配置则和POST
一样。getInputStream()
获取响应体,若没有响应体的话返回空输入流。disconnect()
断开连接,释放资源。例如下面代码:
public void sendRequestWithHTTP(View view){
URL url = null;
HttpURLConnection connection = null;
BufferedReader br = null;
try {
// 1.创建URL对象
url = new URL("http://blog.csdn.net/wangyongge85");
// 2.获取HttpURLConnection对象
connection = (HttpURLConnection) url.openConnection();
// 3.若要发送请求体的话,设置下列方法
//connection.setDoOutput(true);
// 4. 读取响应
br = new BufferedReader(new InputStreamReader(connection.getInputStream()));
StringBuilder stringBuilder = new StringBuilder();
String temp = null;
while ((temp = br.readLine()) != null) {
stringBuilder.append(temp);
}
Log.d(TAG, stringBuilder.toString());
// 注意抛出异常的顺序,先是MalformedURLException
} catch (MalformedURLException e2) {
e2.printStackTrace();
}catch (IOException e) {
e.printStackTrace();
} finally {
// 5.关闭连接
try {
br.close();
connection.disconnect();
} catch (IOException e) {
e.printStackTrace();
}
}
}
需要注意的是:避免在主线程中直接获取网络数据更新UI,这是因为获取数据的过程通常来说是非常耗时的。我们应在子线程中获取数据,但是我们知道在子线程中无法更新UI,因此需要异步处理,关于这部分可以参考我之前的文章:
若响应出现错误的情况下,getInputStream()
会抛出IOException,可以通过getErrorStream()
(返回InputStream类型)获取错误异常。而头文件可以正常的通过getHeaderFields()
获取。
为了能够给服务器上传数据,需要配置setDoOutput(true)
。为了最佳性能,当发送的内容长度已知时应该调用setFixedLengthStreamingMode(int/long)
设置长度,或者在不知道长度的情况下设置setChunedStreamingMode(int)
(参数为默认发送的块大小)。否则,在被传输前,HttpURLConnection将请求体全部内容缓存在内存,导致浪费内存甚至全部占有,也会增加延迟。
该类的输入输出不会缓存。因此调用者通常需要通过BufferedInputStream or BufferedOutputStream
处理流。只有大量的读写操作才可能不用缓冲。
当进行大量的数据传输的时候,在内存中流应该限制一次读写的容量。除非我们需要一次性读写整个内容体(作为一个流处理,而不是先保存在数组或String中)。
为了减少延迟,对于多次请求/响应,该类可能要重复使用相同的底层Socket。因此可能导致HTTP连接的时间长于实际需要的时间。调用disconnect()
可能将socket发送到连接的socket池里。在执行任何HTTP请求之前通过设置http.keepAlive系统属性为false能够禁用该方法(如System.setProperty(“http.keepAlive”, “false”))。http.maxConnections属性能够用于控制每个server空闲连接的数量。
默认情况下HttpURLConnection要求服务器使用gzip压缩。getContentLength()
方法能够返回传递的字节数,我们不能使用该方法预测通过getInputStream()
读取的字节数。而是直到read()
返回-1时才停止读取。通过在请求头设置下列可接受的编码,gzip压缩能够被禁用:
urlConnection.setRequestProperty("Accept-Encoding", "identity");
一些Wi-Fi网络可能阻塞网络连接,直到用户通过登陆页面点击时才能够连接。这种登陆页面是通过HTTP重定向呈现的。我们可以使用getURL()
测试是否我们的连接被重定向了。这种检查若在收到响应头之后被执行的话将会失效,getHeaderFields()
或getInputStream()
来触发。例如下面检查主机是否被重定向:
HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection();
try {
InputStream in = new BufferedInputStream(urlConnection.getInputStream());
if (!url.getHost().equals(urlConnection.getURL().getHost())) {
// 转移到其他app中了
...
} finally {
urlConnection.disconnect();
}
}
HttpURLConnection支持HTTP基本认证。使用抽象类Authenticator能够设置VM-wide认证:
Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication(username, password.toCharArray());
});
}
除非搭配使用HTTPS,否则这对于用户认证来说不是一个安全的机制。这是因为用户名,密码,请求体和响应体在网络上传输没有任何的加密措施。
为了能够在客户端和服务器端建立和维持长时间的潜在连接,HttpURLConnection包含了一个扩展的cookie管理。如下使用CookieHandler和CookieManager:
CookieManager cookieManager = new CookieManager();
CookieHandler.setDefault(cookieManager);
默认情况下,CookieManager只从server接收cookies。其它情况包括:ACCEPT_ALL和ACCEPT_NONE。可以通过实现接口CookiePolicy来自定义管理方案。
默认的CookieManager在内存中保存所有接收到的cookie。当退出连接时,就会清除这些cookies,可以通过实现接口CookieStore来自定义cookie存储。
cookie通过http响应设置,我们也可以代码设置cookies,为了包含在http请求头里,cookie必须要设置作用范围和路径(下面有例子)。
默认情况下,HttpCookie实例只和支持RFC 2965cookies的服务器起作用。但是其他很多网站服务器只支持老的版本RFC 2109。为了实现兼容,可以设置cookie版本为0。
如下:
HttpCookie cookie = new HttpCookie("lang", "fr");
cookie.setDomain("http://blog.csdn.net/wangyongge85");
cookie.setPath("/");
cookie.setVersion(0);
cookieManager.getCookieStore().add(new URI("http://blog.csdn.net/wangyongge85"), cookie);
HttpURLConnection默认使用GET方法,若设置setDoOutput(true)
则使用POST
方法。其它HTTP方法(OPTIONS,HEAD,PUT,DELETE,TRACE)可以使用`setRequestMethod(String)方法设置。
默认情况下,该类直接和原始客户端连接,我们也可以通过HTTP或SOCKS代理连接。可以在创建连接时使用URL.openConnection(Proxy)
设置代理。
该类支持IPv6。对于同时有IPv4和IPv6的主机来说它会试图连接主机的每一个地址直到连接成功。
Android 4.0(API level 15) 包括响应缓存,可以通过android.net.http.HttpResponseCache设置。
每个HttpURLConnection实例可能只是使用一次请求/响应。实例是线程不安全的。