nginx模块开发入门

最新推荐文章于 2024-05-30 00:47:18 发布
最新推荐文章于 2024-05-30 00:47:18 发布
阅读量974 收藏
点赞数
分类专栏： Nginx 源码解析

1 前言

这是本人一边看着教程一边敲c代码记的笔记,写得比较随意。欢迎来信指出错误;(邮箱:xurenlu @ gmail.com ),blog:http://www.162cm.com/; 本文在网上随时更新:http://www.162cm.com/p/ngx_ext.html

2 开发nginx模块之Hello World篇(手把手走一遍)

2.1 进行echo模块的功能设计

以下是本模块要能识别的nginx配置

 

 

作为演示模块,我们这个模块仅仅完成以下功能:
 

  1. 读入nginx.conf中以echo开头的配置;echo是本模块新加入的命令,意思是直接输出; 例如:
  2. 在用户访问/hello时设置文件头为content-type=application/html; 
  3. 在用户访问/hello时输出指定的欢迎词,比如“Hi,this is a demo module”; 
 

2.2 准备nginx的源代码
 

可直接到[http://www.nginx.net/]下载,解压缩;
 

 
 
~#tar -xzf nginx-0.8.9.tar.gz

 

 

2.3 准备好nginx的配置文件,越简单越好,并且要打开调试,关闭daemon模式;
 

 
 
~#vim nginx.conf

 

 

 
 
worker_processes  1;
daemon off; 
master_process  off;
error_log  /tmp/error.log debug;
pid /tmp/nginx_demo.pid;
events {
    worker_connections  1024;
}
http {
    include       /etc/nginx/mime.types;
    sendfile        on;
    keepalive_timeout  65;
    tcp_nodelay        on;
    server {
        listen   8100;
        server_name  localhost;
        access_log  /tmp/access.log;
        error_log  /tmp/error.log debug;
        location /hello {
            echo "Hi,this is a demo module";
        }
    }
}

 

 

2.4 创建nginx模块目录
 

 
 
~#mkdir ngx_module_echo

 

 

2.5 编辑nginx模块的编译相关文件(config)
 

 
 
!#vim ngx_module_echo/config

 

 

其内容为:
 

ngx_addon_name=ngx_module_echo
HTTP_MODULES="$HTTP_MODULES ngx_module_echo"
NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_module_echo.c"
CORE_LIBS="$CORE_LIBS "
#CORE_LIBS="$CORE_LIBS -lm"

 

其实这里的意思也很好理解,这里告诉nginx编译的时候应该在哪里找到模块的源文件;这里指出了我们要包含进来的源文件是ngx_module_echo.c,编辑它,具体内容后面会给出:
 

 
 
#vim ngx_module_echo/ngx_module_echo.c

 

 

,然后试着配置一下nginx:
 

 
 
~#cd nginx-0.8.9
~/nginx-0.8.9/#./configure --add-module=~/ngx_module_echo/

 

 

,会报错:
 

 
 
./configure: error: no ~/ngx_module_echo//config was found

 

 

那是因为我们没有编辑好~/ngx_module_echo/ngx_module_echo.c这个文件,把它的内容改为:
 

 
 

#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>

static char* ngx_echo_readconf(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
static void* ngx_echo_create_loc_conf(ngx_conf_t *cf);
static char* ngx_echo_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child);

typedef struct {
    ngx_str_t ecdata;
    ngx_flag_t           enable;
} ngx_echo_loc_conf_t;

static ngx_command_t  ngx_echo_commands[] = {
    { ngx_string("echo"),
      NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
      ngx_echo_readconf,
      NGX_HTTP_LOC_CONF_OFFSET,
      offsetof(ngx_echo_loc_conf_t, ecdata),
      NULL },
      ngx_null_command
};


static ngx_http_module_t  ngx_echo_module_ctx = {
    NULL,                          /* preconfiguration */
    NULL,           /* postconfiguration */

    NULL,                          /* create main configuration */
    NULL,                          /* init main configuration */

    NULL,                          /* create server configuration */
    NULL,                          /* merge server configuration */

    ngx_echo_create_loc_conf,  /* create location configuration */
    ngx_echo_merge_loc_conf /* merge location configuration */
};


ngx_module_t  ngx_module_echo = {
    NGX_MODULE_V1,
    &ngx_echo_module_ctx, /* module context */
    ngx_echo_commands,   /* module directives */
    NGX_HTTP_MODULE,               /* module type */
    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_int_t
ngx_echo_handler(ngx_http_request_t *r)
{
    printf("called:ngx_echo_handler\n");
    ngx_int_t     rc;
    ngx_buf_t    *b;
    ngx_chain_t   out;

    ngx_echo_loc_conf_t  *cglcf;
    cglcf = ngx_http_get_module_loc_conf(r, ngx_module_echo);
    // 必须是 GET 或者 HEAD 方法，否则返回 405 Not Allowed
    if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD))) {
        return NGX_HTTP_NOT_ALLOWED;
    }
    if (r->headers_in.if_modified_since) {
        return NGX_HTTP_NOT_MODIFIED;
    }
   /* 设置返回的 Content-Type。注意，ngx_str_t 有一个很方便的初始化宏 ngx_string，它可以把ngx_str_t 的 data 和 len 成员都设置好 */
    
	// 设置 Content-Type
	r->headers_out.content_type.len = sizeof("text/html") - 1;
    r->headers_out.content_type.data = (u_char *) "text/html";
 
    // 等同于 ngx_str_t type = ngx_string("text/plain");
    
	// 设置返回状态码
    r->headers_out.status = NGX_HTTP_OK;
	// 响应包是有包体内容的，需要设置 Content-Length 长度
    r->headers_out.content_length_n = cglcf->ecdata.len;
    // 发送 HTTP 头部
    if (r->method == NGX_HTTP_HEAD) {
        rc = ngx_http_send_header(r);

        if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {
            return rc;
        }
    }
    //构造 ngx_buf_t 结构体准备发送包体
    b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));
    if (b == NULL) {
    ngx_log_error(NGX_LOG_ERR, r->connection->log, 0, "Failed to allocate
                  response buffer.");
        return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }
    // 赋值 ngx_buf_t
    out.buf = b;
	// 设置 next 为 NULL
    out.next = NULL;
    

    b->pos = cglcf->ecdata.data;
   // 注意，一定要设置好 last 指针
    b->last = cglcf->ecdata.data+(cglcf->ecdata.len);

    b->memory = 1;
	// 声明这是最后一块缓冲区
    b->last_buf = 1;
	 
    rc = ngx_http_send_header(r);

    if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {
        return rc;
    }
	/* 最后一步为发送包体，发送结束后 HTTP 框架会调用 ngx_http_finalize_request 方法结束请求 */
    return ngx_http_output_filter(r, &out);
}
static char *
ngx_echo_readconf(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
    printf("called:ngx_echo_readconf\n");
    ngx_http_core_loc_conf_t  *clcf;

    clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
    clcf->handler = ngx_echo_handler;
    ngx_conf_set_str_slot(cf,cmd,conf);
    return NGX_CONF_OK;
}


