尚硅谷-尚庭公寓部署文档
文章目录
- 整合版部署文档
- 部署架构图
- 1. 项目目录结构
- 增加注释的 Dockerfile 配置
- (1) 后端服务1 Dockerfile (`backend/service1/Dockerfile`)
- (2) 后端服务2 Dockerfile (`backend/service2/Dockerfile`)
- Dockerfile 配置说明
- 重要注意事项
- 3. Nginx 配置
- (1) 主配置文件 (`nginx/nginx.conf`)
- (2) 前端路由配置 (`nginx/conf.d/app.conf`)
- (3) 管理后台配置 (`nginx/conf.d/admin.conf`)
- 4. Docker Compose 配置
- 5. 部署操作流程
- 6. 关键配置说明
- (1) 网络通信原理
- (2) 健康检查机制
- 7. 高级优化配置
- HTTPS 配置示例
- 安全增强配置
- 8. 常见问题解决
- 9. 方案优势
- 10. 验证部署成功
整合版部署文档
部署架构图
1. 项目目录结构
deploy/
├── docker-compose.yml # 容器编排主文件
├── frontend/ # 前端静态资源
│ ├── app/ # 主应用构建产物
│ │ ├── index.html
│ │ ├── static/
│ │ └── favicon.ico
│ └── admin/ # 管理后台构建产物
│ ├── index.html
│ ├── static/
│ └── favicon.ico
├── backend/ # 后端服务
│ ├── service1/ # 服务1
│ │ ├── Dockerfile
│ │ └── service1.jar
│ └── service2/ # 服务2
│ ├── Dockerfile
│ └── service2.jar
└── nginx/ # Nginx配置├── nginx.conf└── conf.d/ # 站点配置├── app.conf # 主应用配置└── admin.conf # 管理后台配置
增加注释的 Dockerfile 配置
(1) 后端服务1 Dockerfile (backend/service1/Dockerfile
)
# 使用官方 OpenJDK 17 基础镜像
FROM eclipse-temurin:17-jdk# 设置容器内工作目录为 /app
WORKDIR /app# 将宿主机当前目录下的 service1.jar 复制到容器工作目录
COPY service1.jar .# 声明容器运行时暴露的端口(8080)
EXPOSE 8080# 容器启动时执行的命令 - 运行 Java 应用
CMD ["java", "-jar", "service1.jar"]
(2) 后端服务2 Dockerfile (backend/service2/Dockerfile
)
# 使用官方 OpenJDK 17 基础镜像
FROM eclipse-temurin:17-jdk# 设置容器内工作目录为 /app
WORKDIR /app# 将宿主机当前目录下的 service2.jar 复制到容器工作目录
COPY service2.jar .# 声明容器运行时暴露的端口(8081)
EXPOSE 8081# 容器启动时执行的命令 - 运行 Java 应用
CMD ["java", "-jar", "service2.jar"]
Dockerfile 配置说明
指令 | 说明 |
---|---|
FROM | 指定基础镜像,这里使用官方 OpenJDK 17 镜像作为运行环境 |
WORKDIR | 设置工作目录,后续命令都在此目录执行 |
COPY | 将本地文件复制到容器内,这里复制编译好的 JAR 包 |
EXPOSE | 声明容器运行时监听的端口号,便于文档化和端口映射 |
CMD | 指定容器启动时执行的命令,这里是运行 Java 应用程序 |
重要注意事项
-
JAR 文件位置
确保 JAR 文件与 Dockerfile 在同一目录下,否则构建会失败 -
端口映射
在docker-compose.yml
中不需要显式映射后端端口,因为:- 服务通过 Docker 内部网络通信
- 外部访问通过 Nginx 代理
-
多阶段构建(高级用法)
如需在容器内编译代码,可使用多阶段构建:# 第一阶段:构建应用 FROM maven:3.8.6 AS build WORKDIR /app COPY . . RUN mvn clean package -DskipTests# 第二阶段:运行应用 FROM eclipse-temurin:17-jdk WORKDIR /app COPY --from=build /app/target/service1.jar . CMD ["java", "-jar", "service1.jar"]
-
环境变量配置
应用配置应通过docker-compose.yml
的环境变量注入:environment:- DB_URL=jdbc:mysql://db:3306/app- REDIS_HOST=redis
-
时区设置
如需统一时区,可在 Dockerfile 中添加:RUN ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime
3. Nginx 配置
(1) 主配置文件 (nginx/nginx.conf
)
events {}
http {include /etc/nginx/conf.d/*.conf;# 全局优化配置gzip on;gzip_types text/plain text/css application/json application/javascript;keepalive_timeout 65;server_tokens off;
}
(2) 前端路由配置 (nginx/conf.d/app.conf
)
server {listen 80;server_name app.domain.com;location / {root /usr/share/nginx/html/app;try_files $uri $uri/ /index.html;index index.html;# 缓存与安全头expires 1y;add_header Cache-Control "public";add_header X-Frame-Options "SAMEORIGIN";add_header X-Content-Type-Options "nosniff";}# 代理后端服务1location /api/service1 {proxy_pass http://service1:8080;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;proxy_connect_timeout 75s;}
}
(3) 管理后台配置 (nginx/conf.d/admin.conf
)
server {listen 80;server_name admin.domain.com;location / {root /usr/share/nginx/html/admin;try_files $uri $uri/ /index.html;index index.html;# 禁用缓存add_header Cache-Control "no-store, no-cache, must-revalidate";}# 代理后端服务2location /api/service2 {proxy_pass http://service2:8081;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;# WebSocket支持proxy_http_version 1.1;proxy_set_header Upgrade $http_upgrade;proxy_set_header Connection "upgrade";}# 健康检查端点location = /health {return 200 'OK';add_header Content-Type text/plain;}
}
4. Docker Compose 配置
version: '3.8'services:# Nginx网关服务nginx:image: nginx:alpineports:- "80:80"volumes:- ./frontend/app:/usr/share/nginx/html/app:ro- ./frontend/admin:/usr/share/nginx/html/admin:ro- ./nginx/conf.d:/etc/nginx/conf.d- ./logs/nginx:/var/log/nginxnetworks:- app-networkrestart: unless-stoppedhealthcheck:test: ["CMD", "curl", "-f", "http://localhost/health"]interval: 30stimeout: 3s# 后端服务1service1:build:context: ./backend/service1environment:- SPRING_PROFILES_ACTIVE=prod- TZ=Asia/Shanghainetworks:- app-networkrestart: unless-stoppeddeploy:resources:limits:memory: 512M# 后端服务2service2:build:context: ./backend/service2environment:- SPRING_PROFILES_ACTIVE=prod- TZ=Asia/Shanghainetworks:- app-networkrestart: unless-stoppeddeploy:resources:limits:memory: 512M# 自定义网络
networks:app-network:driver: bridgeipam:config:- subnet: 172.28.0.0/16
5. 部署操作流程
# 1. 准备目录结构
mkdir -p deploy/{frontend/{app,admin},backend/{service1,service2},nginx/conf.d,logs/nginx}# 2. 放入项目文件
cp -r /path/to/app/dist/* deploy/frontend/app/
cp -r /path/to/admin/dist/* deploy/frontend/admin/
cp /path/to/service1.jar deploy/backend/service1/
cp /path/to/service2.jar deploy/backend/service2/# 3. 创建Nginx配置文件
# 将上述nginx配置写入对应文件# 4. 启动服务
docker-compose up -d --build# 5. 验证部署
curl -I http://localhost/app/index.html
docker-compose logs -f nginx
6. 关键配置说明
(1) 网络通信原理
- 所有服务通过
app-network
通信 - 容器间通过服务名自动解析(如
service1:8080
) - 静态资源通过卷挂载实时更新
(2) 健康检查机制
healthcheck:test: ["CMD", "curl", "-f", "http://localhost/health"]interval: 30stimeout: 3s
- 每30秒检查Nginx状态
- 失败自动重启容器
- 通过
/health
端点监控
7. 高级优化配置
HTTPS 配置示例
server {listen 443 ssl;server_name app.domain.com;ssl_certificate /etc/nginx/ssl/fullchain.pem;ssl_certificate_key /etc/nginx/ssl/privkey.pem;ssl_protocols TLSv1.2 TLSv1.3;# HSTS强制HTTPSadd_header Strict-Transport-Security "max-age=31536000" always;# 其他配置保持不变...
}
安全增强配置
server {# 安全头部add_header Content-Security-Policy "default-src 'self'";add_header X-XSS-Protection "1; mode=block";# 禁用不安全方法if ($request_method !~ ^(GET|POST)$ ) {return 405;}
}
8. 常见问题解决
问题现象 | 解决方案 |
---|---|
静态资源加载404 | chmod -R 755 deploy/frontend 确保权限正确 |
API代理超时(504) | 检查proxy_connect_timeout 配置,验证容器间网络:docker-compose exec nginx ping service1 |
SPA路由刷新404 | 确认Nginx配置包含try_files $uri $uri/ /index.html |
跨域问题(CORS) | 在代理配置中添加Access-Control-Allow-* 头信息 |
端口冲突 | 修改docker-compose.yml 中的端口映射:"8080:80" |
9. 方案优势
- 高效部署:静态资源实时挂载,无需重建容器
- 资源优化:使用轻量级Alpine镜像(23MB),内存限制控制
- 生产级特性:
- 健康检查自动恢复
- 日志持久化
- 安全头部防护
- 灵活扩展:
# 添加新前端 mkdir deploy/frontend/new-app # 添加Nginx配置 vi deploy/nginx/conf.d/new-app.conf # 重载服务 docker-compose exec nginx nginx -s reload
10. 验证部署成功
# 1. 检查容器状态
docker-compose ps# 2. 测试端点访问
curl -H "Host: app.domain.com" http://localhost/api/service1/health
curl -H "Host: admin.domain.com" http://localhost/api/service2/health# 3. 检查日志
tail -f deploy/logs/nginx/access.log
这个部署只能使用自己电脑配置的域名访问才可以,
使用ip地址或者手机进行访问的时候会发现前端访问不到后端的服务,
但是却可以访问到前端页面和后端服务的OpenApi,
后面查了好久也没有找到是什么问题,就放弃了,要是有大佬知道的话,
还请指点一下ლ(́◉◞౪◟◉‵ლ)感谢
本部署文档和代码以上传gitee上:https://gitee.com/banhuayue/shangting-apartment.git
大家可以直接克隆。