Nginx 轉發時的一個坑,運維居然讓我背鍋!!

Java技術棧發表於2020-12-09

最近遇到一個 Nginx 轉發的坑,一個請求轉發到 Tomcat 時發現有幾個 http header 始終獲取不到,導致線上出現 bug,運維說不是他的問題,這個鍋我背了。

新增的幾個 header 是這樣的:

  • accept_sign
  • accept_token
  • ...

反覆檢查程式碼,確定這些 header 是傳了的,而且本地測試單獨在 tomcat 中是可以接受到這些引數的,所以 tomcat 和命名本身是沒問題的,初步斷定是 Nginx 的問題。

經過一翻搜尋,終於找到了一個 Nginx 的配置引數:underscores_in_headers,這個引數預設值為:off,即預設忽略帶下劃線的 header。

解決方案:

1、在 http 或者 server 配置中把 underscores_in_headers 配置引數開關開啟:

server {
  ...
  underscores_in_headers on;
  ...
}

增加配置後,然後重啟 Nginx。

2、使用破折號(-)代替下劃線(_),或者統一規範直接不要使用下劃線;

我們來看下一般的 http header 長什麼樣的:

一般所見的 headers 確實也都是中槓線,沒有下劃線。

Nginx 為什麼預設忽略帶下劃線 header?

我找到了 Nginx 的官方說明:

https://www.nginx.com/resources/wiki/start/topics/tutorials/config_pitfalls/?highlight=underscores#missing-disappearing-http-headers

If you do not explicitly set underscores_in_headers on;, NGINX will silently drop HTTP headers with underscores (which are perfectly valid according to the HTTP standard). This is done in order to prevent ambiguities when mapping headers to CGI variables as both dashes and underscores are mapped to underscores during that process.

根據官方說明,這樣做是為了避免把 headers 對映為 CGI 變數時出現歧義,因為破折號和下劃線都會被對映為下劃線,所以兩者不好區分……

好吧,終於弄清楚了,這個問題也太變態了,這應該是 Nginx 設計時的一個缺陷吧,這個坑我替你們踩了!

所以,推薦大家使用第二種方案吧,統一規範 headers 不要使用下劃線,使用 Nginx 預設的配置即可,這樣可以儘量避免環境上的差異,以免後續帶來問題。

@阿里Java開發手冊 是否考慮新增這條規範?

版權申明:本文系公眾號 "Java技術棧" 原創,原創實屬不易,轉載、引用本文內容請註明出處,禁止抄襲、洗稿,請自重,尊重他人勞動成果和智慧財產權。

近期熱文推薦:

1.Java 15 正式釋出, 14 個新特性,重新整理你的認知!!

2.終於靠開源專案弄到 IntelliJ IDEA 啟用碼了,真香!

3.我用 Java 8 寫了一段邏輯,同事直呼看不懂,你試試看。。

4.吊打 Tomcat ,Undertow 效能很炸!!

5.《Java開發手冊(嵩山版)》最新發布,速速下載!

覺得不錯,別忘了隨手點贊+轉發哦!

相關文章