nginx 学习（二） hello world 程序

最新推荐文章于 2025-06-24 02:56:32 发布
原创 最新推荐文章于 2025-06-24 02:56:32 发布 · 2.5k 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#nginx #server #web服务器

本篇博客详述了如何使用nginx构建一个经典的hello world模块，包括config的编写、模块代码实现和配置文件的设定。通过这个过程，可以了解如何将第三方模块嵌入nginx并实现HTTP模块的基础操作。

hello wrold

1 本节目的

2实现步骤

  2.1config编写

  2.2模块代码实现

  2.3配置文件的编写

3将模块编译进nginx中


1本节的目的

本节用nginx来实现一个经典程序hello world，这个程序也是我们学任何编程语言时首先接触的程序，这个程序的目的是

初步了解nginx怎样嵌入第三方模块，也是学习nginx的HTTP模块的入门。

2实现步骤

nginx 提供了一种简单的方式将第三方模块嵌入nginx中：只需要三个步骤

步骤一：编写config

步骤二：实现模块的代码

步骤三：修改配置参数，将第三方模块编译到nginx中

下面我们来用最简单的hello world实例来讲这三个步骤的实现。

2.1config编写

config文件里面包含了三个参数，这三个参数如下：

ngx_addon_name:第三方模块名字，这个好像用处不大，一般设置为模块名称

HTTP_MODULES:HTPP模块名称

NGX_ADDON_SRCS:第三方模块源代码路径

下面是helloworld程序的config：

ngx_add_name=ngx_http_hello_module
HTTP_MODULES="$HTTP_MODULES ngx_http_hello_module"
NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_hello_module.c"

2.2模块代码实现

下面来看怎样实现ngx_http_hello_module.c。

首先我们要定义两个函数：

static char* ngx_http_hello(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
static ngx_int_t ngx_http_hello_handler(ngx_http_request_t *r);
 ngx_http_hello

这个函数使用来分析配置文件中的参数，因为我们仅仅要输出hello world 所以我们用无参数的配置，即不许要解析参数的值，下一节我会详细将怎样分析配置参数
ngx_http_hello_handler

每个模块都有一个handler函数，这个函数负责对来自客户端请求的真正处理。这个函数的处理，既可以选择自己直接生成内容，也可以选择拒绝处理，由后续的handler去进行处理，或者是选择丢给后续的filter进行处理。

然后我们要定义三个结构体，这三个结构体是每个模块必不可缺少的结构体：

模块配置指令结构体：

static ngx_command_t ngx_http_hello_commands[] = {
    {
       ngx_string("test_hello"),
       NGX_HTTP_LOC_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,
    NULL,

    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
};
这里我们仅仅知道这三个结构体就行，后面我们会详细介绍。

然后看看nginx函数的实现：

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);
    clcf->handler = ngx_http_hello_handler;
    return NGX_CONF_OK;
}
这个函数主要是解析配置的参数，也可以设置模块的handler函数，这里我们没有解析配置参数，仅仅加载模块的handler函数。

再看真正处理用户请求的handler函数：

static ngx_int_t ngx_http_hello_handler(ngx_http_request_t *r)
{
    if (!(r->method & (NGX_HTTP_HEAD | NGX_HTTP_GET))) 
    {
       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/html");
    ngx_str_t response = ngx_string("hello world!");
    r->headers_out.content_type = type;
    r->headers_out.status = NGX_HTTP_OK;
    r->headers_out.content_length_n = response.len;
    if (r->method == NGX_HTTP_HEAD)
    {
       return ngx_http_send_header(r);
    }
    
    ngx_buf_t* buf = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));
    if (buf == NULL)
    {
       return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }
    buf->pos = ngx_pcalloc(r->pool, response.len);
    buf->last = buf->pos + response.len;
    buf->last_buf = 1;
    buf->memory = 1;
    ngx_memcpy(buf->pos, response.data, response.len);
    
    ngx_chain_t out;
    out.buf = buf;
    out.next = NULL;
    rc = ngx_http_send_header(r);
    if (rc == NGX_ERROR || rc > NGX_OK || r->header_only)
    {
       return rc;
    }

    return ngx_http_output_filter(r, &out);
}
这个函数才是真正处理用户请求的函数，它在解析配置参数以后根据用户的请求作出相应处理，并把处理结果返回给用户。

这样一个简单的hello模块的代码就基本上完成了，其实主要就是上面的三个结构体的定义和handler函数的实现。

2.3配置文件的编写

我们实现一个功能是当我们在浏览其中输入：localhost/hello 按回车键时会看到：hello world！

在配置中应该有hello并且写在nginx.conf 的location：

   location /hello {
            test_hello ;//无参数的配置
     }
