readme.md · JackyCui/chaos

![](https://img.shields.io/badge/language-java-483D8B.svg)
![](https://img.shields.io/badge/license-MIT-483D8B.svg)

# CHAOS(一体化架构解决方案) 🍑

Chaos 是一个基于分布式、前后端分离设计的，开箱即用的快速开发架构。

## 后端架构

| 端 | 框架                 | 版本       | 状态 |
|---|--------------------|----------|----|
|   | SpringBoot         | 2.5.8    |    |
|   | SpringCloud        | 2020.0.4 |    |
|   | SpringCloudAlibaba | 2021.1   |    |
|   | openFiegn          |          |    |
|   | nacos              |          |    |
|   | MybatisPlus        | 3.4.0    |    |
|   | xxl-job            |          |    |

## 快速使用

1，引入依赖包

```xml

<parent>
    <groupId>com.chaos</groupId>
    <artifactId>chaos-framework-dependencies</artifactId>
    <version>2.0-SNAPSHOT</version>
    <relativePath/>
</parent>
```

```xml

<dependency>
    <groupId>com.chaos</groupId>
    <artifactId>chaos-framework-starter</artifactId>
</dependency>
```

## 功能列表

## 登录

## saas 端登录

### 多种认证方式

1，账号密码

```
curl --location --request POST 'http://127.0.0.1:9999/auth/oauth/token?grant_type=admin_username&client_id=saas&client_secret=VIlA38m0G2YwZ1nS&username=cuijian&password=12345678&tenantId=1' \
--header 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MTYxMDI5OTgsInVzZXJJZCI6MTQ4MTI0Nzk3MzY4NTgwNTA1NywidXNlcl9uYW1lIjoiY3VpamlhbiIsImp0aSI6IjIwYjg1NDI1LTEwYmItNGQ5Ni1hY2Y2LTk1ZjA4NjhhYjYwZSIsImNsaWVudF9pZCI6ImNsaWVudCIsInNjb3BlIjpbImFsbCJdfQ.RRH0xwNOy6OiZ0kMl2x3a0ragzmeL94M7qCERcTIM0ryx1e-Qg-IHX6VLMXNXs6VgMwjg1P2x98VJQufg-0AHZf0G5jJJaAHNPNJ2QKxbu-QoCXxh7HWxh9reDbSwVCRjz397wcy8cNrWX23Hnw47vo_beRoeg6caQ9yrvRLYX9qwuXFrFOnYkLDAsTbi0ZyTG9f6pnMUI2__RXmkX2bgCb-lptWcd0N6jtJF-5SiuHJmtTGYbC2rOowsuWFpFpwt_V7D31YzYRQBVG_tjIOCjhKydYbovUx9hXiPTb0Q-OSU1nPkf0YiCHPrcn-QSaym-0gaFD1CMCc8xhpMlUg8w' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Host: 127.0.0.1:9999' \
--header 'Connection: keep-alive' \
--data-raw ''
```

## 开放 api

通过增加 - 后缀识别

```
curl --location --request POST 'http://127.0.0.1:9999/auth/tTenant/one-' \
--header 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhZG1pblVzZXJJZCI6MTQ4MTI0Nzk3MzY4NTgwNTA1NywicGhvbmUiOiIiLCJ1c2VyX25hbWUiOiJjdWlqaWFuIiwic2NvcGUiOlsiYWxsIl0sInRlbmFudElkIjoxLCJleHAiOjE3MzI3ODMwOTIsImF1dGhvcml0aWVzIjpbIjIiXSwianRpIjoiQkI4VGhFVmg5VWxQYVJwT0ZYc0xmUDB0NWpzIiwiY2xpZW50X2lkIjoic2FhcyIsInVzZXJuYW1lIjoiY3VpamlhbiJ9.jJInD5PO8XXg0JWfK07dQLLZYS50KMARx2v_HTOzDs8vaOtmd4YsReCzjDnjPY-8X8xf1qZ9ascGwe5U6uVHtDxaPPt8Kk3dPKwb3AtTB7_snZ79pxI0qr1J9MCvBzk2WcwdTBh9Z52un1t-jVLnooYXXCKX5y-c9on6Fl0FGSJSf4PmAtt6SBjZ2lpDwI26eSIo55l4YxMtcRkiRh_zs_LcHGNFgLxQ0rapFzdKxFMO0aiymUyyGWTx2yuVxaxb0fjs3XCRHJrlwAWQeuNumBFcpGgvc-7dvSb3ZtlBOOOBfA3NM--0xJt7ShoRU_WCcP4k3joFlRWXUQ3ShauGDg' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Host: 127.0.0.1:9999' \
--header 'Connection: keep-alive' \
--data-raw '{
    "id": 380
}'
```

## C 端 api

通过增加 + 后缀识别：即有+后缀的接口，只需登录即可访问，其他限制通过在接口内实现

```
curl --location --request POST 'http://127.0.0.1:9999/auth/tUser/one+' \
--header 'Authorization: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhZG1pblVzZXJJZCI6MTQ4MTI0Nzk3MzY4NTgwNTA1NywicGhvbmUiOiIiLCJ1c2VyX25hbWUiOiJjdWlqaWFuIiwic2NvcGUiOlsiYWxsIl0sInRlbmFudElkIjoxLCJleHAiOjE3MzI3ODMwOTIsImF1dGhvcml0aWVzIjpbIjIiXSwianRpIjoiQkI4VGhFVmg5VWxQYVJwT0ZYc0xmUDB0NWpzIiwiY2xpZW50X2lkIjoic2FhcyIsInVzZXJuYW1lIjoiY3VpamlhbiJ9.jJInD5PO8XXg0JWfK07dQLLZYS50KMARx2v_HTOzDs8vaOtmd4YsReCzjDnjPY-8X8xf1qZ9ascGwe5U6uVHtDxaPPt8Kk3dPKwb3AtTB7_snZ79pxI0qr1J9MCvBzk2WcwdTBh9Z52un1t-jVLnooYXXCKX5y-c9on6Fl0FGSJSf4PmAtt6SBjZ2lpDwI26eSIo55l4YxMtcRkiRh_zs_LcHGNFgLxQ0rapFzdKxFMO0aiymUyyGWTx2yuVxaxb0fjs3XCRHJrlwAWQeuNumBFcpGgvc-7dvSb3ZtlBOOOBfA3NM--0xJt7ShoRU_WCcP4k3joFlRWXUQ3ShauGDg' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Host: 127.0.0.1:9999' \
--header 'Connection: keep-alive' \
--data-raw '{
    "id": 380
}'
```

### xxl-job

http://127.0.0.1:8788/xxl-job-admin/toLogin

## 与前端的交互约定

1，接口返回格式

### 基础格式

```json
{
  "code": 200,
  "msg": "success",
  "showType": 0,
  "success": true
}
```

#### data

```json
{
  "code": 200,
  "msg": "success",
  "showType": 0,
  "data": {
    "id": "1481247973685805057",
    "tenantId": "1",
    "username": "cuijian",
    "status": 1
  },
  "success": true
}
```

#### list

```json
{
  "code": 200,
  "msg": "SUCCESS",
  "showType": 0,
  "list": [
    {
      "id": "1481247973685805057",
      "tenantId": "1",
      "username": "cuijian",
      "status": 1
    }
  ],
  "success": true
}
```

#### page

```json
{
  "code": 200,
  "msg": "SUCCESS",
  "showType": 0,
  "page": {
    "list": [
      {
        "id": "1481247973685805057",
        "tenantId": "1",
        "username": "cuijian",
        "status": 1
      }
    ],
    "total": 1,
    "current": 1
  },
  "success": true
}
```

# 规范

## 1，HttpStatus（http 协议状态码）

表示基础通信状态，使用默认HttpStatus表示
1,200 表示成功
2,4XX 表示授权验证错误
5,5XX 表示服务器内部错误

## code+msg+success
表示业务级错误
1,code 表示业务错误码，默认为200，表示成功
2,msg 表示业务错误信息，默认为success，表示成功
3,success 表示是否成功，默认为true，表示成功(只有在 200 情况下 success=true)，前端通过 success 判断
4,showType 表示是否显示错误信息，默认为0，表示不显示

code
1,200 表示成功      
2,4xx 客户端错误(请求存在错误)     
3,5xx 服务端错误     
4,6xx 业务错误      
5,100X 认证相关

# 请求响应流程
## saas 端处理 
### 1，errorHandler（处理 http 状态码）
```ts
 message.error(`Response status:${error.response.status}`);
```

### 2， responseInterceptors （处理业务状态码，根据 success）

1，success=true，不做处理
2，success=false, 根据showType处理（默认情况不处理）

### 3，services 基础方法层（page，list，get，add，update，remove）
暂不处理

### 4，services handler 方法层（handleAdd，handleUpdate，handleRemove，handleRemoveList）
提供简单的交互提示

# 业务层处理交互
## 场景一：success=false，
1，使用services handler 使用简易交互
2，使用showType（需与后端约定），使用简单交互
3，自己完成交互

## 场景二： success=true，
1，使用services handler 使用简易交互
2，自己完成交互

#### 联系我们

# Poweredby Jacky.Cui

JackyCui/chaos

简介

发行版

贡献者

近期动态

JackyCui/chaos .gitee-modal { width: 500px !important; }

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

JackyCui/chaos