nginx模块nginx-http-footer-filter(淘宝开发)

时间 2019-11-20

标签 nginx 模块 http footer filter 淘宝开发栏目 Nginx 繁體版

原文原文链接

nginx-http-footer-filter想必你们都以为很陌生,那咱们就来认识一下它吧,这是淘宝开发的nginx模块. 它用于nginx在响应请求文件底部追加内容. 今天抽空研究下这个插件，但愿对你们有所帮助。为何发现了这个插件，由于这几天公司须要在全部shtml文件后面追加一个js代码用来作统计（以前统计代码没加齐全），在寻求解决方法的过程当中找到了它认识了它最后喜欢上了它，你可能觉得我用这个插件去实现了我要的功能，其实在认识他以前我用shell脚本替换齐全了. 不过我仍是决定研究测试一下nginx-http-footer-filter，或许之后的需求上能有帮助,更或许能帮上其余须要帮助的人.进入正题吧. javascript

1. nginx-http-footer-filter究竟是作什么的？

说白了，就是在请求的页面底部插入你要插入的代码。 php

2. 咱们能用nginx-http-footer-filter来作什么？

一、统一追加js代码用于统计(我是这么想的)
二、底部追加响应这个请求的realsver（后端真实服务器）信息,便于系统管理员排查故障.
三、你管理着数量庞大的虚拟主机，在全部web后面追加你的广告代码，黑链什么的（很无耻）
四、触类旁通吧,本身想一想能用来作什么吧. css

淘宝用它来作什么？ html

打开淘宝首页，查看他源代码，拖到最下面,内容以下： java

<!--city: fuzhou-->
<!--province: unknown-->
<!--hostname: -->
<!--hostname: home1.cn199-->

咱们能够很清晰的看到，这边有省和地区还有主机名,也就是淘宝真实服务器的主机名,处理我这个请求的主机名为home1.cn199, city取到了fuzhou,provinece省份没取到，估计是它Geo的问题
或者随便打开一个商品页面, 查看源代码,以下： nginx

</html>
<script type="text/javascript">TShop.initFoot({});</script>

能够看到他这边给这页面追加了一个js代码,淘宝开发这个模块的用意想必你们都明白了，集思广益，或许你们还有更好的用处. git

3. 怎么安nginx-http-footer-filter

3.1 下载地址：

https://github.com/alibaba/nginx-http-footer-filter/tree/1.2.2

3.2 安装nginx-footer模块

以前已经安装过nginx，因此我选择覆盖nginx文件。 github

# 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 验证模块是否安装成功

# /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 "你的内容" 便可.看以下配置 web

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 测试nginx-footer效果

# cat 2252.shtml
<html>
    <head>
    <title>test</title>
    </head>
    <body>
        this is webpage
    </body>
</html>

访问站点test.ttlsa.com/html/2252.shtml shell

nginx追加底部代码

如图，咱们能够看到文件最底部加上了,怎么变成了时间撮了,由于我这边是ssi的语法，若是你不知道什么是ssi，那么请参考文章什么是ssi.

他仅仅是在文件的最后一行追加,而不是<body>里面.这点你们要注意了.

4.3 再来测试一下css文件

# cat 2242.css
# this is css file

以下是访问结果：
# this is css file
/* host: test.ttlsa.com - 1376064324 */

看图：

nginx footer追加底部代码css

5. 我能写多个footer指令吗？

不行，如下我写了两个footer

location / {
    footer "12312321321";
    footer "<!-- $date_gmt -->";
    index index.html;
}

以下测试，提示footer指令重复了

# /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变量吗？

固然不是,随便你写，能够是ssi指令，也能够是nginx变量，也能够是任何无心义的字符串
以下：
footer "12312321321";
footer "";
footer "";

好比我想知道这个页面是哪台web服务器处理的,那么我在底部插入主机名便可.这样，有500错误，我即可以立刻定位到具体的服务器了

footer "<!--$hostname-->";

返回结果以下：

nginx footer 追加底部代码nginx变量hostname

7. 服务器返回500,404,403等错误, 是否还会追加内容到底部

会,若是不追加,就没法经过返回的页面得知哪台web出现故障,这明显就不符合做者的初衷了,有些同窗可能以为我在后端设置一个header不就能够了，为何还要去装一个插件，麻烦不麻烦？不信你试试404,500这些错误头部能不能看到。何况你面对的用户都是小白们，难道让他提交错误的时候，问他你看下你的http头部的某值是多少，别人傻眼了。如今你只要说，哥们，网页保存下来传给我。

配置以下：

location / {
    return 500;
    footer "<!--$hostname-->";
}

结果以下：

nginx footer追加底部代码500错误

8. 模块指令说明：

footer模块很是简单，就只有两个指令，具体说明以下
footer字符串
默认值: ``
配置段: http, server, location
这个定义了将什么内容追加到文件内容的底部

footer_types MIME类型
默认值: footer_types: text/html
配置段: http, server, location
定义被追加底部文件的MIME返回类型,默认值是text/html

我原文： nginx模块nginx-http-footer-filter

连接失效点我：http://www.ttlsa.com/html/2252.html