项目简介

nginx4j 是基于 netty 实现的 nginx 的java 版本。

如果你想知道 servlet 如何处理的，可以参考我的另一个项目：

简易版 tomcat

特性

完全兼容 nginx.conf 的配置文件格式
基于 netty 的 nio 高性能处理
静态网资源支持
默认 index.html
404
文件夹的自动索引
大文件的下载支持
gzip 压缩
sendfile 零拷贝特性
http keep-alive 特性
支持多 server
请求头的修改+响应头的修改
常见占位符 $ 的内置支持
cookie 的操作处理 proxy_cookie_domain/proxy_cookie_flags/proxy_cookie_path 内置支持
proxy_pass 反向代理实现

变更日志

变更日志

快速开始

maven 依赖

<dependency>
    <groupId>com.github.houbb</groupId>
    <artifactId>nginx4j</artifactId>
    <version>0.27.0</version>
</dependency>

启动测试

配置文件

# nginx.conf

# 定义运行Nginx的用户和组
user nginx;

# 主进程的PID文件存放位置
pid /var/run/nginx.pid;

# 事件模块配置
events {
    worker_connections 1024;  # 每个工作进程的最大连接数
}

# HTTP模块配置
http {
    include /etc/nginx/mime.types;  # MIME类型配置文件
    default_type application/octet-stream;  # 默认的MIME类型

    # 文件传输设置
    sendfile on;  # 开启高效文件传输
    # Keepalive超时设置
    keepalive_timeout 65;

    # 定义服务器块
    server {
        listen 8080;
        server_name 192.168.1.12:8080;  # 服务器域名

        # 单独为这个 server 启用 sendfile
        sendfile on;

        # 静态文件的根目录
        root D:\data\nginx4j;  # 静态文件存放的根目录
        index index.html index.htm;  # 默认首页

        # 如果需要为这个 server 单独配置 gzip，可以覆盖全局配置
        gzip on;
        gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;

        # 默认匹配
        location / {
            proxy_set_header X-DEFINE-PARAM myDefineParam;
            proxy_set_header X-DEFINE-HOST 127.0.0.1;

            # 增加或修改响应头 这里就提现了一些占位符的强大之处。下一次可以考虑支持
            add_header X-Response-Time 2024-06-08;

            # 删除响应头
            proxy_hide_header X-Unwanted-Header;

            # 占位符测试 v0.17.0
            set $myVal 1000;
            add_header X-MY-VAL $myVal;
            add_header X-MY-HOST $host;
        }
    }

    # 定义服务器块2
    server {
        listen 8081;
        server_name 192.168.1.12:8081;  # 服务器域名

        # 单独为这个 server 启用 sendfile
        sendfile on;

        # 静态文件的根目录
        root D:\data\nginx4j;  # 静态文件存放的根目录
        index index.txt; # 默认首页

        # 默认匹配
        location / {
            proxy_set_header X-DEFINE-PARAM myDefineParam;
            proxy_set_header X-DEFINE-HOST 127.0.0.2;

            # 增加或修改响应头 这里就提现了一些占位符的强大之处。下一次可以考虑支持
            add_header X-Response-Time 2024-06-09;

            # 删除响应头
            proxy_hide_header X-Unwanted-Header;
        }
    }

}

启动代码

// 指定配置文件的位置
NginxUserConfig nginxUserConfig = NginxUserConfigLoaders.configFile("D:\\github\\nginx4j\\src\\main\\resources\\nginx.conf").load();

Nginx4jBs.newInstance()
.nginxUserConfig(nginxUserConfig)
.init()
.start();

启动日志：

[DEBUG] [2024-05-24 23:40:37.573] [main] [c.g.h.l.i.c.LogFactory.setImplementation] - Logging initialized using 'class com.github.houbb.log.integration.adaptors.stdout.StdOutExImpl' adapter.
[INFO] [2024-05-24 23:40:37.576] [main] [c.g.h.n.s.s.NginxServerSocket.start] - [Nginx4j] listen on port=8080

页面访问：http://127.0.0.1:8080

响应：

Welcome to nginx4j!

其他页面

访问 http://localhost:8080/1.txt

将返回对应的文件内容：

hello nginx4j!

不存在

http://localhost:8080/asdfasdf

404 Not Found: The requested resource was not found on this server.

gzip

NginxUserConfig nginxUserConfig = NginxUserConfigLoaders.configFile("D:\\github\\nginx4j\\src\\main\\resources\\nginx.conf").load();

 Nginx4jBs.newInstance()
 .nginxUserConfig(nginxUserConfig)
 .init()
 .start();