目录结构
后端结构
注意
sz-service: 实际服务目录,以后所有服务都放置到此目录下
sz-service-admin: sz-admin 服务,后台管理相关服务
sz-service-websocket: websocket 服务目录,考虑到有socket有可能需要多个节点,因此将它也作为一个服务
sz-service 下的服务可以根据实际需求灵活引用sz-common下的通用模块
shell
sz-boot-parent/
├── sz-build # sz-boot-parent版本管理
├── sz-dependencies # 全局依赖版本管理
├── sz-common # 通用模块集合
│ ├── sz-common-core # 核心通用模块
│ ├── sz-common-db-mongodb # MongoDB 数据库操作模块
│ ├── sz-common-db-mysql # MySQL 数据库操作模块
│ ├── sz-common-db-redis # Redis 数据库操作模块
│ ├── sz-common-excel # Excel 工具模块
│ ├── sz-common-generator # 代码生成器模块
│ ├── sz-common-log # 日志模块
│ ├── sz-common-minio # Minio 对象存储模块
│ ├── sz-common-mq # 消息队列模块
│ └── sz-common-security # 鉴权模块
│ └── sz-common-wechat # 微信相关功能模块
│ ...
└── sz-service # 服务模块
├── sz-service-admin # sz-admin 核心服务模块
└── sz-service-websocket # websocket 服务模块
└── ...
前端结构
提示
在业务开发中,重点关注/src/api
和 /src/views
路径即可。
Directory | 描述 |
---|---|
/scr/api/interface | 描述对象的 ts 结构,用于约束数据的形状,类似于 Java 实体对象的强类型定义。 |
/scr/api/module | 引入项目中的 API 模块,用于处理 HTTP 请求的接口 API。 |
/src/views | 组织和管理项目中的页面结构和逻辑,包含实际页面的 Vue 组件。 |
shell
sz-admin/
├── public # 静态资源文件(该文件夹不会被打包)
│ └── favicon.ico
├── src
│ ├── api # API 接口管理
│ ├── assets # 静态资源文件
│ ├── components # 全局组件
│ ├── config # 全局配置项
│ ├── directives # 全局指令文件
│ ├── hooks # 常用 Hooks 封装
│ ├── languages # 语言国际化 i18n
│ ├── layouts # 框架布局模块
│ ├── router # 路由管理
│ ├── stores # pinia store
│ ├── styles # 全局样式文件
│ ├── typings # 全局 ts 声明
│ ├── utils # 常用util工具库
│ ├── views # 项目所有页面
│ ├── App.vue # 项目主组件
│ └── main.ts # 项目入口文件
├── env.d.ts # 指定 ts 识别 vue
├── index.html # 入口 html
├── package.json # 依赖包管理
├── pnpm-lock.yaml # pnpm依赖包版本锁
├── tsconfig.app.json # 应用程序代码的特定配置,用于浏览器环境。
├── tsconfig.json # typescript 全局配置
├── tsconfig.node.json # Node.js 环境的特定配置,用于服务器端代码或构建脚本。
├── vite.config.mts # vite 全局配置文件
└── README.md