koa知识点

已于 2023-08-17 14:18:53 修改
阅读量75 收藏
点赞数
分类专栏： node.js 文章标签： npm 前端 node.js javascript
于 2023-04-24 23:51:27 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43551056/article/details/130354849
版权

koa基本使用

npm i koa

const koa = require('koa')

const app = new koa()

// 中间件1
app.use((ctx,next)=>{
  ctx.body = 'hi1'
  next()
})

// 中间件2
app.use((ctx,next)=>{
  ctx.body = 'hi2'
  next()
})

// 中间件3
app.use((ctx,next)=>{
  ctx.body = 'hi3'
  next()
})

app.listen(8080, () => {
  console.log('http://localhost:8080');
})

ctx上下文对象

  1. ctx.request和ctx.response 是Koa 封装的对象
  2. ctx.req和ctx.res 是Node.js 封装的对象，有HTTP请求对象的所有属性和方法
  3. next函数返回Promise对象，故可以使用同步的方式接收异步代码

跨域

const cors = require('koa2-cors');
app.use(cors())

路由

npm i @koa/router

const koa = require('koa')
const KoaRouter = require('@koa/router')

const app = new koa()

// 1.创建路由对象
const userRouter = new KoaRouter({ prefix: '/users' })

// 2.在路由中注册中间件
userRouter.get('/', (ctx, next) => {
  ctx.body = "获取get"
})

// 3.使路由生效
app.use(userRouter.routes())
app.use(userRouter.allowedMethods())

app.listen(8080, () => {
  console.log('http://localhost:8080');
})

allowedMethods的作用：用于判断某一个method是否支持
(1). 如果我们请求 get，那么是正常的请求，因为我们有实现get；

(2). 如果我们请求 put、delete、patch，那么就自动报错：Method Not Allowed，状态码：405；

(3). 如果我们请求 link、copy、lock，那么久自动报错：NotImplemented，状态码：501；

参数解析

query、params参数

const koa = require('koa')
const KoaRouter = require('@koa/router')

const app = new koa()

const userRouter = new KoaRouter({ prefix: '/users' })

// params参数
// http://localhost:8080/users/1
userRouter.get('/:id', (ctx, next) => {
  ctx.body = ctx.params.id
})

// query参数
// http://localhost:8080/users?id=1&name=cjc
userRouter.get('/', (ctx, next) => {
  ctx.body = ctx.query
})

app.use(userRouter.routes())
app.use(userRouter.allowedMethods())

app.listen(8080, () => {
  console.log('http://localhost:8080');
})

json、x-www-form-urlencoded

npm i koa-bodyparser

const koa = require('koa')
const KoaRouter = require('@koa/router')
const bodyParser = require('koa-bodyparser')

const app = new koa()

const userRouter = new KoaRouter({ prefix: '/users' })

// 解析json、x-www-form-urlencoded的中间件
app.use(bodyParser())

// json、x-www-form-urlencoded参数
userRouter.post('/', (ctx, next) => {
  ctx.body = ctx.request.body
})

// 使用路由
app.use(userRouter.routes())
app.use(userRouter.allowedMethods())

app.listen(8080, () => {
  console.log('http://localhost:8080');
})

form-data

npm i @koa/multer multer

const koa = require('koa')
const KoaRouter = require('@koa/router')
const multer = require('@koa/multer')

const app = new koa()

const userRouter = new KoaRouter({ prefix: '/users' })

// multer() -> 返回multer实例
// formDataParse.any() -> 返回中间件
const formDataParse = multer()

// form-data参数
userRouter.post('/', formDataParse.any(), (ctx, next) => {
  ctx.body = ctx.request.body
})

app.use(userRouter.routes())
app.use(userRouter.allowedMethods())

app.listen(8080, () => {
  console.log('http://localhost:8080');
})

文件上传

npm i @koa/multer multer

const koa = require('koa')
const KoaRouter = require('@koa/router')
const multer = require('@koa/multer')

const app = new koa()

/**
 * 文件上传
 */
const uploadRouter = new KoaRouter({ prefix: "/upload" });

