Selaa lähdekoodia

update: server/README.md

SliverHorn 3 vuotta sitten
vanhempi
commit
a6e62f388e
1 muutettua tiedostoa jossa 53 lisäystä ja 43 poistoa
  1. 53 43
      server/README.md

+ 53 - 43
server/README.md

@@ -1,44 +1,54 @@
+## server项目结构
+
+```shell
+├── api
+│   └── v1
+├── config
+├── core
+├── docs
+├── global
+├── initialize
+│   └── internal
+├── middleware
+├── model
+│   ├── request
+│   └── response
+├── packfile
+├── resource
+│   ├── excel
+│   ├── page
+│   └── template
+├── router
+├── service
+├── source
+└── utils
+    ├── timer
+    └── upload
+```
+
+| 文件夹       | 说明                    | 描述                        |
+| ------------ | ----------------------- | --------------------------- |
+| `api`        | api层                   | api层 |
+| `--v1`       | v1版本接口              | v1版本接口                  |
+| `config`     | 配置包                  | config.yaml对应的配置结构体 |
+| `core`       | 核心文件                | 核心组件(zap, viper, server)的初始化 |
+| `docs`       | swagger文档目录         | swagger文档目录 |
+| `global`     | 全局对象                | 全局对象 |
+| `initialize` | 初始化 | router,redis,gorm,validator, timer的初始化 |
+| `--internal` | 初始化内部函数 | gorm 的 longger 自定义,在此文件夹的函数只能由 `initialize` 层进行调用 |
+| `middleware` | 中间件层 | 用于存放 `gin` 中间件代码 |
+| `model`      | 模型层                  | 模型对应数据表              |
+| `--request`  | 入参结构体              | 接收前端发送到后端的数据。  |
+| `--response` | 出参结构体              | 返回给前端的数据结构体      |
+| `packfile`   | 静态文件打包            | 静态文件打包 |
+| `resource`   | 静态资源文件夹          | 负责存放静态文件                |
+| `--excel` | excel导入导出默认路径 | excel导入导出默认路径 |
+| `--page` | 表单生成器 | 表单生成器 打包后的dist |
+| `--template` | 模板 | 模板文件夹,存放的是代码生成器的模板 |
+| `router`     | 路由层                  | 路由层 |
+| `service`    | service层               | 存放业务逻辑问题 |
+| `source` | source层 | 存放初始化数据的函数 |
+| `utils`      | 工具包                  | 工具函数封装            |
+| `--timer` | timer | 定时器接口封装 |
+| `--upload`      | oss                  | oss接口封装        |
 
-整理代码结构
-``` lua
-web
-├── api/v1 -- 主要API
-|   ├── sys_initdb.go -- ico
-|   └── sys_user.go --  
-├── config -- 配置文件 设定操作的结构体
-|   ├── auto_code.go -- ico captcha.go
-|   ├── ... -- ico captcha.go
-|   └── zap.go -- core
-├── core -- 主要结构代码
-|   ├── server_other.go -- ico captcha.go
-|   ├── ... -- ico captcha.go
-|   └── zap.go -- 
-├── docs -- 文档系统
-|   ├── docs.go -- ico captcha.go
-|   ├── swagger.json -- json
-|   └── swagger.yaml -- yaml  
-├── global -- global
-├── initialize -- initialize 
-├── middleware -- 中间键
-├── model -- global
-│   ├── request  -- 所有请求model结构体
-|   |   ├── common.go 
-|   |   ├── ...
-|   |   └── sys_user.go -- yaml  
-|   ├── response  -- 返回数据
-|   |   ├── common.go 
-|   |   ├── ...
-|   |   └── sys_user.go -- yaml  
-├── packfile -- 文件写入
-├── resource -- 资源文件
-├── router -- 路由
-├── service -- service层
-├── source -- 文件目录操作 
-├── utils
-├── config.yaml  -- 
-├── Dockerfile  -- docker配置
-├── go.mod    -- mod 配置
-├── go.sum -- sum
-├── latest_log  -- vue-cli 配置
-└── main.go  -- package.json
-```