Skip to main content

Nginx Modules

moudle功能描述
ngx_http_access_module访问控制
ngx_http_addition_module附加内容
ngx_http_auth_basic_module基本认证
ngx_http_autoindex_module目录索引
ngx_http_core_moduleHTTP 核心模块
ngx_http_fastcgi_moduleFastCGI 处理
ngx_http_geo_moduleIP 地址映射
ngx_http_gunzip_module解压缩
ngx_http_gzip_moduleGzip 压缩
ngx_http_headers_module响应头处理
ngx_http_image_filter_module图像过滤
ngx_http_index_module索引文件
ngx_http_js_moduleJavaScript 脚本支持
ngx_http_limit_conn_module连接限流
ngx_http_limit_req_module请求限流
ngx_http_log_module访问日志
ngx_http_map_module映射变量
ngx_http_proxy_moduleHTTP 代理
ngx_http_rewrite_moduleHTTP 重写
ngx_http_secure_link_module安全链接
ngx_http_split_clients_moduleAB 测试
ngx_http_ssl_moduleSSL/TLS 支持
ngx_http_static_module静态文件处理
ngx_http_stub_status_module状态监控
ngx_http_upstream_module上游服务器组
ngx_stream_moduleTCP/UDP 代理

ngx_http_core_module - HTTP 核心模块​

ngx_http_proxy_module - HTTP 代理​

# 日志记录上游 - 方便排查
log_format upstream_logging '[$time_local] $remote_addr - $remote_user - $server_name to: $upstream: $request upstream_response_time $upstream_response_time msec $msec request_time $request_time';
access_log /dev/stdout upstream_logging;

# 可以在 upsteam 不可用的时候也能启动
set $upstream https://localhost:5000;
proxy_pass $upstream/api/;

# 会包含 url 参数
proxy_pass http://127.0.0.1:5000/api/webapp/;
# 等同于
proxy_pass http://localhost:5000/api$request_uri;
# 去掉参数
proxy_pass http://localhost:5000/api$uri;

ngx_http_rewrite_module - HTTP 重写​

  • ngx_http_rewrite_module
  • break - 中断当前重写指令
  • if - 条件控制
    • 逻辑 = !=
      • 空字符串或 "0" 为 false
    • 匹配 ~ ~* !~ !~*
      • 如果包含 } 或 ; 使用双引号括起来
    • 文件 -f !-f
    • 目录 -d !-d
    • 文件目录符号 -e !-e
    • 可执行 -x !-x
  • return - 停止处理立即返回
    • 重定向 - 301, 302, 303, 307, 308
    • 关闭链接 - 444
    • 返回内容
    • 302 应该以 http://, https://, $scheme 开头
  • rewrite - 匹配并替换 URL
    • flag 参数
      • last - 停止处理当前重定向从新搜索匹配
      • break - 停止处理
      • redirect - 302 重定向 - 如果替换不是以 http://, https://, $scheme 开头
      • permanent - 301 重定向
  • rewrite_log
  • set $variable value
  • 参考

ngx_http_map_module​

  • ngx_http_map_module
    • http 上下文
    • map
      • 参数
        • default value - 默认值
        • hostnames - 主机名匹配 - 支持 *.example.net 这样的前缀后缀
        • include file - 引入文件
        • volatile - 不缓存变量
      • 匹配
        • ~ 大小写敏感正则
        • ~* 大小写 不 敏感正则
  • 类似于 switch - 创建新的变量
  • 变量在用到的时候才会求值，因此不会增加处理负担
# 映射路径
map $request_uri $redirect_uri {
  ~/(?<lang>(en|de|fr))/oldname    /$lang/newname;
}
# 映射域名
map $http_host $served_host {
    default $http_host;
    ~(?<name>[^.]+).example.com $name.example.net;
}

ngx_http_addition_module - 附加内容​

  • ngx_http_addition_module
  • add_before_body uri
    • 在消息体之前
  • add_after_body uri
    • 在消息体之后
  • addition_types mime-type
    • 默认 text/html
location / {
    # 请求前置和后置添加到内容
    add_before_body /before_action;
    add_after_body  /after_action;
}

TODO​

http://nginx.org/en/docs/stream/ngx_stream_js_module.html http://nginx.org/en/docs/njs/index.html http://nginx.org/en/docs/http/ngx_http_js_module.html http://nginx.org/en/docs/njs/reference.html