# koa_template_study

**Repository Path**: biluo_x/koa_template_study

## Basic Information

- **Project Name**: koa_template_study
- **Description**: 一个新的学习用koa模板脚手架
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-21
- **Last Updated**: 2022-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Koa

## README

## 说明
这是一个使用koa2+sequelize实现的后端脚手架，具有以下功能。

- 通用返回处理与全局异常处理
- jwt鉴权与路由分割
- 参数统一校验
- controller serivice model分层结构
- orm操作数据库
- 文件上传

## 模块总览

| 模块名 | 位置 | 功能 | 
| - | - | - |
| 入口文件 | */src/index.js* | 统一导入所有中间件
| 路由 | */src/router/* | 统一被保护与全局路由
| 控制器 | */src/controller/* | 对应路由执行的函数
| 服务 | */src/service/* | 操作数据库等复杂的逻辑，由控制器调用
| 数据库连接 | */src/db/* | 配置数据信息，并加载orm模型
| orm模型 | */src/model/* | 每张表对应的orm模型
| 前端数据校验 | */src/schema/* | 参数校验
| 通用工具 | */src/common/* | 封装的各种工具
| 中间件 | */src/middleware/* | 各种中间件，利用koa的机制，统合所有功能

## 使用流程
开启一个新的接口，需要以下几个步骤：
1. 首先在model文件夹下建立数据表对应的orm映射
2. 其次在controller文件夹下创建对应的路由执行函数
3. 根据复杂度自行决定是否需要service
4. 根据需要自行决定是否需要对应的参数校验，如果需要则在schema文件夹下自行创建对应的校验规则
5. 最后根据路由是否需要被保护，在router文件夹下配置对应的路由，router.js为全局路由，jwtRouter.js为被保护路由（jwt鉴权，需要token才能访问）。
> 一个新的接口创建完成，以上所有步骤都有对应的示例文件，参照修改即可