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 相关文章推荐
html的DOM中Event对象onblur事件用法实例
Jan 21 Javascript
JavaScript中常见的字符串操作函数及用法汇总
May 04 Javascript
Javascript中判断对象是否为空
Jun 10 Javascript
JavaScript中的cacheStorage使用详解
Jul 29 Javascript
jq stop()和:is(:animated)的用法及区别(详解)
Feb 12 Javascript
深入理解与使用keep-alive(配合router-view缓存整个路由页面)
Sep 25 Javascript
详解Next.js页面渲染的优化方案
Jan 27 Javascript
微信小程序新手教程之页面打开数量限制
Mar 03 Javascript
Vue.use()在new Vue() 之前使用的原因浅析
Aug 26 Javascript
详解Vue中CSS样式穿透问题
Sep 12 Javascript
原生javascript运动函数的封装示例【匀速、抛物线、多属性的运动等】
Feb 23 Javascript
javascript设计模式 ? 简单工厂模式原理与应用实例分析
Apr 09 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
浅谈Windows下 PHP4.0与oracle 8的连接设置
2006/10/09 PHP
关于PHP5 Session生命周期介绍
2010/03/02 PHP
php无限遍历文件夹示例分享
2014/03/04 PHP
PHP cURL初始化和执行方法入门级代码
2015/05/28 PHP
thinkphp自带验证码全面解析
2016/09/18 PHP
PHP基于mssql扩展远程连接MSSQL的简单实现方法
2016/10/08 PHP
PHP CURL post数据报错 failed creating formpost data
2016/10/16 PHP
Mac系统下安装PHP Xdebug
2018/03/30 PHP
多浏览器兼容的获取元素和鼠标的位置的js代码
2009/12/15 Javascript
Javascript的一种模块模式
2010/09/08 Javascript
jQuery关键词说明插件cluetip使用指南
2015/04/21 Javascript
jQuery实现ajax无刷新分页页码控件
2017/02/28 Javascript
JavaScript实现左右下拉框动态增删示例
2017/03/09 Javascript
基于vue 实现token验证的实例代码
2017/12/14 Javascript
详解Webpack多环境代码打包的方法
2018/08/03 Javascript
Vue自定义toast组件的实例代码
2018/08/15 Javascript
深入浅出了解Node.js Streams
2019/05/27 Javascript
在Python中操作文件之truncate()方法的使用教程
2015/05/25 Python
python爬虫之模拟登陆csdn的实例代码
2018/05/18 Python
Python使用pandas对数据进行差分运算的方法
2018/12/22 Python
python实现图片彩色转化为素描
2019/01/15 Python
pyqt5 键盘监听按下enter 就登陆的实例
2019/06/25 Python
浅析Python语言自带的数据结构有哪些
2019/08/27 Python
Django自定义用户表+自定义admin后台中的字段实例
2019/11/18 Python
基于Python执行dos命令并获取输出的结果
2019/12/30 Python
Python实现FLV视频拼接功能
2020/01/21 Python
优衣库英国官网:UNIQLO英国
2016/12/25 全球购物
德国网上超市:myTime.de
2019/08/26 全球购物
MySQL面试题
2014/01/12 面试题
程序员岗位职责
2013/11/11 职场文书
党校培训思想汇报
2014/01/03 职场文书
教师党员承诺书
2014/03/25 职场文书
田径运动会开幕式及主持词
2014/03/28 职场文书
实习护士自荐信
2014/06/21 职场文书
房屋租赁合同解除协议书
2014/10/11 职场文书
公司宣传语大全
2015/07/13 职场文书