Nginx服务模块开发

最新推荐文章于 2022-09-15 16:49:19 发布
置顶 最新推荐文章于 2022-09-15 16:49:19 发布
阅读量998 收藏 1
点赞数
分类专栏： Nginx 文章标签： nginx 服务器 源码 数据 tcp
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/gamer727/article/details/50449662
版权
本文介绍了如何开发一个基于TCP协议的Nginx服务模块，详细解析了从配置文件增加自定义设置到模块编译进nginx的五个步骤，包括监听端口、初始化参数、处理连接等关键环节。并提供了自定义mypo模块的源码，该模块用于转发客户端数据至指定上流服务器。
摘要由CSDN通过智能技术生成

纵观网上各种关于nginx的模块开发的资料都是基于HTTP的模块开发，这里就整理一篇是基于TCP协议的服务模块开发，并且给出一套自定义服务模块的源码，该模块主要实现的功能是监听某一端口，然后把接收到的客户端数据转发的上流服务器，再把上流服务器的返回数据回传给客户端。模块源码下载地址：https://code.csdn.net/gamer727/nginx_mypo_module
Nginx的服务模块一般都是以四个字母命名的，这里就命名为mypo模块（mypo取“my port”前四个字母）。本模块开发的nginx的版本为1.6.2

根据个人的研究整理，nginx的开发步骤大致归纳以下五步：
第一步，在配置文件中增加自定义配置；
第二步，根据配置文件的内容初始化各种参数；
第三步，开始初始化服务，也就是开始绑定端口，监听端口；
第四步，给各个连接（connection）设置业务处理，这里的业务处理的细节步骤就取决于需求的复杂度了；
第五步，把自定义模块编译进nginx。

第一步，在配置文件nginx.conf中增加自定义配置

mypo {
    server {
        listen 1025;
        upstream 127.0.0.1:1027;

   }

}
配置文件参考

http的，配置文件一般分成三个等级：main、server、location，由于mypo只实现基本的转发功能，所以这里就两个配置，一个listen监听本地端口的，和一个upstream配置上流服务器的。

第二步，根据配置文件的内容初始化各种参数

这里开始进入源码，首先参考http模块新建mypo模块的核心文件：
ngx_mypo_config.h，定义mypo模块的主要结构体和模块标识；
ngx_mypo.c、ngx_mypo.h，mypo模块的入口，调用各种子模块；
ngx_mypo_core_module.c、ngx_mypo_core_module.h，子模块的核心，读取server级别的配置。

首先讲解一下全局配置头文件ngx_mypo_config.h的部分内容：

typedef struct {
    void        **main_conf;
    void        **srv_conf;
    void        **loc_conf;
} ngx_mypo_conf_ctx_t;


typedef struct {
    ngx_int_t   (*preconfiguration)(ngx_conf_t *cf);
    ngx_int_t   (*postconfiguration)(ngx_conf_t *cf);

    void       *(*create_main_conf)(ngx_conf_t *cf);
    char       *(*init_main_conf)(ngx_conf_t *cf, void *conf);

    void       *(*create_srv_conf)(ngx_conf_t *cf);
    char       *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf);

    void       *(*create_loc_conf)(ngx_conf_t *cf);
    char       *(*merge_loc_conf)(ngx_conf_t *cf, void *prev, void *conf);
} ngx_mypo_module_t;

//定义mypo模块的标识，为了避免数值冲突和统一风格，数值是模块名的ASCII码
#define NGX_MYPO_MODULE           0x4D59504F   /* "MYPO" */

ngx_mypo.c：

//读取完配置文件后，如果匹配到了mypo{}就会调用这个结构体里赋值的
//ngx_mypo_block函数，可以说ngx_mypo_block是mypo的整体框架。
static ngx_command_t  ngx_mypo_commands[] = {

    { ngx_string("mypo"),
      NGX_MAIN_CONF|NGX_CONF_BLOCK|NGX_CONF_NOARGS,
      ngx_mypo_block,
      0,
      0,
      NULL },

      ngx_null_command
};


static ngx_core_module_t  ngx_mypo_module_ctx = {
    ngx_string("mypo"),
    NULL,
    NULL
};

