淘寶開發(fā)：Nginx模塊Nginx-Http-Footer-Filter
Nginx-Http-Footer-Filter想必大家都覺得很陌生,那我們就來認(rèn)識(shí)一下它吧,這是淘寶開發(fā)的Nginx模塊. 它用于nginx在響應(yīng)請(qǐng)求文件底部追加內(nèi)容. 今天抽空研究下這個(gè)插件，希望對(duì)大家有所幫助。為什么發(fā)現(xiàn)了這個(gè)插件，因?yàn)檫@幾天公司需要在所有shtml文件后面追加一個(gè)js代碼用來做統(tǒng)計(jì)（之前統(tǒng)計(jì) 代碼沒加齊全），在尋求解決方法的過程中找到了它認(rèn)識(shí)了它***喜歡上了它，你可能以為我用這個(gè)插件去實(shí)現(xiàn)了我要的功能，其實(shí)在認(rèn)識(shí)他之前我用shell腳 本替換齊全了. 不過我還是決定研究測(cè)試一下Nginx-Http-Footer-Filter，或許以后的需求上能有幫助,更或許能幫上其他需要幫助的人.進(jìn)入正題吧.
1. Nginx-Http-Footer-Filter到底是做什么的？
說白了，就是在請(qǐng)求的頁面底部插入你要插入的代碼。
2. 我們能用Nginx-Http-Footer-Filter來做什么？
1、統(tǒng)一追加js代碼用于統(tǒng)計(jì)(我是這么想的)
2、底部追加響應(yīng)這個(gè)請(qǐng)求的realsver（后端真實(shí)服務(wù)器）信息,便于系統(tǒng)管理員排查故障.
3、你管理著數(shù)量龐大的虛擬主機(jī)，在所有web后面追加你的廣告代碼，黑鏈?zhǔn)裁吹模ê軣o恥）
4、舉一反三吧,自己想想能用來做什么吧. 淘寶用它來做什么？ 打開淘寶首頁，查看他源代碼，拖到最下面,內(nèi)容如下：
- <!--city: fuzhou-->
- <!--province: unknown-->
- <!--hostname: -->
- <!--hostname: home1.cn199-->
我們可以很清晰的看到，這邊有省和地區(qū)還有主機(jī)名,也就是淘寶真實(shí)服務(wù)器的主機(jī)名,處理我這個(gè)請(qǐng)求的主機(jī)名為home1.cn199, city取到了fuzhou,provinece省份沒取到，估計(jì)是它Geo的問題
或者隨便打開一個(gè)商品頁面, 查看源代碼,如下：
- </html>
- <script type="text/javascript">TShop.initFoot({});</script>
可以看到他這邊給這頁面追加了一個(gè)js代碼,淘寶開發(fā)這個(gè)模塊的用意想必大家都明白了，集思廣益，或許大家還有更好的用處.
3. 怎么安裝Nginx-Http-Footer-Filter
3.1 下載地址：
https://github.com/alibaba/Nginx-Http-Footer-Filter/tree/1.2.2
3.2 安裝Nginx-Footer模塊
之前已經(jīng)安裝過Nginx，所以我選擇覆蓋Nginx文件。
- # cd /usr/local/src/
- # wget https://codeload.github.com/alibaba/Nginx-Http-Footer-Filter/zip/1.2.2
- # unzip 1.2.2
- # http://nginx.org/download/nginx-1.4.1.tar.gz
- # tar -xzvf nginx-1.4.1.tar.gz
- # cd nginx-1.4.1
- # ./configure --prefix=/usr/local/nginx-1.4.1 \
- --with-http_stub_status_module --with-http_realip_module \
- --add-module=../Nginx-Http-Footer-Filter-1.2.2
- # make
- # mv /usr/local/nginx-1.4.1/sbin/nginx /usr/local/nginx-1.4.1/sbin/old_nginx
- # mv objs/nginx /usr/local/nginx-1.4.1/sbin/
- # /usr/local/nginx-1.4.1/sbin/nginx -s stop
- # /usr/local/nginx-1.4.1/sbin/nginx
3.3 驗(yàn)證模塊是否安裝成功
- # /usr/local/nginx-1.4.1/sbin/nginx -V
- nginx version: nginx/1.4.1
- built by gcc 4.4.7 20120313 (Red Hat 4.4.7-3) (GCC)
- TLS SNI support enabled
- configure arguments: --prefix=/usr/local/nginx-1.4.1
- --with-http_stub_status_module
- --with-http_realip_module
- --add-module=../Nginx-Http-Footer-Filter-1.2.2
4. 怎么使用Nginx-Http-Footer-Filter模塊
4.1 配置location
在location中使用footer "你的內(nèi)容" 即可.看如下配置
- server {
- listen 173.255.219.122:80;
- server_name test.ttlsa.com;
- access_log /data/logs/nginx/test.ttlsa.com.access.log main;
- index index.html index.php index.html;
- root /data/site/test.ttlsa.com;
- location / {
- footer "<!-- $date_gmt -->";
- index index.html;
- }
- location =/html/2252.css {
- footer_types text/css;
- footer "/* host: $server_name - $date_local */";
- }
4.2 測(cè)試Nginx-Footer效果
- # cat 2252.shtml
- <html>
- <head>
- <title>test</title>
- </head>
- <body>
- this is webpage
- </body>
- </html>
訪問站點(diǎn)test.ttlsa.com/html/2252.shtml
nginx追加底部代碼
如圖，我們可以看到文件***部加上了<!-- 1376063369 -->,怎么變成了時(shí)間撮了,因?yàn)槲疫@邊是ssi的語法，如果你不知道什么是ssi，那么請(qǐng)參考文章什么是ssi.
他僅僅是在文件的***一行追加,而不是<body>里面.這點(diǎn)大家要注意了.
4.3 再來測(cè)試一下css文件
- # cat 2242.css
- # this is css file
如下是訪問結(jié)果：
- # this is css file
- /* host: test.ttlsa.com - 1376064324 */
看圖：
nginx footer追加底部代碼css
#p#
5. 我能寫多個(gè)footer指令嗎？
不行，以下我寫了兩個(gè)footer
- location / {
- footer "12312321321";
- footer "<!-- $date_gmt -->";
- index index.html;
- }
如下測(cè)試，提示footer指令重復(fù)了
- # /usr/local/nginx-1.4.1/sbin/nginx -t
- nginx: [emerg] "footer" directive is duplicate in /usr/local/nginx-1.4.1/conf/vhost/test.ttlsa.com.conf:13
- nginx: configuration file /usr/local/nginx-1.4.1/conf/nginx.conf test failed
6. 只能用ssi變量嗎？
當(dāng)然不是,隨便你寫，可以是ssi指令，也可以是nginx變量，也可以是任何無意義的字符串
如下：
- footer "12312321321";
- footer "<!--12312321321-->";
- footer "<!--$remote_addr-->";
比如我想知道這個(gè)頁面是哪臺(tái)web服務(wù)器處理的,那么我在底部插入主機(jī)名即可.這樣，有500錯(cuò)誤，我便可以馬上定位到具體的服務(wù)器了
- footer "<!--$hostname-->";
返回結(jié)果如下：
nginx footer 追加底部代碼nginx變量hostname
7. 服務(wù)器返回500,404,403等錯(cuò)誤, 是否還會(huì)追加內(nèi)容到底部
會(huì),如果不追加,就無法通過返回的頁面得知哪臺(tái)web出現(xiàn)故障,這明顯就不符合作者的初衷了,有些同學(xué)可能覺得我在后端設(shè)置一個(gè)header不就可以了，為什么還要去裝一個(gè)插件，麻煩不麻煩？不信你試試404,500這些錯(cuò)誤頭部能不能看到。況且你面對(duì)的用戶都是小白們，難道讓他提交錯(cuò)誤的時(shí)候，問他你看下你的http頭部的某值是多少，別人傻眼了。現(xiàn)在你只要說，哥們，網(wǎng)頁保存下來傳給我。
配置如下：
- location / {
- return 500;
- footer "<!--$hostname-->";
- }
結(jié)果如下：
nginx footer追加底部代碼500錯(cuò)誤
8. 模塊指令說明：
footer模塊非常簡(jiǎn)單，就只有兩個(gè)指令，具體說明如下
footer字符串
默認(rèn)值: ``
配置段: http, server, location
這個(gè)定義了將什么內(nèi)容追加到文件內(nèi)容的底部 footer_types MIME類型
默認(rèn)值: footer_types: text/html
配置段: http, server, location
定義被追加底部文件的MIME返回類型,默認(rèn)值是text/html
