Java中URLConnection和HttpURLConnection类

最近在做接口方面的开发，需要程序主动发送http请求，之前在.net中使用的httpclient，java中貌似java11才有的httpclient,因此项目中暂且用URLConnection对象来做发送请求对象。

URLConnection是表示Java应用程序和URL之间的连接的所有类的父类。该URLConnection的类提供API的通用网址和它的子类HttpURLConnection类提供HTTP特定功能的附加支持。

请注意，这两个类都是抽象的 - 这就意味着我们无法直接创建URLConnection和HttpURLConnection的新实例。相反，通过从URL对象打开连接来获取URLConnection的实例。

1. 创建一个URL对象
2. 从URL 获取URLConnection对象
3. 配置URLConnection
4. 阅读标题字段
5. 获取输入流并读取数据
6. 获取输出流并写入数据
7. 关闭连接

步骤3至6是可选的，步骤5和6是可互换的。

让我们根据这个序列探索URLConnection和HttpURLConnection类的API 。

配置URLConnection

在实际建立连接之前，我们可以配置影响客户端和服务器之间正在进行的通信的各个方面，例如超时，缓存，HTTP请求方法等。

该URLConnection的类提供了配置连接下面的方法：

• setConnectTimeout（int timeout）：设置连接超时（以毫秒为单位）。一个java.net.SocketTimeoutException如果超时可以建立连接之前被抛出。超时为零表示无限超时（默认值）。

• setReadTimeout（int timeout）：设置读取超时（以毫秒为单位）。超时到期后，没有可用于从连接的输入流中读取的数据，将引发SocketTimeoutException。超时为零表示无限超时（默认值）。

• setDefaultUseCaches（boolean default）：设置URLConnection是否默认使用缓存（默认为true）。此方法会影响URLConnection类的未来实例。

• setUseCaches（boolean useCaches）：设置此连接是否使用缓存（默认为true）。

• setDoInput（boolean doInput）：设置此URLConnection是否可用于从服务器读取内容（默认为true）。

• setDoOutput（boolean doOutput）：设置是否可以使用此URLConnection将数据发送到服务器（默认为false）。

• setIfModifiedSince（long time）：设置客户端检索的内容的最后修改时间，主要用于HTTP协议。例如，如果服务器发现内容自指定时间以来没有改变，则它不获取内容并返回状态代码304-未修改。如果客户端的修改时间超过了指定时间，则客户端将获得新鲜内容。

• setAllowUserInteraction（boolean allow）：启用或禁用用户交互，例如，如果需要，弹出一个身份验证对话框（默认为false）。

• setDefaultAllowUserInteraction（boolean default）：为所有未来的URLConnection对象设置用户交互的默认值。

• setRequestProperty（String key，String value）：设置由key = value对指定的常规请求属性。如果具有密钥的属性已存在，则旧值将被新值覆盖。

请注意，应在建立连接之前调用这些方法。如果已建立连接，则某些方法会抛出IllegalStateException。

此外，子类HttpURLConnection提供了以下用于使用HTTP特定功能配置连接的方法

• setRequestMethod（String method）：设置URL请求的方法，它是HTTP方法GET，POST，HEAD，OPTIONS，PUT，DELETE和TRACE之一。默认方法是GET（注意：这里方法类型必须大写）。

• setChunkedStreamingMode（int chunkLength）：当高级内容未知内容长度时，启用HTTP请求主体的流式传输而不进行内部缓冲。

• setFixedLengthStreamingMode（long contentLength）：当高级已知内容长度时，启用HTTP请求主体的流式传输而不进行内部缓冲。

• setFollowRedirects（boolean follow）：此静态方法设置是否应该由此类的未来对象自动跟随HTTP重定向（默认为true）。

• setInstanceFollowRedirects（boolean follow）：设置HTTP重定向是否应该自动跟随此HttpURLConnection类的实例（默认为true）。

 

阅读标题字段

建立连接后，服务器将处理URL请求并发回包含元数据和实际内容的响应。元数据是key = value对的集合，称为标题字段。

标题字段显示有关服务器，状态代码，协议信息等的信息。实际内容可以是文本，HTML，图像等，具体取决于文档的类型。

所述的URLConnection类提供用于读取头字段下面的方法：

 

• getHeaderFields（）：返回包含所有标题字段的映射。键是字段名称，值是String列表，表示相应的字段值。

• getHeaderField（int n）：读取第n个头字段的值。

• getHeaderField（String name）：读取指定头字段的值。

• getHeaderFieldKey（int n）：读取第n个头字段的键。

• getHeaderFieldDate（String name，long default）：读取解析为Date的命名字段的值。如果字段丢失或值格式错误，则返回默认值。

• getHeaderFieldInt（String name，int default）：读取被解析为整数的命名字段的值。如果字段丢失或值格式错误，则返回默认值。

• getHeaderFieldLong（String name，long default）：读取被解析为长数字的命名字段的值。如果字段丢失或值格式错误，则返回默认值。

这些是读取任何标题字段的一般方法。对于一些经常访问的头字段，URLConnection类提供了更具体的方法：

