create-pixle-koa-template 1.0.0 → 1.0.2

package/template/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pixle-koa-template",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Koa2 template",
   "main": "index.js",
   "scripts": {

package/template/routes/upload.js

@@ -1,28 +1,28 @@
-const Router = require("@koa/router");
-const router = new Router({prefix: '/upload'});
-const UploadController = require("../controllers/UploadController.js");
-const uploadMiddleware = require('../middleware/upload');//上传中间件
-const upload = uploadMiddleware(
-//可选配置项
-//   {
-//   limits:{
-//     fileSize: 20 * 1024 * 1024, // 单个文件最大20MB
-//     files: 5, //一次最多5个文件
-//   },
-//   allowedMimes:["image/jpeg", "image/png"],//允许上传文件格式
-//   //自定义过滤函数
-//   fileFilter:(req, file, cb)=>{
-
-//   }
-//  }
-);
-
-//上传路由(单文件)
-router.post("/single", upload.single(), UploadController.single);
-
-//上传路由(多文件)
-router.post("/multiple", upload.array(), UploadController.multiple);
-
-module.exports = router;
-
-
+const Router = require("@koa/router");
+const router = new Router({prefix: '/upload'});
+const UploadController = require("../controllers/UploadController.js");
+const uploadMiddleware = require('../middleware/upload');//上传中间件
+const upload = uploadMiddleware(
+//可选配置项
+//   {
+//   limits:{
+//     fileSize: 20 * 1024 * 1024, // 单个文件最大20MB
+//     files: 5, //一次最多5个文件
+//   },
+//   allowedMimes:["image/jpeg", "image/png"],//允许上传文件格式
+//   //自定义过滤函数
+//   fileFilter:(req, file, cb)=>{
+
+//   }
+//  }
+);
+
+//上传路由(单文件)
+router.post("/single", upload.single(), UploadController.single);
+
+//上传路由(多文件)
+router.post("/multiple", upload.array(), UploadController.multiple);
+
+module.exports = router;
+
+

package/template/routes/user.js

@@ -1,7 +1,7 @@
 const userController=require('../controllers/UserController')
 const Router = require("@koa/router");
 const router = new Router({
-    prefix: '/user',
+    prefix: '/users',
 });
 
 

package/template/services/DownloadService.js

@@ -28,7 +28,6 @@ class DownloadService {
           // __dirname 表示当前文件所在目录
           // 向上跳转一级（../）后拼接上文件目录
           const dirPath = path.join(__dirname, `../${fileDir}`);
-          
           // 调用 koa-send 中间件实现文件下载
           let result = await send(ctx, fileName, {
               root: dirPath, // 指定文件所在的根目录

package/template/services/EmailService.js

@@ -10,12 +10,12 @@ const QQ_EMAIL_CONFIG = require("../config/email");
 const transporter = nodemailer.createTransport(QQ_EMAIL_CONFIG);
 
 /**
- * 生成4位验证码
+ * 生成6位验证码
  * @returns 验证码
  */
 const generateVerificationCode = () => {
   let code = "";
-  for (let i = 0; i < 4; i++) {
+  for (let i = 0; i < 6; i++) {
     code += Math.floor(Math.random() * 10); // 0-9
   }
   return code;

package/template/services/JwtTokenService.js

@@ -31,6 +31,7 @@ const verifyToken = (token) => {
   try {
     return jwt.verify(token, config.jwt.secret);
   } catch (error) {
+    console.log(error,'error')
     throw new Error("Token验证失败");
   }
 };

package/template//344/275/277/347/224/250/346/225/231/347/250/213.md

@@ -2,7 +2,7 @@
 
 ## 1. 项目概述
 
-本项目是一个基于 Koa.js 框架构建的后端服务基础框架，提供了完整的 MVC 架构设计、用户认证、文件上传、数据访问层等核心功能。框架采用了模块化设计，各组件职责清晰，便于扩展和维护。
+本项目是一个基于 Koa.js 框架构建的后端服务开箱即用的脚手架项目，它提供了完整的 MVC 架构、用户认证、文件上传、数据访问层等核心功能，采用模块化设计，各组件职责清晰，便于扩展与维护。
 
 ### 主要特性：
 - 完整的用户认证系统（登录、注册、密码重置）
@@ -13,6 +13,9 @@
 - Redis 集成（用于验证码、Token 存储）
 - 文件上传下载功能
 - 详细的请求日志记录
+- 支持热更新与环境变量配置
+- 保持Koa的简洁本质，不添加过度抽象
+- 符合前端人员开发习惯的使用设计
 
 ## 2. 环境要求
 
@@ -65,7 +68,7 @@ const pool = mysql.createPool({
   host: "localhost",     // 数据库服务器地址
   port: 3306,            // 数据库端口
   user: "root",          // 数据库用户名
-  password: "abc123abc", // 数据库密码
+  password: "1234qwer", // 数据库密码
   database: "demo",      // 数据库名称
   // 连接池配置
   waitForConnections: true,
@@ -213,103 +216,103 @@ const validateParams = (schema) => {
 module.exports = validateParams;
 ```
 
-### 5.3 验证码系统
-
-验证码系统用于用户注册、密码重置等场景，确保操作的安全性和防止恶意攻击。本系统通过邮箱发送验证码，并使用Redis进行验证码存储和频率限制管理。
-
-#### 验证码使用场景
-
-- **用户注册**：新用户注册时需要验证邮箱的真实性
-- **密码重置**：用户忘记密码时通过邮箱验证码进行身份验证
-
-#### 验证码类型
-
-- `register`：用于用户注册场景
-- `resetPassword`：用于密码重置场景
-
-#### 如何使用验证码系统
-
-##### 1. 发送验证码
-
-**步骤说明**：
-
-1. 调用发送验证码接口 `/api/auth/verify-code`
-2. 系统会自动执行以下操作：
-   - 验证邮箱格式是否正确
-   - 检查邮箱是否已注册（注册场景）
-   - 验证发送频率限制（60秒内只能发送一次）
-   - 验证每日发送次数限制（每邮箱每日最多10次）
-   - 生成4位数字验证码
-   - 发送验证码邮件
-   - 存储验证码到Redis（有效期5分钟）
-
-**使用示例**：
-
-```javascript
-// 前端调用示例
-const response = await fetch('/api/auth/verify-code', {
-  method: 'POST',
-  headers: {
-    'Content-Type': 'application/json'
-  },
-  body: JSON.stringify({
-    email: 'user@example.com',
-    type: 'register'  // 或 'resetPassword'
-  })
-});
-const result = await response.json();
-// {"code": 200, "message": "验证码发送成功", "data": true}
-```
-
-##### 2. 验证验证码
-
-**步骤说明**：
-
-1. 在用户注册或重置密码接口中传递验证码
-2. 系统会自动执行以下操作：
-   - 从Redis获取存储的验证码
-   - 验证验证码是否有效且未过期
-   - 验证用户输入的验证码是否匹配
-   - 验证成功后自动清除验证码（防止重复使用）
-
-**使用示例**：
-
-```javascript
-// 注册时验证验证码
-const registerResponse = await fetch('/api/auth/register', {
-  method: 'POST',
-  headers: {
-    'Content-Type': 'application/json'
-  },
-  body: JSON.stringify({
-    account: 'newuser',
-    password: 'StrongPass123',
-    email: 'user@example.com',
-    code: '1234'  // 用户收到的验证码
-  })
-});
-```
-
-#### 验证码系统的安全特性
-
-1. **有效期限制**：验证码默认有效期为5分钟，通过环境变量 `VERIFICATION_CODE_EXPIRE` 配置
-2. **发送频率限制**：60秒内每个邮箱只能发送一次验证码，通过环境变量 `VERIFICATION_SEND_LIMIT_EXPIRE` 配置
-3. **每日次数限制**：每个邮箱每日最多发送10次验证码，通过环境变量 `MAX_ATTEMPTS_PER_DAY` 配置
-4. **邮箱格式验证**：系统自动验证邮箱格式的合法性
-5. **验证码一次性使用**：验证成功后自动删除验证码，防止重复使用
-6. **安全的Redis存储**：验证码以特定格式存储在Redis中，使用合理的键名前缀
-
-#### 常见错误处理
-
-使用验证码系统时，可能遇到的常见错误：
-
-- 邮箱格式不正确
-- 邮箱已被注册（注册场景）
-- 60秒内已发送验证码
-- 今日发送验证码已达上限
-- 验证码无效或已过期
-- 验证码错误
-
+### 5.3 验证码系统
+
+验证码系统用于用户注册、密码重置等场景，确保操作的安全性和防止恶意攻击。本系统通过邮箱发送验证码，并使用Redis进行验证码存储和频率限制管理。
+
+#### 验证码使用场景
+
+- **用户注册**：新用户注册时需要验证邮箱的真实性
+- **密码重置**：用户忘记密码时通过邮箱验证码进行身份验证
+
+#### 验证码类型
+
+- `register`：用于用户注册场景
+- `resetPassword`：用于密码重置场景
+
+#### 如何使用验证码系统
+
+##### 1. 发送验证码
+
+**步骤说明**：
+
+1. 调用发送验证码接口 `/api/auth/verify-code`
+2. 系统会自动执行以下操作：
+   - 验证邮箱格式是否正确
+   - 检查邮箱是否已注册（注册场景）
+   - 验证发送频率限制（60秒内只能发送一次）
+   - 验证每日发送次数限制（每邮箱每日最多10次）
+   - 生成6位数字验证码
+   - 发送验证码邮件
+   - 存储验证码到Redis（有效期5分钟）
+
+**使用示例**：
+
+```javascript
+// 前端调用示例
+const response = await fetch('/api/auth/verify-code', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json'
+  },
+  body: JSON.stringify({
+    email: 'user@example.com',
+    type: 'register'  // 或 'resetPassword'
+  })
+});
+const result = await response.json();
+// {"code": 200, "message": "验证码发送成功", "data": true}
+```
+
+##### 2. 验证验证码
+
+**步骤说明**：
+
+1. 在用户注册或重置密码接口中传递验证码
+2. 系统会自动执行以下操作：
+   - 从Redis获取存储的验证码
+   - 验证验证码是否有效且未过期
+   - 验证用户输入的验证码是否匹配
+   - 验证成功后自动清除验证码（防止重复使用）
+
+**使用示例**：
+
+```javascript
+// 注册时验证验证码
+const registerResponse = await fetch('/api/auth/register', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json'
+  },
+  body: JSON.stringify({
+    account: 'newuser',
+    password: 'StrongPass123',
+    email: 'user@example.com',
+    code: '123456'  // 用户收到的验证码
+  })
+});
+```
+
+#### 验证码系统的安全特性
+
+1. **有效期限制**：验证码默认有效期为5分钟，通过环境变量 `VERIFICATION_CODE_EXPIRE` 配置
+2. **发送频率限制**：60秒内每个邮箱只能发送一次验证码，通过环境变量 `VERIFICATION_SEND_LIMIT_EXPIRE` 配置
+3. **每日次数限制**：每个邮箱每日最多发送10次验证码，通过环境变量 `MAX_ATTEMPTS_PER_DAY` 配置
+4. **邮箱格式验证**：系统自动验证邮箱格式的合法性
+5. **验证码一次性使用**：验证成功后自动删除验证码，防止重复使用
+6. **安全的Redis存储**：验证码以特定格式存储在Redis中，使用合理的键名前缀
+
+#### 常见错误处理
+
+使用验证码系统时，可能遇到的常见错误：
+
+- 邮箱格式不正确
+- 邮箱已被注册（注册场景）
+- 60秒内已发送验证码
+- 今日发送验证码已达上限
+- 验证码无效或已过期
+- 验证码错误
+
 系统会返回相应的错误信息，前端可以根据返回的错误信息给用户友好的提示。
 ### 5.4 数据访问层
 
@@ -693,7 +696,7 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
 
 **请求**：
 ```
-GET /api/user/current
+GET /api/users/current
 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
 ```
 
@@ -786,12 +789,12 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
 
 | 接口路径 | 方法 | 描述 | 请求参数 | 成功响应 (200 OK) |
 |---------|------|------|---------|-------------------|
-| `/api/user/current` | `GET` | 获取当前用户信息 | 无（需要JWT认证） | `{"code": 200, "message": "获取成功", "data": {"id": 1, "account": "用户名", "email": "邮箱", "created_at": "2023-07-01 00:00:00", "updated_at": "2023-07-01 00:00:00"}}` |
-| `/api/user/list` | `GET` | 获取用户列表 | 查询参数：`email`（邮箱）, `startTime`（开始时间）, `endTime`（结束时间）, `page`（页码）, `pageSize`（每页数量）, `all`（是否获取全部列表，默认为false） | 当all=true时：`{"code": 200, "message": "success", "data": [{"id": 15, "account": "admin", "updated_at": "2025-12-15 16:28:58", "email": "xxx@qq.com", "created_at": "2025-12-15 15:38:12"}]}`<br>当all=false时：`{"code": 200, "message": "success", "data": {"list": [{"id": 15, "account": "admin", "updated_at": "2025-12-15 16:28:58", "email": "xxx@qq.com", "created_at": "2025-12-15 15:38:12"}], "pagination": {"page": 2, "pageSize": 1, "total": 4, "totalPages": 4, "hasNext": true, "hasPrev": true}}}` |
-| `/api/user` | `POST` | 创建新用户 | `{"account": "用户名", "password": "密码", "email": "邮箱"}` | `{"code": 200, "message": "创建成功", "data": {"id": 1, "account": "用户名", "email": "邮箱", "created_at": "2023-07-01 00:00:00", "updated_at": "2023-07-01 00:00:00"}}` |
-| `/api/user/:id` | `PUT` | 更新用户信息 | `{"account": "用户名", "email": "邮箱"}` | `{"code": 200, "message": "success", "data": true}` |
-| `/api/user/:id` | `DELETE` | 删除用户 | 无（路径参数id） | `{"code": 200, "message": "删除成功"}` |
-| `/api/user/:id` | `GET` | 获取指定用户信息 | 无（路径参数id） | `{"code": 200, "message": "获取成功", "data": {"id": 1, "account": "用户名", "email": "邮箱", "created_at": "2023-07-01 00:00:00", "updated_at": "2023-07-01 00:00:00"}}` |
+| `/api/users/current` | `GET` | 获取当前用户信息 | 无（需要JWT认证） | `{"code": 200, "message": "获取成功", "data": {"id": 1, "account": "用户名", "email": "邮箱", "created_at": "2023-07-01 00:00:00", "updated_at": "2023-07-01 00:00:00"}}` |
+| `/api/users/list` | `GET` | 获取用户列表 | 查询参数：`email`（邮箱）, `startTime`（开始时间）, `endTime`（结束时间）, `page`（页码）, `pageSize`（每页数量）, `all`（是否获取全部列表，默认为false） | 当all=true时：`{"code": 200, "message": "success", "data": [{"id": 15, "account": "admin", "updated_at": "2025-12-15 16:28:58", "email": "xxx@qq.com", "created_at": "2025-12-15 15:38:12"}]}`<br>当all=false时：`{"code": 200, "message": "success", "data": {"list": [{"id": 15, "account": "admin", "updated_at": "2025-12-15 16:28:58", "email": "xxx@qq.com", "created_at": "2025-12-15 15:38:12"}], "pagination": {"page": 2, "pageSize": 1, "total": 4, "totalPages": 4, "hasNext": true, "hasPrev": true}}}` |
+| `/api/users` | `POST` | 创建新用户 | `{"account": "用户名", "password": "密码", "email": "邮箱"}` | `{"code": 200, "message": "创建成功", "data": {"id": 1, "account": "用户名", "email": "邮箱", "created_at": "2023-07-01 00:00:00", "updated_at": "2023-07-01 00:00:00"}}` |
+| `/api/users/:id` | `PUT` | 更新用户信息 | `{"account": "用户名", "email": "邮箱"}` | `{"code": 200, "message": "success", "data": true}` |
+| `/api/users/:id` | `DELETE` | 删除用户 | 无（路径参数id） | `{"code": 200, "message": "删除成功"}` |
+| `/api/users/:id` | `GET` | 获取指定用户信息 | 无（路径参数id） | `{"code": 200, "message": "获取成功", "data": {"id": 1, "account": "用户名", "email": "邮箱", "created_at": "2023-07-01 00:00:00", "updated_at": "2023-07-01 00:00:00"}}` |
 
 #### 文件上传相关接口
 
@@ -858,8 +861,10 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
 在 DAO 层可以通过获取连接并手动控制事务：
 
 ```javascript
+const  pool = require("../config/db");
+
 async transactionExample() {
-  const connection = await this.pool.getConnection();
+  const connection = await pool.getConnection();
   try {
     await connection.beginTransaction();
     // 执行多个操作