3将模块编译进nginx中

即安装第三方模块,如下：

./configure --prefix=/home/smtl/桌面/testNx/nginx \
--with-http_ssl_module \
--with-pcre=/home/smtl/下载/pcre-8.33 \
--with-zlib=/home/smtl/下载/zlib-1.2.8 \
--with-openssl=/home/smtl/下载/openssl-0.9.8o \
<span style="color:#FF0000;">--add-module=/home/smtl/桌面/testNx/nginx-1.0.15/my_hello_module</span>
（make ， make install）

注意我们编写的代码所放的文件要放在和nginx源码所放的目录相同：nginx源码放在那个文件里，我们编写的代码的文件就放在那个文件里。

红色标记的部分是我们编写的代码ngx_htttp_hello_module.c所在的文件夹。

然后在浏览器里面输入：localhost/hello。

浏览器输出hello world


程序源代码：



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

static char* ngx_http_hello(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
static ngx_int_t ngx_http_hello_handler(ngx_http_request_t *r);

static ngx_command_t ngx_http_hello_commands[] = {
    {
       ngx_string("test_hello"),
       NGX_HTTP_LOC_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,
    NULL,

    NULL,
    NULL,
    
    NULL,
    NULL,

    NULL,
    NULL,
};

/* static 加上static有错误 */
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
};

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);
    clcf->handler = ngx_http_hello_handler;
    return NGX_CONF_OK;
}

static ngx_int_t ngx_http_hello_handler(ngx_http_request_t *r)
{
    if (!(r->method & (NGX_HTTP_HEAD | NGX_HTTP_GET))) 
    {
       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/html");
    ngx_str_t response = ngx_string("hello world!");
    r->headers_out.content_type = type;
    r->headers_out.status = NGX_HTTP_OK;
    r->headers_out.content_length_n = response.len;
    if (r->method == NGX_HTTP_HEAD)
    {
       return ngx_http_send_header(r);
    }
    
    ngx_buf_t* buf = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));
    if (buf == NULL)
    {
       return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }
    buf->pos = ngx_pcalloc(r->pool, response.len);
    buf->last = buf->pos + response.len;
    buf->last_buf = 1;
    buf->memory = 1;
    ngx_memcpy(buf->pos, response.data, response.len);
    
    ngx_chain_t out;
    out.buf = buf;
    out.next = NULL;
    rc = ngx_http_send_header(r);
    if (rc == NGX_ERROR || rc > NGX_OK || r->header_only)
    {
       return rc;
    }

    return ngx_http_output_filter(r, &out);
}
http://blog.youkuaiyun.com/xiaoliangsky/article/details/39254481


work hard!!!!!










