如何使用 java.net.URLConnection 来触发和处理 HTTP 请求

^{首先是免责声明：发布的代码片段都是基本示例。你需要自己处理琐碎的IOException和RuntimeException，如NullPointerException，ArrayIndexOutOfBoundsException和consorts。}

^{如果您使用的是Android而不是Java，另请注意，自API级别28引入以来，默认情况下禁用明文HTTP请求。我们鼓励您使用 HttpsURLConnection，但如果确实有必要，可以在应用程序清单中启用明文。}

准备

我们首先需要知道至少URL和字符集。这些参数是可选的，取决于功能要求。

String url = "http://example.com";
String charset = "UTF-8";  // Or in Java 7 and later, use the constant: java.nio.charset.StandardCharsets.UTF_8.name()
String param1 = "value1";
String param2 = "value2";
// ...

String query = String.format("param1=%s&param2=%s",
    URLEncoder.encode(param1, charset),
    URLEncoder.encode(param2, charset));

查询参数必须采用格式并由 连接。通常还会使用 URLEncoder#encode（） 使用指定的字符集对查询参数进行 URL 编码。name=value&

^{String#format（） 只是为了方便起见。当我需要字符串串联运算符+两次以上时，我更喜欢它。}

使用（可选）查询参数触发 HTTP GET 请求

这是一项微不足道的任务。这是默认的请求方法。

URLConnection connection = new URL(url + "?" + query).openConnection();
connection.setRequestProperty("Accept-Charset", charset);
InputStream response = connection.getInputStream();
// ...

任何查询字符串都应使用 连接到 URL。Accept-Charset 标头可能会提示服务器参数的编码。如果不发送任何查询字符串，则可以保留标头。如果您不需要设置任何标头，则甚至可以使用URL#openStream（）快捷方式方法。?Accept-Charset

InputStream response = new URL(url).openStream();
// ...

无论哪种方式，如果另一端是HttpServlet，那么它将调用它的doGet（）方法，并且参数将由HttpServletRequest#getParameter（）提供。

出于测试目的，您可以将响应正文打印为标准输出，如下所示：

try (Scanner scanner = new Scanner(response)) {
    String responseBody = scanner.useDelimiter("\\A").next();
    System.out.println(responseBody);
}

使用查询参数触发 HTTP POST 请求

将 URLConnection#setDoOutput（） 设置为隐式将请求方法设置为 POST。Web表单的标准HTTP POST是一种类型，其中查询字符串被写入请求正文。trueapplication/x-www-form-urlencoded

URLConnection connection = new URL(url).openConnection();
connection.setDoOutput(true); // Triggers POST.
connection.setRequestProperty("Accept-Charset", charset);
connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded;charset=" + charset);

try (OutputStream output = connection.getOutputStream()) {
    output.write(query.getBytes(charset));
}

InputStream response = connection.getInputStream();
// ...

注意：每当你想以编程方式提交HTML表单时，不要忘记将任何元素的对放入查询字符串中，当然还要将您要以编程方式“按下”的元素对（因为这通常在服务器端用于区分是否按下了按钮，如果是这样， 哪一个）。name=value<input type="hidden">name=value<input type="submit">

您还可以将获得的 URLConnection 转换为 HttpURLConnection，并改用其 HttpURLConnection#setRequestMethod（）。但是，如果您尝试使用连接进行输出，您仍然需要将URLConnection#setDoOutput（）设置为。true

HttpURLConnection httpConnection = (HttpURLConnection) new URL(url).openConnection();
httpConnection.setRequestMethod("POST");
// ...

无论哪种方式，如果另一端是HttpServlet，那么它将调用它的doPost（）方法，并且参数将由HttpServletRequest#getParameter（）提供。

实际触发 HTTP 请求

您可以使用 URLConnection#connect（） 显式触发 HTTP 请求，但是当您想要获取有关 HTTP 响应的任何信息（例如使用 URLConnection#getInputStream（） 的响应正文等）时，请求将自动按需触发。上面的例子正是这样做的，所以这个调用实际上是多余的。connect()

收集 HTTP 响应信息

1. HTTP 响应状态：

你需要一个 HttpURLConnection 在这里。如有必要，请先施放。

    int status = httpConnection.getResponseCode();

2. HTTP 响应标头：

    for (Entry<String, List<String>> header : connection.getHeaderFields().entrySet()) {
        System.out.println(header.getKey() + "=" + header.getValue());
    }
   

3. HTTP 响应编码：

当 包含参数时，则响应正文可能是基于文本的，我们希望使用服务器端指定的字符编码来处理响应正文。Content-Typecharset

    String contentType = connection.getHeaderField("Content-Type");
    String charset = null;

    for (String param : contentType.replace(" ", "").split(";")) {
        if (param.startsWith("charset=")) {
            charset = param.split("=", 2)[1];
            break;
        }
    }

    if (charset != null) {
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(response, charset))) {
            for (String line; (line = reader.readLine()) != null;) {
                // ... System.out.println(line)?
            }
        }
    } else {
        // It's likely binary content, use InputStream/OutputStream.
    }

