HttpUrlConnection 源码分析

先介绍一下我研究HttpUrlConnection的背景，公司对外提供的SDK是使用HttpUrlConnection(历史原因)写的，有开发者反馈调用量很大，短连接太耗资源。然后我们后台给他开了长连接白名单，但是他们还是反馈我们提供的不是长连接，因为他们看了我们sdk的源码，说我们调用了HttpURLConnection.disconnect()方法，所以不是长连接。为了确认这个问题，开始了我的验证和研究之路。

验证过程

测试代码

package com;

import java.io.IOException;
import java.io.InputStream;
import java.net.HttpRetryException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.concurrent.locks.LockSupport;

/**
 * create by liuyj on 2020/6/30
 *
 * @author yuanjian.e@foxmail.com
 */
public class ConnTest {

    public static void main(String[] args) throws Exception {
        final int code = 1;
        get(conn(code));
        get(conn(code));
        get(conn(code));
        LockSupport.park();
        System.out.println("============");
    }

    public static HttpURLConnection conn(int code) throws IOException {
        URL url = new URL("http://127.0.0.1/test/checkStatus?code=" + code);
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();

        return conn;
    }

    public static boolean get(HttpURLConnection connection) throws IOException, InterruptedException {
        connection.setRequestMethod("GET");
        connection.setUseCaches(false);
        connection.setRequestProperty("Content-Type", "text/html;charset=UTF-8");
        connection.setDoOutput(false);
        connection.setDoInput(true);
        try {
            connection.connect();
            int code = connection.getResponseCode();
            if (code == HttpURLConnection.HTTP_OK) {
                return true;
            } else {
                throw new HttpRetryException("Response Code Error", code);
            }
        } finally {
            InputStream inputStream = connection.getInputStream();
            if (inputStream != null) {
                inputStream.close();
            }
            if (connection != null) {
                connection.disconnect();
            }
            System.out.println("closed");
        }
    }
}

本地通过抓包工具 wireshark 确认是否使用长连接，为模拟线上环境，本地安装了nginx，端口为80

3次Http请求的包

从图中可以看出三次HTTP请求端口号没有改变，且只进行了三次握手和四次挥手，所以说是长连接(客户端和nginx之间)。但是问题来了，为什么调用了HttpURLConnection.disconnect()了还是长连接了？后面让我们一起来分析一下源码。

源码分析

源码分析按照何时连接，何时缓存，何时关闭三个过程分析源码。其实看源码的过程中，因为用户反馈我们调用了disconnect()方法，所以先看了该方法并断点，然后一步一步下去的。排查过程中发现一个很关键的类KeepAliveCache，是用来缓存连接的类，后面的断点调试会主要用到这个类，所以我们先简单看一下这个类。

public synchronized void put(URL var1, Object var2, HttpClient var3);
public synchronized HttpClient get(URL var1, Object var2);

这个类有两个核心方法，put()和get()，看名字基本可以联想到是用来做什么的，put()方法是用来缓存连接使用的，get()方法是用来获取缓存中的连接。

何时连接

首先我们看一下HttpURLConnection conn = (HttpURLConnection) url.openConnection();做了什么，下图是方法注释。

openConnection()

从上图注释中可以看出openConnection()方法会创建URLConnection实例，但是URLConnection实例并不代表真正的TCP连接，只有当调用URLConnection.connect()方法才会创建TCP连接，接下来我们看一下这个方法的注释。
下图是connect()方法的注释，可以看出调用此方法便会建立连接

connect()

此时建立连接，那么如果是长连接那是不是在这里就会获取缓存里的连接呢？抱着疑问，开始断点。

长连接

图中可以看出，确实是去缓存中获取了连接，不过这个连接不是URLConnection，而是HttpClient。那么问题来了，这个缓存是在什么时候存储的呢？

何时缓存

断点put()方法

put()

发现调用inputStream.close();时缓存了HttpClient。我们看一下这个方法HttpInputStream.close()的源码。

public void close() throws IOException {
    if (!this.closed) {
        try {
            if (this.outputStream != null) {
                if (this.read() != -1) {
                    this.cacheRequest.abort();
                } else {
                    this.outputStream.close();
                }
            }

            super.close();
        } catch (IOException var5) {
            if (this.cacheRequest != null) {
                this.cacheRequest.abort();
            }

            throw var5;
        } finally {
            this.closed = true;
            HttpURLConnection.this.http = null;
            HttpURLConnection.this.checkResponseCredentials(true);
        }

    }
}

HttpInputStream是HttpURLConnection的内部类，可以看到finally中将HttpURLConnection的成员变量http置为了null，可能有同学会好奇为什么这么做呢？是因为前面说的，http对象被缓存了，所以这里不能再有这个对象的引用了。那么它的连接到底什么时候断开呢？调用disconnect()方法会断开这个长连接吗？

何时断开

我们先看一下HttpURLConnection.disconnect()的源码

public void disconnect() {
    this.responseCode = -1;
    if (this.pi != null) {
        this.pi.finishTracking();
        this.pi = null;
    }

    if (this.http != null) {
        if (this.inputStream != null) {
            HttpClient var1 = this.http;
            boolean var2 = var1.isKeepingAlive();

            try {
                this.inputStream.close();
            } catch (IOException var4) {
            }

            if (var2) {
                var1.closeIdleConnection();
            }
        } else {
            this.http.setDoNotRetry(true);
            this.http.closeServer();
        }

        this.http = null;
        this.connected = false;
    }

    this.cachedInputStream = null;
    if (this.cachedHeaders != null) {
        this.cachedHeaders.reset();
    }

}

disconnect()

通过断点可以看到，disconnect()方法中的三个判断都会返回false，相当于这个方法只做了一件事，this.responseCode = -1;，所以这个方法并不会断开TCP连接。另外上面分析了HttpURLConnection.http对象是在inputStream.close()方法被调用时置为null的，另外连个对象我并没有深入去了解，有兴趣的同学可以自己研究一下。那么长连接到底何时会被关闭呢？会根据nginx端设置的超时时间自动过期，同时若nginx本身不支持长连接，HttpClient对象也不会被缓存，具体细节，大家可以自行研究。

总结

如果要使用长连接，首先服务端需要支持，其次必须调用HttpURLConnection.getInputStream().close()方法，跟是否调用HttpURLConnection.disconnect()无关。