Nginx 轉(zhuǎn)發(fā)時(shí)的一個(gè)坑,運(yùn)維居然讓我背鍋!
最近遇到一個(gè) Nginx 轉(zhuǎn)發(fā)的坑,一個(gè)請(qǐng)求轉(zhuǎn)發(fā)到 Tomcat 時(shí)發(fā)現(xiàn)有幾個(gè) http header 始終獲取不到,導(dǎo)致線上出現(xiàn) bug,運(yùn)維說(shuō)不是他的問(wèn)題,這個(gè)鍋我背了。
新增的幾個(gè) header 是這樣的:
- accept_sign
- accept_token
- ...
反復(fù)檢查代碼,確定這些 header 是傳了的,而且本地測(cè)試單獨(dú)在 tomcat 中是可以接受到這些參數(shù)的,所以 tomcat 和命名本身是沒(méi)問(wèn)題的,初步斷定是 Nginx 的問(wèn)題。
經(jīng)過(guò)一翻搜索,終于找到了一個(gè) Nginx 的配置參數(shù):underscores_in_headers,這個(gè)參數(shù)默認(rèn)值為:off,即默認(rèn)忽略帶下劃線的 header。
解決方案:
1、在 http 或者 server 配置中把 underscores_in_headers 配置參數(shù)開(kāi)關(guān)打開(kāi):
- server {
- ...
- underscores_in_headers on;
- ...
- }
增加配置后,然后重啟 Nginx。
2、使用破折號(hào)(-)代替下劃線(_),或者統(tǒng)一規(guī)范直接不要使用下劃線;
我們來(lái)看下一般的 http header 長(zhǎng)什么樣的:
一般所見(jiàn)的 headers 確實(shí)也都是中杠線,沒(méi)有下劃線。
Nginx 為什么默認(rèn)忽略帶下劃線 header?
我找到了 Nginx 的官方說(shuō)明:
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.
根據(jù)官方說(shuō)明,這樣做是為了避免把 headers 映射為 CGI 變量時(shí)出現(xiàn)歧義,因?yàn)槠普厶?hào)和下劃線都會(huì)被映射為下劃線,所以兩者不好區(qū)分……
好吧,終于弄清楚了,這個(gè)問(wèn)題也太變態(tài)了,這應(yīng)該是 Nginx 設(shè)計(jì)時(shí)的一個(gè)缺陷吧,這個(gè)坑我替你們踩了!
所以,推薦大家使用第二種方案吧,統(tǒng)一規(guī)范 headers 不要使用下劃線,使用 Nginx 默認(rèn)的配置即可,這樣可以盡量避免環(huán)境上的差異,以免后續(xù)帶來(lái)問(wèn)題。
本文轉(zhuǎn)載自微信公眾號(hào)「Java技術(shù)棧」,可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系Java技術(shù)棧公眾號(hào)。