static void *
ngx_echo_create_loc_conf(ngx_conf_t *cf)
{
    printf("called:ngx_echo_create_loc_conf\n");
    ngx_echo_loc_conf_t  *conf;

    conf = ngx_pcalloc(cf->pool, sizeof(ngx_echo_loc_conf_t));
    if (conf == NULL) {
        return NGX_CONF_ERROR;
    }

    conf->ecdata.len=0;
    conf->ecdata.data=NULL;
    conf->enable = NGX_CONF_UNSET;
    return conf;
}
static char *
ngx_echo_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
{
    printf("called:ngx_echo_merge_loc_conf\n");
    ngx_echo_loc_conf_t *prev = parent;
    ngx_echo_loc_conf_t *conf = child;

    ngx_conf_merge_str_value(conf->ecdata, prev->ecdata, 10);
    ngx_conf_merge_value(conf->enable, prev->enable, 0);
/**
    if(conf->enable)
        ngx_echo_init(conf);
        */
    return NGX_CONF_OK;
    return NGX_CONF_OK;
}


 

以上为原版，以下为《深入解析Nginx》书中的内容：
 

 
 

 
 

static ngx_int_t ngx_http_mytest_handler(ngx_http_request_t *r)
{
// 必须是 GET 或者 HEAD 方法，否则返回 405 Not Allowed
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;
}
/* 设置返回的 Content-Type。注意，ngx_str_t 有一个很方便的初始化宏 ngx_string，它可以把
ngx_str_t 的 data 和 len 成员都设置好 */
ngx_str_t type = ngx_string("text/plain");
// 返回的包体内容
ngx_str_t response = ngx_string("Hello World!");
// 设置返回状态码
r->headers_out.status = NGX_HTTP_OK;
// 响应包是有包体内容的，需要设置 Content-Length 长度
r->headers_out.content_length_n = response.len;
// 设置 Content-Type
r->headers_out.content_type = type;
// 发送 HTTP 头部
rc = ngx_http_send_header(r);
if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {return rc;
}
// 构造 ngx_buf_t 结构体准备发送包体
ngx_buf_t *b;
b = ngx_create_temp_buf(r->pool, response.len);
if (b == NULL) {
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
// 将 Hello World 复制到 ngx_buf_t 指向的内存中
ngx_memcpy(b->pos, response.data, response.len);
// 注意，一定要设置好 last 指针
b->last = b->pos + response.len;
// 声明这是最后一块缓冲区
b->last_buf = 1;
// 构造发送时的 ngx_chain_t 结构体
ngx_chain_t out;
// 赋值 ngx_buf_t
out.buf = b;
// 设置 next 为 NULL
out.next = NULL;
/* 最后一步为发送包体，发送结束后 HTTP 框架会调用 ngx_http_finalize_request 方法结束请求 */
return ngx_http_output_filter(r, &out);
}
 


 
  
 


  下面好了,再回到nginx的源目录configure: 

 

 
 
