教育商城.md · jeyarLin/KOA

# 三、技术分析

## 1 技术选型

## 2 系统框架

## 3 数据库设计

-- 查看表结构 
mysql> desc zd_goods;

### 1) 商品表

表名：zd_goods
| 字段名 | 字段类型 | 说明 |
| --- | --- | --- |
| id | int | 主键，自增 |
| goods_name | varchar(255) | 商品名称 |
| goods_price | decimal(10,2) | 商品价格 |
| goods_num | int | 商品库存 |
| goods_img | varchar(255) | 商品图片的url |

### 2) 购物车表

表名：zd_carts
| 字段名 | 字段类型 | 说明 |
| --- | --- | --- |
| id | int | 主键，自增 |
| goods_id | int | 商品id |
| user_id | int | 用户id |
| number | int | 商品数量 |
| selected | tinyint(1) | 0：未选中，1：选中（默认值） |

### 3) 地址表

表名：zd_addresses
| 字段名 | 字段类型 | 说明 |
| --- | --- | --- |
| id | int | 主键，自增 |
| user_id | int | 用户id |
| consignee | varchar(255) | 收货人 |
| phone | char(11) | 手机号 |
| address | varchar(255) | 收货地址 |
| is_default | tinyint(1) | 0：不是默认地址（默认值），1：默认地址 |

### 4) 订单表

表名：zd_orders
| 字段名 | 字段类型 | 说明 |
| --- | --- | --- |
| id | int | 主键，自增 |
| user_id | int | 用户id |
| address_id | int | 地址id |
| goods_info | text | 商品信息 |
| number | decimal(10,2) | 订单总金额 |
| order_number | char(16) | 订单号 |
| status | tinyint | 订单状态(0: 未支付,1: 已支付, 2: 已发货, 3: 已签收, 4: 取消) |

### 5) 用户表

表名：zd_users
| 字段名 | 字段类型 | 说明 |
| --- | --- | --- |
| id | int | 主键，自增 |
| user_name | varchar(255) | 用户名，unique |
| password | char(64) | 密码 |
| is_admin | tinyint(1) | 0：不是管理员，1：是管理员 |

## 4 接口设计
### 1) 用户模块

- 注册接口

POST /users/register

请求参数 Body->row->JSON

```
{
    "user_name":"Jeyar001",
    "password":"123qwe"
}
```

响应-成功

```
{
    "code": 0,
    "message": "用户注册成功",
    "result": {
        "id": 26,
        "user_name": "Jeyar001"
    }
}
```

响应-失败

```
  userFormateError: {
    code: "10001",
    message: "用户名或密码为空",
    result: "",
  },
  userAlreadyExisted: {
    code: "10002",
    message: "用户已经存在",
    result: "",
  },
  userRegisterError: {
    code: "10003",
    message: "用户注册错误",
    result: "",
  },
```

- 用户登录接口

POST /users/login

请求参数 Body->row->JSON

```
{
    "user_name":"Tom",
    "password":"123qwe"
}
```

响应-成功

```
{
    "code": 0,
    "message": "用户登录成功",
    "result": {
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTYsInVzZXJfbmFtZSI6IlRvbSIsImlzX2FkbWluIjpmYWxzZSwiaWF0IjoxNjk3MTk3MTIzLCJleHAiOjE2OTcyODM1MjN9.3yFIlJd8fvTt8OYppzTLffqt1LHtsNe1JtKghs1RdPM"
    }
}
```

- 修改密码接口

PATCH /users

请求参数 Body->row->JSON

```
{
    "password":"123qwe"
}
```

响应-成功

```
{
    "code": 0,
    "message": "修改密码成功",
    "result": ""
}
```

### 2) 商品模块

- 商品图片上传接口

POST /goods/upload

请求参数

form-data Key:file Values:Select Files

响应-成功

```
{
    "code": 0,
    "message": "商品图片上传成功",
    "result": {
        "goods_img": "f95c340c26a00d3ec40741100.png"
    }
}
```

- 发布商品接口

POST /goods

请求参数 Body->row->JSON

```
{
    "goods_name": "蓝牙音箱big",
    "goods_price": 199,
    "goods_num": 3,
    "goods_img": "a985abd874b5b8af6b676e500.jpeg"
}
```

