首页 > 科技 >

Nginx 更多 handler 模块示例分析

2019-09-15 07:53:58 暂无 阅读:1853 评论:0
Nginx 更多 handler 模块示例分析

http access module

该模块的代码位于src/http/modules/ngx_http_access_module.c中。该模块的感化是供应对于特定 host 的客户端的接见掌握。能够限制特定 host 的客户端对于办事端悉数,或许某个 server,或许是某个 location 的接见。

该模块的实现非常简洁,总共也就只有几个函数。 static ngx_int_t ngx_http_access_handler(ngx_http_request_t *r);

static ngx_int_t ngx_http_access_inet(ngx_http_request_t *r,

ngx_http_access_loc_conf_t *alcf, in_addr_t addr);

#if (NGX_HAVE_INET6)

static ngx_int_t ngx_http_access_inet6(ngx_http_request_t *r,

ngx_http_access_loc_conf_t *alcf, u_char *p);

#endif

static ngx_int_t ngx_http_access_found(ngx_http_request_t *r, ngx_uint_t deny);

static char *ngx_http_access_rule(ngx_conf_t *cf, ngx_command_t *cmd,

void *conf);

static void *ngx_http_access_create_loc_conf(ngx_conf_t *cf);

static char *ngx_http_access_merge_loc_conf(ngx_conf_t *cf,

void *parent, void *child);

static ngx_int_t ngx_http_access_init(ngx_conf_t *cf);

对于与设置相关的几个函数都不需要做注释了,需要提一下的是函数 ngx_http_access_init,该函数在实现上把本模块挂载到了 NGX_HTTP_ACCESS_PHASE 阶段的 handler 上,从而使本身的被挪用时机发生在了 NGX_HTTP_CONTENT_PHASE 等阶段前。因为进行客户端地址的限制搜检,基本不需要比及这么后背。

此外看一下这个模块的主处理函数 ngx_http_access_handler。这个函数的逻辑也非常简洁,首要是凭据客户端地址的类型,来离别选择 ipv4 类型的处理函数 ngx_http_access_inet 照样 ipv6 类型的处理函数 ngx_http_access_inet6。

而这个两个处理函数内部也非常简洁,就是轮回搜检每个划定,搜检是否有成家的划定,若是有就返回成家的究竟,若是都没有成家,就默认拒绝。

http static module

从某种水平上来说,此模块能够算的上是“最正宗的”,“最陈旧”的 content handler。因为本模块的感化就是读取磁盘上的静态文件,并把文件内容作为发生的输出。在Web手艺成长的早期,只有静态页面,没有办事端剧本来动态生成 HTML 的时候。生怕斥地个 Web 办事器的时候,第一个要斥地就是如许一个 content handler。

http static module 的代码位于src/http/modules/ngx_http_static_module.c中,总共只有两百多行近三百行。能够说是非常短小。

我们首先来看一下该模块的模块上下文的界说。 ngx_http_module_t ngx_http_static_module_ctx = {

NULL, /* preconfiguration */

ngx_http_static_init, /* postconfiguration */

NULL, /* create main configuration */

NULL, /* init main configuration */

NULL, /* create server configuration */

NULL, /* merge server configuration */

NULL, /* create location configuration */

NULL /* merge location configuration */

};

是非常的简练吧,蝉联何与设置相关的函数都没有。对了,因为该模块没有供应任何设置指令。人人想想也就知道了,这个模块做的事情实在是太简洁了,也的确没什么好设置的。独一需要挪用的函数是一个 ngx_http_static_init 函数。好了,来看一下这个函数都干了写什么。 static ngx_int_t

ngx_http_static_init(ngx_conf_t *cf)

{

ngx_http_handler_pt *h;

ngx_http_core_main_conf_t *cmcf;

cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);

h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers);

if (h == NULL) {

return NGX_ERROR;

}

*h = ngx_http_static_handler;

return NGX_OK;

}

仅仅是挂载这个 handler 到 NGX_HTTP_CONTENT_PHASE 处理阶段。简洁吧?

下面我们就看一下这个模块最焦点的处理逻辑地点的 ngx_http_static_handler 函数。该函数也许占了这个模块代码量的百分之八九十。 static ngx_int_t

ngx_http_static_handler(ngx_http_request_t *r)

{

u_char *last, *location;

size_t root, len;

ngx_str_t path;

ngx_int_t rc;

ngx_uint_t level;

ngx_log_t *log;

ngx_buf_t *b;

ngx_chain_t out;

ngx_open_file_info_t of;

ngx_http_core_loc_conf_t *clcf;

if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD|NGX_HTTP_POST))) {

return NGX_HTTP_NOT_ALLOWED;

}

