# mymodule

**Repository Path**: luoyang112_study/mymodule

## Basic Information

- **Project Name**: mymodule
- **Description**: nginx模块学习
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-21
- **Last Updated**: 2024-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>
#include <ngx_string.h>
#include <ngx_http_request.h>
#include <ngx_hash.h>
- 定义一个Nginx的HTTP模块 ngx_module_t，结构体说明如下：

	struct ngx_module_s
{
	// 表示当前模块在这类模块中的序号,对于所有http模块,
	// ctx_index是由核心模块ngx_http_module设置的
	// 表达优先级和模块位置
	ngx_uint_t ctx_index;
	// 表示当前模块在所有模块中的序号
	ngx_uint_t index;

	// 保留字段,未使用
	ngx_uint_t spare0;
	ngx_uint_t spare1;
	ngx_uint_t spare2;
	ngx_uint_t spare3;
	// 版本,目前只有1
	ngx_uint_t version;
	// 用于指向一类模块的上下文结构体,模块上下文。指向特定类型模块的公共接口
	void *ctx;
	// 将处理nginx.conf中的配置项
	ngx_command_t *commands;
	// 模块类型,HTTP_FILTER_MODULES，CORE_MODULES，EVENT_MODULES，HTTP_MODULES，HTTP_HEADERS_FILER_MODULE
	// HTTP_FILTER_MODULES         --> http过滤模块
	//
	// CORE_MODULES                --> 核心模块
	//
	// EVENT_MODULES               --> 事件模块
	//
	// HTTP_MODULES                --> HTTP模块
	//
	// HTTP_HEADERS_FILER_MODULE   --> HTTP头部过滤模块
	// 还可以自定义新的模块
	ngx_uint_t type;

	/**
	 * 七个重要的模块回调点
	 */
	// master进程启动时调用，但是目前框架从不调用，因此直接设置成NULL就行
	ngx_int_t (*init_master)(ngx_log_t *log);
	// 初始化所有模块时被调用，master/worker模式下，在启动worker前完成
	ngx_int_t (*init_module)(ngx_cycle_t *cycle);
	// worker子进程已经产生，每个worker进程初始化过程会调用所有模块的init_process
	ngx_int_t (*init_process)(ngx_cycle_t *cycle);
	// 由于nginx不支持多线程模式，所以init_thread在框架中没被调用过
	ngx_int_t (*init_thread)(ngx_cycle_t *cycle);
	// 此函数也没被调用
	void (*exit_thread)(ngx_cycle_t *cycle);
	// worker进程退出前调用
	void (*exit_process)(ngx_cycle_t *cycle);
	// master退出前被调用
	void (*exit_master)(ngx_cycle_t *cycle);

	// 尚未使用，用NGX_MODULE_V1_PADDING填充即可
	uintptr_t spare_hook0;
	uintptr_t spare_hook1;
	uintptr_t spare_hook2;
	uintptr_t spare_hook3;
	uintptr_t spare_hook4;
	uintptr_t spare_hook5;
	uintptr_t spare_hook6;
	uintptr_t spare_hook7;
};
``` - 代码如下：

            ``` static ngx_int_t ngx_http_mymodule_handler(ngx_http_request_t *r);
static char *
ngx_http_mymodule(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
static ngx_command_t ngx_http_mymodule_commands[] = {
	{ngx_string("mymodule"),
	 NGX_HTTP_MAIN_CONF | NGX_HTTP_SRV_CONF | NGX_HTTP_LOC_CONF | NGX_HTTP_LMT_CONF | NGX_CONF_NOARGS,
	 // set回调函数，
	 // char               *(*set)(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
	 // 当某个配置快中出现mymodule时，就会回调此函数
	 ngx_http_mymodule,
	 NGX_HTTP_LOC_CONF_OFFSET,
	 0,
	 NULL},
	// 空的ngx_command_t用于表示数组结束
	// #define ngx_null_command  { ngx_null_string, 0, NULL, 0, 0, NULL }
	ngx_null_command

};
static ngx_http_module_t ngx_http_mymodule_module_ctx = {
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL};

ngx_module_t ngx_http_mymodule_module = {
	NGX_MODULE_V1,
	// ctx,对于HTTP模块来说，ctx必须是ngx_http_module_t接口
	&ngx_http_mymodule_module_ctx,
	// commands,
	ngx_http_mymodule_commands,
	// 定义http模块时，必须设置成NGX_HTTP_MODULE
	NGX_HTTP_MODULE,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NULL,
	NGX_MODULE_V1_PADDING};

// 配置项对应的回调函数
static char *
ngx_http_mymodule(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);

	// 在NGX_HTTP_CONTENT_PHASE阶段会调用此回调函数
	clcf->handler = ngx_http_mymodule_handler;

	return NGX_CONF_OK;
}

// 实际完成处理的回调函数
/*
 * r 是nginx已经处理完了的http请求头
 */
static ngx_int_t ngx_http_mymodule_handler(ngx_http_request_t *r)
{
	return NGX_HTTP_NOT_ALLOWED;
}
```

	- 测试下
    ```
			  ./
		  configure-- add -
	module = src / mymodule / --without - http_rewrite_module-- without - http_gzip_module make install
    ``` 配置nginx.conf

																				  location /
																			  test
{
	mymodule;
}
由于直接返回了NGX_HTTP_NOT_ALLOWED（405状态码）
	![405测试](http://upload-images.jianshu.io/upload_images/9669276-8f69f37c14c1a9ec?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)