响应-成功

```
{
    "code": 0,
    "message": "发布商品成功",
    "result": {
        "id": 4,
        "goods_name": "蓝牙音箱big",
        "goods_price": 199,
        "goods_num": 3,
        "goods_img": "a985abd874b5b8af6b676e500.jpeg"
    }
}
```

- 修改商品接口

PUT /goods/:id

请求参数 Body->row->JSON

```
{
    "goods_name": "蓝牙音箱plus",
    "goods_price": 198,
    "goods_num": 30,
    "goods_img": "7dc687ce14245725aa4269900.png"
}
```

响应-成功

```
{
    "code": 0,
    "message": "修改商品成功",
    "result": ""
}
```

- 删除商品接口（硬删除）

DELETE /goods/:id

响应-成功

```
{
    "code": 0,
    "message": "删除商品成功",
    "result": ""
}
```

- 下架商品接口

POST /goods/:id/off

响应-成功

```
{
    "code": 0,
    "message": "下架商品成功",
    "result": ""
}
```

- 上架商品接口

POST /goods/:id/on

响应-成功

```
{
    "code": 0,
    "message": "上架商品成功",
    "result": ""
}
```

- 商品列表接口

GET /goods?pageNum=1&pageSize=10

响应-成功

```
{
    "code": 0,
    "message": "获取商品列表成功",
    "result": {
        "pageNum": "1",
        "pageSize": "10",
        "total": 4,
        "list": [
            {
                "id": 1,
                "goods_name": "蓝牙音箱plus",
                "goods_price": "198.00",
                "goods_num": 30,
                "goods_img": "7dc687ce14245725aa4269900.png",
                "createdAt": "2023-10-11T12:49:26.000Z",
                "updatedAt": "2023-10-13T11:49:48.000Z",
                "deletedAt": null
            },
            {
                "id": 2,
                "goods_name": "蓝牙音箱pro",
                "goods_price": "199.00",
                "goods_num": 3,
                "goods_img": "a985abd874b5b8af6b676e501.png",
                "createdAt": "2023-10-11T12:49:40.000Z",
                "updatedAt": "2023-10-11T12:49:40.000Z",
                "deletedAt": null
            },
            {
                "id": 3,
                "goods_name": "蓝牙音箱",
                "goods_price": "199.00",
                "goods_num": 3,
                "goods_img": "a985abd874b5b8af6b676e500.jpeg",
                "createdAt": "2023-10-12T07:12:53.000Z",
                "updatedAt": "2023-10-12T07:12:53.000Z",
                "deletedAt": null
            },
            {
                "id": 4,
                "goods_name": "蓝牙音箱big",
                "goods_price": "199.00",
                "goods_num": 3,
                "goods_img": "a985abd874b5b8af6b676e500.jpeg",
                "createdAt": "2023-10-13T11:47:36.000Z",
                "updatedAt": "2023-10-13T11:47:36.000Z",
                "deletedAt": null
            }
        ]
    }
}
```

### 3) 购物车模块

- 加入购物车接口

POST /carts

请求参数 Body->row->JSON

```
{
    "goods_id": 1
}
```

响应-成功

```
{
    "code": 0,
    "message": "添加到购物车成功",
    "result": {
        "id": 7,
        "goods_id": 1,
        "user_id": 25,
        "number": 1,
        "selected": true,
        "createdAt": "2023-10-12T08:01:53.000Z",
        "updatedAt": "2023-10-13T12:00:14.000Z"
    }
}
```

- 购物车列表接口

GET /carts?pageNum=1&pageSize=10

响应-成功

```
{
    "code": 0,
    "message": "获取购物车列表成功",
    "result": {
        "pageNum": "1",
        "pageSize": "10",
        "total": 2,
        "list": [
            {
                "id": 7,
                "number": 2,
                "selected": true,
                "goods_info": {
                    "id": 1,
                    "goods_name": "蓝牙音箱plus",
                    "goods_price": "198.00",
                    "goods_img": "7dc687ce14245725aa4269900.png"
                }
            },
            {
                "id": 8,
                "number": 1,
                "selected": true,
                "goods_info": {
                    "id": 2,
                    "goods_name": "蓝牙音箱pro",
                    "goods_price": "199.00",
                    "goods_img": "a985abd874b5b8af6b676e501.png"
                }
            }
        ]
    }
}
```

