koa搭建nodejs项目并注册接口
在数据库实战开发的过程中,我们经常会遇到一些这样那样的问题,然后要卡好半天,等问题解决了才发现原来一些细节知识点还是没有掌握好。今天golang学习网就整理分享《koa搭建nodejs项目并注册接口》,聊聊接口、MySQL、Node.js、koa,希望可以帮助到正在努力赚钱的你。
使用nodejs注册接口逻辑处理会比较复杂,直接通过express或者koa能够简化开发流程,这里记录用koa来搭建nodejs项目并注册接口,对koa不太熟悉的话可以参考这一篇。让nodejs开启服务更简单--koa篇
项目结构
项目整体结构如下,将不同功能的文件按模块划分,使得代码逻辑更为清晰
node_modules // 安装的包 src // 自己编码的部分 app // 注册的app constants // 定义常量 controller // 注册接口所使用到的方法 middleware // 处理数据的中间件 router // 路由 service // 定义sql语句 utils // 处理数据的方法 main.js // 入口 .env // 放到环境变量的配置文件 package-lock.json // 包的依赖关系 package.json // 需要安装哪些包
注册app
koa中所有的操作都需要通过注册的这个app对象来完成,先在 app/index.js 中注册并导出
const Koa = require('koa') const app = new Koa() module.exports = app
http开启服务
src文件夹下建立 main.js文件,引入app对象,开启http服务
const app = require('./app') const { APP_PORT } = require('./app/config') app.listen(APP_PORT, ()=>{ console.log('开启服务啦') })
账号密码、端口号等信息直接写在文件中是不安全的,上传或共享项目的时候容易泄露,所以保存到不影响项目的的文件当中,根目录中新增 .env 文件,使用 dotenv 将 .env 文件中的配置项注册到环境变量中
const dotenv = require('dotenv') dotenv.config(); module.exports = { APP_PORT } = process.env
启动 main.js就已经可以监听8000端口了,因为没有对请求做出响应,所以此时访问8000,只能返回 Not Find
注册路由
一组路由就是一组映射关系,定义路径与处理函数,如下演示注册的接口逻辑,中间件用来判断数据的正确性,控制层的函数用来进行响应
const Router = require('koa-router') const RegisterRouter = new Router({ prefix: '/register' }) const { register } = require('../controller/register.controller') const { verifyUser, encryptionPwd } = require('../middleware/register.middleware') RegisterRouter.post('/', verifyUser, encryptionPwd, register) module.exports = RegisterRouter
中间件
判断是否传入了用户名和密码以及是否已注册,对传入的隐私数据进行加密
const crypto = require('crypto') const { hasUser } = require('../service/register.service') const { USER_ALREADY_EXISTS, NAME_OR_PASSWORD_REQUIRED } = require('../constants/error-types') class RegisterMiddleWare { async verifyUser(ctx, next) { const { name, password } = ctx.request.body if (!name || !password) { const error = new Error(NAME_OR_PASSWORD_REQUIRED) return ctx.app.emit('error', error, ctx) } let users = await hasUser(name) if (users) { const error = new Error(USER_ALREADY_EXISTS) return ctx.app.emit('error', error, ctx) } await next() } async encryptionPwd(ctx, next) { const { password } = ctx.request.body const md5 = crypto.createHash('md5') const pwd = md5.update(password).digest('hex') ctx.request.body.password = pwd await next() } } module.exports = new RegisterMiddleWare()
与数据库建立连接
创建表结构
CREATE TABLE IF NOT EXISTS `user`( id INT PRIMARY KEY AUTO_INCREMENT, name varchar(50) NOT NULL UNIQUE, password varchar(200) NOT NULL, createAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP, updateAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP );
service/register.service.js 中定义插入数据库的方法
const connection = require('../app/database') class RegisterService { async hasUser(name) { const statement = `SELECT * FROM user WHERE name = ?` try { const [result] = await connection.execute(statement, [name]) return result.length } catch (error) { console.log('LoginService-hasUser', error) } } async insertUser(name, password) { const statement = `INSERT INTO user(name, password) VALUES(?,?)` try { const [result] = await connection.execute(statement, [name, password]) return result } catch (error) { console.log('LoginService-insertUser', error) } } } module.exports = new RegisterService()
很多地方都需要用到与数据库的连接,所以在 app/databse.js 中统一建立连接池
const mysql = require('mysql2') const { MYSQL_HOST, MYSQL_PORT, MYSQL_DATABASE, MYSQL_USER, MYSQL_PASSWORD, } = require('./config') const connection = mysql.createPool({ database: MYSQL_DATABASE, host: MYSQL_HOST, port: MYSQL_PORT, user: MYSQL_USER, password: MYSQL_PASSWORD }) connection.getConnection((error, conn)=>{ conn.connect((err)=>{ console.log(error, err) }) }) module.exports = connection.promise()
数据库的账号密码直接硬编码写在代码中会存在问题,同样的写到 .env 文件中,通过config.js 导出
// config.js const dotenv = require('dotenv') dotenv.config() module.exports = { APP_PORT, MYSQL_HOST, MYSQL_PORT, MYSQL_DATABASE, MYSQL_USER, MYSQL_PASSWORD, } = process.env
捕获错误
当注册账号时,用户已注册或者密码不符合规范需要返回错误信息,在 constants/error-types 中定义常见的错误信息
const USER_ALREADY_EXISTS = 'user_already_exists' const NAME_OR_PASSWORD_REQUIRED = 'name_or_password_required' module.exports = { USER_ALREADY_EXISTS, NAME_OR_PASSWORD_REQUIRED }
app/error-handle.js 中对错误信息进行判断
const { USER_ALREADY_EXISTS } = require('../constants/error-types') const errorHandle = (error, ctx) => { let code = 200 let message = '' switch (error.message) { case USER_ALREADY_EXISTS: message = '该用户已存在' break; } ctx.status = code ctx.body = message } module.exports = errorHandle
app/index.js 引入路由定义的接口,获取post请求传递的参数,并绑定错误的处理方式
const Koa = require('koa') const app = new Koa() const bodyParser = require('koa-bodyparser') const LoginRouter = require('../router/register.router') const errorHandle = require('./error-handle') app.use(bodyParser()) app.use(LoginRouter.routes()) app.use(LoginRouter.allowedMethods()) app.on('error', errorHandle) module.exports = app
进行响应
在controller/register.controller.js中定义对应的处理方法
const { insertUser } = require('../service/register.service') class RegisterController { async register(ctx, next) { const { name, password } = ctx.request.body const result = await insertUser(name, password) ctx.body = result } } module.exports = new RegisterController()
到这里为止,我们就可以对接口进行访问啦

