Koa2 入门实践

2023-12-18 18:32
文章标签 实践 入门 koa2

本文主要是介绍Koa2 入门实践,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

第一个例子:启动

初始化项目,安装环境

# -y 就是不想自己逐条配置,直接全部使用默认配置
npm init -y# 安装 koa 并写入 package.json 中
npm i koa --save# 好的代码规范还是必要的
npm i standard --save-dev# 安装 nodemon 用于开发环境快速自动重启
npm i -g nodemon

配置开发选项

这个时候我们就可以用到 npm script 了,避免重复输入命令

# package.json 中的 scripts 中添加# 正常启动服务
"start": "node index.js",
# 启动开发环境,保存修改内容后自动重启
"dev": "NODE_ENV=develpment nodemon index.js"
  • 编写 index.js

这个时候我们新建一个文件叫 index.js 并编辑它

// index.js// 引入 koa
const Koa = require('koa')// 新建 koa 实例
const app = new Koa()app.use(async (ctx) => { ctx.body = JSON.stringify(ctx) })// 监听 5820 端口,服务启动成功输出内容
app.listen(5820, () => { console.log('APP LISTEN PORT 5820') })

然后我们在项目下打开终端,输入 npm run dev 就可以启动服务的开发模式了,这个时候可以看到控制台输出了 APP LISTEN PORT 5820,同时我们打开浏览器并访问 localhost:5820 ,就可以看到当前访问的上下文信息了

这是最简单的例子,同时也是最重要的,标志了你已可以正式启动 Koa 服务了

GET 请求的参数接收

写一个最简单的例子

// 引入 koa
const Koa = require('koa')// 新建 koa 实例
const app = new Koa()app.use(async (ctx) => {ctx.body = {url: ctx.url,params: ctx.request.query,param_string: ctx.request.querystring,ctx_params: ctx.query,ctx_params_string: ctx.querystring}
})// 监听 5820 端口,服务启动成功输出内容
app.listen(5820, () => { console.log('APP LISTEN PORT 5820') })

这个时候,我们在浏览器提交一个请求,使用get访问 localhost:5820?hello=world&pika=qiu

这个时候我们就可以查看内容了

从这里可以看出

获取在 koa 中 GET 的参数方式有两种:query和querystring。同时我们可以看出,在可以从 request 中接收 GET 请求和直接从上下文中接收 GET 请求都是可以的。

  • query:返回的是的参数对象。
  • querystring:返回的是请求字符串。

POST 请求的参数接收

koa 并不带 POST 请求的解析,这个时候,我们就要自己编写 POST 请求的解析函数了

function parseParams (ctx) {return new Promise((resolve, reject) => {try {let paramsdata = ''ctx.req.on('data', (data) => {paramsdata += data})ctx.req.addListener('end', function () {resolve(parseQueryStr(paramsdata))})} catch (error) {reject(error)}})
}function parseQueryStr (queryStr) {let queryData = {}let queryStrList = queryStr.split('&')for (let [index, queryStr] of queryStrList.entries()) {let itemList = queryStr.split('=')queryData[itemList[0]] = decodeURIComponent(itemList[1])}return queryData
}

使用的时候就可以这么使用

app.use(async (ctx) => {let params = await parseParams(ctx)ctx.body = {method: ctx.method,url: ctx.url,params}
})

这个时候,我们可以使用 POSTMAN 来模拟一下 POST 请求的发送,我们可以发现参数已经被成功解析了

koa-bodyparser 中间件

当然 POST 请求这么常见的需求是一定有造好的轮子的,这个时候我们就可以使用 koa-bodyparser 来进行参数的解析了

安装依赖

npm i koa-bodyparser --save
  • 引入并使用
