Koa 框架

最新推荐文章于 2024-08-12 08:59:52 发布
最新推荐文章于 2024-08-12 08:59:52 发布
阅读量217 收藏 1
点赞数 1
分类专栏： node 文章标签： node koa js
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/html_z/article/details/125449815
版权

Koa 框架

认识 Koa

  • 前面我们已经学习了express，另外一个非常流行的Node Web服务器框架就是Koa。
  • Koa官方的介绍：
    • koa：next generation web framework for node.js；
    • koa：node.js的下一代web框架；
  • 事实上，koa是express同一个团队开发的一个新的Web框架：
    • 目前团队的核心开发者TJ的主要精力也在维护Koa，express已经交给团队维护了；
    • Koa旨在为Web应用程序和API提供更小、更丰富和更强大的能力；
    • 相对于express具有更强的异步处理能力（后续我们再对比）；
    • Koa的核心代码只有1600+行，是一个更加轻量级的框架，我们可以根据需要安装和使用中间件；
  • 事实上学习了express之后，学习koa的过程是很简单的；

Koa 初体验

  • 我们来体验一下koa的Web服务器

    • 在桌面新建文件夹learn_koa

    • 打开终端初始化项目npm init -y

    • 在package.json配置脚本

      {
  "name": "learn_koa",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "start": "nodemon ./src/app.js"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "koa": "^2.13.4",
    "nodemon": "^2.0.16"
  }
}

    • 根据脚本新建文件src，在文件src下面新建文件夹app.js

    • 安装koa框架npm i koa

      在这里插入图片描述

    • 启动项目npm start

      在这里插入图片描述

  • koa注册的中间件提供了两个参数：

  • ctx：上下文（Context）对象；

    • koa并没有像express一样，将req和res分开，而是将它们作为ctx的属性；

    • ctx代表依次请求的上下文对象；

    • ctx.request：获取请求对象；

    • ctx.response：获取响应对象；

      const Koa = require("koa");

const app = new Koa();

// context 上下文对象
// 包含两个主要的对象 request responst
app.use((context, next) => {
  console.log(context);
  console.log("普通中间件");
});

app.listen(8888, () => {
  console.log("服务器开启成功");
});

      在这里插入图片描述

  • next：本质上是一个dispatch，类似于之前的next；

Koa中间件

  • koa通过创建的app对象，注册中间件只能通过use方法：
    • Koa并没有提供methods的方式来注册中间件；
    • 也没有提供path中间件来匹配路径；
  • 但是真实开发中我们如何将路径和method分离呢？
    • 方式一：根据 request自己来判断；
    • 方式二：使用第三方路由中间件；

路由的使用

  • koa官方并没有给我们提供路由的库，我们可以选择第三方库：koa-router

    • npm install koa-router

      在这里插入图片描述

  • 我们可以先封装一个user.router.js的文件：

    // router/user.js 
const Router = require("koa-router");

const userRouter = new Router({
  prefix: "/user",
});

userRouter.get("/", (ctx) => {
  // 响应结果
  ctx.body = "用户列表";
});

userRouter.post("/", (ctx) => {
  // 响应结果
  ctx.body = "添加成功";
});
userRouter.delete("/", (ctx) => {
  // 响应结果
  ctx.body = "删除成功";
});
userRouter.patch("/", (ctx) => {
  // 响应结果
  ctx.body = "修改成功";
});

module.exports.userRouter = userRouter;

  • 在app中将router.routes()注册为中间件：

    const Koa = require("koa");

const { userRouter } = require("./router/user");

const app = new Koa();

// 注册路由中间件
// userRouter.routes() 加载路由规则
// userRouter.allowedMethods() 对于没有实现和没有使用的请求方式做出正确的响应
app.use(userRouter.routes()).use(userRouter.allowedMethods());

app.listen(8888, () => {
  console.log("服务器开启成功");
});

  • 注意：allowedMethods用于判断某一个method是否支持：

    • 如果我们请求 get，那么是正常的请求，因为我们有实现get；
    • 如果我们请求 put、delete、patch，那么就自动报错：Method Not Allowed，状态码：405；
    • 如果我们请求 link、copy、lock，那么就自动报错：Not Implemented，状态码：501；

参数解析：params - query

  • 请求地址：localhost:8888/user/2

    • 获取params：

      // router/user.js

const Router = require("koa-router");

const userRouter = new Router({
  prefix: "/user",
});

userRouter.get("/:id", (ctx) => {
  // params 方式传参
  console.log(ctx.params.id);
  // 响应结果
  ctx.body = "用户列表";
});