以下还有几篇相关笔记可供参考
jwt实现token鉴权(nodejs koa
如何通过cookie、session鉴权(nodejs/koa)
超详细的mysql总结(DQL)
超详细的mysql总结(基本概念、DDL、DML)
nodejs中如何使用http创建一个服务
到这里,我们也就讲完了《koa搭建nodejs项目并注册接口》的内容了。个人认为,基础知识的学习和巩固,是为了更好的将其运用到项目中,欢迎关注golang学习网公众号,带你了解更多关于mysql的知识点!

- 上一篇
- 十年磨一剑,匠心打造中国人自己的网络编程架构t-io

- 下一篇
- page optimization
-
- 复杂的小海豚
- 这篇技术文章太及时了,好细啊,很好,码住,关注师傅了!希望师傅能多写数据库相关的文章。
- 2023-04-23 10:31:53
-
- 壮观的战斗机
- 写的不错,一直没懂这个问题,但其实工作中常常有遇到...不过今天到这,帮助很大,总算是懂了,感谢师傅分享技术文章!
- 2023-03-18 03:20:10
-
- 冷傲的店员
- 太详细了,码起来,感谢up主的这篇文章内容,我会继续支持!
- 2023-03-07 10:17:04
-
- 数据库 · MySQL | 1天前 |
- MySQL设置中文界面,超简单教程来了!
- 332浏览 收藏
-
- 数据库 · MySQL | 1天前 | mysql 索引提示
- MySQL进阶必看!FORCE/USE/IGNOREINDEX用法大揭秘
- 182浏览 收藏
-
- 数据库 · MySQL | 1天前 |
- 手把手教你写MySQL存储过程,小白也能轻松上手
- 163浏览 收藏
-
- 数据库 · MySQL | 1天前 | mysql group by
- MySQL分组查询优化:GROUPBY原理+索引优化超全解析
- 324浏览 收藏
-
- 数据库 · MySQL | 1天前 |
- MySQL设置中文语言,轻松拥有中文界面
- 211浏览 收藏
-
- 数据库 · MySQL | 1天前 |
- MySQL建库语句从入门到精通:创建数据库+设置字符集&排序规则(附实例)
- 176浏览 收藏
-
- 数据库 · MySQL | 1天前 |
- 从零开始学MySQL数据库操作,小白轻松变大神!
- 496浏览 收藏
-
- 数据库 · MySQL | 1天前 |
- MySQL插入日期到时间字段,轻松搞定日期格式
- 484浏览 收藏
-
- 数据库 · MySQL | 1天前 | mysql 数据压缩
- MySQL怎么实现高效压缩存储?表压缩+列式存储详细解读
- 272浏览 收藏
-
- 数据库 · MySQL | 1天前 | mysql JOIN优化
- MySQL优化JOIN操作:七大技巧教你提升关联查询速度
- 106浏览 收藏
-
- 数据库 · MySQL | 1天前 |
- MySQL出现中文乱码?超详细解决方案一次性搞定
- 211浏览 收藏
-
- 数据库 · MySQL | 1天前 |
- MySQL主从复制这样配!搞懂这些参数,replication稳了~
- 131浏览 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 542次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 508次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 497次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 484次学习
-
- 茅茅虫AIGC检测
- 茅茅虫AIGC检测,湖南茅茅虫科技有限公司倾力打造,运用NLP技术精准识别AI生成文本,提供论文、专著等学术文本的AIGC检测服务。支持多种格式,生成可视化报告,保障您的学术诚信和内容质量。
- 18次使用
-
- 赛林匹克平台(Challympics)
- 探索赛林匹克平台Challympics,一个聚焦人工智能、算力算法、量子计算等前沿技术的赛事聚合平台。连接产学研用,助力科技创新与产业升级。
- 49次使用
-
- 笔格AIPPT
- SEO 笔格AIPPT是135编辑器推出的AI智能PPT制作平台,依托DeepSeek大模型,实现智能大纲生成、一键PPT生成、AI文字优化、图像生成等功能。免费试用,提升PPT制作效率,适用于商务演示、教育培训等多种场景。
- 57次使用
-
- 稿定PPT
- 告别PPT制作难题!稿定PPT提供海量模板、AI智能生成、在线协作,助您轻松制作专业演示文稿。职场办公、教育学习、企业服务全覆盖,降本增效,释放创意!
- 52次使用
-
- Suno苏诺中文版
- 探索Suno苏诺中文版,一款颠覆传统音乐创作的AI平台。无需专业技能,轻松创作个性化音乐。智能词曲生成、风格迁移、海量音效,释放您的音乐灵感!
- 57次使用
-
- golang MySQL实现对数据库表存储获取操作示例
- 2022-12-22 499浏览
-
- golang 基于 mysql 简单实现分布式读写锁
- 2023-01-07 384浏览
-
- goalng 结构体 方法集 接口实例详解
- 2022-12-30 250浏览
-
- 详解如何利用GORM实现MySQL事务
- 2023-01-07 184浏览
-
- Go语言实现操作MySQL的基础知识总结
- 2023-01-23 265浏览