当前位置：首页 > 文章列表 > 数据库 > MySQL > koa搭建nodejs项目并注册接口

koa搭建nodejs项目并注册接口

来源：SegmentFault 2023-02-16 15:22:23 0浏览收藏

所属专题：Node.js 24 后端工程实践专题 - 从 LTS 升级、原生测试到权限、性能与生产部署

在数据库实战开发的过程中，我们经常会遇到一些这样那样的问题，然后要卡好半天，等问题解决了才发现原来一些细节知识点还是没有掌握好。今天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()

到这里为止，我们就可以对接口进行访问啦