Koa从零搭建到Api实现项目的搭建方法


Posted in Javascript onJuly 30, 2019

什么是Koa?

Koa 是一个新的 web 框架,由 Express 幕后的原班人马打造, 致力于成为 web 应用和 API 开发领域中的一个更小、更富有表现力、更健壮的基石。 通过利用 async 函数,Koa 帮你丢弃回调函数,并有力地增强错误处理。 Koa 并没有捆绑任何中间件, 而是提供了一套优雅的方法,帮助您快速而愉快地编写服务端应用程序。

Koa vs Express

Koa使用promises和async函数来摆脱回调地狱的应用并简化错误处理。它暴露自己ctx.request和ctx.response对象而不是节点req和res对象。另一方面,Express 使用其他属性和方法扩充节点req和res对象,并包括许多其他“框架”功能,例如路由和模板,Koa没有。

因此,如果你希望更接近node.js和传统的node.js样式编码,你可能希望坚持使用Connect / Express或类似的框架。如果你想摆脱回调,请使用Koa。

总结

Koa是一个比Express更精简,使用node新特性的中间件框架,相比之前express就是一个庞大的框架

  • 如果你喜欢diy,很潮,可以考虑Koa,它有足够的扩展和中间件,而且自己写很简单
  • 如果你想简单点,找一个框架啥都有,那么先Express

如果你有兴趣了解更多不同,请访问Koa vs Express

Koa 项目搭建

注意,本篇教程面向有一定Koa使用经验的用户。如果,你还不了解Koa,请先看下面的文档Koa 中文文档

Koa 文档过于精简,虽然将每一个API都进行解释说明,但还是很难将其组织起来进行应用,对于初学者来说可谓是很不友好。

笔者第一个Koa项目,将所有接口,逻辑,配置等全部写在了app.js中,虽说完美运行,但是可读性,可维护性极差,所以一个好的目录结构尤为重要

目录创建

  • config - 配置
  • models - 数据库模型(ROM)
  • controller - 控制器
  • middlewares - 中间件
  • public - 静态资源
  • service - 服务
  • router - 路由
  • app.js - 启动文件

依赖安装

创建好项目目录后我们需要安装一些依赖,来供我们使用

  • babel-core/babel-preset-es2015 - 让 nodeJs 支持 es6 modules
  • koa - koa2
  • koa-body - request body 解析
  • koa-cache-control - 缓存控制
  • koa-compress - gzip
  • koa-cors - 跨域
  • koa-logger - 日志
  • koa-onerror - 错误处理
  • koa-router - 路由
  • koa-session - session
  • koa-static - 静态资源服务
  • koa-helmet - 安全
  • md5 - md5 加密
  • mkdirp - 递归创建目录

可以根据自己的需求进行选择,但是一些依赖是必须安装的

  • koa - koa2
  • koa-body - request body 解析
  • koa-router - 路由

后面的内容会讲解每个插件有什么用,如何去用。

目录详解

config

config是我们的配置文件,比如:

  • 数据库(mysql,oracle,redis等)
  • OSS
  • ...

实际运用:

  • confirg
    • database.config.js(新建)

database.config.js

export default {
 database: '',
 username: '',
 password: '',
 dialect: '',
 host: '',
 port: 3306
}

具体配置之后会跟大家仔细讲解。

models

models文件夹主要是我们的数据库模型(ORM),存储数据库映射文件,eg:

  • models
    • index.js - 入口文件
    • user.js - 对应数据库中的user表

index.js

import Sequelize from 'sequelize'
import config from '../config/database.config'
const sequelize = new Sequelize(config)
export const user = sequelize.import(__dirname + '/user')
export default {
 user,
 sequelize
}

以下序号代表代码行号:

  1. 引入sequelize,它是一个ORM框架,之后会详细讲解它的使用
  2. 引入我们之前在config中创建的数据库配置文件呢
  3. 使用sequelize连接数据库
  4. 将本地数据库映射文件导出供我们使用

controller

controller为控制层,主要处理外部请求。调用service层,将service返回的内容整合后返回给调用方

举例:

const user = require('../service/user')
const findAllUser = async (ctx) => {
 const data = ctx.request.body
 const result = await user.findAllUser(data)
 ctx.body = send({data: result})
}
module.exports = {
 findAllUser
}

以下序号代表代码行号:

  1. 获取请求体
  2. 调用service层
  3. 将service返回的内容返回给调用者(send是自定义的数据格式化方法)

service

service作为服务层主要做相信的业务逻辑处理,数据处理等,将结果返回给controller层

举例:

const db = require('../models/')
const findAllUser = async () => {
 const result = await db.user.findAll()
 return result
}
module.exports = {
 findAllUser
}

以下序号代表代码行号:

  • 获取数据库映射文件,因为要操作数据库
  • 从数据库中查寻全部用户(db.user.findAll()为sequelize中提供的查询方法)
  • 返回给controller

routers

router管理我们的路由,也就是接口地址