module.exports.userRouter = userRouter;

      在这里插入图片描述

  • 请求地址：localhost:8888/user?name=张三&age=21

    • 获取query：

      // router/user.js

const Router = require("koa-router");

const userRouter = new Router({
  prefix: "/user",
});

userRouter.get("/", (ctx) => {
  // query 方式传参
  console.log(ctx.query);
  // 响应结果
  ctx.body = "用户列表";
});

module.exports.userRouter = userRouter;

      在这里插入图片描述

参数解析：json

  • 请求地址：http://localhost:8888/user

    • body是json格式

      在这里插入图片描述

  • 获取json数据：

  • 安装依赖：npm install koa-bodyparser;

    在这里插入图片描述

  • 使用koa-bodyparser的中间件；

    • 在入口文件index.js中

      const Koa = require("koa");

const bodyParser = require("koa-bodyparser");

const { userRouter } = require("./router/user");

const app = new Koa();

// bodyParser() 解析 json 数据的中间件
app.use(bodyParser());

// 注册路由中间件
// userRouter.routes() 加载路由规则
// userRouter.allowedMethods() 对于没有实现和没有使用的请求方式做出正确的响应
app.use(userRouter.routes()).use(userRouter.allowedMethods());

app.listen(8888, () => {
  console.log("服务器开启成功");
});

    • 在router文件下面的user.js中

      // router/user.js

const Router = require("koa-router");

const userRouter = new Router({
  prefix: "/user",
});

userRouter.post("/", (ctx) => {
  // json 方式传参
  console.log(ctx.request.body);
  // 响应结果
  ctx.body = "添加成功";
});

module.exports.userRouter = userRouter;

参数解析：x-www-form-urlencoded

  • 请求地址：http://localhost:8888/user

    • body是x-www-form-urlencoded格式：

      在这里插入图片描述

  • 获取json数据：(和json是一致的)

    • 安装依赖： npm install koa-bodyparser;

    • 使用koa-bodyparser的中间件；

      • 在入口文件index.js中

        const Koa = require("koa");

const bodyParser = require("koa-bodyparser");

const { userRouter } = require("./router/user");

const app = new Koa();

// bodyParser() 解析 json 数据的中间件
app.use(bodyParser());

// 注册路由中间件
// userRouter.routes() 加载路由规则
// userRouter.allowedMethods() 对于没有实现和没有使用的请求方式做出正确的响应
app.use(userRouter.routes()).use(userRouter.allowedMethods());

app.listen(8888, () => {
  console.log("服务器开启成功");
});

      • 在router文件下面的user.js中

        // router/user.js

const Router = require("koa-router");

const userRouter = new Router({
  prefix: "/user",
});

userRouter.put("/", (ctx) => {
  // json 方式传参
  console.log(ctx.request.body);
  // 响应结果
  ctx.body = "修改成功";
});

module.exports.userRouter = userRouter;

参数解析：form-data

  • 请求地址：http://localhost:8888/user/upload

    • body是form-data格式

      在这里插入图片描述

  • 解析body中的数据，我们需要使用multer

    • 安装依赖：npm install koa-multer;

      在这里插入图片描述

    • 使用multer中间件；

      // router/user.js

const Router = require("koa-router");
const multer = require("koa-multer");
// 注意我这里安装的nanoid是3.x的版本，其它版本可能会报错
const { nanoid } = require("nanoid");
const { extname } = require("path");

const userRouter = new Router({
  prefix: "/user",
});

const storage = multer.diskStorage({
  destination(req, file, cb) {
    cb(null, "uploads/");
  },
  filename(req, file, cb) {
    // 文件名
    const fileName = nanoid();
    // 文件的后缀名
    const extName = extname(file.originalname);
    cb(null, fileName + extName);
  },
});
// 文件上传
const upload = multer({
  storage,
});
userRouter.post("/upload", upload.single("file"), (ctx) => {
  // form-data 方式传参
  // 文件信息
  console.log(ctx.req.file);
  // 表单数据
  console.log(ctx.req.body);
  // 响应结果
  ctx.body = "文件上传成功";
});

module.exports.userRouter = userRouter;

      在这里插入图片描述

数据的响应

  • 输出结果：body将响应主体设置为以下之一：

    • string ：字符串数据

      ctx.response.body = "hello world";

    • Buffer ：Buffer数据

    • Stream ：流数据

    • Object|| Array：对象或者数组

      // Object 
ctx.body = {
  name: "why",
  age: 18,
  height: 1.88,
};

      // Array