维护会话

服务器端会话通常由 Cookie 提供支持。某些 Web 表单要求您登录和/或被会话跟踪。您可以使用 CookieHandler API 来维护 Cookie。在发送所有HTTP请求之前，您需要准备一个包含ACCEPT_ALL CookiePolicy的CookieManager。

// First set the default cookie manager.
CookieHandler.setDefault(new CookieManager(null, CookiePolicy.ACCEPT_ALL));

// All the following subsequent URLConnections will use the same cookie manager.
URLConnection connection = new URL(url).openConnection();
// ...

connection = new URL(url).openConnection();
// ...

connection = new URL(url).openConnection();
// ...

请注意，众所周知，这并非在所有情况下都能正常工作。如果它失败了，那么最好的方法是手动收集并设置cookie标头。您基本上需要从登录名或第一个请求的响应中获取所有标头，然后通过后续请求传递此标头。Set-CookieGET

// Gather all cookies on the first request.
URLConnection connection = new URL(url).openConnection();
List<String> cookies = connection.getHeaderFields().get("Set-Cookie");
// ...

// Then use the same cookies on all subsequent requests.
connection = new URL(url).openConnection();
for (String cookie : cookies) {
    connection.addRequestProperty("Cookie", cookie.split(";", 2)[0]);
}
// ...

这是为了摆脱与服务器端无关的cookie属性，如，等。或者，您也可以使用 代替 。split(";", 2)[0]expirespathcookie.substring(0, cookie.indexOf(';'))split()

流式传输模式

默认情况下，HttpURLConnection 将在实际发送请求正文之前缓冲整个请求正文，无论您是否使用 设置了固定的内容长度。每当您同时发送大型 POST 请求（例如上传文件）时，这可能会导致 s。为了避免这种情况，您需要设置 HttpURLConnection#setFixedLengthStreamingMode（）。connection.setRequestProperty("Content-Length", contentLength);OutOfMemoryException

httpConnection.setFixedLengthStreamingMode(contentLength);

但是，如果事先确实不知道内容长度，那么您可以通过相应地设置HttpURLConnection#setChunkedStreamingMode（）来使用分块流模式。这将设置 HTTP 传输编码标头，该标头将强制以块的形式发送请求正文。下面的示例将以 1 KB 的块形式发送正文。chunked

httpConnection.setChunkedStreamingMode(1024);

用户代理

可能会发生请求返回意外响应的情况，而它适用于真正的Web浏览器。服务器端可能正在根据用户代理请求标头阻止请求。默认情况下，Will 会将其设置为最后一个部分显然是 JRE 版本的位置。您可以按如下方式覆盖它：URLConnectionJava/1.6.0_19

connection.setRequestProperty("User-Agent", "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"); // Do as if you're using Chrome 41 on Windows 7.

使用最近浏览器中的用户代理字符串。

错误处理

如果 HTTP 响应代码为（客户端错误）或（服务器错误），则可能需要读取 ，以查看服务器是否已发送任何有用的错误信息。4nn5nnHttpURLConnection#getErrorStream()

InputStream error = ((HttpURLConnection) connection).getErrorStream();

如果 HTTP 响应代码为 -1，则连接和响应处理出现问题。该实现在较旧的JRE中有些错误，以保持连接处于活动状态。您可能希望通过将系统属性设置为 来关闭它。您可以在应用程序开始时通过以下方式以编程方式执行此操作：HttpURLConnectionhttp.keepAlivefalse

System.setProperty("http.keepAlive", "false");

上传文件

您通常对混合 POST 内容（二进制和字符数据）使用多部分/表单数据编码。RFC2388 中更详细地描述了编码。

String param = "value";
File textFile = new File("/path/to/file.txt");
File binaryFile = new File("/path/to/file.bin");
String boundary = Long.toHexString(System.currentTimeMillis()); // Just generate some unique random value.
String CRLF = "\r\n"; // Line separator required by multipart/form-data.
URLConnection connection = new URL(url).openConnection();
connection.setDoOutput(true);
connection.setRequestProperty("Content-Type", "multipart/form-data; boundary=" + boundary);