// 引入 koa
const Koa = require('koa')
// 引入 koa-bodyparser
const KoaBodyparser = require('koa-bodyparser')
// 新建 koa 实例
const app = new Koa()// 使用中间件
app.use(KoaBodyparser())app.use(async (ctx) => {ctx.body = {method: ctx.method,url: ctx.url,params: ctx.request.body}
})// 监听 5820 端口,服务启动成功输出内容
app.listen(5820, () => { console.log('APP LISTEN PORT 5820') })

然后我们使用 POSTMAN 模拟一下请求就可以看出,这里我们直接使用 ctx.request.body 就可以取到格式化后的参数对象了

koa 原生路由

先编写一个简单的中间件

// 因为使用了 fs 模块,所以我们要引入
const fs = require('fs')// 先写好对应的文件,然后写一个读取文件内容的函数
function readfile (params) {return new Promise((resolve, reject) => {fs.readFile(`./route/${params}.html`, 'binary', (err, data) => {if (err) {reject(err)} else {resolve(data)}})})
}
// 再编写路由配置
async function route (url) {let page = ''switch (url) {case '/index':page = 'index'breakcase '/page':page = 'page'breakcase '/user':page = 'user'breakdefault: page = '/404'break}let html = await readfile(page)return html
}
// 就可以这么使用了
app.use(async (ctx) => {let html = await route(ctx.url)ctx.body = html
})

koa-router中间件

当然,常用的东西肯定是有中间件的,这个时候我们就可以祭出 koa-router

安装 koa-router

npm i koa-router --save
  • 基础案例
// 引入 koa
const Koa = require('koa')
// 引入 koa-router
const KoaRouter = require('koa-router')
// 实例化一个 koa 对象
const app = new Koa()
// 实例化一个 router 对象
let route = new KoaRouter()// 表示接收 get 请求,接收 url 为 /
// 其中 next 指的是下一个中间件,可以在代码中使用 await next() 来提前执行
route.get('/', (ctx, next) => {ctx.body = 'Hello get'
})// 表示接收 post 请求
route.post('/test', (ctx, next) => {ctx.body = 'hello post'
})// 表示接收全部请求
route.all('/all', (ctx, next) => {ctx.body = 'hello all'
})// 装载路由,并只允许指定方法访问
app.use(route.routes()).use(route.allowedMethods())// 监听 5820 端口,服务启动成功输出内容
app.listen(5820, () => { console.log('APP LISTEN PORT 5820') })

层级案例

当然,日常工作中的路由不可能这么简单,这个时候我们就需要使用多层次的路由的,下面看案例

先简单创建一下目录并路由文件


mkdir route
touch route1.js route2.js
// route1.js
let KoaRouter = require('koa-router')let route = new KoaRouter()route.get('/test1', (ctx, next) => {ctx.body = 'route1 test1'
})route.get('/test2', (ctx, next) => {ctx.body = 'route1 test2'
})route.get('/test3', (ctx, next) => {ctx.body = 'route1 test3'
})module.exports = route
// route2.js
let KoaRouter = require('koa-router')let route = new KoaRouter()route.get('/test1', (ctx, next) => {ctx.body = 'route2 test1'
})route.get('/test2', (ctx, next) => {ctx.body = 'route2 test2'
})route.get('/test3', (ctx, next) => {ctx.body = 'route2 test3'
})module.exports = route
// 根目录下的 server.js
// 引入 koa,路由
const Koa = require('koa')
let KoaRouter = require('koa-router')
// 实例化一个 koa 对象
const app = new Koa()
// 创建一个全局的父路由,子路由要全部挂载在父路由下
let fatherRoute = new KoaRouter()
// 引入子路由
const route1 = require('./route/route1')
const route2 = require('./route/route2')// 装载路由,并只允许指定方法访问
fatherRoute.use('/route1', route1.routes(), route1.allowedMethods())
fatherRoute.use('/route2', route2.routes(), route2.allowedMethods())// Koa 装载父路由
app.use(fatherRoute.routes()).use(fatherRoute.allowedMethods())// 监听 5820 端口,服务启动成功输出内容
app.listen(5820, () => { console.log('APP LISTEN PORT 5820') })
  • 这个时候我们就可以启动,然后访问 localhost:5820/route1/test1

