Nginx源码分析 - 实战篇 - 编写一个阶段化的模块(25)

老码农zhuli 2020-11-13 04:45:51
nginx 分析 源码 实战 实战篇


目录

代码实例

初始化绑定阶段处理

回调函数写日志

编译调试结果


代码实例


HTTP模块篇,我们讲过Nginx的HTTP阶段处理 《Nginx源码分析 - HTTP模块篇 - HTTP模块的阶段处理PHASE handler》

我们代码在《Nginx源码分析 - 实战篇 - 编写一个自定义的模块》的基础上,将定义一个回调函数挂载到HTTP处理的阶段上。

#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>
static ngx_int_t ngx_http_hello_handler(ngx_http_request_t *r);
static char *
ngx_http_hello(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
static ngx_int_t ngx_http_hello_init(ngx_conf_t *cf);
static ngx_int_t ngx_http_hello_log_handler(ngx_http_request_t *r);
/**
* 处理nginx.conf中的配置命令解析
* 例如:
* location /hello {
* hello
* }
* 当用户请求:http://127.0.0.1/hello的时候,请求会跳转到hello这个配置上
* hello的命令行解析回调函数:ngx_http_hello
*/
static ngx_command_t ngx_http_hello_commands[] = { {
ngx_string("hello"),
NGX_HTTP_MAIN_CONF | NGX_HTTP_SRV_CONF | NGX_HTTP_LOC_CONF | NGX_HTTP_LMT_CONF
| NGX_CONF_NOARGS, ngx_http_hello,
NGX_HTTP_LOC_CONF_OFFSET, 0, NULL },
ngx_null_command };
/**
* 模块上下文
*/
static ngx_http_module_t ngx_http_hello_module_ctx = { NULL, ngx_http_hello_init, NULL, NULL,
NULL, NULL, NULL, NULL };
/**
* 模块的定义
*/
ngx_module_t ngx_http_hello_module = {
NGX_MODULE_V1, &ngx_http_hello_module_ctx, ngx_http_hello_commands,
NGX_HTTP_MODULE, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
NGX_MODULE_V1_PADDING };
/**
* 命令解析的回调函数
* 该函数中,主要获取loc的配置,并且设置location中的回调函数handler
*/
static char *
ngx_http_hello(ngx_conf_t *cf, ngx_command_t *cmd, void *conf) {
ngx_http_core_loc_conf_t *clcf;
clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
/* 设置回调函数。当请求http://127.0.0.1/hello的时候,会调用此回调函数 */
clcf->handler = ngx_http_hello_handler;
return NGX_CONF_OK;
}
/**
* 模块回调函数,输出hello world
*/
static ngx_int_t ngx_http_hello_handler(ngx_http_request_t *r) {
if (!(r->method & (NGX_HTTP_GET | NGX_HTTP_HEAD))) {
return NGX_HTTP_NOT_ALLOWED;
}
ngx_int_t rc = ngx_http_discard_request_body(r);
if (rc != NGX_OK) {
return rc;
}
ngx_str_t type = ngx_string("text/plain");
ngx_str_t response = ngx_string("Hello World");
r->headers_out.status = NGX_HTTP_OK;
r->headers_out.content_length_n = response.len;
r->headers_out.content_type = type;
rc = ngx_http_send_header(r);
if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {
return rc;
}
ngx_buf_t *b;
b = ngx_create_temp_buf(r->pool, response.len);
if (b == NULL) {
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
ngx_memcpy(b->pos, response.data, response.len);
b->last = b->pos + response.len;
b->last_buf = 1;
ngx_chain_t out;
out.buf = b;
out.next = NULL;
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
"hello world ");
return ngx_http_output_filter(r, &out);
}
/**
* 初始化
* 将ngx_http_hello_log_handler挂载到NGX_HTTP_LOG_PHASE日志处理阶段
*/
static ngx_int_t ngx_http_hello_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_LOG_PHASE].handlers);
if (h == NULL) {
return NGX_ERROR;
}
*h = ngx_http_hello_log_handler;
return NGX_OK;
}
/**
* NGX_HTTP_LOG_PHASE日志处理阶段的回调函数å
*/
static ngx_int_t ngx_http_hello_log_handler(ngx_http_request_t *r) {
/* 仅仅在日志处理阶段,新增加一行日志 */
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
"hello ==================================> ");
return NGX_DECLINED;
}

初始化绑定阶段处理


我们定义了一个ngx_http_hello_init的方法,主要用于将ngx_http_hello_log_handler函数挂载到NGX_HTTP_LOG_PHASE日志处理阶段

/**
* 初始化
* 将ngx_http_hello_log_handler挂载到NGX_HTTP_LOG_PHASE日志处理阶段
*/
static ngx_int_t ngx_http_hello_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_LOG_PHASE].handlers);
if (h == NULL) {
return NGX_ERROR;
}
*h = ngx_http_hello_log_handler;
return NGX_OK;
}