~/nginx-0.8.9/#./configure --add-module=/home/renlu/ngx_module_echo/ --with-
                                        debug
.... 这里省却输出;
make

 

 

然后运行一下看看,先测一下配置文件的正确性:
 

 
 
~/nginx-0.8.9/#./objs/nginx -c /home/renlu/ngx_module_echo/nginx.conf -t
called:ngx_echo_create_loc_conf
called:ngx_echo_create_loc_conf
called:ngx_echo_create_loc_conf
called:ngx_echo_readconf
called:ngx_echo_merge_loc_conf
called:ngx_echo_merge_loc_conf
the configuration file /home/renlu/ngx_module_echo/nginx.conf syntax is ok
configuration file /home/renlu/ngx_module_echo/nginx.conf test is successful

 

 

运行之:
 

 
 
~/nginx-0.8.9/#./objs/nginx -c /home/renlu/ngx_module_echo/nginx.conf
called:ngx_echo_create_loc_conf
called:ngx_echo_create_loc_conf
called:ngx_echo_create_loc_conf
called:ngx_echo_readconf
called:ngx_echo_merge_loc_conf
called:ngx_echo_merge_loc_conf

 

 

在另一个终端执行一个curl:
 

 
 
~#curl http://localhost:8100/hello
Hi,this is a demo module

 

 

好了,大功告成,nginx模块版的hello world就到这里了;
 

3 Nginx模块开发之入门介绍
 

3.1 Nginx 配置文件
 

Nginx配置文件中的指令一般分为main,server,location,upstream四种;
 

  1. main: 全局指令,比如本文中 worker_processes 1这些; 
  2. server:特定主机相关的配置; 
  3. location:特定uri相关的配置; 
  4. upstream:上游服务器相关配置,fastcgi,proxy_pass这类都可能用到; 
 

3.2 Nginx 模块的分类
 

Nginx的模块一般也分为三种:
 

  1. handlers :直接处理请求,进行输出内容,修改headers信息等操作;handlers处理器模块一般只能有一个;
  2. filters (过滤器模块),对其他处理器模块输出的内容进行修改操作,最后再交给nginx去输出; 
  3. proxies (代理类模块),其实也就是upstream类的模块;主要跟后端一些服务比如fastcgi等操交互,代理,负载均衡都属于这类;
     其实这些nginx模块具体的处理函数原型都是一样的: 
 

 
 
    static ngx_int_t ngx_http_module_handler (ngx_http_request_t *r);

 

 

只是内部的处理各不相同,而且分为三种,也只是对它们具体做的事情的特点做了一个总结而已; 处理器模块一般是自己进行处理,过滤器模块是在原来的输出上进行修改,而上游模块是再去连接其他网络地址,请求一定内容来输出.
 

