nginx使用replace-filter-nginx-module實現內容替換

有時候咱們想對響應（例如PHP接口）返回的內容作些字符串，雖然可使用各語言代碼相關方法（例如PHP的str_replace）進行替換，可是在nginx層面替換是更方便的，無需修改代碼。

約定：本文源代碼目錄統一放在：/root/soft/src 裏。

開始安裝

安裝sregex運行庫

安裝此模塊須要先安裝 sregex 運行庫：

$ git clone https://github.com/agentzh/sregex
$ cd sregex
$ make
$ make install

軟連接：

$ ln -sv /usr/local/lib/libsregex.so.0.0.1 /lib64/libsregex.so.0

安裝 replace-filter-nginx-module

而後獲取 replace-filter-nginx-module 模塊，並解壓，無需安裝：

$ cd /root/soft/src
$ git clone https://github.com/agentzh/replace-filter-nginx-module

獲取Nginx源碼：

$ wget http://nginx.org/download/nginx-1.12.2.tar.gz
$ tar zxvf nginx-1.12.2.tar.gz

這裏採用靜態編譯的方式安裝模塊，須要從新編譯 nginx 。獲取 nginx 上一次編譯參數：

$ nginx -V
nginx version: nginx/1.12.2
built by gcc 4.4.7 20120313 (Red Hat 4.4.7-16) (GCC) 
built with OpenSSL 1.0.1e-fips 11 Feb 2013
TLS SNI support enabled
configure arguments: --user=www --group=www --prefix=/usr/local/nginx --with-http_stub_status_module --with-http_ssl_module --with-http_gzip_static_module --with-ipv6 --with-http_sub_module --with-ld-opt=-ljemalloc --with-http_ssl_module --with-http_realip_module --with-http_addition_module --with-http_sub_module

這裏添加 replace-filter-nginx-module 模塊：

--add-module=/root/soft/src/replace-filter-nginx-module

最終編譯命令：

cd nginx-1.12.2

$  ./configure --user=www --group=www --prefix=/usr/local/nginx --with-http_stub_status_module --with-http_ssl_module --with-http_gzip_static_module --with-ipv6 --with-http_sub_module --with-ld-opt=-ljemalloc --with-http_ssl_module --with-http_realip_module --with-http_addition_module --with-http_sub_module --add-module=/root/soft/src/replace-filter-nginx-module-0.01rc5
 
$ make

因爲這裏是升級nginx，因此千萬不要make install，否則就真的覆蓋了。這裏先備份一下。 接下來手動替換二進制文件：

$ cp /usr/local/nginx/sbin/nginx /usr/local/nginx/sbin/nginx.bak
$ cp -rfp ./objs/nginx /usr/local/nginx/sbin/

測試是否可行：

$ nginx -v
nginx version: nginx/1.12.2

配置是否正常：

$ /usr/local/nginx/sbin/nginx -t
nginx: the configuration file /usr/local/nginx/conf/nginx.conf syntax is ok
nginx: configuration file /usr/local/nginx/conf/nginx.conf test is successful

測試

這裏測試的是：把接口返回的 img.test.com 換成 media.test.com。

修改：/usr/local/nginx/conf/vhost/test.com.conf

location ~ [^/]\.php(/|$)
{
    # comment try_files $uri =404; to enable pathinfo
    try_files $uri =404;
    fastcgi_pass  127.0.0.1:9000;
    fastcgi_index index.php;
    include fastcgi.conf;
}

爲：

location ~ [^/]\.php(/|$)
{
    replace_filter 'img.test.com' 'media.test.com' g;
    replace_filter_types application/json;
    
    # comment try_files $uri =404; to enable pathinfo
    try_files $uri =404;
    fastcgi_pass  127.0.0.1:9000;
    fastcgi_index index.php;
    include fastcgi.conf;

注意須要添加replace_filter_types。

保存後檢查配置是否ok：

$ /usr/local/nginx/sbin/nginx -t
nginx: the configuration file /usr/local/nginx/conf/nginx.conf syntax is ok
nginx: configuration file /usr/local/nginx/conf/nginx.conf test is successful

而後熱重啓：

# 升級完成第一次須要重啓
$ service nginx restart 
 
# 熱重啓
$ /usr/local/nginx/sbin/nginx -s reload

編譯動態模塊

replace-filter-nginx-module 支持以動態模塊方式加載，詳見：https://github.com/openresty/replace-filter-nginx-module#installation 。Nginx版本須要 >=1.9.11 。

$  ./configure --user=www --group=www --prefix=/usr/local/nginx --with-http_stub_status_module --with-http_ssl_module --with-http_gzip_static_module --with-ipv6 --with-http_sub_module --with-ld-opt=-ljemalloc --with-http_ssl_module --with-http_realip_module --with-http_addition_module --with-http_sub_module 
--add-dynamic-module=/root/soft/src/replace-filter-nginx-module

$ make -j2
$ make install

相比靜態編譯，參數--add-module改爲了--add-dynamic-module。

編譯成功後，會把模塊安裝在nginx/modules/目錄。查看：

$ ls /usr/local/nginx/modules/
ngx_http_replace_filter_module.so

接下來咱們須要在nginx.conf配置中加入如下內容，實現動態調用模塊：

load_module /usr/local/nginx/modules/ngx_http_replace_filter_module.so;

注意：load_module指令不能放在 http{} 裏面：

worker_processes  1;

load_module xxx;

#error_log  logs/error.log;
#error_log  logs/error.log  notice;
#error_log  logs/error.log  info;

#pid        logs/nginx.pid;

events {
    worker_connections  1024;
}

http {

}

接下來能夠按上面的 測試 小節測試。惟一不一樣的是無需使用service nginx restart重啓Nginx，直接使用nginx -s reload熱重啓就好了。

參考

一、已安裝nginx動態添加模塊
http://coolnull.com/4245.html
二、LNMP平滑升級nginx並安裝ngx_lua模塊教程
http://www.mamicode.com/info-detail-1110824.html
三、openresty/replace-filter-nginx-module: Streaming regular expression replacement in response bodies
https://github.com/openresty/replace-filter-nginx-module#synopsis
四、比ngx_http_substitutions_filter_module 更強大的替換模塊sregex的replace-filter-nginx-module
http://www.javashuo.com/article/p-ppkbyfxl-ds.html
五、Nginx編譯安裝Lua - 飛鴻影~ - 博客園
http://www.javashuo.com/article/p-uyselemm-dh.html