Koa 真解

news2024/12/23 10:34:15

1. 前言

昨天花费了比较多的时间将Koa的源码阅读了一遍,主要是项目中用到了Koa,为了做的更加得心应手所以先将源码看一下,总体上源码还是非常简单的,没啥难度。一方面为了总结另一方面也是为了不太看懂源码的同学们,今天我会好好的写总结下,供大家学习。

2. 基础用法

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

app.use( (ctx) => {
  ctx.body = "hello wold"
});

app.listen(3001, () => {
  console.log("服务启动成功")
})

以上简单的代码就是基于Koa的web程序。

  1. 其实大致的用法跟http.createserver保持一致的
  2. app.use中的函数 其实就是我们核心处理的逻辑
  3. .listen 表示端口监听
  4. 其实内容很简单,所以源码也比较简单,让我们来一起分析下吧。

3. koa 分析

3.1 核心文件

在这里插入图片描述

  • application Koa框架 入口级文件
  • context Koa context上下文 文件
  • request Koa request 请求文件
  • response Koa response 响应文件
  • koa-componse Koa 实现中间件串行的文件(我从别的源码中扒拉过来的)
  • delegates Koa 实现ctx 属性代理的文件(我从别的源码中扒拉过来的)

3.2 构造初期化

其实文件application.js 是我们应用的入口。我们在开发过程中导出Koa,其实就是导出这个文件。通过下图可以看出。

在这里插入图片描述

其实在Koa初期化的过程中,还是做了一些特殊的处理,接下来让我们看下。

在这里插入图片描述
源码位置

上述代码的作用在于:解决多个应用存在的问题,如下代码

const Koa = require("koa")
const app = new Koa();
const app1 = new Koa();
const app2 = new Koa();

app.context.test = 1;

如果给一个app实例上赋值,那么所有的实例都会存在相同的值,所以使用Object.create 用来进行属性隔离的。

3.3 ctx特有属性

在使用中间件的时候,我们一般都会在ctx上获取一些属性,但是你知道有哪些值的分类吗???

  1. ctx.req, ctx.res 指的是原生的http的req以及res。
  2. ctx.request, ctx.response 指的框架自定义的属性,都可以在上面获取
  3. ctx.xxx 如果从ctx上获取某些属性的话,其实是通过代理的形式来从ctx.request, ctx.response上获取的。
  4. 接下来我们看下源码实现
  createContext (req, res) {
    // 为了每次请求都会有一个新上下文内容 所以每次请求都会进行Object.create
    const context = Object.create(this.context)
    const request = context.request = Object.create(this.request)
    const response = context.response = Object.create(this.response)

    // 下面赋值的目的在于 "你中有我,我中有你"
    context.app = request.app = response.app = this
    context.req = request.req = response.req = req
    context.res = request.res = response.res = res
    request.ctx = response.ctx = context
    request.response = response
    response.request = request
    context.originalUrl = request.originalUrl = req.url
    context.state = {}
    return context
  }

上述代码中实现了你中有我,我中有你。 会将context, req, res, request, response 互相关联。

3.3.1 QA

  • 问题: 为什么在函数createContext中会有Object.create呢???
  • 解答: 每次请求过来,开始执行中间件的时候都会调用此方法,所以每次都会生成一个新的ctx。从Koa的角度来看,每个请求都应该是一个全新的,不应该跟之前的有关联。 所以如果在中间件运行过程中给ctx挂载一个属性,只能给后面的中间件使用,无法做到下次请求使用

3.4 中间件核心原理

首先我们看下 添加中间件的本质:

  use (fn) {
    // fn 必须是一个函数。 反之就会保存
    if (typeof fn !== 'function') throw new TypeError('middleware must be a function!')
    // 添加到数组中。 返回this。 可以进行use链
    this.middleware.push(fn)
    return this
  }

其实中间件use的部分无非是 将中间件函数添加到数组中。 每次都会串行执行所有的函数。那就让我们看来下 是如何串行的

return function (context, next) {
  let index = -1;
  return dispatch(0);
  function dispatch(i) {
    index = i;
    let fn = middleware[i];
    // 此处就是将返回结果包裹Promise
    return Promise.resolve(fn(context, dispatch.bind(null, i + 1)));
  }
};
  • 通过上述的代码其实我们可以看到,源码中无非是通过递归调用函数,将每个函数串行。
  • 函数fn中第二个参数dispatch,其实就是我们平常使用的next函数。 如果不手动调用next,就不会执行下一个函数。
  • 而且函数外面 我们其实是用Promise.reoslve包裹,所以内部使用async await 是一定没有错误的。不然会出现意向不到的错误。

