nginx header filter and body filter

最新推荐文章于 2024-08-24 11:45:00 发布

原创最新推荐文章于 2024-08-24 11:45:00 发布 · 2k 阅读

0 ·

CC 4.0 BY-SA版权

本文详细介绍了 Nginx filter 的使用实例，通过代码解释如何在响应 body 的末尾添加字符串，包括初始化、过滤器实现及配置指令，并讨论了在不同场景下正确使用的注意事项。

这是一个Nginx filter 例子，做的事情仅仅是在resopnse 的body末尾加上一个字符串。

ngx_http_mytest_module.c

#include <ngx_core.h>
#include <ngx_http.h>
#include <ngx_config.h>
static ngx_str_t data = ngx_string("hello world!\n");
static ngx_int_t ngx_http_mytest_init(ngx_conf_t*);
static ngx_int_t ngx_http_mytest_filter(ngx_http_request_t*);
static ngx_int_t ngx_http_mytest_body_filter(ngx_http_request_t*,ngx_chain_t*);

static ngx_command_t ngx_http_mytest_commands[] = 
{
	ngx_null_command
};
static ngx_http_module_t ngx_http_mytest_ctx={
	NULL,
	ngx_http_mytest_init,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL
};
ngx_module_t ngx_http_mytest_filter_module={
	NGX_MODULE_V1,
	&ngx_http_mytest_ctx,
	ngx_http_mytest_commands,
	NGX_HTTP_MODULE,
	NULL,                                  /* init master */     
	NULL,                                  /* init module */
	NULL,                                  /* init process */
	NULL,                                  /* init thread */ 
	NULL,                                  /* exit thread */ 
	NULL,                                  /* exit process */
	NULL,                                  /* exit master */ 
	NGX_MODULE_V1_PADDING                
};                    

static ngx_http_output_header_filter_pt ngx_http_next_header_filter;
static ngx_http_output_body_filter_pt ngx_http_next_body_filter;

static ngx_int_t ngx_http_mytest_filter(ngx_http_request_t *r){

	ngx_log_debug4(NGX_LOG_DEBUG_HTTP,r->connection->log,0,"header_in:%*s"
	"headers_in.server:%V,headers_out.content_type:%V"
	,r->header_in->end - r->header_in->start
	,r->header_in->start
	,&r->headers_in.server
	,&r->headers_out.content_type
	);
	ngx_chain_t *b = (NULL!=r&&NULL!=r->request_body&&NULL!=r->request_body->bufs)?
	r->request_body->bufs:NULL;
	ngx_log_debug(NGX_LOG_DEBUG_HTTP,r->connection->log,0,"request_body:");
	while(NULL != b){
	if(NULL!=b->buf){
		ngx_log_debug2(NGX_LOG_DEBUG_HTTP,r->connection->log,0
		,"%*s"
		,b->buf->end-b->buf->start
		,b->buf->start);}
		b=b->next;
	}
	r->headers_out.content_length_n += data.len;
	return ngx_http_next_header_filter(r);
}
static ngx_int_t ngx_http_mytest_body_filter(ngx_http_request_t *r,ngx_chain_t *in){
	ngx_chain_t *buf;
	ngx_chain_t * p;
	ngx_buf_t *b;
	b = /*ngx_calloc_buf(r->pool);*/ngx_pcalloc(r->pool,sizeof(ngx_buf_t));
	if(NULL != b){
		b->memory = 1;
		b->last_buf = 1;
		b->last_in_chain = 1;
		b->pos = data.data;
		b->last = data.data + data.len;
		buf = ngx_alloc_chain_link(r->pool);
		buf->buf = b;
		buf->next = NULL;
		p = in;
		while(NULL != p->next)
			p = p->next;
		p->buf->last_buf = 0;
		p->buf->last_in_chain = 0;
		p->next = buf;
		//r->headers_out.content_length_n += (b->last - b->pos);
	}
	//ngx_http_send_header(r);
	
	return ngx_http_next_body_filter(r,in);
}
static ngx_int_t ngx_http_mytest_init(ngx_conf_t *conf){
	ngx_http_next_header_filter = ngx_http_top_header_filter;
	ngx_http_top_header_filter = ngx_http_mytest_filter;  
	
	ngx_http_next_body_filter = ngx_http_top_body_filter;
	ngx_http_top_body_filter = ngx_http_mytest_body_filter;
	return NGX_OK;
}

config

ngx_addon_name=ngx_http_mytest_filter_module
HTTP_AUX_FILTER_MODULES="$HTTP_AUX_FILTER_MODULES ngx_http_mytest_filter_module"
NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_mytest_module.c"

在练习的过程中，把r-headers_out.content_length_n += data.len;给写到ngx_http_mytest_body_filter里去了，结果是死活发不出去新的内容，后来仔细研究查阅了下，ngx_http_mytest_filter中调用完后头已经发送出去了，再在body_filter里改头信息是无效的了；

两种方式：一、如果body内容不定，可以在header_filter里对headers_out.content_length_n进行discard(API)，这样就会转换成chunked的方式发送了；二、header_filter里不send_header(API)，留到body_filter里处理完body后再调用send_header(r)(API)。