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 图片 上一张 下一张 链接效果(续篇)
Apr 20 Javascript
一个仿糯米弹框效果demo
Jul 22 Javascript
jQuery中extend()和fn.extend()方法详解
Jun 03 Javascript
jquery采用oop模式class类的使用示例
Jan 22 Javascript
详解原生JavaScript实现jQuery中AJAX处理的方法
May 10 Javascript
AngularJS ng-bind-template 指令详解
Jul 30 Javascript
AngularJS路由Ui-router模块用法示例
May 29 Javascript
js学习总结之DOM2兼容处理重复问题的解决方法
Jul 27 Javascript
AngularJS遍历获取数组元素的方法示例
Nov 11 Javascript
使用veloticy-ui生成文字动画效果
Feb 08 Javascript
JavaScript实现计算圆周率到小数点后100位的方法示例
May 08 Javascript
使用Layui搭建后台管理界面的操作方法
Sep 20 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
浅析php变量修饰符static的使用
2013/06/28 PHP
Joomla简单判断用户是否登录的方法
2016/05/04 PHP
PHPExcel导出2003和2007的excel文档功能示例
2017/01/04 PHP
php 可变函数使用小结
2018/06/12 PHP
JavaScript将相对地址转换为绝对地址示例代码
2013/07/19 Javascript
JS中如何判断传过来的JSON数据中是否存在某字段
2014/08/18 Javascript
JavaScript面向对象的实现方法小结
2015/04/14 Javascript
jQuery实现强制cookie过期方法汇总
2015/05/22 Javascript
Node.js实现JS文件合并小工具
2016/02/02 Javascript
Ubuntu 16.04 64位中搭建Node.js开发环境教程
2016/10/19 Javascript
BootStrap中关于Select下拉框选择触发事件及扩展
2016/11/22 Javascript
AngularJs 利用百度地图API 定位当前位置 获取地址信息
2017/01/18 Javascript
xmlplus组件设计系列之分隔框(DividedBox)(8)
2017/05/02 Javascript
使用vue-cli创建项目的图文教程(新手入门篇)
2018/05/02 Javascript
vue获取时间戳转换为日期格式代码实例
2019/04/17 Javascript
layer.open弹层查看缩略图的原图,自适应大小的实例
2019/09/05 Javascript
[01:52]深扒TI7聊天轮盘语音出处7
2017/05/11 DOTA
如何高效使用Python字典的方法详解
2017/08/31 Python
Python使用cx_Oracle调用Oracle存储过程的方法示例
2017/10/07 Python
Python3 加密(hashlib和hmac)模块的实现
2017/11/23 Python
Python实现矩阵转置的方法分析
2017/11/24 Python
Mac 使用python3的matplot画图不显示的解决
2019/11/23 Python
python如何基于redis实现ip代理池
2020/01/17 Python
暇步士官网:Hush Puppies
2016/09/22 全球购物
美国网上花店:JustFlowers
2017/02/12 全球购物
美国照明、家居装饰和家具购物网站:Bellacor
2017/09/20 全球购物
退伍老兵事迹材料
2014/01/31 职场文书
化学教学随笔感言
2014/02/19 职场文书
外国人聘用意向书
2014/04/01 职场文书
说明书怎么写
2014/05/06 职场文书
公司授权委托书范文
2014/08/02 职场文书
小学教师师德整改措施
2014/09/29 职场文书
开展批评与自我批评发言稿
2014/10/16 职场文书
2016年大学自主招生自荐信范文
2015/03/24 职场文书
家装电话营销开场白
2015/05/29 职场文书
时尚女魔头观后感
2015/06/04 职场文书