快速创建一个服务器

安装koa

npm install koa -S

基本配置

const Koa &＃61; require(&＃39;koa&＃39;);let { Port } &＃61; require(&＃39;./config&＃39;);let app &＃61; new Koa();// responseapp.use(ctx &＃61;> { ctx.body &＃61; &＃39;Hello Koa&＃39;;});// 监听服务器启动端口app.listen(Port, () &＃61;> { console.log(&＃96;服务器启动在${ Port }端口&＃96;);});

测试

就这样一个node.js服务器就启动起来了&＃xff0c;

使用postman测试一下

路由中间件

思路&＃xff1a;

• 使用koa-router中间件处理路由&＃xff1b;
• 如果把所有的路由写在一起&＃xff0c;将会非常拥挤&＃xff0c;不利于后期维护&＃xff0c;所以为每个业务模块配置模块子路由&＃xff1b;
• 然后把所有的模块子路由汇总到./src/roters/index.js&＃xff1b;
• 再在入口文件require(&＃39;./routers&＃39;)。

路由中间件目录

└── src # 源代码目录 └── routers # 路由目录 └── router # 子路由目录 ├── usersRouter.js # 用户模块子路由 ├── ... # 更多的模块子路由 ├── index.js # 路由入口文件

安装koa-router

npm install koa-router -S

模块子路由设计

const Router &＃61; require(&＃39;koa-router&＃39;);// 导入控制层const usersController &＃61; require(&＃39;../../controllers/usersController&＃39;);let usersRouter &＃61; new Router();usersRouter .post(&＃39;/users/login&＃39;, usersController.Login)module.exports &＃61; usersRouter;

模块子路由汇总

const Router &＃61; require(&＃39;koa-router&＃39;);let Routers &＃61; new Router();const usersRouter &＃61; require(&＃39;./router/usersRouter&＃39;);Routers.use(usersRouter.routes());module.exports &＃61; Routers;

使用路由中间件

// 使用路由中间件const Routers &＃61; require(&＃39;./routers&＃39;);app.use(Routers.routes()).use(Routers.allowedMethods());

接口测试

使用postman测试接口localhost:5000/users/login

数据库连接封装

思路&＃xff1a;

• 后端与数据库的交互是非常频繁的&＃xff0c;如果是一个接一个地创建和管理连接&＃xff0c;将会非常麻烦&＃xff1b;
• 所以使用连接池的方式&＃xff0c;封装一个连接池模块&＃xff1b;
• 对连接进行集中的管理(取出连接&＃xff0c;释放连接)&＃xff1b;
• 执行查询使用的是connection.query()&＃xff0c;对connection.query()进行二次封装&＃xff0c;统一处理异常&＃xff1b;
• 向外导出一个db.query()对象&＃xff0c;使用的时候&＃xff0c;只需要传入sql语句、查询参数即可&＃xff0c;例如&＃xff1a;

db.query(&＃39;select * from users where userName &＃61; ? and password &＃61; ?&＃39;, [&＃39;userName&＃39;, &＃39;password&＃39;])

安装mysql依赖包

npm install mysql -S

配置连接选项

在config.js添加如下代码&＃xff0c;然后在db.js引入

// 数据库连接设置dbConfig: { connectionLimit: 10, host: &＃39;localhost&＃39;, user: &＃39;root&＃39;, password: &＃39;&＃39;, database: &＃39;storeDB&＃39;}

连接池封装

创建"./src/models/db.js"

