Nginx 开发工具包 (NDK) 技术文档

1. 安装指南

1.1 下载源码

首先，从GitHub下载NDK的源码：

git clone https://github.com/simpl/ngx_devel_kit.git

1.2 解压源码

下载完成后，解压源码：

tar -xzf ngx_devel_kit.tar.gz

1.3 编译Nginx

在编译Nginx时，添加NDK模块的路径：

./configure --add-module=/path/to/ngx_devel_kit

1.4 动态模块编译（可选）

如果你使用的是Nginx 1.9.11及以上版本，可以选择将NDK编译为动态模块：

./configure --add-dynamic-module=/path/to/ngx_devel_kit

然后在nginx.conf中加载动态模块：

load_module /path/to/modules/ndk_http_module.so;

2. 项目的使用说明

2.1 用户使用说明

如果你使用的其他Nginx模块依赖NDK，你需要按照以下步骤操作：

1. 下载并解压NDK源码。
2. 在编译Nginx时，添加NDK模块的路径。

2.2 开发者使用说明

如果你是Nginx模块开发者，并希望使用NDK的功能，你需要：

1. 在你的模块中包含NDK的头文件：

   #include <ndk.h>
   

2. 在模块的配置文件中声明使用的NDK模块：

   have=NDK_[module_name]  . auto/have
   

3. 项目API使用文档

3.1 主要功能

NDK提供了以下主要功能：

• 额外的conf_set函数，用于处理正则表达式、复杂值、路径等。
• 简化任务的宏，如检查NULL值。
• 对Nginx主源代码的补丁。
• 包含ngx_auto_lib_core通用外部库处理程序。

3.2 模块化设计

NDK采用模块化设计，开发者可以根据需要选择编译特定的NDK模块，而不是全部编译。

3.3 自动生成与可扩展性

NDK中的许多宏是自动生成的，开发者可以通过简单的配置文件扩展这些宏。

4. 项目安装方式

4.1 静态模块安装

在编译Nginx时，通过--add-module选项添加NDK模块的路径：

./configure --add-module=/path/to/ngx_devel_kit

4.2 动态模块安装

对于Nginx 1.9.11及以上版本，可以使用--add-dynamic-module选项将NDK编译为动态模块：

./configure --add-dynamic-module=/path/to/ngx_devel_kit

然后在nginx.conf中加载动态模块：

load_module /path/to/modules/ndk_http_module.so;

通过以上步骤，你可以成功安装并使用Nginx开发工具包（NDK），并根据需要进行配置和扩展。