3.3 Nginx模块的加载
 

  1. Nginx 模块是被编译进入了nginx,而不像apache是编译一个so文件在配置文件中指定是否加载
  2. 解析配置文件时,Nginx 的各个模块都有机会去接手处理某个请求;但是,同一URI处理请求的模块只能有一个,所有的模块会“竟争”这个,不会出到地址”/index.php”这一个location同时被fastcgi和proxy两个模块处理的情况;至于竟争的过程….我还没弄清楚,需要继续读代码才知道;
  3. nginx模块可以在任何时候发生效果,比如: 
  
    1. 在读取配置文件之前 
    2. 读到存在 location 和 server 下或其他任何部分下的每一个配置指令 
    3. 当 Nginx 初始化全局部分配置时 
    4. 当 Nginx 初始化server部分配置时 
    5. 当 Nginx 将全局部分的配置与server部分的配置合并的时候 
    6. 当 Nginx 初始化location部分配置的时候 
    7. 当 Nginx 将其上层server配置与位置(location)部分配置合并的时候 
    8. 当 Nginx 的主进程开始的时候 
    9. 当一个新的工作进程(worker)开始的时候 
    10. 当一个工作进程退出的时候 
    11. 当主进程退出的时候 
    12. 在处理请求时 
    13. 在过滤回应(response)的头部 
    14. 在过滤回应(response)的主体 
    15. 选择一台后端服务器时 
    16. 初始化到后端服务器的请求 
    17. 重新初始化到后端的服务器的请求(reinit_request) 
    18. 处理来自后端服务器的回复 
    19. 完成与后端服务器的交互 
     
 

转自：http://www.162cm.com/p/ngx_ext.html

                

        

        

    

  


    

      

        

            

              
                
                  wdt3385
                
              
            

            

                关注
              
            

        

        

          
      

      

            

                专栏目录
          









                



	

		

			

				
					
7步精通：从编写到发布，打造你的Nginx模块

				
			

			

				

					java专栏
				

				

					09-02
					
					1302
					
				

			

		

		

			
				
想象一下，Nginx就像是一个多功能的瑞士军刀，而模块就是这把刀上的不同工具。每个模块都赋予了Nginx新的功能，让这个服务器能够执行特定的任务。模块化的设计让Nginx既灵活又强大，可以轻松应对各种网络服务的需求。恭喜你，现在你已经成功搭建了Nginx模块的开发环境，并且创建了模块的基础框架。在下一章，我们将深入到模块的编写和实现，让你的模块真正开始工作。准备好了吗？让我们继续前进，探索Nginx模块开发的奇妙世界！🌈🚀恭喜你，你已经成功编写并测试了你的第一个Nginx模块！

			
		

	



                

            
              



	

		

			

				
					
Nginx模块开发入门

				
			

			

				

					07-02
				

			

		

		

			
				
### Nginx模块开发入门详解  #### Nginx概述与市场地位  Nginx作为一款高性能的HTTP服务器和反向代理服务器，在全球范围内享有极高的声誉。根据权威机构W3Techs的数据，截至某一时间点，全球排名前100万的网站中，...

			
		

	



              


  
              

                


	

		

			

				
					
详细解释：nginx中Nginx Main Module（主模块）配置及各个参数含义

				
			

			

				

					eltdong的专栏
				

				

					10-10
					
					290
					
				

			

		

		

			
				