其中ngx_http_hello_init方法在模块上下文ngx_http_hello_module_ctx的处理阶段被初始化

/**
* 模块上下文
*/
static ngx_http_module_t ngx_http_hello_module_ctx = { NULL, ngx_http_hello_init, NULL, NULL,
NULL, NULL, NULL, NULL };

回调函数写日志


回调函数ngx_http_hello_log_handler,主要写一行error的日志

/**
* NGX_HTTP_LOG_PHASE日志处理阶段的回调函数å
*/
static ngx_int_t ngx_http_hello_log_handler(ngx_http_request_t *r) {
/* 仅仅在日志处理阶段,新增加一行日志 */
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
"hello ==================================> ");
return NGX_DECLINED;
}

编译调试结果


因为我们绑定的是日志处理阶段,所以每次对Nginx的HTTP请求,都会回调ngx_http_hello_log_hanlder方法

我们可以看Nginx的日志中发现,我们已经成功了


 

版权声明
本文为[老码农zhuli]所创,转载请带上原文链接,感谢
https://initphp.blog.csdn.net/article/details/72912723

  1. [front end -- JavaScript] knowledge point (IV) -- memory leakage in the project (I)
  2. This mechanism in JS
  3. Vue 3.0 source code learning 1 --- rendering process of components
  4. Learning the realization of canvas and simple drawing
  5. gin里获取http请求过来的参数
  6. vue3的新特性
  7. Get the parameters from HTTP request in gin
  8. New features of vue3
  9. vue-cli 引入腾讯地图(最新 api,rocketmq原理面试
  10. Vue 学习笔记(3,免费Java高级工程师学习资源
  11. Vue 学习笔记(2,Java编程视频教程
  12. Vue cli introduces Tencent maps (the latest API, rocketmq)
  13. Vue learning notes (3, free Java senior engineer learning resources)
  14. Vue learning notes (2, Java programming video tutorial)
  15. 【Vue】—props属性
  16. 【Vue】—创建组件
  17. [Vue] - props attribute
  18. [Vue] - create component
  19. 浅谈vue响应式原理及发布订阅模式和观察者模式
  20. On Vue responsive principle, publish subscribe mode and observer mode
  21. 浅谈vue响应式原理及发布订阅模式和观察者模式
  22. On Vue responsive principle, publish subscribe mode and observer mode
  23. Xiaobai can understand it. It only takes 4 steps to solve the problem of Vue keep alive cache component
  24. Publish, subscribe and observer of design patterns
  25. Summary of common content added in ES6 + (II)
  26. No.8 Vue element admin learning (III) vuex learning and login method analysis
  27. Write a mini webpack project construction tool
  28. Shopping cart (front-end static page preparation)
  29. Introduction to the fluent platform
  30. Webpack5 cache
  31. The difference between drop-down box select option and datalist
  32. CSS review (III)
  33. Node.js学习笔记【七】
  34. Node.js learning notes [VII]
  35. Vue Router根据后台数据加载不同的组件(思考-&gt;实现-&gt;不止于实现)
  36. Vue router loads different components according to background data (thinking - & gt; Implementation - & gt; (more than implementation)
  37. 【JQuery框架,Java编程教程视频下载
  38. [jQuery framework, Java programming tutorial video download
  39. Vue Router根据后台数据加载不同的组件(思考-&gt;实现-&gt;不止于实现)
  40. Vue router loads different components according to background data (thinking - & gt; Implementation - & gt; (more than implementation)
  41. 【Vue,阿里P8大佬亲自教你
  42. 【Vue基础知识总结 5,字节跳动算法工程师面试经验
  43. [Vue, Ali P8 teaches you personally
  44. [Vue basic knowledge summary 5. Interview experience of byte beating Algorithm Engineer
  45. 【问题记录】- 谷歌浏览器 Html生成PDF
  46. [problem record] - PDF generated by Google browser HTML
  47. 【问题记录】- 谷歌浏览器 Html生成PDF
  48. [problem record] - PDF generated by Google browser HTML
  49. 【JavaScript】查漏补缺 —数组中reduce()方法
  50. [JavaScript] leak checking and defect filling - reduce() method in array
  51. 【重识 HTML (3),350道Java面试真题分享
  52. 【重识 HTML (2),Java并发编程必会的多线程你竟然还不会
  53. 【重识 HTML (1),二本Java小菜鸟4面字节跳动被秒成渣渣
  54. [re recognize HTML (3) and share 350 real Java interview questions
  55. [re recognize HTML (2). Multithreading is a must for Java Concurrent Programming. How dare you not
  56. [re recognize HTML (1), two Java rookies' 4-sided bytes beat and become slag in seconds
  57. 【重识 HTML ,nginx面试题阿里
  58. 【重识 HTML (4),ELK原来这么简单
  59. [re recognize HTML, nginx interview questions]
  60. [re recognize HTML (4). Elk is so simple