• getContentEncoding（）：读取内容编码头字段的值，该字段指示内容的编码类型。

• getContentLength（）：读取content-length头字段的值，该字段指示内容的大小（以字节为单位）。

• getContentType（）：读取content-type头字段的值，该字段指示内容的类型。

• getDate（）：读取日期标题字段的值，该字段指示服务器上的日期时间。

• getExpiration（）：读取expires头字段的值，指示响应被视为过时的时间。这是用于缓存控制。

• getLastModified（）：读取上次修改的头字段的值，该字段指示内容的上次​​修改时间。

子类HttpURLConnection提供了另一种方法：

• getResponseCode（）：返回服务器发送的HTTP状态码。

请注意，读取头字段时，将隐式建立连接，而不调用connect（）。

 

关闭连接

要关闭连接，请在InputStream或OutputStream对象上调用close（）方法。这样做可以释放与URLConnection实例关联的网络资源。

下面是一个请求的列子：

import javax.net.ssl.*;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URL;
import java.net.URLEncoder;
import java.security.cert.X509Certificate;
import java.util.Base64;
import java.util.Map;

/**
 * @Author: bo zhang
 * @Description:
 * @Date:Create：in 2018-09-28 0:01
 * @Modified By：暂无
 */
public class HttpRequest {

    //忽略证书的认证
    private static void SkipCertificateValidation() throws Exception {
        // Create a trust manager that does not validate certificate chains
        TrustManager[] trustAllCerts = new TrustManager[]{new X509TrustManager() {
            public X509Certificate[] getAcceptedIssuers() {
                return null;
            }

            public void checkClientTrusted(X509Certificate[] certs, String authType) {
            }

            public void checkServerTrusted(X509Certificate[] certs, String authType) {
            }
        }
        };
        // Install the all-trusting trust manager
        SSLContext sc = SSLContext.getInstance("SSL");
        sc.init(null, trustAllCerts, new java.security.SecureRandom());
        HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
        // Create all-trusting host name verifier
        HostnameVerifier allHostsValid = new HostnameVerifier() {
            public boolean verify(String hostname, SSLSession session) {
                return true;
            }
        };
        // Install the all-trusting host verifier
        HttpsURLConnection.setDefaultHostnameVerifier(allHostsValid);
    }

    /**
     * 请求方式
     *
     * @param urlStr 接口请求链接
     * @return get请求直接返回请求的流
     * @throws Exception
     */
    public static InputStream getRequestWithAuth(String urlStr, Map params) throws Exception {
        SkipCertificateValidation();//https请求的时候跳过证书认证（得在创建con前面才有效）
        URL url = new URL(urlStr);
        HttpsURLConnection con = (HttpsURLConnection) url.openConnection();
        con.setRequestMethod("GET");//注意这个get要大写
        /////  "GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE"  有这些方法
        con.setRequestProperty("Content-type", "application/x-www-form-urlencoded");

        //采用base auth验证方式
        /*String authEncoded = Base64.getEncoder().encodeToString((authStr).getBytes());
        con.setRequestProperty("Authorization", "Basic " + authEncoded); //这个是必须要加的*/
        con.setDoInput(true);
        if (con.getResponseCode() != 200) {
            throw new RuntimeException("请求出错，状态码为：" + con.getResponseCode());
        }
        return con.getInputStream();
    }

    /**
     * 请求方式
     *
     * @param urlStr 接口请求链接
     * @return
     * @throws Exception
     */
    public static String postRequestWithAuth(String urlStr,  Map params) throws Exception {
        SkipCertificateValidation();//跳过证书认证
        URL url = new URL(urlStr);
        HttpsURLConnection con = (HttpsURLConnection) url.openConnection();
        con.setRequestMethod("POST");
        con.setDoOutput(true);
        con.setDefaultUseCaches(false);//post请求不需要缓存
        con.setRequestProperty("Content-type", "application/x-www-form-urlencoded");

      /*  String authStr = user + ":" + pass;
        String authEncoded = Base64.getEncoder().encodeToString((authStr).getBytes());
        con.setRequestProperty("Authorization", "Basic " + authEncoded);*/

        //设置请求要加的参数
        SetRequestValue(con.getOutputStream(),params);

        con.setConnectTimeout(5000);
        int code = con.getResponseCode();
        if (code != 200) {
            return "接口发生未处理异常，请求状态码："+code;
          //con.getErrorStream()  可获得出错后的  返回流
        }
        con.disconnect();//断开连接
        return "请求成功！";
    }

    //将参数拼接起来
    private static void SetRequestValue(OutputStream outputStream, Map params) throws IOException {
        if (params != null && params.size() > 0) {
            DataOutputStream out = new DataOutputStream(outputStream);
            String requestString = "";
            for (String key : params.keySet()) {
                requestString += key.trim() + "=" + URLEncoder.encode(params.get(key).toString(), "UTF-8").trim() + "&";
            }
            System.out.println("原始长度：" + requestString);
            System.out.println("需要的字符串：" + requestString.substring(0, requestString.length() - 1));
            out.writeBytes(requestString);
            out.flush();
            out.close();
        }
    }
}