README.md · sky-zhou/xhCloud

# 项目文档

## 1. 基本介绍

### 1.1 项目介绍

测试用户名：admin

测试密码：abc123

> XhCloud是一个基于gin开发的后端的后台管理系统，集成token，动态路由，动态菜单，动态表单，提供多种示例文件，让您把更多时间专注在业务开发上。

### 1.2 贡献指南

Hi! 首先感谢你使用 XhCloud。

XhCloud 是一套为后台管理平台准备的一整套前后端分离架构式的开源框架，旨在快速搭建后台管理系统。

#### 1.2.1 Issue 规范

- issue 仅用于提交 Bug 或 Feature 以及设计相关的内容，其它内容可能会被直接关闭。如果你在使用时产生了疑问，请到 Slack 或 [Gitter](https://gitter.im/ElemeFE/element)
  里咨询。

- 在提交 issue 之前，请搜索相关内容是否已被提出。

#### 1.2.2 Pull Request 规范

- 请先 fork 一份到自己的项目下，不要直接在仓库下建分支。

- commit 信息要以`[文件名]: 描述信息` 的形式填写，例如 `README.md: fix xxx bug`。

- 确保 PR 是提交到 `develop` 分支，而不是 `master` 分支。

- 如果是修复 bug，请在 PR 中给出描述信息。

- 合并代码需要两名维护人员参与：一人进行 review 后 approve，另一人再次 review，通过后即可合并。

### 1.3 版本列表

- master: 开发中

## 2. 使用说明

### 2.2 server端

使用 goland等编辑工具，打开XhCloud跟目录

```bash
# 使用 go.mod

# 安装go依赖包
go list (go mod tidy)

# 编译
go build
```

> Zap日志库使用指南&&配置指南

Zap日志库的配置选择在[config.yaml](./config-local.yaml)下的zap

```yaml
# zap logger configuration
zap:
  level: 'debug'
  format: 'console'
  prefix: '[XHSOFTWARE]'
  director: 'log'
  link_name: 'latest_log'
  show_line: true
  encode_level: 'LowercaseColorLevelEncoder'
  stacktrace_key: 'stacktrace'
  log_in_console: true
```

| 配置名 | 配置的类型 | 说明 |
| -------------- | ---------- | ------------------------------------------------------------ |
| level | string | level的模式的详细说明,请看[zap官方文档](https://pkg.go.dev/go.uber.org/zap?tab=doc#pkg-constants) info: info模式,无错误的堆栈信息,只输出信息 debug:debug模式,有错误的堆栈详细信息 warn:warn模式 error: error模式,有错误的堆栈详细信息 dpanic: dpanic模式 panic: panic模式 fatal: fatal模式 |
| format | string | console: 控制台形式输出日志 json: json格式输出日志 |
| prefix | string | 日志的前缀 |
| director | string | 存放日志的文件夹,修改即可,不需要手动创建 |
| link_name | string | 在server目录下会生成一个link_name的[软连接文件](https://baike.baidu.com/item/%E8%BD%AF%E9%93%BE%E6%8E%A5),链接的是director配置项的最新日志文件 |
| show_line | bool | 显示行号, 默认为true,不建议修改 |
| encode_level | string | LowercaseLevelEncoder:小写 LowercaseColorLevelEncoder:小写带颜色 CapitalLevelEncoder: 大写 CapitalColorLevelEncoder: 大写带颜色 |
| stacktrace_key | string | 堆栈的名称,即在json格式输出日志时的josn的key |
| log_in_console | bool | 是否输出到控制台,默认为true |

- 开发环境 || 调试环境配置建议
 - `level:debug`
 - `format:console`
 - `encode_level:LowercaseColorLevelEncoder`或者`encode_leve:CapitalColorLevelEncoder`
- 部署环境配置建议
 - `level:error`
 - `format:json`
 - `encode_level: LowercaseLevelEncoder `或者 `encode_level:CapitalLevelEncoder`
 - `log_in_console: false`
- 建议只是建议,按照自己的需求进行即可,给出建议仅供参考

### 2.3 swagger自动化API文档

#### 2.3.1 安装 swagger

##### （1）可以翻墙

````
go get -u github.com/swaggo/swag/cmd/swag
````

##### （2）无法翻墙

由于国内没法安装 go.org/x 包下面的东西，推荐使用 [goproxy.io](https://goproxy.io/zh/)

```bash
如果您使用的 Go 版本是 1.13 及以上(推荐)
# 启用 Go Modules 功能
go env -w GO111MODULE=on 
# 配置 GOPROXY 环境变量
go env -w GOPROXY=https://goproxy.io,direct
# 使用如下命令下载swag
go get -u github.com/swaggo/swag/cmd/swag
```

#### 2.3.2 生成API文档

````
cd xhcloud
swag init
````

执行上面的命令后，XhCloud目录下会出现docs文件夹，登录http://localhost:9090/swagger/index.html，即可查看swagger文档

## 3. 技术选型

- 后端：用`Gin`快速搭建基础restful风格API，`Gin`是一个go语言编写的Web框架。
- 数据库：采用`MySql`(5.6.44)版本，使用`gorm`实现对数据库的基本操作。
- 缓存：使用`Redis`实现记录 表单配置信息缓存、token对应用户信息缓存、表单ID缓存
- API文档：使用`Swagger`构建自动化文档。
- 配置文件：使用`fsnotify`和`viper`实现`yaml`格式的配置文件。
- 日志：使用`go-logging`实现日志记录。

## 4. 项目架构

### 4.1 系统架构图

![系统架构图]('https://gitee.com/sky-zhou_admin/xhcloud-document/blob/master/%E6%A1%86%E6%9E%B6%E8%AE%BE%E8%AE%A1%E5%9B%BE%E7%89%87/xhsoft%E4%B8%9A%E5%8A%A1%E8%AE%BE%E8%AE%A11.png')

### 4.3 目录结构

```
  XhCloud  	     （后端文件夹）
    ├─api            （API）
    ├─config         （配置包）
    ├─core  	     （內核）
    ├─docs  	     （swagger文档目录）
    ├─global         （全局对象）
    ├─initialiaze    （初始化）
    ├─middleware     （中间件）
    ├─model          （结构体层）
    ├─resource       （资源）
    ├─router         （路由）
    ├─service         (服务) 
    └─utils	         （公共功能）

```

## 5. 主要功能

- 权限管理：基于`jwt`和`casbin`实现的权限管理
- 文件上传下载：实现基于七牛云的文件上传操作（为了方便大家测试，我公开了自己的七牛测试号的各种重要token，恳请大家不要乱传东西）
- 分页封装：前端使用mixins封装分页，分页方法调用mixins即可
- 用户管理：系统管理员分配用户角色和角色权限。
- 角色管理：创建权限控制的主要对象，可以给角色分配不同api权限和菜单权限。
- 菜单管理：实现用户动态菜单配置，实现不同角色不同菜单。
- api管理：不同用户可调用的api接口的权限不同。
- 配置管理：配置文件可前台修改（测试环境不开放此功能）。
- 富文本编辑器：MarkDown编辑器功能嵌入。
- 条件搜索：增加条件搜索示例。
- restful示例：可以参考用户管理模块中的示例API。

```
后台文件参考: model\dnModel\api.go 
```

- 多点登录限制：需要在`config.yaml`中把`system`中的`useMultipoint`修改为true(需要自行配置Redis和Config中的Redis参数，测试阶段，有bug请及时反馈)。
- 分片长传：提供文件分片上传和大文件分片上传功能示例。
- 表单生成器：表单生成器借助 [@form-generator](https://github.com/JakHuang/form-generator)。
- 代码生成器：后台基础逻辑以及简单curd的代码生成器。

## 6. 计划任务
- [x] 用户登录登出 生成token 存入redis
- [x] 配置表单信息加载至redis
- [x] 单表单保存、修改功能(同时校验redis)
- [x] 单表单删除记录
- [ ] 单表单提交反提交
- [ ] 工作流集成
- [ ] 单表查询列表

## 8. 联系方式
### 微信交流

| 微信 |
| :---: | 
| <img width="150" src="https://gitee.com/sky-zhou_admin/xhcloud-document/blob/master/%E6%A1%86%E6%9E%B6%E8%AE%BE%E8%AE%A1%E5%9B%BE%E7%89%87/1622194897696.jpg">

添加微信，备注"加入XhCloud交流群"

## 10. 商用注意事项
如果您将此项目用于商业用途，请遵守Apache2.0协议并保留作者技术支持声明。

sky-zhou/xhCloud

简介

发行版

贡献者

近期动态

sky-zhou/xhCloud .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

sky-zhou/xhCloud