# tool-box-master

**Repository Path**: AnMo2011/tool-box-master

## Basic Information

- **Project Name**: tool-box-master
- **Description**: 工具盒子
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-17
- **Last Updated**: 2023-12-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 工具盒子

### 代码生成：
* 后端采用MyBatis-Plus作为项目持久层框架，其中用到了MyBatis-Plus分页、乐观锁、逻辑删除、自动填充、代码生成等功能。
* 注：在使用代码生成时需要注意，已经生成好了的代码就不要重复生成，避免存在问题，生成时因注释之前生成的数据库表名，在生成本次所用到的数据库表

### 前后端数据交互规范
* 前，后端分离开发.
* 前，后端所有的交互不采用Http编码，例如：404，502等等，我们认为在常规情况下，所有的响应都是成功的。避免因为采用Http编码，在前，后端的中间环节中，例如：Nginx，SLB，路由器，运营商等等会对非200的Http编码进行截获，加入一些我们不需要的意外的逻辑或者数据。前端可以认为收到非200的Http响应编码，一律是因为网络因素造成，提示用户网络不佳，稍后进行重试。
* 前，后端采用json数据结构作为主要数据通信模式，json数据结构如下

```json
{
  "result": "请求时间戳为：1701401012832",
  "success": true,
  "code": 0,
  "message": "操作成功"
}
```

| 名称      | 类型      | 说明                                                         |
|---------|---------|------------------------------------------------------------|
| result  | T【对象类型】 | 真正返回的数据对象。                                                 |
| success | Boolean | 是否调用成功（true->成功 / false->失败）                               |
| code    | Integer | 0 代表正常；小于0代表系统异常，前段需要关注；大于0代表业务异常，前端无需关注，直接提示用户message信息即可 |
| message | String  | 中文提示                                                       |

### Code 小于 0
| code | 说明      |
|------|---------|
| \-1  | 服务暂时不可用 |
| \-2  | Token错误 |
| \-3  | 暂无权限    |
| \-10 | 操作失败    |

> 注：剩余提示语很多，从1000开始计算，在定义时要注意message不要带敏感信息给到前端！

### 通用接口参数
* 定义的参数难免有大量重复的，此处定义了一些通用参数，不在接口另作说明了。

| 请求参数           | 参数      | 名称            | 说明                                 |
|----------------|---------|---------------|------------------------------------|
| startDate      | String  | 开始日期          | 格式：2019\-05\-01 精确到日期，且开始日期从每月1号开始 |
| endDate        | String  | 结束日期          | 格式：2019\-06\-30 精确到日期，且结束日期至每月最后一天 |
| startTimestamp | Long    | 开始时间（单位秒或者毫秒） |                                    |
| endTimestamp   | Long    | 结束时间（单位秒或者毫秒） |                                    |
| pageIndex      | Integer | 第几页           | pageIndex为空时默认从第一页查询               |
| pageSize       | Integer | 每页几条记录        | pageSize为空是默认每页十条数据                |