var mysql &＃61; require(&＃39;mysql&＃39;);const { dbConfig } &＃61; require(&＃39;../config.js&＃39;);var pool &＃61; mysql.createPool(dbConfig);var db &＃61; {};db.query &＃61; function (sql, params) { return new Promise((resolve, reject) &＃61;> { // 取出连接 pool.getConnection(function (err, connection) { if (err) { reject(err); return; } connection.query(sql, params, function (error, results, fields) { console.log(&＃96;${ sql }&＃61;>${ params }&＃96;); // 释放连接 connection.release(); if (error) { reject(error); return; } resolve(results); }); }); });}// 导出对象module.exports &＃61; db;

更多的信息请参考mysql文档。

请求体数据处理

思路&＃xff1a;

• 使用koa-body中间件&＃xff0c;可以很方便的处理请求体的数据&＃xff0c;例如

let { userName, password } &＃61; ctx.request.body;

安装koa-body中间件

npm install koa-body -S

使用koa-body中间件

在config.js配置上传文件路径

uploadDir: path.join(__dirname, path.resolve(&＃39;../public/&＃39;)), // 上传文件路径

在app.js使用koa-body中间件

const KoaBody &＃61; require(&＃39;koa-body&＃39;);let { uploadDir } &＃61; require(&＃39;./config&＃39;);

// 处理请求体数据app.use(KoaBody({ multipart: true, // parsedMethods默认是[&＃39;POST&＃39;, &＃39;PUT&＃39;, &＃39;PATCH&＃39;] parsedMethods: [&＃39;POST&＃39;, &＃39;PUT&＃39;, &＃39;PATCH&＃39;, &＃39;GET&＃39;, &＃39;HEAD&＃39;, &＃39;DELETE&＃39;], formidable: { uploadDir: uploadDir, // 设置文件上传目录 keepExtensions: true, // 保持文件的后缀 maxFieldsSize: 2 * 1024 * 1024, // 文件上传大小限制 onFileBegin: (name, file) &＃61;> { // 文件上传前的设置 // console.log(&＃96;name: ${name}&＃96;); // console.log(file); } }}));

异常处理

思路&＃xff1a;

• 程序在执行的过程中难免会出现异常&＃xff1b;
• 如果因为一个异常服务器就挂掉&＃xff0c;那会大大增加服务器的维护成本&＃xff0c;而且体验极差&＃xff1b;
• 所以在中间件的执行前进行一次异常处理。

在app.js添加如下代码

// 异常处理中间件app.use(async (ctx, next) &＃61;> { try { await next(); } catch (error) { console.log(error); ctx.body &＃61; { code: &＃39;500&＃39;, msg: &＃39;服务器未知错误&＃39; } }});

静态资源服务器

思路&＃xff1a;

• 前端需要大量的静态资源&＃xff0c;后端不可能为每条静态资源的请求都写一份代码&＃xff1b;
• koa-static可以非常方便的实现一个静态资源服务器&＃xff1b;
• 只需要创建一个文件夹统一放静态资源&＃xff0c;例如./public&＃xff1b;
• 那么就可以通过http://localhost:5000/public/文件夹/文件名直接访问。

安装koa-static中间件

npm install koa-static -S

使用koa-static中间件

在config.js配置静态资源路径

staticDir: path.resolve(&＃39;../public&＃39;), // 静态资源路径

在app.js使用koa-static中间件

const KoaStatic &＃61; require(&＃39;koa-static&＃39;);let { staticDir } &＃61; require(&＃39;./config&＃39;);

// 为静态资源请求重写urlapp.use(async (ctx, next) &＃61;> { if (ctx.url.startsWith(&＃39;/public&＃39;)) { ctx.url &＃61; ctx.url.replace(&＃39;/public&＃39;, &＃39;&＃39;); } await next();});// 使用koa-static处理静态资源app.use(KoaStatic(staticDir));

接口测试

使用浏览器测试接口http://localhost:5000/public/imgs/a.png

session实现

思路&＃xff1a;

• 使用koa-session中间件实现session的操作&＃xff1b;
• 用于登录状态的管理&＃xff1b;
• 本例子使用内存存储的方案&＃xff0c;适用于session数据量小的场景&＃xff1b;
• 如果session数据量大&＃xff0c;建议使用外部存储介质存放session数据 。

安装koa-session中间件

npm install koa-session -S

使用koa-session中间件

创建"./src/middleware/session.js"

let store &＃61; { storage: {}, set (key, session) { this.storage[key] &＃61; session; }, get (key) { return this.storage[key]; }, destroy (key) { delete this.storage[key]; }}let CONFIG &＃61; { key: &＃39;koa:session&＃39;, maxAge: 86400000, autoCommit: true, // 自动提交标头(默认为true) overwrite: true, // 是否可以覆盖(默认为true httpOnly: true, // httpOnly与否(默认为true) signed: true, // 是否签名(默认为true) rolling: false, // 强制在每个响应上设置会话标识符COOKIE。到期重置为原始的maxAge&＃xff0c;重置到期倒数 renew: false, // 在会话即将到期时更新会话&＃xff0c;因此我们始终可以使用户保持登录状态。(默认为false) sameSite: null, // 会话COOKIE sameSite选项 store // session池}module.exports &＃61; CONFIG;

在app.js使用koa-session中间件

const Session &＃61; require(&＃39;koa-session&＃39;);// sessionconst CONFIG &＃61; require(&＃39;./middleware/session&＃39;);app.keys &＃61; [&＃39;session app keys&＃39;];app.use(Session(CONFIG, app));

登录拦截器

思路&＃xff1a;

• 系统会有一些模块需要用户登录后才能使用的&＃xff1b;
• 接口设计是&＃xff0c;需要登录的模块api均以/user/开头&＃xff1b;
• 那么只需要在全局路由执行前判断api是否以/user/;
• 如果是&＃xff0c;则判断是否登录&＃xff0c;登录了就放行&＃xff0c;否则拦截&＃xff0c;直接返回错误信息&＃xff1b;
• 如果不是&＃xff0c;直接放行。

在"./src/middleware/isLogin.js"&＃xff0c;创建一个验证是否登录的函数

module.exports &＃61; async (ctx, next) &＃61;> { if (ctx.url.startsWith(&＃39;/user/&＃39;)) { if (!ctx.session.user) { ctx.body &＃61; { code: &＃39;401&＃39;, msg: &＃39;用户没有登录&＃xff0c;请登录后再操作&＃39; } return; } } await next();};

在app.js使用登录拦截器

// 判断是否登录const isLogin &＃61; require(&＃39;./middleware/isLogin&＃39;);app.use(isLogin);

分层设计

思路&＃xff1a;

• 路由负责流量分发&＃xff1b;
• 控制层负责业务逻辑处理&＃xff0c;及返回接口json数据&＃xff1b;
• 数据持久层负责数据库操作&＃xff1b;
• 下面以用户模块的登录、注册、用户名查找接口的实现为例说明。

目录结构

└── src # 源代码目录 └── routers # 路由目录 └── router # 子路由目录 ├── usersRouter.js # 用户模块子路由 ├── ... # 更多的模块子路由 ├── index.js # 路由入口文件 └── controllers # 控制层目录 ├── usersController.js # 用户模块控制层 ├── ... # 更多的模块控制层 └── models # 数据持久层目录 └── dao # 模块数据持久层目录 ├── usersDao.js # 用户模块数据持久层 ├── ... # 更多的模块数据持久层 ├── db.js # 数据库连接函数 ├── app.js # 入口文件

用户模块接口实现

接口文档

数据库设计

create database storeDB;use storeDB;create table users( user_id int primary key auto_increment, userName char (20) not null unique, password char (20) not null, userPhoneNumber char(11) null);

路由设计

const Router &＃61; require(&＃39;koa-router&＃39;);// 导入控制层const usersController &＃61; require(&＃39;../../controllers/usersController&＃39;);let usersRouter &＃61; new Router();usersRouter .post(&＃39;/users/login&＃39;, usersController.Login) .post(&＃39;/users/findUserName&＃39;, usersController.FindUserName) .post(&＃39;/users/register&＃39;, usersController.Register)module.exports &＃61; usersRouter;

控制层设计

const userDao &＃61; require(&＃39;../models/dao/usersDao&＃39;);const { checkUserInfo, checkUserName } &＃61; require(&＃39;../middleware/checkUserInfo&＃39;);module.exports &＃61; { /** * 用户登录 * &＃64;param {Object} ctx */ Login: async ctx &＃61;> { let { userName, password } &＃61; ctx.request.body; // 校验用户信息是否符合规则 if (!checkUserInfo(ctx, userName, password)) { return; } // 连接数据库根据用户名和密码查询用户信息 let user &＃61; await userDao.Login(userName, password); // 结果集长度为0则代表没有该用户 if (user.length &＃61;&＃61;&＃61; 0) { ctx.body &＃61; { code: &＃39;004&＃39;, msg: &＃39;用户名或密码错误&＃39; } return; } // 数据库设置用户名唯一 // 结果集长度为1则代表存在该用户 if (user.length &＃61;&＃61;&＃61; 1) { const loginUser &＃61; { user_id: user[0].user_id, userName: user[0].userName }; // 保存用户信息到session ctx.session.user &＃61; loginUser; ctx.body &＃61; { code: &＃39;001&＃39;, user: loginUser, msg: &＃39;登录成功&＃39; } return; } //数据库设置用户名唯一 //若存在user.length !&＃61; 1 || user.length!&＃61;0 //返回未知错误 //正常不会出现 ctx.body &＃61; { code: &＃39;500&＃39;, msg: &＃39;未知错误&＃39; } }, /** * 查询是否存在某个用户名,用于注册时前端校验 * &＃64;param {Object} ctx */ FindUserName: async ctx &＃61;> { let { userName } &＃61; ctx.request.body; // 校验用户名是否符合规则 if (!checkUserName(ctx, userName)) { return; } // 连接数据库根据用户名查询用户信息 let user &＃61; await userDao.FindUserName(userName); // 结果集长度为0则代表不存在该用户,可以注册 if (user.length &＃61;&＃61;&＃61; 0) { ctx.body &＃61; { code: &＃39;001&＃39;, msg: &＃39;用户名不存在&＃xff0c;可以注册&＃39; } return; } //数据库设置用户名唯一 //结果集长度为1则代表存在该用户,不可以注册 if (user.length &＃61;&＃61;&＃61; 1) { ctx.body &＃61; { code: &＃39;004&＃39;, msg: &＃39;用户名已经存在&＃xff0c;不能注册&＃39; } return; } //数据库设置用户名唯一&＃xff0c; //若存在user.length !&＃61; 1 || user.length!&＃61;0 //返回未知错误 //正常不会出现 ctx.body &＃61; { code: &＃39;500&＃39;, msg: &＃39;未知错误&＃39; } }, Register: async ctx &＃61;> { let { userName, password } &＃61; ctx.request.body; // 校验用户信息是否符合规则 if (!checkUserInfo(ctx, userName, password)) { return; } // 连接数据库根据用户名查询用户信息 // 先判断该用户是否存在 let user &＃61; await userDao.FindUserName(userName); if (user.length !&＃61;&＃61; 0) { ctx.body &＃61; { code: &＃39;004&＃39;, msg: &＃39;用户名已经存在&＃xff0c;不能注册&＃39; } return; } try { // 连接数据库插入用户信息 let registerResult &＃61; await userDao.Register(userName, password); // 操作所影响的记录行数为1,则代表注册成功 if (registerResult.affectedRows &＃61;&＃61;&＃61; 1) { ctx.body &＃61; { code: &＃39;001&＃39;, msg: &＃39;注册成功&＃39; } return; } // 否则失败 ctx.body &＃61; { code: &＃39;500&＃39;, msg: &＃39;未知错误&＃xff0c;注册失败&＃39; } } catch (error) { reject(error); } }};

数据持久层设计

const db &＃61; require(&＃39;../db.js&＃39;);module.exports &＃61; { // 连接数据库根据用户名和密码查询用户信息 Login: async (userName, password) &＃61;> { const sql &＃61; &＃39;select * from users where userName &＃61; ? and password &＃61; ?&＃39;; return await db.query(sql, [userName, password]); }, // 连接数据库根据用户名查询用户信息 FindUserName: async (userName) &＃61;> { const sql &＃61; &＃39;select * from users where userName &＃61; ?&＃39;; return await db.query(sql, [userName]); }, // 连接数据库插入用户信息 Register: async (userName, password) &＃61;> { const sql &＃61; &＃39;insert into users values(null,?,?,null)&＃39;; return await db.query(sql, [userName, password]); }}

校验用户信息规则函数

module.exports &＃61; { /** * 校验用户信息是否符合规则 * &＃64;param {Object} ctx * &＃64;param {string} userName * &＃64;param {string} password * &＃64;return: */ checkUserInfo: (ctx, userName &＃61; &＃39;&＃39;, password &＃61; &＃39;&＃39;) &＃61;> { // userName &＃61; userName ? userName : &＃39;&＃39;; // password &＃61; password ? password : &＃39;&＃39;; // 判断是否为空 if (userName.length &＃61;&＃61;&＃61; 0 || password.length &＃61;&＃61;&＃61; 0) { ctx.body &＃61; { code: &＃39;002&＃39;, msg: &＃39;用户名或密码不能为空&＃39; } return false; } // 用户名校验规则 const userNameRule &＃61; /^[a-zA-Z][a-zA-Z0-9_]{4,15}$/; if (!userNameRule.test(userName)) { ctx.body &＃61; { code: &＃39;003&＃39;, msg: &＃39;用户名不合法(以字母开头&＃xff0c;允许5-16字节&＃xff0c;允许字母数字下划线)&＃39; } return false; } // 密码校验规则 const passwordRule &＃61; /^[a-zA-Z]w{5,17}$/; if (!passwordRule.test(password)) { ctx.body &＃61; { code: &＃39;003&＃39;, msg: &＃39;密码不合法(以字母开头&＃xff0c;长度在6~18之间&＃xff0c;只能包含字母、数字和下划线)&＃39; } return false; } return true; }, /** * 校验用户名是否符合规则 * &＃64;param {type} * &＃64;return: */ checkUserName: (ctx, userName &＃61; &＃39;&＃39;) &＃61;> { // 判断是否为空 if (userName.length &＃61;&＃61;&＃61; 0) { ctx.body &＃61; { code: &＃39;002&＃39;, msg: &＃39;用户名不能为空&＃39; } return false; } // 用户名校验规则 const userNameRule &＃61; /^[a-zA-Z][a-zA-Z0-9_]{4,15}$/; if (!userNameRule.test(userName)) { ctx.body &＃61; { code: &＃39;003&＃39;, msg: &＃39;用户名不合法(以字母开头&＃xff0c;允许5-16字节&＃xff0c;允许字母数字下划线)&＃39; } return false; } return true; }}

测试

登录测试

注册测试

查找用户名测试

结语

• 一个node.js(Koa)后端服务器快速启动模板到这里已经搭建好了&＃xff1b;
• 需要使用的时候只需要分模块的添加一些接口并实现&＃xff0c;就可以快速的构建起来一个后端服务器&＃xff1b;
• 后面还打算加一个文件上传(续传)模块&＃xff1b;
• 项目源代码仓库&＃xff1a;koa2-start-basic&＃xff0c;如果你觉得还不错&＃xff0c;可以到Github点Star支持一下哦&＃xff1b;
• 笔者还在不断的学习中&＃xff0c;如果有表述错误或设计错误&＃xff0c;欢迎提意见。
• 感谢你的阅读&＃xff01;

作者&＃xff1a;hai_27
链接&＃xff1a;https://juejin.im/post/5e6de50f6fb9a07cae137bf5