const upload = multer({
  storage: multer.diskStorage({
    destination(req, file, cb) {
      cb(null, "./imgs"); //指定存储文件夹为 imgs
    },
    filename(req, file, cb) {
      // 解决中文名乱码的问题
      file.originalname = Buffer.from(file.originalname, "latin1").toString(
        "utf8"
      );
      cb(null, Date.now() + "_" + file.originalname);
    },
  }),
});

// 单文件上传
uploadRouter.post("/singleFile", upload.single("photo"), (ctx, next) => {
  ctx.body = ctx.request.file;
});

// 多文件上传
uploadRouter.post("/multiFiles", upload.array("photos"), (ctx, next) => {
  ctx.body = ctx.request.files;
});

app.use(uploadRouter.routes());
app.use(uploadRouter.allowedMethods());

app.listen(8080, () => {
  console.log('http://localhost:8080');
})

总结

const koa = require("koa");
const KoaRouter = require("@koa/router");
const bodyParser = require("koa-bodyparser");
const multer = require("@koa/multer");
const static = require("koa-static");
const app = new koa();

/**
 * 全局中间件
 */
// 1.跨域
// 2.普通全局中间件
app.use(bodyParser());

/**
 * 路由中间件，参数解析
 */
const userRouter = new KoaRouter({ prefix: "/users" });

// query、params
userRouter.get("/:id", (ctx, next) => {
  const { params, query } = ctx;
  ctx.body = {
    params: params,
    query: query,
  };
});

// json、x-www-form-urlencoded
userRouter.post("/addUser", (ctx, next) => {
  ctx.body = ctx.request.body;
  console.log(ctx.req.body, ctx.request.body);
});

// form-data
const formDataParse = multer();
userRouter.post("/addUserByForm", formDataParse.any(), (ctx, next) => {
  ctx.body = ctx.request.body;
});

app.use(userRouter.routes());
app.use(userRouter.allowedMethods());

/**
 * 文件上传
 */
const uploadRouter = new KoaRouter({ prefix: "/upload" });

const upload = multer({
  storage: multer.diskStorage({
    destination(req, file, cb) {
      cb(null, "./imgs"); //指定存储文件夹为 imgs
    },
    filename(req, file, cb) {
      // 解决中文名乱码的问题
      file.originalname = Buffer.from(file.originalname, "latin1").toString(
        "utf8"
      );
      cb(null, Date.now() + "_" + file.originalname);
    },
  }),
});

// 单文件上传
uploadRouter.post("/singleFile", upload.single("photo"), (ctx, next) => {
  ctx.body = ctx.request.file;
});

// 多文件上传
uploadRouter.post("/multiFiles", upload.array("photos"), (ctx, next) => {
  ctx.body = ctx.request.files;
});

app.use(uploadRouter.routes());
app.use(uploadRouter.allowedMethods());

// 静态服务器
app.use(static("./imgs"));

app.listen(8080, () => {
  console.log("http://localhost:8080");
});

静态资源

npm i koa-static 

const koa = require('koa')
const static = require('koa-static')

const app = new koa()

// 静态服务器
// http://localhost:8080/[imgs文件夹下的文件名] 访问静态资源
// http://localhost:8080/1691313647439_labi.jpg
app.use(static('./imgs'))

app.listen(8080, () => {
  console.log('http://localhost:8080');
})

错误处理和数据响应

数据响应

响应体ctx.body的类型:

  1. string
  2. Buffer
  3. Stream
  4. Object || Array
  5. null 不响应任何内容

ctx.status未设置任何内容，Koa自动将状态设置为200或204（no content）

const koa = require("koa");
const KoaRouter = require("@koa/router");
const fs = require("fs");
const app = new koa();

const userRouter = new KoaRouter({ prefix: "/users" });

userRouter.get("/", (ctx, next) => {
  // // 1.string
  // ctx.body = "ok";

  // // 2.Object || Array
  // ctx.body = {
  //   name: "ccc",
  //   age: 999,
  // };

  // // 3.Buffer
  // ctx.body = Buffer.from("Buffer数据");

  // 4.Stream 流数据
  const readStream = fs.createReadStream("./imgs/1691313647439_labi.jpg");
  ctx.type = "image/jpeg";
  ctx.body = readStream;

  // 5.null
  // ctx.body = null;
});

