Nginx 下 504 Gateway Time-out 解决方案

本文介绍: 通过浏览器向后台发起请求够，由于后台处理时间长，实际后台程序依然在执行，Ngin x 已经返回 504 Ga t e w a y Ti m e–out 的解决方案

问题：通过浏览器向后台发起请求够，由于后台处理时间长，出现504 Ga t e w a y Ti m e–out，实际后台程序依然在执行。如何解决？

504从哪来：本文的场景下504是nginx 返回的。

Sy ntax:	`proxy_read_timeout time;`
De fa ul t:	proxy_read_timeout 60s;
Con text:	`http`, `server`, `location`

官方地址：Module ngx_http_proxy_module (nginx.org)

官方描述如下：De fin es a timeout f o r read in g a response f ro m t he pro xi e d server. The timeout i s set only between t w o success i ve re ad operations, not for the tr ans m i ss ion of the w h ole response. If the pro xied server does not tran smit any th in g wi th in thi s time, the connection i s closed.

一个请求有三方参与：浏览器，nginx，后台服务器。

504的错误码是有nginx 返回的。结合官网的解释，我们可以得出结论：

当nginx与后台的链接两次读取有效数据之间超过配置的时间时，就会产生504超时。nginx会主动关闭与后台服务器的链接。注意是两次成功读取的间隔，不是整个repo nse的时间。

默认情况下proxy_re ad_timeout时60s。

如果你百度或google，通常解决方式有两种：提高后台处理效率 或 增大proxy_re ad_timeout。

增大方法很简单，proxy_read_timeout [你期望的时间]。

But，后台效率提升总是有极限的。而proxy_read_timeout是固定值。总会有些正常业务场景，超过了设置的time out值。

两种解决方案

本人解决的问题：上传 excel 文件后，由于文件大小无法预计，所以后台处理时间也无法预计。同时还要支持大文件的上传。上传后由后台解析处理。post 请求，返回的是json。

一，关闭read-tim out，可以实现，但是生产环境下你敢不设置超时时间么？所以不建议。

二，既然nginx只要从repo nse成功读取数据两次的间隔在proxy_read_time out 设置的时间内，就不会超时。那么我们是不是可以通过持续的向response 中写入数据来保证不超时呢。

答案是肯定的。

想通了这一点，实现就十分简单。

1，正常上传文件。

2，新建一个线程。持有response的引用，含有标志位，满足条件时循环执行，程序开始处理数据前，启动线程。

3，线程的功能只有一个，以固定间隔向res p onse中写入数据。使nginx与后台链接不超时。

4，这里就需要注意，我的方法是返回json，同时要持续向res p onse写入数据，所以我手动拼装json 字符串。相当于在之前返回的json中增加一个属性，名称随意，我的叫p end in g，值随意，非空即可。我是用英文半角的句号” . “。

5，数据处理完后，回调线程的stop 方法，终止线程中的循环。

注意：如有雷同纯属巧合。如果已经有大佬讲过这种解决方式，请艾特我，我立即删除本文。

保持线程代码如下：

#上下文代码
//获取鲜橙池executor，具体方式看个人。不会的直接百度，有很多
response.setContentType(ContentType.APPLICATION_JSON.getMimeType());
ResponseKeeper responseKeeper = new ResponseKeeper(response);
executorService.execute(responseKeeper);
#上下文代码


public class ResponseKeeper implements Runnable {

        /**
        * 循环标志：true时停止循环，终止线程
        */
        private boolean done = false;
        
        private HttpServletResponse response;

        public void stop(){
            done = true;
        }

        public ResponseKeeper(HttpServletResponse response) {
            this.response = response;
        }

        @Override
        public void run() {
            try {
                response.getWriter().write("{"pending":"");
                while(!done){
                    response.getWriter().write(".");
                    response.getWriter().flush();
                    LOGGER.error("flush-{}", System.currentTimeMillis());
                    Thread.sleep(1000);
                }
                response.getWriter().write("", "status": "0", "msg":"success"}");
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }