nginx中的listen指令實(shí)例解析
劇情回顧
上一篇文章我們分析了location指令的解析過程，簡單的回顧一下這個(gè)內(nèi)容：每個(gè)location對應(yīng)一個(gè)ngx_http_core_loc_conf_t結(jié)構(gòu)體，所有的location通過一個(gè)雙向隊(duì)列連接在一起。數(shù)據(jù)結(jié)構(gòu)比較復(fù)雜。
listen指令
nginx作為一個(gè)高性能的HTTP服務(wù)器，網(wǎng)絡(luò)的處理是其核心，了解網(wǎng)絡(luò)的初始化有助于加深對nginx網(wǎng)絡(luò)處理的了解。與網(wǎng)絡(luò)有關(guān)的配置命令主要有兩個(gè)：listen和sever_name。listen命令設(shè)置nginx監(jiān)聽地址，對于IP協(xié)議，這個(gè)地址就是address和port，對于UNIX域套接字協(xié)議，這個(gè)地址就是path，一條listen指令只能指定一個(gè)address或者port，address也可以是主機(jī)名
從這一篇文章開始，我們分析listen指令的解析過程，listen指令的配置如下：從nginx.org的手冊中我們可以獲取listen的使用方法：
listen address[:port] [default_server] [setfib=number] [backlog=number] [rcvbuf=size] [sndbuf=size] [accept_filter=filter] [deferred] [bind] [ipv6only=on|off] [ssl] [so_keepalive=on|off|[keepidle]:[keepintvl]:[keepcnt]];
一個(gè)listen指令攜帶的參數(shù)是很復(fù)雜的。不過，我們一般很少關(guān)注那些不太常用的參數(shù)，以下是一些常用的配置方式：
listen 127.0.0.1:8000; listen 127.0.0.1 不加端口，默認(rèn)監(jiān)聽80端口; listen 8000 listen *:8000 listen localhost:8000
解析listen指令中的uri和端口
從上面的內(nèi)容知道，listen有多種用法，我們在解析的時(shí)候需要獲取到listen指令的端口號(hào)和uri部分，nginx提供了ngx_parse_url()方法來解析uri和port，該函數(shù)在解析listen指令的時(shí)候會(huì)被調(diào)用。
ngx_int_t
ngx_parse_url(ngx_pool_t *pool, ngx_url_t *u)
{
u_char *p;
size_t len;
p = u->url.data;
len = u->url.len;
// 這里是解析unix domain的協(xié)議
if (len >= 5 && ngx_strncasecmp(p, (u_char *) "unix:", 5) == 0) {
return ngx_parse_unix_domain_url(pool, u);
}
// 解析IPV6協(xié)議
if (len && p[0] == '[') {
return ngx_parse_inet6_url(pool, u);
}
// 解析IPV4協(xié)議
return ngx_parse_inet_url(pool, u);
}
我們使用的是IPV4協(xié)議，這里分析ngx_parse_inet_url()函數(shù)
// u.url = "80";
// u.listen = 1;
// u.default_port = 80;
static ngx_int_t
ngx_parse_inet_url(ngx_pool_t *pool, ngx_url_t *u)
{
u_char *p, *host, *port, *last, *uri, *args;
size_t len;
ngx_int_t n;
struct sockaddr_in *sin;
#if (NGX_HAVE_INET6)
struct sockaddr_in6 *sin6;
#endif
u->socklen = sizeof(struct sockaddr_in);
sin = (struct sockaddr_in *) &u->sockaddr;
sin->sin_family = AF_INET;// IPV4類型
u->family = AF_INET;
host = u->url.data; // "80"
last = host + u->url.len; // host的最后字符的位置
port = ngx_strlchr(host, last, ':'); // 找到port, 這里為 NULL
uri = ngx_strlchr(host, last, '/'); // 找到uri，這里為 NULL
args = ngx_strlchr(host, last, '?'); // 找到參數(shù)args，這里為 NULL
if (args) {
if (uri == NULL || args < uri) {
uri = args;
}
}
if (uri) {
if (u->listen || !u->uri_part) {
u->err = "invalid host";
return NGX_ERROR;
}
u->uri.len = last - uri;
u->uri.data = uri;
last = uri;
if (uri < port) {
port = NULL;
}
}
if (port) {
port++;
len = last - port;
n = ngx_atoi(port, len);
if (n < 1 || n > 65535) {
u->err = "invalid port";
return NGX_ERROR;
}
u->port = (in_port_t) n;
sin->sin_port = htons((in_port_t) n);
u->port_text.len = len;
u->port_text.data = port;
last = port - 1;
} else {
if (uri == NULL) {
if (u->listen) {
/* test value as port only */
n = ngx_atoi(host, last - host);
if (n != NGX_ERROR) {
if (n < 1 || n > 65535) {
u->err = "invalid port";
return NGX_ERROR;
}
u->port = (in_port_t) n;
sin->sin_port = htons((in_port_t) n);
u->port_text.len = last - host;
u->port_text.data = host;
u->wildcard = 1;
return NGX_OK;
}
}
}
u->no_port = 1;
u->port = u->default_port;
sin->sin_port = htons(u->default_port);
}
len = last - host;
if (len == 0) {
u->err = "no host";
return NGX_ERROR;
}
u->host.len = len;
u->host.data = host;
if (u->listen && len == 1 && *host == '*') {
sin->sin_addr.s_addr = INADDR_ANY;
u->wildcard = 1;
return NGX_OK;
}
sin->sin_addr.s_addr = ngx_inet_addr(host, len);
if (sin->sin_addr.s_addr != INADDR_NONE) {
if (sin->sin_addr.s_addr == INADDR_ANY) {
u->wildcard = 1;
}
u->naddrs = 1;
u->addrs = ngx_pcalloc(pool, sizeof(ngx_addr_t));
if (u->addrs == NULL) {
return NGX_ERROR;
}
sin = ngx_pcalloc(pool, sizeof(struct sockaddr_in));
if (sin == NULL) {
return NGX_ERROR;
}
ngx_memcpy(sin, &u->sockaddr, sizeof(struct sockaddr_in));
u->addrs[0].sockaddr = (struct sockaddr *) sin;
u->addrs[0].socklen = sizeof(struct sockaddr_in);
p = ngx_pnalloc(pool, u->host.len + sizeof(":65535") - 1);
if (p == NULL) {
return NGX_ERROR;
}
u->addrs[0].name.len = ngx_sprintf(p, "%V:%d",
&u->host, u->port) - p;
u->addrs[0].name.data = p;
return NGX_OK;
}
if (u->no_resolve) {
return NGX_OK;
}
if (ngx_inet_resolve_host(pool, u) != NGX_OK) {
return NGX_ERROR;
}
u->family = u->addrs[0].sockaddr->sa_family;
u->socklen = u->addrs[0].socklen;
ngx_memcpy(&u->sockaddr, u->addrs[0].sockaddr, u->addrs[0].socklen);
switch (u->family) {
#if (NGX_HAVE_INET6)
case AF_INET6:
sin6 = (struct sockaddr_in6 *) &u->sockaddr;
if (IN6_IS_ADDR_UNSPECIFIED(&sin6->sin6_addr)) {
u->wildcard = 1;
}
break;
#endif
default: /* AF_INET */
sin = (struct sockaddr_in *) &u->sockaddr;
if (sin->sin_addr.s_addr == INADDR_ANY) {
u->wildcard = 1;
}
break;
}
return NGX_OK;
}
這個(gè)函數(shù)就是解析了我們listen的地址和端口號(hào)，我們的配置文件中，端口號(hào)為80，并沒有配置監(jiān)聽地址，所以u(píng)->wildcard = 1，表示這是一個(gè)通配符，要監(jiān)聽該服務(wù)器所有ip地址的這個(gè)端口號(hào)。
解析listen指令
下面從源碼中看一下listen的配置：
{
ngx_string("listen"),
NGX_HTTP_SRV_CONF|NGX_CONF_1MORE,
ngx_http_core_listen,
NGX_HTTP_SRV_CONF_OFFSET,
0,
NULL
}
從配置文件中我們可以知道，listen只能出現(xiàn)在server 模塊中，可以帶有多個(gè)參數(shù)。
對應(yīng)的處理函數(shù)為 ngx_http_core_listen,下面我們分析這個(gè)函數(shù),我們刪除了一些進(jìn)行錯(cuò)誤判斷的代碼，
static char *
ngx_http_core_listen(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_http_core_srv_conf_t *cscf = conf;
ngx_str_t *value, size;
ngx_url_t u;
ngx_uint_t n;
ngx_http_listen_opt_t lsopt;
cscf->listen = 1;
value = cf->args->elts;
ngx_memzero(&u, sizeof(ngx_url_t));
u.url = value[1];
u.listen = 1;
u.default_port = 80;
if (ngx_parse_url(cf->pool, &u) != NGX_OK) {
return NGX_CONF_ERROR;
}
ngx_memzero(&lsopt, sizeof(ngx_http_listen_opt_t));
ngx_memcpy(&lsopt.sockaddr.sockaddr, &u.sockaddr, u.socklen);
lsopt.socklen = u.socklen;
lsopt.backlog = NGX_LISTEN_BACKLOG;
lsopt.rcvbuf = -1;
lsopt.sndbuf = -1;
#if (NGX_HAVE_SETFIB)
lsopt.setfib = -1;
#endif
#if (NGX_HAVE_TCP_FASTOPEN)
lsopt.fastopen = -1;
#endif
lsopt.wildcard = u.wildcard;
#if (NGX_HAVE_INET6)
lsopt.ipv6only = 1;
#endif
(void) ngx_sock_ntop(&lsopt.sockaddr.sockaddr, lsopt.socklen, lsopt.addr,
NGX_SOCKADDR_STRLEN, 1);
for (n = 2; n < cf->args->nelts; n++) {
if (ngx_strcmp(value[n].data, "default_server") == 0
|| ngx_strcmp(value[n].data, "default") == 0)
{
lsopt.default_server = 1;
continue;
}
// 這里面的其他代碼都是處理listen的各種參數(shù)，對我們這里的分析沒有用處
}
if (ngx_http_add_listen(cf, cscf, &lsopt) == NGX_OK) {
return NGX_CONF_OK;
}
return NGX_CONF_ERROR;
}
這個(gè)函數(shù)的整體流程就是解析listen指令的各個(gè)參數(shù)，生成一個(gè) ngx_http_listen_opt_t，顧名思義，這個(gè)結(jié)構(gòu)體就是保存一些監(jiān)聽端口的選項(xiàng)(listening port option)。這里調(diào)用了一個(gè)函數(shù)ngx_parse_url()，我們上面已經(jīng)分析過了，這個(gè)函數(shù)的作用就是解析url中的address和port。
然后最重要的部分就要到了，ngx_http_core_listen()函數(shù)在最后面調(diào)用了ngx_http_add_listen()函數(shù)，該函數(shù)是將listen的端口信息保存到ngx_http_core_main_conf_t結(jié)構(gòu)體的ports動(dòng)態(tài)數(shù)組中。
ngx_http_add_listen()函數(shù)
// cf: 配置結(jié)構(gòu)體
// cscf: listen指令所在的server的配置結(jié)構(gòu)體
// lsopt : ngx_http_core_listen()生成的listen option
ngx_int_t
ngx_http_add_listen(ngx_conf_t *cf, ngx_http_core_srv_conf_t *cscf,
ngx_http_listen_opt_t *lsopt)
{
in_port_t p;
ngx_uint_t i;
struct sockaddr *sa;
ngx_http_conf_port_t *port;
ngx_http_core_main_conf_t *cmcf;
// 獲取 ngx_http_core_module模塊的main_conf結(jié)構(gòu)體ngx_http_core_main_conf_t
cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
// ports字段是一個(gè)數(shù)組
if (cmcf->ports == NULL) {
cmcf->ports = ngx_array_create(cf->temp_pool, 2,
sizeof(ngx_http_conf_port_t));
if (cmcf->ports == NULL) {
return NGX_ERROR;
}
}
sa = &lsopt->sockaddr.sockaddr;
p = ngx_inet_get_port(sa);
port = cmcf->ports->elts;
for (i = 0; i < cmcf->ports->nelts; i++) {
if (p != port[i].port || sa->sa_family != port[i].family) {
continue;
}
/* a port is already in the port list */
return ngx_http_add_addresses(cf, cscf, &port[i], lsopt);
}
/* add a port to the port list */
port = ngx_array_push(cmcf->ports);
if (port == NULL) {
return NGX_ERROR;
}
port->family = sa->sa_family;
port->port = p;
port->addrs.elts = NULL;
return ngx_http_add_address(cf, cscf, port, lsopt);
}
這個(gè)函數(shù)將端口號(hào)的信息保存到了 ngx_http_core_main_conf_t結(jié)構(gòu)體的port字段中。
總結(jié)
以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。
相關(guān)文章
正向代理不僅用于提升訪問速度,還能提高網(wǎng)絡(luò)安全性、管理訪問權(quán)限和優(yōu)化網(wǎng)絡(luò)流量,在本文中,我們將詳細(xì)介紹如何在Nginx中配置正向代理,以及整合ngx_http_proxy_connect_module 插件,需要的朋友可以參考下2024-05-05
Nginx配置WebSocket反向代理的實(shí)現(xiàn)示例
本文主要介紹了Nginx配置WebSocket反向代理的實(shí)現(xiàn)示例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-08-08
這篇文章主要為大家介紹了nginx訪問頁面中文亂碼解決方案,文中有相關(guān)的代碼示例供大家參考,有需要的朋友可以借鑒參考下,希望能夠有所幫助2023-09-09
Windows下Nginx的啟動(dòng)停止重啟等命令操作過程
最近在window 上安裝了nginx ,對nginx 的操作不是很熟，故在此記錄一下常用操作，本文詳細(xì)介紹了Windows下Nginx的啟動(dòng)，停止，重啟等命令,需要的朋友可以參考下2024-03-03
Nginx學(xué)習(xí)之靜態(tài)文件服務(wù)器配置方法
本篇文章主要介紹了Nginx學(xué)習(xí)之靜態(tài)文件服務(wù)器配置方法，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-02-02
NginxWebUI 是一款圖形化管理 nginx 配置的工具,可以使用網(wǎng)頁來快速配置 nginx單機(jī)與集群的各項(xiàng)功能,本文就來介紹一下Nginx網(wǎng)頁配置工具nginxWebUI的具體使用,感興趣的可以了解一下2023-08-08
這篇文章主要介紹了Nginx服務(wù)優(yōu)化配置方案,非常不錯(cuò)，具有參考借鑒價(jià)值，需要的朋友可以參考下2018-03-03
這篇文章主要介紹了Nginx 負(fù)載均衡4種模式,本文給大家介紹的非常詳細(xì)，感興趣的朋友跟隨腳本之家小編一起學(xué)習(xí)吧2018-06-06
這篇文章主要介紹了使用nginx配置訪問wgcloud的方法,在這里大家需要記得agent的配置文件項(xiàng)serverUrl的80端口也要寫上，需要的朋友可以參考下2021-06-06
nginx禁止某個(gè)IP訪問站點(diǎn)的設(shè)置方法
近期發(fā)現(xiàn)博客遭到某些人的惡意灌水，頻繁地利用發(fā)帖機(jī)器人發(fā)表評(píng)論，給博客的管理帶來諸多不便，搜索了一下資料，可以利用nginx的ngx_http_access_module 模塊設(shè)置允許/禁止哪些ip或ip段訪問站點(diǎn)。2010-12-12