在这里插入图片描述

3.4.1 正确以及错误的实例

  • 正确实例
app.use(async (ctx, next) => {
  console.log(1)
  await next();
  console.log(4)
})
app.use(async (ctx, next) => {
  console.log(2)
  await next();
  console.log(5)
})
app.use(async (ctx, next) => {
  console.log(3)
  await next();
  console.log(6)
})
// 1 2 3 6 5 4
  • 错误实例
app.use(async (ctx, next) => {
  console.log(1)
  await next();
  console.log(4)
})
app.use(async (ctx, next) => {
  console.log(2)
  next();
  console.log(5)
})
app.use(async (ctx, next) => {
  console.log(3)
  await next();
  console.log(6)
})
// 1 2 3 5 6 4

3.5 ctx代理

其实在使用中间件的过程中,我们可以通过ctx.headers 来获取值,那么ctx真的会定义此属性吗??? 源码我就不进行粘贴了。看下分析源码

其实只要有一定js代码基础的知道,我们可以通过proxy, ‘Object.defineProperty’, ‘__defineGetter__’ 来进行代理。

而从ctx上获取值的原理也很简单:通过代理的形式,在使用ctx.属性 的时候,从request, ‘response’ 来获取值 从而返回。设置值 是同样如此的。

4. 结论:

Koa的源码部分就分析到这里,其实都很简单没啥难度的。如果大家有什么不懂的,或是 有什么新的建议,可以在评论区及时跟我留言啊。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/165039.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

代码审计-7 ThinkPHP框架代码审计

ThinkPHP框架目录 applocation:此目录为应用目录,网站主要的文件控制器都放在applocation目录下 view:此目录在applocation下,为视图层 extend:为扩展类库目录 public:为网站对外访问目录,也就…

汽车路径尽头放一个点图像验证

文章目录前言一.图片二.大致思路2.1 小车位置识别2.2 采用轮廓算法得到路径的坐标2.3 采用断点续连的方法,将轮廓算法得到点组成直线,并寻找到最后的坐标三 缺陷四.如果大佬有其他的好的方法欢迎大佬们留言交流前言 提示:文章写完后&#xf…

坑多路难走,学数据分析转行前要知道培训机构不会说的事情

想要转行做数据分析师?那就要做好迎接坑多路难走的准备。虽然培训机构可以教你如何使用工具和算法,但它们很少会告诉你真正的行业现状。在这个竞争激烈的领域中,需要知道的不仅仅是如何处理数据,还有如何在企业中应用它。 跟着我…

CMMI之配置管理

配置管理(Configuration Management, CM)的目的是通过执行版本控制、变更控制等规程,以及使用配置管理软件,来保证所有配置项的完整性和可跟踪性。配置管理是对工作成果的一种有效保护。配置管理过程域是SPP模型的重要组成部分。本…

42. 【农产品溯源项目前后端Demo】后端-区块链连接服务