app.use(userRouter.routes());
app.use(userRouter.allowedMethods());

app.listen(8080, () => {
  console.log("http://localhost:8080");
});

错误处理

  1. 抛出自定义错误事件 ctx.app.emit(eventName,…args), 第一个参数为监听器的名称，第二个为不定参数
  2. app.on(“eventName”, (errCode, ctx) => {}) ,回调函数中的参数，均为emit中传递过来的
const koa = require("koa");
const KoaRouter = require("@koa/router");
const bodyParser = require("koa-bodyparser");
const app = new koa();

const userRouter = new KoaRouter({ prefix: "/users" });
app.use(bodyParser());

userRouter.post("/login", (ctx, next) => {
  const { name, pwd } = ctx.request.body;
  if (!name || !pwd) {
    // 1.抛出自定义错误事件error
    ctx.app.emit("error", -1001, ctx);
  } else if (name !== "ccc" || pwd !== 123) {
    ctx.app.emit("error", -1002, ctx);
  } else {
    ctx.body = {
      code: 0,
      msg: "登录成功",
      token: "xxx",
    };
  }
});

app.use(userRouter.routes());
app.use(userRouter.allowedMethods());

// 2.监听事件，统一错误处理
app.on("error", (code, ctx) => {
  let msg = "未知错误";
  switch (code) {
    case -1001:
      msg = "账号或密码为空";
      break;
    case -1002:
      msg = "账号或密码错误";
      break;
    default:
      break;
  }

  ctx.body = {
    code,
    msg,
  };
});

app.listen(8080, () => {
  console.log("http://localhost:8080");
});

Koa执行同步、异步代码

洋葱模型（U型）

Koa的中间件机制：

  1. 遇到next或者 await next就中断本中间件的代码执行，跳转到对应的下一个中间件执行期内的代码，一直到最后一个中间件
  2. 然后逆序回退到倒数第二个中间件await next 或者next下部分的代码执行，完成后继续回退，一直回退到第一个中间件await next或者next下部分的代码执行完成，中间件全部执行结束。
  3. Koa 是在所有中间件中使用 ctx.body 设置响应数据，但是并不会立即响应，而是在所有中间件执行结束后，再调用 res.end(ctx.body) 进行响应

洋葱模型：请求与响应都在最外层，中间件处理是一层层进行。

同步代码

const koa = require("koa");
const app = new koa();

// Koa执行同步代码
app.use((ctx, next) => {
  console.log("middleware1");
  ctx.msg = "aaa";
  next();

  ctx.body = ctx.msg;
});

app.use((ctx, next) => {
  console.log("middleware2");
  ctx.msg += "bbb";
  next();
});

app.use((ctx, next) => {
  console.log("middleware3");
  ctx.msg += "ccc";
});

app.listen(8080, () => {
  console.log("http://localhost:8080");
});

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

异步代码

  1. next前不加await
    如果执行的下一个中间件是一个异步函数, 那么next默认不会等到中间件的结果, 就会执行下一步操作

  2. next前加await
    koa中的next()返回Promise对象，故可以等待异步代码执行结果
    express中的next()返回void

const koa = require("koa");
const app = new koa();

function asyncFoo() {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      resolve("bbb");
    }, 1000);
  });
}

// Koa执行异步代码
app.use(async (ctx, next) => {
  console.log("middleware1");
  ctx.msg = "aaa";
  await next();

  ctx.body = ctx.msg;
});

app.use(async (ctx, next) => {
  console.log("middleware2");
  const res = await asyncFoo();

  ctx.msg += res;

  await next();
});

app.use((ctx, next) => {
  console.log("middleware3");
  ctx.msg += "ccc";
});

app.listen(8080, () => {
  console.log("http://localhost:8080");
});

在这里插入图片描述
在这里插入图片描述