localhost:5820/route2/test3 来查看一下效果

koa 中使用cookie

最简单的 key-value 形式设置与获取

// 引入 koa
const Koa = require('koa')
// 引入 koa-router
const KoaRouter = require('koa-router')
// 实例化一个 koa 对象
const app = new Koa()
// 实例化一个 router 对象
let route = new KoaRouter()// 最简单的 key-value 形式,可以直接使用上下文对象提供的 cookie 对象进行操作
route.get('/', (ctx, next) => {ctx.cookies.set('TESTCOOKIE', 'LOVEWZJ'.repeat(5))ctx.body = 'SET COOKIE OK'
})// 获取 cookie
route.get('/test', (ctx, next) => {ctx.body = `GET COOKIE IS ${ctx.cookies.get('TESTCOOKIE')}`
})// 装载路由,并只允许指定方法访问
app.use(route.routes()).use(route.allowedMethods())// 监听 5820 端口,服务启动成功输出内容
app.listen(5820, () => { console.log('APP LISTEN PORT 5820') })
// 复杂的 key-value-options 形式
route.get('/', (ctx, next) => {ctx.cookies.set('TESTCOOKIE', 'LOVEWZJ', {maxAge: 1000 * 60 * 60 * 24,expires: new Date('2018-12-31')})ctx.body = `SET COOKIE OK ${new Date().toLocaleTimeString()}`
})
  • 配置项
名称含义示例
pathcookie 的路径默认 /
domaincookie 的域*.baidu.com
expirescookie 有效期时间new Date(‘2018-12-31’)
maxAgecookie 最大存活时间1000 * 60 * 60 * 24
httpOnly是否只能通过 HTTP 协议发送true|false
signed是否要做签名true|false
secure通过什么协议发送 cookiefalse 表示 cookie 通过 HTTP 协议发送,true 表示 cookie 通过 HTTPS 发送
overwirte是否允许重写true|false

koa-static 中间件

对于一些静态的资源,比如图片,CSS文件,JS文件,HTML文件等资源,我们可以直接使用 koa-static 中间件进行处理。

安装依赖

npm i kao-static --save
  •  

应用

注意:这里是把所有的静态资源放在 static 目录下

// 引入 koa
const Koa = require('koa')
// 引入 path 模块
const path = require('path')
// 引入 koa-static 中间件
const KoaStatic = require('koa-static')// 实例化一个 koa 对象
const app = new Koa()// 装载静态资源中间件
app.use(KoaStatic(path.join(__dirname, './static')
))// 监听 5820 端口,服务启动成功输出内容
app.listen(5820, () => { console.log('APP LISTEN PORT 5820') })

koa 中间件

app.use() 的功能实际上就是把里面的函数加入到回调函数执行列表中,下面我们写一个简单的例子来看一下

// 引入 koa
const Koa = require('koa')// 实例化一个 koa
const app = new Koa()
app.use(log)app.use(async (ctx) => { ctx.body = ctx.url })// 我们写的异步程序
async function log (ctx, next) {ctx.url = 'I CAN CHANGE CTX URL'await next()
}// 监听 5820 端口,服务启动成功输出内容
app.listen(5820, () => { console.log('APP LISTEN PORT 5820') })

转载https://blog.csdn.net/qq_17347575/article/details/79601333

这篇关于Koa2 入门实践的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/509382

相关文章

Spring事务传播机制最佳实践

《Spring事务传播机制最佳实践》Spring的事务传播机制为我们提供了优雅的解决方案,本文将带您深入理解这一机制,掌握不同场景下的最佳实践,感兴趣的朋友一起看看吧... 目录1. 什么是事务传播行为2. Spring支持的七种事务传播行为2.1 REQUIRED(默认)2.2 SUPPORTS2

