当前位置: 首页 > news >正文

【web应用】前后端分离项目基本框架组成:Vue + Spring Boot 最佳实践指南

文章目录

  • 前言
  • 一、项目结构与角色边界
    • 1、整体目录约定
    • 2、角色职责与协作流程
  • 二、接口设计规范
    • 1、RESTful URL + 版本控制
    • 2、统一返回体
    • 3、自动生成文档
  • 三、安全与质量红线
  • 四、前端工程化实践
  • 五、后端可观测性
  • 六、部署与 CI/CD
  • 七、团队协作 Tips


前言

本文基于真实项目经验,系统梳理前后端分离架构下的开发规范、协作流程与部署实践,适用于 Vue + Spring Boot 技术栈,帮助团队快速搭建可维护、可扩展的现代化 Web 应用。

一、项目结构与角色边界

1、整体目录约定

project-root
├── frontend/            # Vue 前端
│   ├── src/api          # 接口封装
│   ├── src/views        # 业务页面
│   ├── src/router       # 前端路由
│   └── .env.*           # 多环境变量
├── backend/             # Spring Boot 后端
│   ├── src/main/java
│   │   ├── controller   # REST 接口
│   │   ├── service      # 业务逻辑
│   │   ├── repository   # 数据访问
│   │   └── config       # 统一配置
│   └── pom.xml
├── deploy/              # Docker & K8s 部署脚本
└── docs/                # Swagger/YApi 接口文档

2、角色职责与协作流程

阶段前端后端共同点
需求评审评估交互工作量评估业务/数据工作量输出接口粒度
接口定义提供 UI 需要的数据结构编写 Swagger/YApi 并生成 Mock评审后锁定接口文档
开发使用 Mock 数据并行开发实现业务逻辑 & 单元测试Git Flow 分支管理
联调切换代理到真实后端打开 Swagger 在线调试使用 Postman 做契约测试
上线构建静态包→CDNDocker 镜像→K8s/虚拟机CI/CD 同 Pipeline

二、接口设计规范

1、RESTful URL + 版本控制

GET    /api/v1/users?page=1&size=20
POST   /api/v1/users
PUT    /api/v1/users/{id}
DELETE /api/v1/users/{id}

2、统一返回体

{"code": 0,"msg": "success","data": { ... },"traceId": "c0a8644e166..."
}

3、自动生成文档

Springfox/Knife4j 一键扫描注解 → 前端可直接在线调试,无需 Postman 导入。

三、安全与质量红线

维度实践要点
认证JWT + Spring Security;Token 存 HttpOnly Cookie 或 Authorization Header
鉴权@PreAuthorize(“hasRole(‘ADMIN’)”)
参数校验DTO 层 @Validated + Hibernate Validator
跨域Spring 全局 CORS 配置或使用 Gateway 统一处理
敏感数据统一脱敏 + 返回最小化原则
审计日志AOP 记录所有请求耗时、参数、返回值与异常

四、前端工程化实践

  1. 请求封装:基于 Axios 的 src/api/request.ts 自动携带 Token、统一错误提示。
  2. 环境变量.env.development / .env.production 区分代理地址。
  3. 路由守卫:动态加载菜单 + 权限指令 v-permission
  4. 构建优化:Vite/Webpack 拆包 + CDN + Gzip,首屏 < 1.5 s。

五、后端可观测性

能力技术方案
日志Logback + ELK 收集
链路追踪Spring Cloud Sleuth → Zipkin
指标Micrometer → Prometheus → Grafana Dashboard
告警PrometheusRule 钉钉/飞书机器人

六、部署与 CI/CD

  1. 容器化
    • 前端:nginx:alpine 静态镜像,大小 < 20 MB。
    • 后端:多阶段 Dockerfile mvn packageopenjdk:17-jre-slim
  2. 流水线示例(GitLab CI)
    stages: [build, docker, deploy]
    build:frontend:script: cd frontend && npm ci && npm run build
    build:backend:script: cd backend && mvn -B package -DskipTests
    deploy:k8s:script: helm upgrade --install app chart/
    
  3. 灰度发布:K8s Ingress + Nginx 权重分流,支持秒级回滚。

七、团队协作 Tips

  • 接口变更:通过 YApi 的「通知」功能告知全员,旧版本保留 2 个 Sprint。
  • Mock 数据:Mock.js 自动拦截 Ajax 请求,支持随机图片、延迟返回。
  • 代码规范:前端 ESLint + Prettier,后端 Spotless + Checkstyle,提交前 Git Hook 强制格式化。

http://www.dtcms.com/a/316182.html

相关文章:

  • 深度解析 TCP 三次握手与四次挥手:从原理到 HTTP/HTTPS 的应用
  • 微服务—OpenFeign
  • Spring中七种Propagation类的事务属性详解
  • 研发团队看板协作中的自动化实践:集成CI/CD与任务流转
  • 007TG洞察:高效运营Telegram私域流量:技术挑战与自动化解决方案探索
  • 中科米堆CASAIM自动化三维扫描系统自动测量压铸件尺寸
  • 【原创】基于gemini-2.5-flash-preview-05-20多模态模型实现短视频的自动化二创
  • 从 “看懂图” 到 “读懂视频”:多模态技术如何用文本反哺视觉?
  • 原型模式在C++中的实现与面向对象设计原则
  • 二维数点问题 1
  • 学习日志28 python
  • AI编程新时代:从氛围编程到上下文编程的深度实践和思考
  • 鸿蒙开发、大数据开发、Java开发与前端开发全面对比解析
  • 【银行测试】银行票据项目业务+票据测试点分析(四)
  • 2025《艾诺提亚失落之歌》逆向工程解包尝试
  • Linux网络编程:TCP初体验
  • VirtualBox安装教程
  • 64位程序调用32位dll方法
  • 【Linux系统编程】线程概念与控制
  • 使用valgrind工具检测server端lib库的内存泄漏
  • FT5X06 触摸芯片
  • 【技术教程】如何将 ONLYOFFICE 文档连接到 Confluence
  • nodejs 编程基础01-NPM包管理
  • Android 之 Kotlin
  • 让 Spark 干体力活:用 Java 快速找出最小值
  • GaussDB 并行创建索引
  • Webpack 5 Module Federation 模块共享最佳实践
  • AI智能体的安全困境:防护机制与伦理平衡的艺术
  • 高精度惯性导航IMU传感器供应商价格
  • Python-机器学习初识