蟑螂大道
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Koa项目搭建过程详细记录
08-27
下面是详细的知识点记录： 一、Koa项目搭建 Koa项目搭建过程可以使用koa-generator来生成应用，使用cnpm install -g koa-generator安装koa-generator，然后使用koa2新建项目，例如：koa2 /foo。 二、中间件介绍 ...
koa-server.zip
07-28
【描述】中涉及的知识点包括： 1. **Node.js**: JavaScript运行环境，允许开发者在服务器端使用JavaScript编写代码，提供丰富的库和框架，如Koa，以简化web开发。 2. **Koa**: Koa是Node.js的一个轻量级框架，由...
node-koa-server.rar
07-24
**可能的知识点讲解：** 1. **Node.js基础**：理解异步非阻塞I/O、事件驱动编程以及模块系统。 2. **Koa框架**：学习Koa的中间件机制、路由处理、错误处理和响应构建。 3. **Sequelize ORM**：掌握数据库模型定义、...
koa2-study:koa 学习笔记
05-18
本学习笔记将深入探讨 `Koa2` 的基础概念、安装、中间件机制、路由处理以及错误处理等关键知识点。 **1. Koa2 的安装与基本结构** 要开始使用 `Koa2`，首先需要通过 `npm` 安装： ```bash npm install koa ``` ...
koa-island
03-18
技术栈 Node.js Koa2 Sequelize requireDirectory Koa-router LinValidator jsonwebtoken lodash知识点深度JS异常处理与初步异常初步异常链与局部异常处理深入Koa中间件合并范围应用理解Node.js在Web架构中的作用Koa...
安装nodejs | npm报错
DX390609的博客
07-09 492
输入cmd打开命令提示符，输入node -v可以看到版本，说明nodejs安装成功。官网：https://nodejs.org/en/
解决npm install 安装报错记录贴
最新发布
小橙的博客
07-12 295
1，**把vscode换成最新版** 2，**确认你的node npm版本和node-scss版本是否匹配**， 尝试降低node-scss或者把node-scss升级到最高版本 3，**删掉项目代码，重新clone**， 重新安装node_modules
windows 修改 npmrc
计算机辅助工程
07-10 1004
如果你想修改当前用户的.npmrc，它通常位于用户的主目录下（例如C:\Users\你的用户名.npmrc）。使用文本编辑器（如Notepad++或者Visual Studio Code）打开.npmrc文件。.npmrc文件通常位于用户的主目录下，如果是全局配置，则位于npm的安装目录下。这将输出npm的全局前缀路径，全局.npmrc通常位于这个路径下的etc文件夹内。保存.npmrc文件后，配置更改即生效。步骤1：找到.npmrc文件的位置。找到.npmrc文件的位置。编辑.npmrc文件。
npm install失败，数据源过期
qq_50661854的博客
07-10 384
npm install失败，更换数据源后可正常安装
npm和yarn清理缓存命令
专注基础架构领域
07-12 307
yarn清除缓存1、查看yarn全局缓存目录2、清除缓存。
【前端】包管理器：npm、Yarn 和 pnpm 的全面比较
九日的博客
07-10 743
npm 是 Node.js 的默认包管理器，由 Node.js 官方维护。自 2010 年发布以来，npm 已成为 JavaScript 生态系统的核心工具，用于安装、共享和管理 JavaScript 项目的依赖包。Yarn 是由 Facebook 开发的包管理器，于 2016 年发布，旨在解决 npm 在大规模项目中的性能和一致性问题。Yarn 是对 npm 的一种改进和替代，提供了更快、更可靠的包管理体验。pnpm 是一种高效的包管理器，于 2016 年由 Zoltan Kochan 开发。
npm、cnpm、pnpm、yarn的区别
yiguoxiaohai的博客
07-10 290
npm、cnpm、pnpm、yarn的区别：npm, cnpm, pnpm, 和 yarn 都是 JavaScript 的包管理工具，用于自动化处理包的安装、更新、配置和管理。它们之间的主要区别在于它们各自的实现方式、性能优化、以及一些特有的功能。
微信小程序开发基础知识6----使用npm包
weixin_46027901的博客
07-10 526
Vant Weapp 是有赞前端团队开源的一套小程序 U 组件库，助力开发者快速搭建小程序应用。它所使用的是MIT 开源许可协议，对商业使用比较友好。官方文档地址 https://youzan.github.io/vant-weappAPI Promise化，指的是通过额外的配置，将官方提供的、基于回调函数的异步 API，升级改造为基于Promise 的异步 API，从而提高代码的可读性、维护性，避免回调地狱的问题。
npm error File “xxx\.node-gyp\18.18.2\include\node\common.gypi“, line 1
计算机辅助工程
07-10 282
报错信息提示的是 npm 在尝试构建一个模块时遇到了问题，具体是在查找文件 common.gypi 时遇到了问题。.node-gyp 是一个用于编译 Node.js 原生模块的工具，而 common.gypi 是一个配置文件，通常包含了编译 Node.js 本地代码所需的配置信息。如果以上步骤都不能解决问题，可能需要查看更详细的错误日志，或者在网上搜索具体的错误代码，以找到更具体的解决方案。确认 Node.js 和 npm 是最新版本，或者至少是与你要安装的包兼容的版本。
Windows系统上使用npm来安装和配置Yarn，在VSCode中使用
懒人w的博客
07-11 492
你可以在VSCode中配置任务来运行Yarn命令。创建或编辑项目根目录下的。下载并安装最新版本的Node.js，npm会随Node.js一起安装。你可以在VSCode的集成终端中运行Yarn命令。文件中定义脚本，并在VSCode的集成终端中运行。如果还没有安装Node.js和npm，可以从。根据提示填写项目的相关信息，完成后会生成一个。在这个配置文件中，你可以通过按下。快捷键来运行配置的任务。创建或编辑项目根目录下的。这会在启动调试前自动运行。
npm error code 1
计算机辅助工程
07-10 418
如果上述方法都不能解决问题，可以查看npm的错误日志或者在社区寻求帮助，提供更详细的错误信息可以更快地定位问题。确认要安装的包名和版本号是否正确，可以尝试清除npm缓存使用npm cache clean --force。检查package.json文件是否存在语法错误，可以使用npm json检查。尝试更新npm到最新版本使用npm install -g npm@latest。检查文件和目录权限，确保当前用户有足够权限操作。检查网络连接，确保可以访问npm仓库。权限问题，无法写入某些文件或目录。
小程序创建与项目初始化(构建 npm + 集成 Sass)
weixin_44166849的博客
07-12 405
二、创建小程序。
Vue3项目如何使用npm link本地测试组件库
wocwin的博客
07-09 319
Vue3项目如何使用npm link本地测试组件库
npm link,npm unlink调试本地开发npm包
qq_42372534的博客
07-11 390
1.在要测试的项目（package.json里的name为xxx）的根目录下下执行。
node.js知识点
09-14
Node.js是一个基于Chrome V8引擎的JavaScript运行环境，用于构建高性能、可扩展的网络应用程序。它允许我们在服务器端使用JavaScript编写和运行代码，并且具有以下重要的知识点： 1. 异步编程：Node.js采用非阻塞I/O模型，通过事件驱动和回调函数实现异步编程。这使得可以处理大量并发请求而不会阻塞应用程序。 2. 模块化：Node.js支持模块化开发，通过模块系统可以将代码分割成小的、可复用的模块。内置的模块系统提供了大量的核心模块，同时也可以使用第三方模块。 3. 事件驱动：Node.js使用事件驱动的架构，通过触发和监听事件来实现异步处理。核心模块`events`提供了事件的处理能力。 4. 文件系统操作：Node.js提供了对文件系统的操作能力，可以读写文件、创建和删除目录等。核心模块`fs`用于处理文件系统相关操作。 5. 网络通信：Node.js可以创建网络服务器和客户端，通过核心模块`http`和`https`实现HTTP和HTTPS协议的通信。 6. 第三方库和框架：Node.js拥有庞大的第三方库和框架生态系统，如Express.js、Koa.js、Socket.io等，可以加速开发过程。 7. 数据库连接：Node.js可以连接各种数据库，如MySQL、MongoDB、PostgreSQL等。通过相应的驱动程序或ORM框架，可以实现与数据库的交互。 8. 安全性：Node.js有一些内置的安全机制，如防止跨站脚本攻击（XSS）和SQL注入攻击。同时也可以使用第三方模块增强安全性。 这些是Node.js的一些重要知识点，希望对你有帮助！如果你还有其他问题，可以继续提问。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值