HttpURLConnection简介
在JDK的 java.net
包中已经提供了访问HTTP协议的基本功能的类:HttpURLConnection
。
HttpURLConnection
是Java的标准类,它继承自URLConnection
,可用于向指定网站发送GET请求、POST请求。
它在URLConnection的基础上提供了如下便捷的方法:
int getResponseCode(); // 获取服务器的响应代码。
String getResponseMessage(); // 获取服务器的响应消息。
String getResponseMethod(); // 获取发送请求的方法。
void setRequestMethod(String method); // 设置发送请求的方法。
HttpURLConnection使用
- 使用GET方式访问HTTP
package com.qf.demo;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
/**
* GET请求示例*/
public class GetDemo {
public static void main(String[] args) {
try {
// 1. 得到访问地址的URL
URL url = new URL("http://localhost:8080/Servlet/do_login.do?username=test&password=123456");
// 2. 得到网络访问对象java.net.HttpURLConnection
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
/* 3. 设置请求参数(过期时间,输入、输出流、访问方式),以流的形式进行连接 */
// 设置是否向HttpURLConnection输出
connection.setDoOutput(false);
// 设置是否从HttpUrlConnection读入
connection.setDoInput(true);
// 设置请求方式
connection.setRequestMethod("GET");
// 设置是否使用缓存
connection.setUseCaches(true);
// 设置此 HttpURLConnection 实例是否应该自动执行 HTTP 重定向
connection.setInstanceFollowRedirects(true);
// 设置超时时间
connection.setConnectTimeout(3000);
// 连接
connection.connect();
// 4. 得到响应状态码的返回值 responseCode
int code = connection.getResponseCode();
// 5. 如果返回值正常,数据在网络中是以流的形式得到服务端返回的数据
String msg = "";
if (code == 200) { // 正常响应
// 从流中读取响应信息
BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
String line = null;
while ((line = reader.readLine()) != null) { // 循环从流中读取
msg += line + "\n";
}
reader.close(); // 关闭流
}
// 6. 断开连接,释放资源
connection.disconnect();
// 显示响应结果
System.out.println(msg);
} catch (IOException e) {
e.printStackTrace();
}
}
}
- 使用POST方式访问HTTP
package com.qf.demo;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
/**
* POST请求示例*/
public class PostDemo {
public static void main(String[] args) {
try {
// 1. 获取访问地址URL
URL url = new URL("http://localhost:8080/Servlet/do_login.do");
// 2. 创建HttpURLConnection对象
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
/* 3. 设置请求参数等 */
// 请求方式
connection.setRequestMethod("POST");
// 设置连接超时时间
connection.setConnectTimeout(3000); // 设置是否向 HttpUrlConnection 输出,对于post请求,参数要放在 http 正文内,因此需要设为true,默认为false。
connection.setDoOutput(true);
// 设置是否从 HttpUrlConnection读入,默认为true
connection.setDoInput(true);
// 设置是否使用缓存
connection.setUseCaches(false);
// 设置此 HttpURLConnection 实例是否应该自动执行 HTTP 重定向
connection.setInstanceFollowRedirects(true);
// 设置使用标准编码格式编码参数的名-值对
connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); // 添加 HTTP HEAD 中的一些参数。 // JDK8中,HttpURLConnection默认开启Keep-Alive
// connection.setRequestProperty("Connection", "Keep-Alive");
// 连接
connection.connect();
/* 4. 处理输入输出 */
// 写入参数到请求中
String params = "username=test&password=123456";
OutputStream out = connection.getOutputStream();
out.write(params.getBytes());
out.flush();
out.close();
// 从连接中读取响应信息
String msg = "";
int code = connection.getResponseCode();
if (code == 200) {
BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
String line;
while ((line = reader.readLine()) != null) {
msg += line + "\n";
}
reader.close();
}
// 5. 断开连接
connection.disconnect();
// 处理结果
System.out.println(msg);
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
HttpURLConnection说明
HttpURLConnection
对象不能直接构造,需要通过URL类中的openConnection()
方法来获得。- 对
HttpURLConnection
对象的配置都需要在connect()
方法执行之前完成,因为connect()
会根据HttpURLConnection
对象的配置值生成HTTP头部信息。 HttpURLConnection
的connect()
函数,实际上只是建立了一个与服务器的TCP连接,并没有实际发送HTTP请求
。HTTP请求实际上直到我们获取服务器响应数据(如调用getInputStream()
、getResponseCode()
等方法)时才正式发送出去。HttpURLConnection
是基于HTTP协议的,其底层通过socket
通信实现。如果不设置超时(timeout),在网络异常的情况下,可能会导致程序僵死而不继续往下执行
。- HTTP正文的内容是通过
OutputStream
流写入的, 向流中写入的数据不会立即发送到网络,而是存在于内存缓冲区中,待流关闭时,根据写入的内容生成HTTP正文。 - 调用
getInputStream()
方法时,返回一个输入流,用于从中读取服务器对于HTTP请求的返回信息。
我们可以使用
HttpURLConnection.connect()
方法手动的发送一个HTTP请求,但是如果要获取HTTP响应的时候,请求就会自动的发起,比如我们使用HttpURLConnection.getInputStream()
方法的时候,所以完全没有必要调用connect()
方法。
HttpURLConnection长连接(Keep-Alive)
JDK8自带的HttpURLConnection
,默认启用keepAlive,支持HTTP / 1.1
和HTTP / 1.0
持久连接。
使用后的HttpURLConnection
会放入缓存中供以后的同host:port的请求重用,底层的socket在keepAlive超时之前不会关闭。
HttpURLConnection
受以下system properties
控制:
http.keepAlive=<boolean>(默认值:true)
,是否启用keepAlive,如果设置为false,则HttpURLConnection不会缓存,使用完后会关闭socket连接。http.maxConnections=<int>(默认值:5)
,每个目标host缓存socket连接的最大数。
说明:
- 如果在
HttpURLConnection
的header
中加入Connection: close
,则此连接不会启用keepAlive
- 想要启用keepAlive,程序请求完毕后,
必须调用HttpURLConnection.getInputStream().close()
表示归还长连接给缓存,以供下次相同host:port
的请求重用底层socket连接
而不能调用HttpURLConnection.disconnect()
表示关闭底层socket连接,不会启用keepAlivekeepAliveTimeout
首先从http response header
中获取,如果没有取到,则默认为5秒,sun.net.www.http.KeepAliveCache.java
中有一个线程,每5秒执行一次,检查缓存的连接的空闲时间是否超过keepAliveTimeout
,如果超过则关闭连接。从KeepAliveCache
中获取缓存的连接时也会检查获取到的连接的空闲时间是否超过keepAliveTimeout
,如果超过则关闭连接,并且获取下一个连接,再执行以上检查,直达获取到空闲时间在keepAliveTimeout
以内的缓存连接为此。
HttpURLConnection关闭
本身要关闭 HttpURLConnection
是很简单的,调用 connection.disconnect()
就可以了。
这里是想说明一下,是否需要关闭,应该根据实际需要来:
- 当
HttpURLConnection
是Connection: close
模式,那么关闭 inputStream 后就会自动断开连接。 - 当
HttpURLConnection
是Connection: Keep-Alive
模式,那么关闭 inputStream 后,并不会断开底层的 Socket 连接。这样的好处,是当需要连接到同一服务器地址时,可以复用该 Socket。这时如果要求断开连接,就可以调用connection.disconnect()
了。 - 当然,
HttpURLConnection
连接到底是不是 Keep-Alive 模式,除了HttpURLConnection
请求设置为Keep-Alive
外 (http 1.0中默认是关闭的,http 1.1中默认启用Keep-Alive),也需要服务器支持Keep-Alive
,才可以真正建立Keep-Alive
连接。
与HttpClient的区别
在一般情况下,如果只是需要向Web站点的某个简单页面提交请求并获取服务器响应,HttpURLConnection完全可以胜任。但在绝大部分情况下,Web站点的网页可能没这么简单,这些页面并不是通过一个简单的URL就可访问的,可能需要用户登录而且具有相应的权限才可访问该页面。
在这种情况下,就需要涉及Session、Cookie的处理了,如果打算使用HttpURLConnection来处理这些细节,当然也是可能实现的,只是处理起来难度就大了。
为了更好地处理向Web站点请求,包括处理Session、Cookie等细节问题,Apache开源组织提供了一个HttpClient项目
。看它的名称就知道它是一个简单的HTTP客户端(并不是浏览器),可以用于发送HTTP请求,接收HTTP响应。但不会缓存服务器的响应,不能执行HTML页面中嵌入的Javascript代码;也不会对页面内容进行任何解析、处理。
简单来说,HttpClient就是一个增强版的HttpURLConnection,HttpURLConnection可以做的事情HttpClient全部可以做,HttpURLConnection没有提供的有些功能,HttpClient也提供了,但它只是关注于如何发送请求、接收响应,以及管理HTTP连接。