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。

相关文章

Python 中的 with open文件操作的最佳实践

Python 中的 with open文件操作的最佳实践

《Python中的withopen文件操作的最佳实践》在Python中,withopen()提供了一个简洁而安全的方式来处理文件操作,它不仅能确保文件在操作完成后自动关闭,还能处理文件操作中的异... 目录什么是 with open()？为什么使用 with open()？使用 with open() 进行
阅读更多...
Spring Boot + MyBatis Plus 高效开发实战从入门到进阶优化(推荐)

Spring Boot + MyBatis Plus 高效开发实战从入门到进阶优化(推荐)

《SpringBoot+MyBatisPlus高效开发实战从入门到进阶优化(推荐)》本文将详细介绍SpringBoot+MyBatisPlus的完整开发流程,并深入剖析分页查询、批量操作、动... 目录Spring Boot + MyBATis Plus 高效开发实战：从入门到进阶优化1. MyBatis
阅读更多...
Spring Boot 配置文件之类型、加载顺序与最佳实践记录

Spring Boot 配置文件之类型、加载顺序与最佳实践记录

《SpringBoot配置文件之类型、加载顺序与最佳实践记录》SpringBoot的配置文件是灵活且强大的工具,通过合理的配置管理,可以让应用开发和部署更加高效,无论是简单的属性配置,还是复杂... 目录Spring Boot 配置文件详解一、Spring Boot 配置文件类型1.1 applicatio
阅读更多...
tomcat多实例部署的项目实践

tomcat多实例部署的项目实践

《tomcat多实例部署的项目实践》Tomcat多实例是指在一台设备上运行多个Tomcat服务,这些Tomcat相互独立,本文主要介绍了tomcat多实例部署的项目实践,具有一定的参考价值,感兴趣的可... 目录1.创建项目目录，测试文China编程件2js.创建实例的安装目录3.准备实例的配置文件4.编辑实例的
阅读更多...
Python 中的异步与同步深度解析(实践记录)

Python 中的异步与同步深度解析(实践记录)

《Python中的异步与同步深度解析(实践记录)》在Python编程世界里,异步和同步的概念是理解程序执行流程和性能优化的关键,这篇文章将带你深入了解它们的差异,以及阻塞和非阻塞的特性,同时通过实际... 目录python中的异步与同步：深度解析与实践异步与同步的定义异步同步阻塞与非阻塞的概念阻塞非阻塞同步
阅读更多...
Python Dash框架在数据可视化仪表板中的应用与实践记录

Python Dash框架在数据可视化仪表板中的应用与实践记录

《PythonDash框架在数据可视化仪表板中的应用与实践记录》Python的PlotlyDash库提供了一种简便且强大的方式来构建和展示互动式数据仪表板,本篇文章将深入探讨如何使用Dash设计一... 目录python Dash框架在数据可视化仪表板中的应用与实践1. 什么是Plotly Dash？1.1
阅读更多...
springboot集成Deepseek4j的项目实践

springboot集成Deepseek4j的项目实践

《springboot集成Deepseek4j的项目实践》本文主要介绍了springboot集成Deepseek4j的项目实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录Deepseek4j快速开始Maven 依js赖基础配置基础使用示例1. 流式返回示例2. 进阶
阅读更多...
Android App安装列表获取方法(实践方案)

Android App安装列表获取方法(实践方案)

《AndroidApp安装列表获取方法(实践方案)》文章介绍了Android11及以上版本获取应用列表的方案调整,包括权限配置、白名单配置和action配置三种方式,并提供了相应的Java和Kotl... 目录前言实现方案         方案概述一、 androidManifest 三种配置方式
阅读更多...
Spring Boot中定时任务Cron表达式的终极指南最佳实践记录

Spring Boot中定时任务Cron表达式的终极指南最佳实践记录

《SpringBoot中定时任务Cron表达式的终极指南最佳实践记录》本文详细介绍了SpringBoot中定时任务的实现方法,特别是Cron表达式的使用技巧和高级用法,从基础语法到复杂场景,从快速启... 目录一、Cron表达式基础1.1 Cron表达式结构1.2 核心语法规则二、Spring Boot中定
阅读更多...
Ubuntu中Nginx虚拟主机设置的项目实践

Ubuntu中Nginx虚拟主机设置的项目实践

《Ubuntu中Nginx虚拟主机设置的项目实践》通过配置虚拟主机,可以在同一台服务器上运行多个独立的网站,本文主要介绍了Ubuntu中Nginx虚拟主机设置的项目实践,具有一定的参考价值,感兴趣的可... 目录简介安装 Nginx创建虚拟主机1. 创建网站目录2. 创建默认索引文件3. 配置 Nginx4
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2