Skip to content

Commit d5e5088

Browse files
author
奇淼(piexlmax
authored
Merge pull request #570 from SliverHorn/sliver_horn_gva_gormv2_dev_develop
update: server/README.md
2 parents f112a05 + d239aa1 commit d5e5088

File tree

1 file changed

+53
-43
lines changed

1 file changed

+53
-43
lines changed

server/README.md

Lines changed: 53 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,54 @@
1+
## server项目结构
2+
3+
```shell
4+
├── api
5+
│   └── v1
6+
├── config
7+
├── core
8+
├── docs
9+
├── global
10+
├── initialize
11+
│   └── internal
12+
├── middleware
13+
├── model
14+
│   ├── request
15+
│   └── response
16+
├── packfile
17+
├── resource
18+
│   ├── excel
19+
│   ├── page
20+
│   └── template
21+
├── router
22+
├── service
23+
├── source
24+
└── utils
25+
├── timer
26+
└── upload
27+
```
28+
29+
| 文件夹 | 说明 | 描述 |
30+
| ------------ | ----------------------- | --------------------------- |
31+
| `api` | api层 | api层 |
32+
| `--v1` | v1版本接口 | v1版本接口 |
33+
| `config` | 配置包 | config.yaml对应的配置结构体 |
34+
| `core` | 核心文件 | 核心组件(zap, viper, server)的初始化 |
35+
| `docs` | swagger文档目录 | swagger文档目录 |
36+
| `global` | 全局对象 | 全局对象 |
37+
| `initialize` | 初始化 | router,redis,gorm,validator, timer的初始化 |
38+
| `--internal` | 初始化内部函数 | gorm 的 longger 自定义,在此文件夹的函数只能由 `initialize` 层进行调用 |
39+
| `middleware` | 中间件层 | 用于存放 `gin` 中间件代码 |
40+
| `model` | 模型层 | 模型对应数据表 |
41+
| `--request` | 入参结构体 | 接收前端发送到后端的数据。 |
42+
| `--response` | 出参结构体 | 返回给前端的数据结构体 |
43+
| `packfile` | 静态文件打包 | 静态文件打包 |
44+
| `resource` | 静态资源文件夹 | 负责存放静态文件 |
45+
| `--excel` | excel导入导出默认路径 | excel导入导出默认路径 |
46+
| `--page` | 表单生成器 | 表单生成器 打包后的dist |
47+
| `--template` | 模板 | 模板文件夹,存放的是代码生成器的模板 |
48+
| `router` | 路由层 | 路由层 |
49+
| `service` | service层 | 存放业务逻辑问题 |
50+
| `source` | source层 | 存放初始化数据的函数 |
51+
| `utils` | 工具包 | 工具函数封装 |
52+
| `--timer` | timer | 定时器接口封装 |
53+
| `--upload` | oss | oss接口封装 |
154

2-
整理代码结构
3-
``` lua
4-
web
5-
├── api/v1 -- 主要API
6-
| ├── sys_initdb.go -- ico
7-
| └── sys_user.go --
8-
├── config -- 配置文件 设定操作的结构体
9-
| ├── auto_code.go -- ico captcha.go
10-
| ├── ... -- ico captcha.go
11-
| └── zap.go -- core
12-
├── core -- 主要结构代码
13-
| ├── server_other.go -- ico captcha.go
14-
| ├── ... -- ico captcha.go
15-
| └── zap.go --
16-
├── docs -- 文档系统
17-
| ├── docs.go -- ico captcha.go
18-
| ├── swagger.json -- json
19-
| └── swagger.yaml -- yaml
20-
├── global -- global
21-
├── initialize -- initialize
22-
├── middleware -- 中间键
23-
├── model -- global
24-
│ ├── request -- 所有请求model结构体
25-
| | ├── common.go
26-
| | ├── ...
27-
| | └── sys_user.go -- yaml
28-
| ├── response -- 返回数据
29-
| | ├── common.go
30-
| | ├── ...
31-
| | └── sys_user.go -- yaml
32-
├── packfile -- 文件写入
33-
├── resource -- 资源文件
34-
├── router -- 路由
35-
├── service -- service层
36-
├── source -- 文件目录操作
37-
├── utils
38-
├── config.yaml --
39-
├── Dockerfile -- docker配置
40-
├── go.mod -- mod 配置
41-
├── go.sum -- sum
42-
├── latest_log -- vue-cli 配置
43-
└── main.go -- package.json
44-
```

0 commit comments

Comments
 (0)