记一次SpringBoot RestTemplate大型翻车现场

最近几天老是收到反馈SpringBoot项目请求第三方接口报错了，请求不通了。刚一开始我们还怀疑是第三方接口不稳定，但是当我们使用restful工具例如PostMan请求第三方接口的时候，第三方接口是正常的，能够正常返回数据，同时Http状态码也是正常的。这个时候搞得我们一头雾水，痛定思痛我们有必要把这个问题排查下。下面就整个排查问题的步骤和过程记录下，方便以后避雷。

首先，我们有必要去我们的服务器上看看SpringBoot项目的日志信息，当我们找到日志文件，打开发现日志文件中有很多异常日志：

从错误日志信息中我们可以发现，JVM虚拟机栈溢出了，而且还是出现在跟RestTemplate相关的。这就更奇怪了，一个简单的使用RestTemplate怎么会出现StackOverflowError呢？RestTemplate仅仅是一个向外部发送Http请求的组件，封装了许多好用的方法，例如：Post，Get，Put等常规Http方法进行封装，Java Bean与Json序列化进行互转等。以及提供了许多可扩展的接口方便其他功能的接入。带着这些疑问我们有必要看看我们程序的源代码了。

查看源代码我们发现，我们在使用RestTemplate请求第三方接口的时候，需要进行Basic安全认证，而这种安全认证也是Http中最基本的认证方式，它需要一组账号信息，用户名和密码就可以进行安全认证了。然而，RestTemplate在进行Basic安全认证的时候采用了多种方法，在我们的源代码程序中，我们采用了下面的这种形式：

通过源代码我们可以看到，这里我们使用了一种拦截器的机制实现了Http Basic安全认证，似乎这也没什么大问题。为什么在这里就会发生StackOverflowError栈溢出现象呢？带着这个疑问我们在网上查找了大量资料。阅读了大量博客和文章后，我们发现了有一句话频频出现

StackOverflowError代表的是，当栈深度超过虚拟机分配给线程的栈大小时就会出现此错误

有了这个信息，我们大胆猜测会不会是哪发生了递归调用？导致递归调用次数超过了JVM默认设置的栈大小。这个时候我们就需要根据错误信息的行数看看RestTemplate的源代码了，先看看
BasicAuthenticationInterceptor的源代码

这个intercept方法中主要完成的功能是设置Http Basic安全认证的头部信息，然后继续执行后续的Http请求，然后我们还需要进入execute方法看看后面的操作流程。

在这个
InterceptingClientHttpRequest类中我们似乎发现了点什么，当iterator这个数组对象中始终有元素的时候，那么递归调用就开始了。这个nextInterceptor就是我们上面讲到的
BasicAuthenticationInterceptor对象，就会不停的在这两个方法中发生递归调用，直到JVM虚拟机默认分配的栈被完全占满，然后JVM虚拟机就会抛出一个StackOverflowError错误。

虽然已经找到了问题所在，那么抱着精益求精的工作态度，我们需要验证下我们的想法。我们新建一个main函数来模拟下出现错误的场景：

import org.springframework.http.client.support.BasicAuthenticationInterceptor;
import org.springframework.web.client.RestTemplate;

public class Test {
    public static void main(String[] args) {
        RestTemplate restTemplate = new RestTemplate();
        int n = 0;
        while (n < 10000) {
            restTemplate.getInterceptors().add(new BasicAuthenticationInterceptor("test", "test"));
            n++;
        }
        restTemplate.getForObject("https://www.baidu.com/", String.class);
    }
}

然后我们把IDEA启动这个main函数的栈大小改小点

这里我们将JVM虚拟机的栈大小设置成1024KB，然后启动main函数让程序跑起来，当程序没有完全跑结束的时候，错误信息已经打印出来了

这个错误信息跟我们在生产服务器上看到的错误信息一样。这个时候我们还需要再验证下，到底是不是栈大小设置的不合理造成的，我们把运行main函数的栈改大点试试

这里我们把JVM虚拟机的栈大小调整到512MB，再次启动上面的main函数，结果没有出现任何错误信息；

现在我们可以下结论了，出现这个问题的原因应该是：

• RestTemplate在进行Http Basic安全认证的时候，编码不规范，在每一次请求的时候都添加了一遍BasicAuthenticationInterceptor拦截器，而RestTemplate又是在SpringBoot启动的时候注入到Spring容器中的，由Spring容器管理RestTemplate对象。这种情况下，就会导致拦截器积压太多，造成递归调用；
• 生产环境的JVM虚拟机栈大小采用默认配置，可能存在JVM栈大小配置不合理的情况；

针对上面的整个排查过程和验证过程，我们的解决方案是：

1. 重构RestTemplate的Http Basic认证这块的逻辑，采用另外一种方法实现；
2. 可能需要调整JVM虚拟机的栈大小；

重构RestTemplate的Http Basic认证可以采用下面的方法，示例如下：

这种方法就不存在使用拦截器，从而也不会发生递归调用的情况。在SpringBoot项目启动的时候，我们就把Http Basic认证的信息传递给RestTemplate，RestTemplate初始化后就自动注入到Spring容器中，交由Spring容器管理，因为我们使用了注解Bean关键字。

如果需要调整JVM虚拟机的栈大小，我们就需要在启动SpringBoot项目的时候，将JDK的参数-Xss传递给JVM虚拟机，如果项目是部署在Tomcat容器中，在启动Tomcat的时候也需要将-Xss参数传递给JVM虚拟机。这个-Xss参数值的大小设置多少合适呢？这个可能没有一个固定的值，需要根据实际的服务器硬件配置，以及具体项目的性能指标来综合考虑。这个值可能也不会是一成不变的，可能需要多次调整然后才能确定一个最优值。这就涉及到JVM虚拟机调优的范畴，网上有许多介绍这方面的博客和文章，这里就不再赘述。如果对这块比较感兴趣的可以自行去网上找资料学习。