这里是控制 Nginx 的基本功能的指令.
指令：
[#daemon daemon]
[#debug_points debug_points]
[#error_log error_log]
[#include include]
[#lock_file lock_file]
[#master_process master_process]
[#pid pid]
[#ssl_en...

			
		

	





	

		

			

				
					
nginx代理windowsAD域认证 ntlm认证处理

				
			

			

				

					weixin_44310246的博客
				

				

					04-12
					
					2643
					
				

			

		

		

			
				
于是我换个搜索引擎再搜搜，发现了大佬写的ntlm模块，只需要下载下来，然后解压，按说明添加模板，在upstream中加一个 ntlm;把keepalive_requests 设置为3，keepalive_timeout 设置为1，只能减少几率，但是并发上来，还是得凉，这肯定不允许啊。因为建立的是长连接，会导致2个或者多个用户同时认证时，可能会返回别人的信息，比如张三和李四同时认证，然后张三的电脑返回了李四的info，于是我又打开了搜索引擎（天晴了，雨停了，我觉得我又行了），搜索NTLM认证原理。

			
		

	



		

			
		



	

		

			

				
					
【nginx】开发一个模块的简要步骤

				
			

			

				

					weixin_43747685的博客
				

				

					10-06
					
					1678
					
				

			

		

		

			
				
1、nginx模块的基本数据结构
2、搭建http的过滤器功能
3、新增模块的编译和运行

			
		

	





	

		

			

				
					
安装nginx出现编译错误：./configure: error

				
			

			

				

					cat_star的博客
				

				

					08-14
					
					6752
					
				

			

		

		

			
				
在Centos安装nginx遇到的rewrite和HTTP cache错误解决办法：

wgethttp://nginx.org/download/nginx-0.8.33.tar.gz
tar-zxvfnginx-0.8.33.tar.gz
cdnginx-0.8.33
./configure--prefix=/usr/local/nginx



安装Nginx时报错

./c...

			
		

	





	

		

			

				
					
nginx模块开发指南

				
			

			

				

					09-21
				

			

		

		

			
				
nginx模块开发指南中涵盖的知识点极为丰富，它不仅提供了nginx模块开发的入门指导，还深入探讨了HTTP模块及通信协议的相关知识。在预备知识部分，指南着重强调了C语言的基础技能，以及对nginx配置文件结构的理解是...

			
		

	





	

		

			

				
					
Nginx开发从入门到精通pdf高清带目录

				
			

			

				

					10-11
				

			

		

		

			
				
《Nginx开发从入门到精通》是一本深入解析Nginx技术的书籍，适合对Web服务器技术感兴趣的初学者和进阶者。Nginx是一款高性能的HTTP和反向代理服务器，广泛应用于互联网领域的网站部署和负载均衡。本书旨在帮助读者...

			
		

	





	

		

			

				
					
nginx模块开发之一

				
			

			

				

					for_tech的博客
				

				

					05-17
					
					2175
					
				

			

		

		

			
				
本文以开发一个简单nginx模块为例，讲述nginx http模块开发的入门知识。

			
		

	





	

		

			

				
					
Linux下./configure错误详解

				
			

			

				

					weixin_33897722的博客
				

				

					10-07
					
					3667
					
				

			

		

		

			
				
说明:
sudo apt-get install  package-name   更新你指定的软件包
sudo apt-get update                           获取更新列表 
sudo apt-get dist-upgrade                  开始更新

./configure的问题
错误： C compiler cannot cre...

			
		

	





	

		

			

				
					
nginx 模块架构介绍

				
			

			

				

					王道长的技术博客
				

				

					10-31
					
					3608
					
				

			

		

		

			
				
nginx架构介绍
Nginx 的代码是由一个 核心 和一系列的 模块 组成。
核心
核心的功能如下：
主要用于提供 WebServer 的基本功能；
实现 Web 和 Mail 反向代理的功能；
还用于启用网络协议；
创建必要的运行时环境以及确保不同的模块之间平滑地进行交互。
模块
大多跟协议相关的功能和应用特有的功能都是由 Nginx 的模块实现的。
这些功能模块大致可以分为：事件模块、阶段性...

			
		

	





	

		

			

				
					
Centos中安装带rtmp模块的Nginx

				
			

			

				

					VirtualMe的博客
				

				

					05-07
					
					1709
					
				

			

		

		

			
				
Centos7安装带nginx-rtmp-module模块的nginx，通过该模块可以实现基础的推流服务器、点播服务器、直播服务器、hls协议、rtmp协议等功能

			
		

	





	

		

			

				
					
Neginx配置

				
			

			

				

					wujianjun6932的专栏
				

				

					03-08
					
					1158
					
				

			

		

		

			
				
./configure \
--prefix=/usr/local/nginx \
--pid-path=/var/run/nginx/nginx.pid \
--lock-path=/var/lock/nginx.lock \
--error-log-path=/var/log/nginx/error.log \
--http-log-path=/var/log/nginx/acces

			
		

	





	

		

			

				
					
安装nginx时./configure报错

				
			

			

				

					qq_59833893的博客
				

				

					11-09
					
					1989
					
				

			

		

		

			
				
【代码】安装nginx时./configure报错。

			
		

	





	

		

			

				
					
【Nginx 进阶】2、模块化设计

					
最新发布

				
			

			

				

					weixin_52938153的博客
				

				

					05-30
					
					793
					
				

			

		

		

			
				
Nginx（发音为“engine-x”）是一个高性能的HTTP和反向代理服务器，同时也是一个IMAP/POP3代理服务器。由俄罗斯的程序员Igor Sysoev所开发，首个公开版本发布于2004年。Nginx是免费的开源软件，遵循类BSD许可协议的条款发布。

Nginx的设计优化重点在于高并发、高性能和低内存使用。在架构上，Nginx使用异步事件驱动的方法，这使得它在处理大量并发连接时表现出色，特别是在处理静态资源、反向代理或负载平衡时，效率极高。由于其稳定性和轻量级的资源占用，Nginx非常适合在现代的

			
		

	





	

		

			

				
					
Nginx模块开发入门指南

				
			

			

				

					
				

			

		

		

			
				
"Nginx模块开发入门."  Nginx是一个高度可扩展的HTTP服务器，以其在高并发场景下的优秀性能而闻名。它采用微内核架构，核心功能精简，但可以通过添加各种模块来增强其功能。随着Nginx的发展，越来越多的公司，如淘宝...

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

	
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

                
 1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
 2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

              

            

          

      

      余额充值