Nginx的http开发中用两种介入方式打印“hello world”
小麒麟的成长之路
11-07 2120
在对nginx进行http开发时，有两种方式介入http模块，具体可以参考nginx模块定制开发中介入http模块的方法及NGX_HTTP_CONTENT_PHASE阶段的详细介绍，下面用代码来具体实现这两种方法打印“hello world”。 方法一、在ngx_http_module_t接口的postconfiguration方法中将自定义的方法添加到handler动态数组中 源
nginx详解
9.冄2.7.號的博客
09-22 1284
nginx简介 nginx概述 Nginx (“engine x”) 是一个高性能的 HTTP 和反向代理服务器,特点是占有内存少，并发能力强，事实上 nginx 的并发能力确实在同类型的网页服务器中表现较好，中国大陆使用 nginx网站用户有：百度、京东、新浪、网易、腾讯、淘宝等。 nginx作为web服务器 Nginx 可以作为静态页面的 web 服务器，同时还支持 CGI 协议的动态语言，比...
nginx-hello-world:一个基于Nginx的微型“ Hello world！” 用于测试需要Docker映像的事物的Docker映像
04-13
Nginx你好世界 一个基于Nginx的微型“ Hello world！” Docker映像，用于测试需要Docker映像的事物。
使用nginx简单创建一个网站返回hello world!
最新发布
2501_90656587的博客
06-24 329
如果你看到：nginx: configuration file /etc/nginx/nginx.conf test is successful。此时，Nginx 已启动，你可以尝试访问公网 IP（如果 80 端口开放了，会显示 Nginx 欢迎页。如果自己配置的是中文内容的话， 那需要对文字进行转码。如果返回前面自己设计好的内容那就证明配置成功。表示任何域名或 IP 都能访问这个站点。写着“hello world”。修改后记得重启nginx服务。直接输入linux的公网ip。根目录是我们刚才创建的。
nginx 源码学习笔记（一）——初识nginx helloworld模块
数据库天地
03-13 179
最近看完一本书，而且还是跟我一个学校的人写的关于nginx的内容，个人觉得内容可以更充实点，包括整本书的后半本没有太大的价值，但是总体来说还是不错的哈哈！(是不有点自恋)，不费话了，今天记录下我刚刚编写的nginx hello_world模块内容，网上也没有源代码，就完全手敲了，累呀！ 1.nginx模块 首先nginx和apache最大的不同就是nginx的模块不能够动态添加，需要在编译...
Nginx学习之一-第一个程序Hello World
热门推荐
计算机专业同学的充电站。
06-19 2万+
本例子实现了一个简单的hello world程序。运行效果： 虚拟机Ubuntu中： win7中chrome浏览器： 一、config文件编写 Nginx提供了一种简单的方式将第三方的模块编译到Nginx中。首先把源代码文件全部放到一个目录下，同时在该目录中编写一个文件用于通知Nginx如何编译本模块，这个文件名必须为config。 然后，在configure
Docker基础教程：使用nginx部署helloworld应用程序
标题中的“docker-helloworld”指向的是一个特定的Docker容器，其主要功能是提供一个简单的“Hello World”应用程序。这个容器是Docker镜像的一个实例，可以在其中部署运行。标题表明这是针对Docker的一个示例应用...
nginx之第一个helloworld程序
HN_gsf的博客
08-22 657
本例子实现一个简单的helloworld程序，在客户端输入test时，网页上显示是hello world，以此来练习nginx的配置文件的书写，以及新添加模块的方法； 在nginx中新添加一个模块，需要四步，第一步就是编写模块文件module.c第二步就是编写config文件，第三步就是修改配置文件；第四步就是编译（好多文章中关于第四步叙述的并不详细） 第一步， Nginx提供了一种简单的方式
hello-world:Industrial Edge应用程序“ Hello World”是一个入门Web应用程序
05-09
这是用于Industrial Edge的Hello World应用程序。 描述 概述 此应用程序是用于Industrial Edge的Hello World Web服务器应用程序。 要求 二手零件 操作系统：Windows或Linux Docker最低V18.09 Docker Compose V2.4...
uwsgi-flask:Docker nginx + uwsgi-flask 镜像，包括一个 Hello World 烧瓶应用程序
06-23
带有 Nginx、uWSGI 和 Hello World Flask 应用程序的 Docker 镜像。 该图像基于我的 ubuntu-python 3.4 图像（它又在 phusion/baseimage 之上运行）。 Hello World 应用程序已启用并将在端口 80 上内部启动，并在...
【Nginx】输出/返回 HelloWorld
sayyy的专栏
01-18 5508
略
Nginx的第一个模块-Hello World
08-25 2842
麻雀虽小，五脏俱全，小小的Hello World盛行于程序世界，就在于其代码虽短，但要真正运行起来，需要我们略通基本语法，稍懂编译运行环境，知晓操作过程，最后，还有一颗持之以恒，不怕折腾的心。前一阵子跑通了Nginx的Hello World程序，今天重温了一遍就顺便写篇博客，记录下来，好记性不如烂笔头，方便以后查阅。
Nginx模块开发系列2--hello_world框架
weixin_49406295的博客
08-13 378
Nginx模块开发-hello_world框架
nginx的helloworld模块的helloworld
走在左边
11-29 273
经典的nginx的helloworld尝试了一下 过程就是 [code="java"]nginx--->config文件---->module--->command[]函数----->handler | | ctx等 位置等[/code] 函数就是这个n...
开发Nginx模块Helloworld
weixin_30655219的博客
08-11 209
本文是对《深入理解Nginx》一书中的实例进行实战时的记录。 1模块目录结构 my_test_module/ ├── config └── ngx_http_mytest_module.c 1.1配置文件 config文件内容如下： ngx_addon_name=ngx_http_mytest_module HTTP_MODULES="$HTTP_MOD...
Nginx学习（2）
爱跳的矮子丶的博客
10-31 311
RewriteRewrite模块功能：用来执行URL重定向。这个机制有利于去掉恶意访问的url，也有利于搜索引擎优化（SEO）Nginx使用语法源于Perl兼容正则表达式（PCRE）库,基本语法如下：^ : 必须以^后的实体开头 $ :必须以$前的实体结尾 . :匹配任意字符 [] :匹配指定字符集内的任意字符 [^] :匹配任何不包括在指定字符集内的任意字符串 | :匹配|之前或之后的
Nginx模块开发之最简单的Hello模块
yasi_xi的专栏
10-27 5543
转自：http://bg.biedalian.com/2013/08/09/nginx-hello-world.html
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值