if (r->uri.data[r->uri.len - 1] == '/') {

return NGX_DECLINED;

}

log = r->connection->log;

/*

* ngx_http_map_uri_to_path() allocates memory for terminating '\0'

* so we do not need to reserve memory for '/' for possible redirect

*/

last = ngx_http_map_uri_to_path(r, &path, &root, 0);

if (last == NULL) {

return NGX_HTTP_INTERNAL_SERVER_ERROR;

}

path.len = last - path.data;

ngx_log_debug1(NGX_LOG_DEBUG_HTTP, log, 0,

"http filename: \"%s\"", path.data);

clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);

ngx_memzero(&of, sizeof(ngx_open_file_info_t));

of.read_ahead = clcf->read_ahead;

of.directio = clcf->directio;

of.valid = clcf->open_file_cache_valid;

of.min_uses = clcf->open_file_cache_min_uses;

of.errors = clcf->open_file_cache_errors;

of.events = clcf->open_file_cache_events;

if (ngx_http_set_disable_symlinks(r, clcf, &path, &of) != NGX_OK) {

return NGX_HTTP_INTERNAL_SERVER_ERROR;

}

if (ngx_open_cached_file(clcf->open_file_cache, &path, &of, r->pool)

!= NGX_OK)

{

switch (of.err) {

case 0:

return NGX_HTTP_INTERNAL_SERVER_ERROR;

case NGX_ENOENT:

case NGX_ENOTDIR:

case NGX_ENAMETOOLONG:

level = NGX_LOG_ERR;

rc = NGX_HTTP_NOT_FOUND;

break;

case NGX_EACCES:

#if (NGX_HAVE_OPENAT)

case NGX_EMLINK:

case NGX_ELOOP:

#endif

level = NGX_LOG_ERR;

rc = NGX_HTTP_FORBIDDEN;

break;

default:

level = NGX_LOG_CRIT;

rc = NGX_HTTP_INTERNAL_SERVER_ERROR;

break;

}

if (rc != NGX_HTTP_NOT_FOUND || clcf->log_not_found) {

ngx_log_error(level, log, of.err,

"%s \"%s\" failed", of.failed, path.data);

}

return rc;

}

r->root_tested = !r->error_page;

ngx_log_debug1(NGX_LOG_DEBUG_HTTP, log, 0, "http static fd: %d", of.fd);

if (of.is_dir) {

ngx_log_debug0(NGX_LOG_DEBUG_HTTP, log, 0, "http dir");

ngx_http_clear_location(r);

r->headers_out.location = ngx_palloc(r->pool, sizeof(ngx_table_elt_t));

if (r->headers_out.location == NULL) {

return NGX_HTTP_INTERNAL_SERVER_ERROR;

}

len = r->uri.len + 1;

if (!clcf->alias && clcf->root_lengths == NULL && r->args.len == 0) {

location = path.data + clcf->root.len;

*last = '/';

} else {

if (r->args.len) {

len += r->args.len + 1;

}

location = ngx_pnalloc(r->pool, len);

if (location == NULL) {

return NGX_HTTP_INTERNAL_SERVER_ERROR;

}

last = ngx_copy(location, r->uri.data, r->uri.len);

*last = '/';

if (r->args.len) {

*++last = '?';

ngx_memcpy(++last, r->args.data, r->args.len);

}

}

/*

* we do not need to set the r->headers_out.location->hash and

* r->headers_out.location->key fields

*/

r->headers_out.location->value.len = len;

r->headers_out.location->value.data = location;

return NGX_HTTP_MOVED_PERMANENTLY;

}

#if !(NGX_WIN32) /* the not regular files are probably Unix specific */

if (!of.is_file) {

ngx_log_error(NGX_LOG_CRIT, log, 0,

"\"%s\" is not a regular file", path.data);

return NGX_HTTP_NOT_FOUND;

}

#endif

if (r->method & NGX_HTTP_POST) {

return NGX_HTTP_NOT_ALLOWED;

}

rc = ngx_http_discard_request_body(r);

if (rc != NGX_OK) {

return rc;

}

log->action = "sending response to client";

r->headers_out.status = NGX_HTTP_OK;

r->headers_out.content_length_n = of.size;

r->headers_out.last_modified_time = of.mtime;

