koa搭建nodejs项目并注册接口
使用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开启服务
项目根目录建立 main.js文件,引入app对象,开启http服务
const app = require('./app')
const { APP_PORT } = require('./app/config')
app.listen(APP_PORT, ()=>{
console.log('开启服务啦')
})
账号密码、端口号等信息直接写在文件中是不安全的,上传或共享项目的时候容易泄露,所以保存到不影响项目的的文件当中,根目录中新增 .env 文件,使用 dotenv 将 .env 文件中的配置项注册到环境变量中
APP_PORT=8000
app文件夹中新增config.js文件用于保存配置信息,防止随意更改
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 导出
// .env
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_DATABASE=mall
MYSQL_USER=root
MYSQL_PASSWORD=123456
APP_PORT=8000
// 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()
到这里为止,我们就可以对接口进行访问啦
以上就是注册一个接口的完整流程,不同接口可能需要通过不同的中间件去处理,比如登录接口需要验证密码,派发token,其他和用户权限有关的接口需要验证token。
以下还有几篇相关笔记可供参考
jwt实现token鉴权(nodejs koa
如何通过cookie、session鉴权(nodejs/koa)
超详细的mysql总结(DQL)
超详细的mysql总结(基本概念、DDL、DML)
nodejs中如何使用http创建一个服务
原文地址:https://www.cnblogs.com/vigourice/p/15311889.html
- 在Python中实现你自己的推荐系统
- 在Java中如何实现“Pless presss any key to continue.”
- 震惊小伙伴的Python单行代码
- 如何打造一款可靠的WAF(Web应用防火墙)
- 为啥我的Python这么慢 (一)
- 矩阵的基本知识构造重复矩阵的方法——repmat(xxx,xxx,xxx)构造器的构造方法单位数组的构造方法指定公差的等差数列指定项数的等差数列指定项数的lg等差数列sub2ind()从矩阵索引==》
- 简单的Writer和ReaderWriter的主要方法Writer工作原理Reader的主要方法readLine():String
- 为啥我的Python这么慢 - 项查找 (二)
- 初识字节流+实现缓冲字节流OutputStream的主要方法构造方法读关流实现BufferedInputStream实现BufferedOutputStream为什么read()返回的是Int型而不是
- Properties+重温Map+本地计数器Map方法Properties的方法用Properties的好处
- SequenceInputStreamSequenceInputStream构造方法读关流刷新
- 怎么实现关闭窗口
- java.io.StreamCorruptedException: invalid type code: AC错误的解决方法
- 不可不知的一点Python陷阱
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- NHibernate 批量数据插入测试
- MvvmCross 框架中 ViewModel 之间的导航以及生命周期
- 在 mono 下尝试 ASP.NET vNext
- 设计模式之享元模式
- 设计模式之外观模式
- 设计模式之装饰器模式
- 设计模式之桥模式
- 笔试编程 | 二分查找、数组、排序
- Spark SQL解析查询parquet格式Hive表获取分区字段和查询条件
- Apache Hive
- SAUI-关于input滚动问题
- 学好Spark必须要掌握的Scala技术点
- EF Linq中的左连接Left Join查询
- dotnet 删除自身程序的方法
- Roslyn 读取 PackageReference 的版本号和内容