try (
    OutputStream output = connection.getOutputStream();
    PrintWriter writer = new PrintWriter(new OutputStreamWriter(output, charset), true);
) {
    // Send normal param.
    writer.append("--" + boundary).append(CRLF);
    writer.append("Content-Disposition: form-data; name=\"param\"").append(CRLF);
    writer.append("Content-Type: text/plain; charset=" + charset).append(CRLF);
    writer.append(CRLF).append(param).append(CRLF).flush();

    // Send text file.
    writer.append("--" + boundary).append(CRLF);
    writer.append("Content-Disposition: form-data; name=\"textFile\"; filename=\"" + textFile.getName() + "\"").append(CRLF);
    writer.append("Content-Type: text/plain; charset=" + charset).append(CRLF); // Text file itself must be saved in this charset!
    writer.append(CRLF).flush();
    Files.copy(textFile.toPath(), output);
    output.flush(); // Important before continuing with writer!
    writer.append(CRLF).flush(); // CRLF is important! It indicates end of boundary.

    // Send binary file.
    writer.append("--" + boundary).append(CRLF);
    writer.append("Content-Disposition: form-data; name=\"binaryFile\"; filename=\"" + binaryFile.getName() + "\"").append(CRLF);
    writer.append("Content-Type: " + URLConnection.guessContentTypeFromName(binaryFile.getName())).append(CRLF);
    writer.append("Content-Transfer-Encoding: binary").append(CRLF);
    writer.append(CRLF).flush();
    Files.copy(binaryFile.toPath(), output);
    output.flush(); // Important before continuing with writer!
    writer.append(CRLF).flush(); // CRLF is important! It indicates end of boundary.

    // End of multipart/form-data.
    writer.append("--" + boundary + "--").append(CRLF).flush();
}

如果另一端是 HttpServlet，则将调用其 doPost（） 方法，并且这些部件将由 HttpServletRequest#getPart（） 提供（注意，因此不是，依此类推！然而，这种方法相对较新，它在Servlet 3.0（Glassfish 3，Tomcat 7等）中引入。在Servlet 3.0之前，你最好的选择是使用Apache Commons FileUpload来解析请求。另请参阅此答案，了解 FileUpload 和 Servelt 3.0 方法的示例。getParameter()getPart()multipart/form-data

处理不可信或配置错误的 HTTPS 站点

^{如果您使用的是Android而不是Java，请小心：如果您在开发过程中没有部署正确的证书，下面的解决方法可能会节省您的一天。但是您不应该将其用于生产。如今（2021 年 4 月），如果 Google 检测到不安全的主机名验证程序，则 Google 将不允许在 Play 商店中分发您的应用，请参阅 https://support.google.com/faqs/answer/7188426。}

有时您需要连接HTTPS URL，也许是因为您正在编写Web抓取工具。在这种情况下，您可能会在某些HTTPS站点上遇到不保持其SSL证书最新的HTTPS站点，或者在某些配置错误的HTTPS站点上。javax.net.ssl.SSLException: Not trusted server certificatejava.security.cert.CertificateException: No subject alternative DNS name matching [hostname] foundjavax.net.ssl.SSLProtocolException: handshake alert: unrecognized_name

Web 抓取程序类中的以下一次性运行初始值设定项应该对这些 HTTPS 站点更加宽松，因此不再引发这些异常。staticHttpsURLConnection

static {
    TrustManager[] trustAllCertificates = new TrustManager[] {
        new X509TrustManager() {
            @Override
            public X509Certificate[] getAcceptedIssuers() {
                return null; // Not relevant.
            }
            @Override
            public void checkClientTrusted(X509Certificate[] certs, String authType) {
                // Do nothing. Just allow them all.
            }
            @Override
            public void checkServerTrusted(X509Certificate[] certs, String authType) {
                // Do nothing. Just allow them all.
            }
        }
    };

    HostnameVerifier trustAllHostnames = new HostnameVerifier() {
        @Override
        public boolean verify(String hostname, SSLSession session) {
            return true; // Just allow them all.
        }
    };

    try {
        System.setProperty("jsse.enableSNIExtension", "false");
        SSLContext sc = SSLContext.getInstance("SSL");
        sc.init(null, trustAllCertificates, new SecureRandom());
        HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
        HttpsURLConnection.setDefaultHostnameVerifier(trustAllHostnames);
    }
    catch (GeneralSecurityException e) {
        throw new ExceptionInInitializerError(e);
    }
}

最后的话

Apache HttpComponents HttpClient在这一切中更加方便:)

• HttpClient Tutorial
• 客户端示例

解析和提取 HTML

如果您想要的只是从HTML解析和提取数据，那么最好使用像Jsoup这样的HTML解析器。

• Java中领先的HTML解析器的优缺点是什么
• 如何在Java中扫描和提取网页

在使用HTTP时，它几乎总是比基类更有用（因为当你在HTTP URL上请求时，它是一个抽象类，无论如何你都会得到的）。HttpURLConnectionURLConnectionURLConnectionURLConnection.openConnection()

然后，您可以不依赖于隐式将请求方法设置为POST，而是执行某些人可能会发现更自然的事情（并且还允许您指定其他请求方法，例如PUT，DELETE，...）。URLConnection#setDoOutput(true)httpURLConnection.setRequestMethod("POST")

它还提供了有用的HTTP常量，因此您可以执行以下操作：

int responseCode = httpURLConnection.getResponseCode();

if (responseCode == HttpURLConnection.HTTP_OK) {