24 使用Nginx部署 Java Web 服务

优质

小牛编辑

134浏览

2023-12-01

比较早之前，部署 Java web 服务只是单纯使用 Tomcat 做 Web 服务器，前后端代码融合在一个工程之中。Tomcat 启动后对外提供一个端口接收和相应 http请求。随着 Nginx 的越来越流行，同时加上其优秀的反响代理和负载均衡功能，我们在线上的 Java web 通常会结合二者，即使用 Nginx + Tomcat 的方式来部署 Java web 服务。最近两年，随着微服务化和前后端工程分离思想的流行，使用 Spring Boot 和 Vue 框架进行 Java web 开发的人的人越来越多。由于前后端分离后需要解决请求跨域的问题，往往会使用 Nginx 做一层反向代理，这样可以减少一些代码风险。所以，目前主流的 Java web开发模式是:

基于 Vue 等优秀的前端框架完成页面开发；
使用 Spring Boot 等 java web 框完成后端服务开发；
前端工程打包后是一堆静态文件，可以直接由 Nginx 进行代理访问；后端服务启动后会占用端口等待请求，Nginx 将使用反向代理功能将前端发起的 http 请求转到对应的后台服务去处理。如果在多台机器上部署了相同的服务，还可以使用 Nginx 中的负载均衡功能，将请求均匀分发到上游的服务，实现系统的高可用性。

1. 部署前端

前端框架如 Vue 打包出来往往是静态的文件 index.html 加上一个 static 目录。static 目录下有 fonts、css、js、img等静态资源目录。前端的访问是从 index.html 开始的。假设服务器上打包出的前端代码放到/root/test-web目录下，对应部署前端的配置如下:

...

http{
    server {
       # 监听8080端口
       listen 8080;     
       # 指定域名，不指定也可以
       server_name www.xxx.com;
       
       # 浏览器交互调参，打开gzip压缩、缓存等等
       gzip on;
       ...
       
       location / {
           root  /root/test-web;
           # 也可以简单使用 index index.html
           try_files $uri $uri/ /index.html;
       }
       
       # vue 页面中向后台 java 服务发送请求
       ...
    }
}
...

2. 部署java后台服务

Nginx 部署 Java Web 服务时，主要用到是 Nginx 的代理转发功能，对于不同类型的接口而言，可能会有不同的转发逻辑。如果是使用 spring cloud 这样的微服务框架，每个服务可能会部署多个会这分开部署在不同机器，在 Nginx 同样只需要使用 proxy_pass 指令将 http 请求转发到对应的上游服务上即可，同时负载均衡模块也在 java web 后台服务中用到的比较多。最后是在java web 的开发中，也常常会涉及到 websocket 协议，因此 Nginx 在部署 java web 服务时也会用到 websocket 代理转发。所以 Nginx 在部署 Java Web 服务时的基本配置大概如下:

...

http{

    server {
       # 监听8080端口
       listen 8080;     
       # 指定域名，不指定也可以
       server_name www.xxx.com;
       
       # 参数调优
       client_max_body_size 20m; 
       client_body_buffer_size 128k
       ...
       
       # 如果使用多个后台服务，可以配置负载均衡
       ...
       
       # 访前端的 vue 页面
       location / {
           ...
       }
       # vue 页面中向后台 java 服务发送请求
       location /xxxx { 
            proxy_pass http://xxxx:xx/xxx;
       }
       
       # 配置多种方向代理，不同类型接口有不同的转发方式
       ...
       
       # 如果有，则配置websocket代理
       location /xxxy {
           proxy_http_version 1.1;
           proxy_set_header Upgrade $http_upgrade;
           proxy_set_header Connection "upgrade";
           proxy_pass http://xxxxx:xx/yyy;
       }
    }   
}
...

如果涉及的服务较多， Nginx 的配置往往会拆成多个文件进行编写，这样就用到了前面提到的 include 指令。

3. 小结

总结 Nginx 部署 java 服务，主要是使用 proxy_pass 指令进行端口转发，因为都是 http 请求的转发，所以配置会比较简单。但是如果服务较多时， Nginx 需要编写多个 server 指令块或者多个 location 块去匹配不同的 URL并转发到对应的上游服务。往往大型网站使用的服务较多时，会使用 include 指令对 Nginx 的配置进行拆分，不同的配置处理不同服务的转发，这样会更简洁明了，方便网站运维人员管理和修改 Nginx 配置。