本节介绍后端代码是如何与区块链网络连接的。 1.在后端代码里fabric包 负责与区块链网络连接,并发送交易。 2.fabric.Const文件 定义 区块链网络拓扑结构,请查看注释。 public final class Const {//区块链网络中organizations的配置目录,从配置文件读取证书目录public stat…

【JavaEE】单例模式如何保证在多线程环境下线程安全高可用?

文章目录1 单例模式回顾2 饿汉式单例模式的实现3 懒汉式单例模式的实现4 单例模式的线程安全问题分析5 线程安全的懒汉式实现6 总结1 单例模式回顾 单例模式是设计模式的一种。而设计模式就是针对我们实际开发中写代码所遇到的不同场景所设立的解决方案。在笔者JavaSE阶段的文章…

Vue组件化编程需要注意的命名规则

在Vue组件化编程过程中,开始接触的不太注意命名规则,比如对于组件的内部参数命名以及在父组件中使用命名感到模糊,犯一些错误,就感觉在踩坑。 其实,这是对Vue组件化编程中的命名规则没有留意,稍加学习就可以…

java伪随机数生成器

关于随机数的基本概念 1、对随机数性质分类: 随机性:符合该性质的叫弱伪随机数。这种随机数仅可以用于一般应用,无法用在密码学,例如java中的java.util.Random类不可预测性:符合该性质的叫强伪随机数。在密码学中&am…

学习记录660@项目管理一般知识

看了项目管理一般知识这一章的知识,最开始觉得这些内容,觉得太过于书面化,比如关于什么是项目管理,都要用一段正式定义,充满了国内教育的繁琐感,但是细细品味觉得这些定义是很有道理的,并不是多…

保障接口数据安全的十种方案

视频介绍 数据加密 --主要针对网络抓包 AES 对称加密 RES 非对称加密 实践中直接使用 HTTPS 对于用户个人信息及密码等敏感信息 可额外进行加密 (如密码会进行md5加密防止撞库) 加签验签 --甄别数据在传输过程中被篡改 通常通过哈希算法 进行验证 需…

【学习笔记】【Pytorch】十、搭建CIFAR-10 model结构和Sequential的使用

【学习笔记】【Pytorch】十、搭建CIFAR-10 model结构和Sequential的使用学习地址主要内容一、CIFAR-10 model结构介绍二、代码实现学习地址 PyTorch深度学习快速入门教程【小土堆】. 主要内容 一、CIFAR-10 model结构介绍 input : 332x32,3通道32x32的图片 -->…

kubernetes学习-快速上手速查手册

目录使用k3s快速搭建k8s安装k8s dashboard使用Helm部署K8S资源k8s核心命令一切推倒重来资源创建方式NamespacePodDeploymentServiceIngressConfigMapJob数据持久化搭建NFSPV和PVC使用k3s快速搭建k8s 官网地址https://www.rancher.cn/k3s/ k3s是一个轻量级的k8s,拥…

【SpringCloud12】Gateway服务网关

1.概述简介 1.1官网 1.Zuul 1.X 2.Gateway 1.2是什么 Cloud全家桶中有个很重要的组件就是网关,在1.x版本中都是采用的Zuul网关;但在2.x版本中,zuul的升级一直跳票,SpringCloud最后自己研发了一个网关替代Zuul,那就…

uboot下识别FAT32格式的U盘报错:## Valid DOS partition found ##

1、出错的现象 (1)U盘被格式成FAT32文件系统,在Windows和Linux系统中都可以正常识别并挂载,在uboot下可以正常识别但是不能挂载; (2)在uboot下使用usb命令可以探测到U盘,但是用fatls、fatinfo等命令去挂载U盘时会失败,…

Spring MVC+Spring+Mybatis实现支付宝支付功能

本教程详细介绍了如何使用ssm框架实现支付宝支付功能。本文章分为两大部分,分别是「支付宝测试环境代码测试」和「将支付宝支付整合到ssm框架」,详细的代码和图文解释,自己实践的时候一定仔细阅读相关文档,话不多说我们开始。 本…

永磁同步电机(PMSM)磁场定向控制(FOC)转速环PI调节器参数整定

文章目录前言一、调节器的工程设计方法二、转速环PI调节器的参数整定2.1.转速环的结构框图2.2.典型II型系统2.3.转速环PI参数整定计算公式三、转速环PI调节器设计实例3.1.永磁同步电机磁场定向的转速外环电流内环双闭环控制3.2.转速环PI参数计算3.3.仿真分析总结前言 本章节采…

【2022年度总结2023新年Flag】--2022:高考失利,我奋力奔跑的大一上;2023,朝着成为更优秀的自己迈进ing

🌱博主简介:是瑶瑶子啦,一名大一计科生,目前在努力学习C进阶,JavaSE。热爱写博客~正在努力成为一个厉害的开发程序媛! ✈往期博文回顾:【C语言篇】请把这篇文章推给现在还对指针一知半解的童鞋超生动图解,详…

linux w5500 驱动及使用

1、驱动 驱动来源: a. 内核:linux内核w5500驱动,包含两个源文件w5100.c和w5100-spi.c /kernel/drivers/net/ethernet/wiznet/w5100.c kernel/drivers/net/ethernet/wiznet/w5100-spi.c kernel/drivers/net/ethernet/wiznet/w5100.h 可通过make menuconfi…

Django 入门学习

记录Django入门学习过程 1 基本环境 安装virtualenv pip3.9 install virtualenv 使用命令行创建 创建一个项目 virtualenv dj 进入虚拟环境 cd dj/bin source ./activate 进入成功后bash前面显示括号 安装 Django pip install django3.0.6 安装成功后之星django-…

创建者模式

1.单例模式 单例模式能够保证一个类只有一个实例,并且提供一个可以访问该实例的全局节点 实现步骤 类中添加一个私有静态成员变量用于保存单例实例声明一个公有静态构建方法用于获取单例实例在静态方法中实现"延迟初始化"。 该方法会在首次被调用时创建一…