//服务模块入口的结构体，所有的服务模块入口结构体的ngx_module_t.type
//都是设置为NGX_CORE_MODULE的，子模块就是自定义的，如NGX_MYPO_MODULE。
ngx_module_t  ngx_mypo_module = {
    NGX_MODULE_V1,
    &ngx_mypo_module_ctx,                  /* module context */
    ngx_mypo_commands,                     /* module directives */
    NGX_CORE_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 char *
ngx_mypo_block(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
    char                        *rv;
    ngx_uint_t                   mi, m, s;
    ngx_conf_t                   pcf;
    ngx_mypo_module_t           *module;
    ngx_mypo_conf_ctx_t         *ctx;
    ngx_mypo_core_loc_conf_t    *clcf;
    ngx_mypo_core_srv_conf_t   **cscfp;
    ngx_mypo_core_main_conf_t   *cmcf;

    /* the main mypo context */

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

    *(ngx_mypo_conf_ctx_t **) conf = ctx;


    /* count the number of the mypo modules and set up their indices */

    ngx_mypo_max_module = 0;
    for (m = 0; ngx_modules[m]; m++) {
        if (ngx_modules[m]->type != NGX_MYPO_MODULE) {
            continue;
        }

        ngx_modules[m]->ctx_index = ngx_mypo_max_module++;
    }

    /* the mypo main_conf context, it is the same in the all mypo contexts */

    ctx->main_conf = ngx_pcalloc(cf->pool,
                                 sizeof(void *) * ngx_mypo_max_module);
    if (ctx->main_conf == NULL) {
        return NGX_CONF_ERROR;
    }


    /*
     * the mypo null srv_conf context, it is used to merge
     * the server{}s' srv_conf's
     */

    ctx->srv_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_mypo_max_module);
    if (ctx->srv_conf == NULL) {
        return NGX_CONF_ERROR;
    }


    /*
     * the mypo null loc_conf context, it is used to merge
     * the server{}s' loc_conf's
     */

    ctx->loc_conf = ngx_pcalloc(cf->pool, sizeof(void *) * ngx_mypo_max_module);
    if (ctx->loc_conf == NULL) {
        return NGX_CONF_ERROR;
    }


    /*
     * create the main_conf's, the null srv_conf's, and the null loc_conf's
     * of the all mypo modules
     */

    for (m = 0; ngx_modules[m]; m++) {
        if (ngx_modules[m]->type != NGX_MYPO_MODULE) {
            continue;
        }

        module = ngx_modules[m]->ctx;
        mi = ngx_modules[m]->ctx_index;

        if (module->create_main_conf) {
            ctx->main_conf[mi] = module->create_main_conf(cf);
            if (ctx->main_conf[mi] == NULL) {
                return NGX_CONF_ERROR;
            }
        }

        if (module->create_srv_conf) {
            ctx->srv_conf[mi] = module->create_srv_conf(cf);
            if (ctx->srv_conf[mi] == NULL) {
                return NGX_CONF_ERROR;
            }
        }

        if (module->create_loc_conf) {
            ctx->loc_conf[mi] = module->create_loc_conf(cf);
            if (ctx->loc_conf[mi] == NULL) {
                return NGX_CONF_ERROR;
            }
        }
    }

    pcf = *cf;
    cf->ctx = ctx;

    for (m = 0; ngx_modules[m]; m++) {
        if (ngx_modules[m]->type != NGX_MYPO_MODULE) {
            continue;
        }

        module = ngx_modules[m]->ctx;

        if (module->preconfiguration) {
            if (module->preconfiguration(cf) != NGX_OK) {
                return NGX_CONF_ERROR;
            }
        }
    }

    /* parse inside the mypo{} block */

    cf->module_type = NGX_MYPO_MODULE;
    cf->cmd_type = NGX_MYPO_MAIN_CONF;
    rv = ngx_conf_parse(cf, NULL);

    if (rv != NGX_CONF_OK) {
        goto failed;
    }

    /*
     * init mypo{} main_conf's, merge the server{}s' srv_conf's
     * and its location{}s' loc_conf's
     */

    cmcf = ctx->main_conf[ngx_mypo_core_module.ctx_index];
    cscfp = cmcf->servers.elts;

    for (m = 0; ngx_modules[m]; m++) {
        if (ngx_modules[m]->type != NGX_MYPO_MODULE) {
            continue;
        }

        module = ngx_modules[m]->ctx;
        mi = ngx_modules[m]->ctx_index;

        /* init mypo{} main_conf's */

        if (module->init_main_conf) {
            rv = module->init_main_conf(cf, ctx->main_conf[mi]);
            if (rv != NGX_CONF_OK) {
                goto failed;
            }
        }

        rv = ngx_mypo_merge_servers(cf, cmcf, module, mi);
        if (rv != NGX_CONF_OK) {
            goto failed;
        }
    }


    /* create location trees */
    for (s = 0; s < cmcf->servers.nelts; s++) {

        clcf = cscfp[s]->ctx->loc_conf[ngx_mypo_core_module.ctx_index];

        if (ngx_mypo_init_locations(cf, cscfp[s], clcf) != NGX_OK) {
            return NGX_CONF_ERROR;
        }

        if (ngx_mypo_init_static_location_trees(cf, clcf) != NGX_OK) {
            return NGX_CONF_ERROR;
        }
    }
最低0.47元/天 解锁文章
gamer727
关注
专栏目录
7步精通：从编写到发布，打造你的Nginx模块
java专栏
09-02 1302
想象一下，Nginx就像是一个多功能的瑞士军刀，而模块就是这把刀上的不同工具。每个模块都赋予了Nginx新的功能，让这个服务器能够执行特定的任务。模块化的设计让Nginx既灵活又强大，可以轻松应对各种网络服务的需求。恭喜你，现在你已经成功搭建了Nginx模块的开发环境，并且创建了模块的基础框架。在下一章，我们将深入到模块的编写和实现，让你的模块真正开始工作。准备好了吗？让我们继续前进，探索Nginx模块开发的奇妙世界！🌈🚀恭喜你，你已经成功编写并测试了你的第一个Nginx模块！
Nginx 动态模块开发：C 语言扩展
最新发布
java专栏
09-19 904
Nginx 是一款高性能的 Web 服务器和反向代理服务器。它可以处理大量的并发连接，并且非常稳定。简单来说，Nginx 就像是一个超级市场，它负责把顾客（请求）引导到正确的货架（后端服务）上。通过这篇俏皮可爱的指南，我们不仅了解了如何使用 C 语言为 Nginx 开发动态模块，还学习了如何配置 Nginx 来加载和使用这些模块。现在，你可以尝试在自己的项目中实践这些知识，让你的 Nginx 服务器变得更加灵活和强大！如果你有任何疑问或者想要深入了解某个主题，请随时告诉我！
Nginx基础知识. Nginx模块开发
博客
08-25 817
Nginx模块开发初识     下面将开发一个简单的HTTP模块作为线索进行讲解. Part1. 模块需要使用的信息存储结构 关于ngx_module_t 既然要进行模块开发, 那么就必须会使用到存储模块的数据结构, 下面先看看这个结构体 //因为是初识, 所以结构体的一些变量暂时不管 typedef struct ngx_module_s ngx_module_t; struc
Nginx模块开发入门
weixin_34274029的博客
04-19 529
前言 Nginx是当前最流行的HTTP Server之一，根据W3Techs的统计，目前世界排名（根据Alexa）前100万的网站中，Nginx的占有率为6.8%。与Apache相比，Nginx在高并发情况下具有巨大的性能优势。 Nginx属于典型的微内核设计，其内核非常简洁和优雅，同时具有非常高的可扩展性。Nginx最初仅仅主要被用于做反向代理，后来随着HTTP核心的成熟和各种HTTP扩展模...
Nginx服务模块详解
weixin_45409403的博客
12-15 258
Nginx 工作原理 Nginx 由内核和模块组成 Nginx 本身做的工作实际很少，当它接到一个 HTTP 请求时， 它仅仅是通过查找配置文件将此次请求映射到一个 location block，而此 location 中所配 置的各个指令则会启动不同的模块去完成工作，因此模块可以看做 Nginx 真正的劳动工作者。 通常一个 location 中的指令会涉及一个 handler 模块和多个 fi...
nginx的模块开发
陈海峰的博客
03-23 569
nginx刚刚在国内开始流行的时候， 我就把它引入公司技术体系，用来替代apache主要做动静分离。 nginx的并发处理能力和稳定性，以及优秀的软件架构深深得吸引了我， 让我跨入了高性能服务器开发的大门。 正巧当时要基于flash技术开发一套行情系统， 而且要支持 代理环境， 而当时并没有什么好的办法让flash通过socket并穿过代理访问行情服务器， 后来只能采用http技术去访问行情
NGINX模块开发
11-30 778
•Nginx是当前最流行的HTTP Server之一 •Nginx 模块主要有3 种角色： –handlers(处理模块) 用于处理HTTP请求，然后产生输出 –filters（过滤模块） 过滤handler产生的输出 （“接力链表（CHAIN OF RESPONSIBILITY）”模型） –load-balancers（负载均衡模块）当有多于一台的后端备选服务器时，选择一台
深入理解Nginx模块开发与架构解析(完整版)
03-26
深入理解Nginx模块开发与架构解析(完整版) pdf，nginx必备知识
深入理解Nginx模块开发与架构解析（第2版）
11-19
《深入理解Nginx模块开发与架构解析（第2版）》是一本专注于Nginx技术的专业书籍，针对Nginx的内部工作机制和模块开发进行了深入的探讨。本书旨在帮助读者掌握Nginx的核心概念、架构设计以及如何进行模块开发，从而...
深入理解Nginx模块开发与架构解析第2版
04-17
深入理解Nginx模块开发与架构解析第2版LinuxUnix技术丛书 mobi格式，可以下载mobi阅读器打开
Nginx 模块开发
Linuxhus的博客
09-15 456
在过滤模块中，所有输出的内容都是通过一条单链表所组成，Nginx都是读到一部分的内容就放到链表，然后输出出去（ngx_http_write_filter_module）。Nginx把 HTTP响应头的存储方式想象成一个 hash 表，在 Nginx 内部可以很方便地查找和修改各个响应头部，ngx_http_header_filter_module 过滤模块把所有的 HTTP 头组合成一个完整的 buffer，最终 ngx_http_write_filter_module 过滤模块把 buffer 输出。
Nginx模块开发
编程的本质是数学问题
08-01 1214
最简单的Nginx模块开发，虽然简单，但是是最重要的第一步。 主要是看：http://blog.codinglabs.org/articles/intro-of-nginx-module-development.html   1.准备模块文件 在nginx-1.4.2安装目录新建一个自己的模块的目录 # mkdir myModule 再新建ngx_http_echo目录 #mkdir
nginx模块开发之一
for_tech的博客
05-17 2176
本文以开发一个简单nginx模块为例，讲述nginx http模块开发的入门知识。
【Linux网络编程】Nginx -- 模块开发(基本模块解析)
CopperSun 技术博客
03-03 538
【Linux网络编程】Nginx 模块开发 -- 基本模块解析 参考 本博客为博主的学习实践总结，并参考了众多博主的博文，在此表示感谢，博主若有不足之处，请批评指正。 【1】深入理解 Nginx 模块开发与架构解析 ...
nginx 模块开发_Nginx模块开发与架构全方位深度解析（内含35.6 MB可复制文档）
weixin_29264201的博客
01-15 296
Nginx作为负载均衡服务：Nginx 既可以在内部直接支持 Rails 和 PHP 程序对外进行服务，也可以支持作为 HTTP代理服务对外进行服务。Nginx采用C进行编写，不论是系统资源开销还是CPU使用效率都比 Perlbal 要好很多。今天分享一份Nginx模块开发与架构解析实战文档，文档35.6 MB内容全部可复制！相信看完后对Nginx会有更深入的了解。戳这里直达领取​shimo.im...
源码安装 nginx 并设置为 service
哈哈虎的博客
08-24 528
下载 http://nginx.org/en/download.html 官方文档 http://nginx.org/en/docs/configure.html 我选择安装 1.20.1 我的环境 ： 虚拟机 Ubuntu 20.04 Server 再找一个使用 apt install nginx 的同类服务器，用于对照，主要是后续设置 service 的时候参考 下载 $ wget http://103.78.124.87/2Q2W33852EB623DB3C4CBAA9755060B20190FB88
Nginx模块开发:自定义模块hello world
wh1312142954的博客
06-01 401
#include <ngx_config.h> #include <ngx_core.h> #include <ngx_http.h> static char *ngx_http_mytest(ngx_conf_t *cf, ngx_command_t *cmd, void *conf); static void *ngx_http_mytest_create_loc_conf(ngx_conf_t *cf); static char *ngx_http_mytest.
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值