举例:

const user = require('../controller/user')
const koa_router = require('koa-router');
const router = koa_router();
router.post('/findAll', user.findAllUser)
module.exports = router

以下序号代表代码行号:

  1. 引入controller层
  2. 定义接口类型,地址,调用方法(post, '/findAll'',findAllUser)

app.js

app.js是我们的入口文件及主文件,我们将router里配置的路由在此引入

const
 koaBody = require('koa-body')
 Koa = require('koa'),
 Router = require('koa-router')
 router = new Router()

const user = require('./routers/user');
router.use("/user",user.routes());

这样我们就可以访问:ip:port/user/findAll 接口。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
jquery中获得$.ajax()事件返回的值并添加事件的方法
Apr 15 Javascript
jquery 读取页面load get post ajax 四种方式代码写法
Apr 02 Javascript
jQuery代码优化 选择符篇
Nov 01 Javascript
JS文字球状放大效果代码分享
Aug 19 Javascript
JavaScript中各种引用类型的常用操作方法小结
May 05 Javascript
手机端点击图片放大特效PhotoSwipe.js插件实现
Aug 24 Javascript
微信小程序-获得用户输入内容
Feb 13 Javascript
Angular4 ElementRef的应用
Feb 26 Javascript
ES6知识点整理之模块化的应用详解
Apr 15 Javascript
怎样在vue项目下添加ESLint的方法
May 16 Javascript
从零使用TypeScript开发项目打包发布到npm
Feb 14 Javascript
Vue发布订阅模式实现过程图解
Apr 30 Javascript
js实现的格式化数字和金额功能简单示例
Jul 30 #Javascript
JS实现点击发送验证码 xx秒后重新发送功能
Jul 30 #Javascript
微信小程序渲染性能调优小结
Jul 30 #Javascript
vue通过video.js解决m3u8视频播放格式的方法
Jul 30 #Javascript
微信小程序用户授权弹窗 拒绝时引导用户重新授权实现
Jul 29 #Javascript
vue使用混入定义全局变量、函数、筛选器的实例代码
Jul 29 #Javascript
vue前后分离调起微信支付
Jul 29 #Javascript
You might like
Drupal 添加模块出现莫名其妙的错误的解决方法(往往出现在模块较多时)
2011/04/18 PHP
PHP下打开phpMyAdmin出现403错误的问题解决方法
2013/05/23 PHP
PHP中if和or运行效率对比
2014/12/12 PHP
PHP调用Linux命令权限不足问题解决方法
2015/02/07 PHP
Valerio 发布了 Mootools
2006/09/23 Javascript
setAttribute 与 class冲突解决
2008/02/17 Javascript
事件绑定之小测试  onclick && addEventListener
2011/07/31 Javascript
兼容IE、FireFox、Chrome等浏览器的xml处理函数js代码
2011/11/30 Javascript
jquery DIV撑大让滚动条滚到最底部代码
2013/06/06 Javascript
首页图片漂浮效果示例代码
2014/06/05 Javascript
DOM基础教程之使用DOM
2015/01/19 Javascript
window.open()实现post传递参数
2015/03/12 Javascript
javascript实现在线客服效果
2015/07/15 Javascript
javascript实现的简单计时器
2015/07/19 Javascript
javascript发送短信验证码实现代码
2015/11/12 Javascript
js 截取或者替换字符串中的数字实现方法
2016/06/13 Javascript
JavaScript中undefined和null的区别
2017/05/03 Javascript
Nodejs+angularjs结合multiparty实现多图片上传的示例代码
2017/09/29 NodeJs
layui框架中layer父子页面交互的方法分析
2017/11/15 Javascript
JavaScript时间戳与时间日期间相互转换
2017/12/11 Javascript
Vue父子组件双向绑定传值的实现方法
2018/07/31 Javascript
通过JQuery,JQueryUI和Jsplumb实现拖拽模块
2019/06/18 jQuery
分享Angular http interceptors 拦截器使用(推荐)
2019/11/10 Javascript
Selenium执行JavaScript脚本的方法示例
2020/12/31 Javascript
[02:37]2018DOTA2亚洲邀请赛赛前采访-EG篇
2018/04/03 DOTA
Python实现的Google IP 可用性检测脚本
2015/04/23 Python
Python3 replace()函数使用方法
2018/03/19 Python
在Python中使用gRPC的方法示例
2018/08/08 Python
对django 模型 unique together的示例讲解
2019/08/06 Python
如何定义TensorFlow输入节点
2020/01/23 Python
推荐WEB开发者最佳HTML5和CSS3代码生成器
2015/11/24 HTML / CSS
Overload和Override的区别。Overloaded的方法是否可以改变返回值的类型
2013/10/30 面试题
质量承诺书怎么写
2014/05/24 职场文书
校庆标语集锦
2014/06/25 职场文书
感恩教育主题班会
2015/08/12 职场文书
Python与C++中梯度方向直方图的实现
2022/03/17 Python