ctx.body = ["abc", "def", "nba"];

    • null ：不输出任何内容

    • 如果response.status尚未设置，Koa会自动将状态设置为200或204。

  • 请求状态：status

    ctx.status = 201;
ctx.response.status = 204;

静态服务器

  • koa并没有内置部署相关的功能，所以我们需要使用第三方库：

    • npm install koa-static
      在这里插入图片描述

  • 部署的过程类似于express：

    const Koa = require("koa");

const bodyParser = require("koa-bodyparser");
const static = require("koa-static");

const { userRouter } = require("./router/user");

const app = new Koa();

// bodyParser() 解析 json 数据的中间件
app.use(bodyParser());

app.use(static("./dist/index.html"));

// 注册路由中间件
// userRouter.routes() 加载路由规则
// userRouter.allowedMethods() 对于没有实现和没有使用的请求方式做出正确的响应
app.use(userRouter.routes()).use(userRouter.allowedMethods());

app.listen(8888, () => {
  console.log("服务器开启成功");
});

和express对比

  • 在学习了两个框架之后，我们应该已经可以发现koa和express的区别：
  • 从架构设计上来说：
    • express是完整和强大的，其中帮助我们内置了非常多好用的功能；
    • koa是简洁和自由的，它只包含最核心的功能，并不会对我们使用其他中间件进行任何的限制。
      • 甚至是在app中连最基本的get、post都没有给我们提供；
      • 我们需要通过自己或者路由来判断请求方式或者其他功能；
  • 因为express和koa框架他们的核心其实都是中间件：
    • 但是他们的中间件事实上，它们的中间件的执行机制是不同的，特别是针对某个中间件中包含异步操作时；