Java中的雪花算法Snowflake解析与实践技巧

《Java中的雪花算法Snowflake解析与实践技巧》本文解析了雪花算法的原理、Java实现及生产实践,涵盖ID结构、位运算技巧、时钟回拨处理、WorkerId分配等关键点,并探讨了百度UidGen... 目录一、雪花算法核心原理1.1 算法起源1.2 ID结构详解1.3 核心特性二、Java实现解析2.

从入门到精通C++11 <chrono> 库特性

《从入门到精通C++11<chrono>库特性》chrono库是C++11中一个非常强大和实用的库,它为时间处理提供了丰富的功能和类型安全的接口,通过本文的介绍,我们了解了chrono库的基本概念... 目录一、引言1.1 为什么需要<chrono>库1.2<chrono>库的基本概念二、时间段(Durat

MySQL 中 ROW_NUMBER() 函数最佳实践

《MySQL中ROW_NUMBER()函数最佳实践》MySQL中ROW_NUMBER()函数,作为窗口函数为每行分配唯一连续序号,区别于RANK()和DENSE_RANK(),特别适合分页、去重... 目录mysql 中 ROW_NUMBER() 函数详解一、基础语法二、核心特点三、典型应用场景1. 数据分

解析C++11 static_assert及与Boost库的关联从入门到精通

《解析C++11static_assert及与Boost库的关联从入门到精通》static_assert是C++中强大的编译时验证工具,它能够在编译阶段拦截不符合预期的类型或值,增强代码的健壮性,通... 目录一、背景知识:传统断言方法的局限性1.1 assert宏1.2 #error指令1.3 第三方解决

深度解析Spring AOP @Aspect 原理、实战与最佳实践教程

《深度解析SpringAOP@Aspect原理、实战与最佳实践教程》文章系统讲解了SpringAOP核心概念、实现方式及原理,涵盖横切关注点分离、代理机制(JDK/CGLIB)、切入点类型、性能... 目录1. @ASPect 核心概念1.1 AOP 编程范式1.2 @Aspect 关键特性2. 完整代码实

从入门到精通MySQL 数据库索引(实战案例)

《从入门到精通MySQL数据库索引(实战案例)》索引是数据库的目录,提升查询速度,主要类型包括BTree、Hash、全文、空间索引,需根据场景选择,建议用于高频查询、关联字段、排序等,避免重复率高或... 目录一、索引是什么?能干嘛?核心作用:二、索引的 4 种主要类型(附通俗例子)1. BTree 索引(

Redis 配置文件使用建议redis.conf 从入门到实战

《Redis配置文件使用建议redis.conf从入门到实战》Redis配置方式包括配置文件、命令行参数、运行时CONFIG命令,支持动态修改参数及持久化,常用项涉及端口、绑定、内存策略等,版本8... 目录一、Redis.conf 是什么?二、命令行方式传参(适用于测试)三、运行时动态修改配置(不重启服务

MySQL 用户创建与授权最佳实践

《MySQL用户创建与授权最佳实践》在MySQL中,用户管理和权限控制是数据库安全的重要组成部分,下面详细介绍如何在MySQL中创建用户并授予适当的权限,感兴趣的朋友跟随小编一起看看吧... 目录mysql 用户创建与授权详解一、MySQL用户管理基础1. 用户账户组成2. 查看现有用户二、创建用户1. 基

Spring Boot 实现 IP 限流的原理、实践与利弊解析

《SpringBoot实现IP限流的原理、实践与利弊解析》在SpringBoot中实现IP限流是一种简单而有效的方式来保障系统的稳定性和可用性,本文给大家介绍SpringBoot实现IP限... 目录一、引言二、IP 限流原理2.1 令牌桶算法2.2 漏桶算法三、使用场景3.1 防止恶意攻击3.2 控制资源