if (ngx_http_set_content_type(r) != NGX_OK) {

return NGX_HTTP_INTERNAL_SERVER_ERROR;

}

if (r != r->main && of.size == 0) {

return ngx_http_send_header(r);

}

r->allow_ranges = 1;

/* we need to allocate all before the header would be sent */

b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));

if (b == NULL) {

return NGX_HTTP_INTERNAL_SERVER_ERROR;

}

b->file = ngx_pcalloc(r->pool, sizeof(ngx_file_t));

if (b->file == NULL) {

return NGX_HTTP_INTERNAL_SERVER_ERROR;

}

rc = ngx_http_send_header(r);

if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {

return rc;

}

b->file_pos = 0;

b->file_last = of.size;

b->in_file = b->file_last ? 1: 0;

b->last_buf = (r == r->main) ? 1: 0;

b->last_in_chain = 1;

b->file->fd = of.fd;

b->file->name = path;

b->file->log = log;

b->file->directio = of.is_directio;

out.buf = b;

out.next = NULL;

return ngx_http_output_filter(r, &out);

}

首先是搜检客户端的 http 恳求类型(r->method),若是恳求类型为NGX_HTTP_GET|NGX_HTTP_HEAD|NGX_HTTP_POST,则持续进行处理,不然一律返回 NGX_HTTP_NOT_ALLOWED 从而拒绝客户端的提议的恳求。

其次是搜检恳求的 url 的结尾字符是不是斜杠/,若是是解说恳求的不是一个文件,给后续的 handler 行止理,好比后续的 ngx_http_autoindex_handler(若是是恳求的是一个目录下面,能够列出这个目录的文件),或许是 ngx_http_index_handler(若是恳求的路径下面有个默认的 index 文件,直接返回 index 文件的内容)。

然后接下来挪用了一个 ngx_http_map_uri_to_path 函数,该函数的感化是把恳求的 http 和谈的路径转化成一个文件系统的路径。

然后凭据转化出来的具体路径,去打开文件,打开文件的时候做了 2 种搜检,一种是,若是恳求的文件是个 symbol link,凭据设置,是否许可符号链接,不许可返回错误。还有一个搜检是,若是恳求的是一个名称,是一个目录的名字,也返回错误。若是都没有错误,就读取文件,返回内容。其实说返回内容或者不是稀奇正确,对照正确的说法是,把发生的内容传递给后续的 filter 行止理。

http log module

该模块供应了对于每一个 http 恳求进行记录的功能,也就是我们见到的 access.log。当然这个模块对于 log 供应了一些设置指令,使得能够对照轻易的定制 access.log。

这个模块的代码位于src/http/modules/ngx_http_log_module.c,固然这个模块的代码有接近 1400 行,然则首要的逻辑在于对日志自己花样啊,等细节的处理。我们在这里进行剖析首要是存眷,若何编写一个 log handler 的问题。

因为 log handler 的时候,拿到的参数也是 request 这个器材,那么也就意味着我们若是需要,能够好好研究下这个构造,把我们需要的所有信息都记录下来。

对于 log handler,有一点稀奇需要注重的就是,log handler 是无论若何都邑被挪用的,就是只要办事端接管到了一个客户端的恳求,也就是发生了一个 request 对象,那么这些个 log handler 的处理函数都邑被挪用的,就是在释放 request 的时候被挪用的(ngx_http_free_request函数)。

那么当然绝对不克忘怀的就是 log handler 最好,也是建议被挂载在 NGX_HTTP_LOG_PHASE 阶段。因为挂载在其他阶段,有或者在某些情形下被跳过,而没有执行到,导致你的 log 模块记录的信息不全。

还有一点要解说的是,因为 Nginx 是许可在某个阶段有多个 handler 模块存在的,凭据其处理究竟,确定是否要挪用下一个 handler。然则对于挂载在 NGX_HTTP_LOG_PHASE 阶段的 handler,则基本不存眷这里 handler 的具体处理函数的返回值,所有的都被挪用。如下,位于src/http/ngx_http_request.c中的 ngx_http_log_request 函数。 static void

ngx_http_log_request(ngx_http_request_t *r)

{

ngx_uint_t i, n;

ngx_http_handler_pt *log_handler;

ngx_http_core_main_conf_t *cmcf;

cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);

log_handler = cmcf->phases[NGX_HTTP_LOG_PHASE].handlers.elts;

n = cmcf->phases[NGX_HTTP_LOG_PHASE].handlers.nelts;

for (i = 0; i < n; i++) {

log_handler[i](r);

}

}

相关文章