- 更新购物车接口

PATCH /carts/:id

请求参数 Body->row->JSON

```
{
    "number": 1,
    "selected": true
}
```

响应-成功

```
{
    "code": 0,
    "message": "更新购物车成功",
    "result": ""
}
```

- 删除购物车接口

DELETE /carts

请求参数 Body->row->JSON

```
{
    "ids":[7,8]
}
```

响应-成功

```
{
    "code": 0,
    "message": "删除购物车成功",
    "result": 2
}
```

- 全选购物车接口

POST /carts/selectAll

响应-成功

```
{
    "code": 0,
    "message": "全部选中",
    "result": [
        2
    ]
}
```

- 全不选购物车接口

POST /carts/unSelectAll

响应-成功

```
{
    "code": 0,
    "message": "全不选中",
    "result": [
        2
    ]
}
```

### 4) 地址模块

- 添加地址接口

POST /address

请求参数 Body->row->JSON

```
{
    "consignee":"蒋春霞",
    "phone":"18381067439",
    "address":"四川省成都市新津区柳河社区花源大道333号"
}
```

响应-成功
```
{
    "code": 0,
    "message": "添加地址成功",
    "result": {
        "is_default": false,
        "id": 1,
        "user_id": 25,
        "consignee": "蒋春霞",
        "phone": "18381067439",
        "address": "四川省成都市新津区柳河社区花源大道333号",
        "updatedAt": "2023-10-12T11:44:14.685Z",
        "createdAt": "2023-10-12T11:44:14.685Z"
    }
}
```

- 地址列表接口

GET /address

响应-成功
```
{
    "code": 0,
    "message": "获取地址成功",
    "result": [
        {
            "id": 1,
            "consignee": "蒋春霞",
            "phone": "18381067439",
            "address": "四川省成都市新津区柳河社区花源大道333号",
            "is_default": false
        }
    ]
}
```

- 更新地址接口

PUT /address/:id

请求参数 Body->row->JSON

```
{
    "consignee":"竹子",
    "phone":"18381067437",
    "address":"四川省成都市新津区柳河社区花源大道333号"
}
```

响应-成功

```
{
    "code": 0,
    "message": "更新地址成功",
    "result": [
        1
    ]
}
```

- 删除地址接口

DELETE /address/:id

响应-成功

```
{
    "code": 0,
    "message": "删除地址成功",
    "result": 1
}
```

- 默认地址接口

PATCH /address/:id

响应-成功

```
{
    "code": 0,
    "message": "设置默认成功",
    "result": [
        1
    ]
}
```

### 5) 订单模块

- 生成订单接口

POST /orders

请求参数 Body->row->JSON

```
{
    "address_id": 1,
    "goods_info": "[{},{},{}]",
    "total": "199.00"
}
```

响应-成功
```
{
    "code": 0,
    "message": "生成订单成功",
    "result": {
        "status": 0,
        "id": 1,
        "user_id": 25,
        "address_id": 1,
        "goods_info": "[{},{},{}]",
        "total": "199.00",
        "order_number": "XZD1697116227076",
        "updatedAt": "2023-10-12T13:10:27.078Z",
        "createdAt": "2023-10-12T13:10:27.078Z"
    }
}
```

- 订单列表接口

GET /orders?pageNum=1&pageSize=10&status=0

响应-成功

```
{
    "code": 0,
    "message": "获取订单列表成功",
    "result": {
        "pageNum": "1",
        "pageSize": "10",
        "total": 1,
        "list": [
            {
                "goods_info": "[{},{},{}]",
                "total": "199.00",
                "order_number": "XZD1697116227076",
                "status": 0
            }
        ]
    }
}
```

- 更新订单状态

PATCH /orders/

请求参数 Body->row->JSON

```
{
    "status": 1
}
```

响应
```
{
    "code": 0,
    "message": "更新订单状态成功",
    "result": [
        1
    ]
}
```

jeyarLin/KOA

简介

发行版

贡献者

近期动态

jeyarLin/KOA .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

jeyarLin/KOA