BloggerM
关注
专栏目录
Koa框架
m0_55689351的博客
05-26 1241
认识Koa 前面我们已经学习了express，另外一个非常流行的Node Web服务器框架就是Koa。 Koa官方的介绍： koa：next generation web framework for node.js； koa：node.js的下一代web框架； 事实上，koa是express同一个团队开发的一个新的Web框架： 目前团队的核心开发者TJ的主要精力也在维护Koa，express已经交给团队维护了； Koa旨在为Web应用程序和API提供更...
KOA框架
qq_39889855的博客
06-09 813
koa中文网Koa(koa.js)中文网 -- 基于 Node.js 平台的下一代 web 开发框架 下载 npm install koa-router -s 先链式执行完函数再执行next（）后面的语句
koa框架会用也会写—(koa-bodyparser、koa-better-body)
weixin_34256074的博客
09-29 341
Koa中常用的中间件： koa-session：让无状态的http拥有状态，基于cookie实现的后台保存信息的session koa-mysql:封装了需要用到的SQL语句 koa-mysql-session：当不想让session存储到内存，而想让session存储到mysql数据库中时使用 koa-router：后台会接受到各种请求的url，路由会根据不同的url来使用不同的处理逻辑。 k...
koa-bodyparser
冷月心的博客
08-13 1061
koa-bodyparser
Koa BodyParser 使用教程
gitblog_00324的博客
08-10 518
Koa BodyParser 使用教程 bodyparserKoa body parsing middleware项目地址:https://gitcode.com/gh_mirrors/bo/bodyparser Koa BodyParser 是一个用于解析 HTTP 请求主体（body）的中间件，适合 Koa.js 框架。下面将详细介绍如何安装和使用它。 1. 项目目录结构及介绍 在 Koa ...
KOA笔记（03）：中间件koa-bodyparser
LAZYPET BLOG
05-14 781
1、bodyparser的作用 为了更方便的处理post请求，在koa中获取post请求的参数 1、下载 npm i koa-bodyparser --save 2、引入 const bodyPaser = require('koa-bodyparser') 3、加入中间件（不需要配置也可以） koa.use(bodyPaser()); 4、使用 在post请求路由中使用ctx.request.body即可返回post请求中的对象 .post('/doAdd', async (ctx) => {
Koa框架教程
01-27
【Koa框架教程】 Koa 是一款针对Node.js平台的轻量级Web应用框架，以其优雅、简洁和高效而著称。它具有高度的可扩展性，所有的功能都是通过插件来实现，遵循Unix哲学，使得Koa的核心代码非常精简，只有1000多行。...
Node.js的Koa框架上手及MySQL操作指南
12-23
由 Express 原班人马打造的 koa，致力于成为一个更小、更健壮、更富有表现力的 Web 框架。使用 koa 编写 web 应用，通过组合不同的 generator，可以免除重复繁琐的回调函数嵌套，并极大地提升常用错误处理效率。Koa ...
Koa 框架教程.html
09-07
Koa 框架教程
Koa框架基础快速入门
01-27
**Koa框架基础快速入门** Koa框架是Node.js领域中的一个轻量级Web应用框架，由Express团队创建，旨在提供更加简洁、高效且强大的功能。Koa的主要目标是通过使用ES6的Generator特性（在较新版本的Node.js中为async/...
深入koa-bodyparser原理解析
01-01
一、前置知识 在理解koa-bodyparser原理之前，首先需要了解部分HTTP相关的知识。 1、报文主体 HTTP报文主要分为请求报文和响应报文，koa-bodyparser主要针对请求报文的处理。 请求报文主要由以下三个部分组成： 报文头部 空行 报文主体 而koa-bodyparser中的body指的就是请求报文中的报文主体部分。 2、服务器端获取报文主体流程 HTTP底层采用TCP提供可靠的字节流服务，简单而言就是报文主体部分会被转化为二进制数据在网络中传输，所以服务器端首先需要拿到二进制流数据。 谈到网络传输，当然会涉及到传输速度的优化，而其中一种优化方式就是对内
KOA 学习（八） koa-bodyparser
weixin_33743248的博客
03-13 203
此控件支持Josn,form,text类型 用法 var Koa = require('koa'); var bodyParser = require('koa-bodyparser'); var app = new Koa(); app.use(bodyParser()); app.use(async ctx => { // the parsed body w...
node中间件koa-bodyparser
Lval的博客
12-16 565
koa-bodyparser中间件 这个中间件可以将post请求的参数转为json格式返回 koa接收到的post请求参数并不是json格式，我们需要将其转换为json 使用方法：安装后直接在ctx.request.body内获取POST请求参数，中间件自动给我们解析为json 安装： npm install --save koa-bodyparser const Koa = require('k...
koa请求体解析中间件——koa-bodyparser
sunpowerz的博客
07-10 3791
使用 const Koa = require('koa'); const bodyParser = require("koa-bodyparser"); const server = new Koa(); server.listen(8080); server.use(bodyParser()); server.use(async ctx=>{ if (ctx.url ===...
探索Koa.js中的BodyParser：高效处理HTTP请求体
gitblog_00028的博客
03-26 490
探索Koa.js中的BodyParser：高效处理HTTP请求体 bodyparserKoa body parsing middleware项目地址:https://gitcode.com/gh_mirrors/bo/bodyparser 在Web开发中，处理HTTP请求体是不可或缺的一部分。对于Node.js开发者，特别是使用Koa.js框架的朋友，body-parser是一个非常实用的中间件...
Koa BodyParser 入门与实战指南
gitblog_01181的博客
08-10 327
Koa BodyParser 入门与实战指南 bodyparserKoa body parsing middleware项目地址:https://gitcode.com/gh_mirrors/bo/bodyparser Koa BodyParser 是一个专为 Koa 框架设计的中间件，用于解析 HTTP 请求中的请求体内容。它支持多种数据格式，如 JSON、URL 编码的数据、原始二进制流和文...
82 # koa-bodyparser 中间件的使用以及实现
学习前端这门手艺，栈底到栈顶依次是：浏览器架构、Web 网络、事件循环机制、JavaScript 核心、V8 的内存管理、浏览器的渲染流程、Web 安全、CSS、React、Vue、Node、构建工具链等
09-11 711
koa 中所有的异步都必须是 promise，只有 promise 才有等待效果，必须所有的 next 方法前需要有 await、return 否则没有等待效果。koa 中不能用回调的方式来实现，因为 async 函数执行的时候不会等待回调完成。将业务代码的引用自己实现的。实现一个表单提交功能。输入账号密码，点击提交。
推荐项目：Koa-bodyparser - 简化Koa框架请求体解析的利器
最新发布
gitblog_00136的博客
08-12 298
推荐项目：Koa-bodyparser - 简化Koa框架请求体解析的利器 bodyparserKoa body parsing middleware项目地址:https://gitcode.com/gh_mirrors/bo/bodyparser 在构建现代Web应用时，处理HTTP请求中的数据是必不可少的一环。对于基于Koa的Node.js应用，@koa/bodyparser这一开源项目无疑...
Koa框架入门教程：从零到精通
"Koa框架教程 - 学习如何使用Koa构建Web应用" Koa是基于Node.js的Web框架，以其优雅、简洁和高度可扩展性而受到开发者喜爱。Koa的核心理念是通过中间件来处理Web应用的流程，这使得它能够灵活地与其他模块配合，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值