Node框架 【Koa】开发框架、路由

news2024/11/16 4:10:31

文章目录

  • 🌟前言
  • 🌟开发框架
    • 🌟应用程序
      • 🌟应用程序Koa类
      • 🌟应用对象(app)的方法
        • 🌟app.use(function)
        • 🌟app.listen(...)
      • 🌟应用程序设置
    • 🌟上下文(Context)
  • 🌟路由
    • 🌟koa-router
    • 🌟安装
    • 🌟Router类
      • 🌟router.prefix(prefix)
      • 🌟router.routes()
    • 🌟基本使用
    • 🌟请求方式
    • 🌟路由参数
    • 🌟设置路由前缀
    • 🌟路由模块化
  • 🌟写在最后

在这里插入图片描述

🌟前言

哈喽小伙伴们,新的专栏 Node 已开启;这个专栏里边会收录一些Node的基础知识和项目实战;今天我们继续带大家了解Node的框架 Koa ;让我们一起来看看吧🤘

🌟开发框架

🌟应用程序

🌟应用程序Koa类

Koa 应用程序是一个包含一组中间件函数的对象(app),在一个应用中,只需要实例化一个,它是按照类似堆栈的方式组织和执行的。

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

当我们安装了koa这个框架后,require该框架,我们可以得到一个Koa类,实例化这个类我们可以得到一个 app 实例对象。

🌟应用对象(app)的方法

方法描述
app.use(function)将给定的中间件方法添加到此应用程序。app.use() 返回 this, 因此可以链式调用.
app.listen(…)创建并返回 HTTP 服务器,将给定的参数传递给 Server#listen()。

🌟app.use(function)

app.use(function) 将给定的中间件方法添加到此应用程序。app.use() 返回 this, 因此可以链式调用.

基本使用:

app.use(async (ctx, next) => {
  const start = Date.now();
  await next();                  // 进入下一个中间件执行,执行结束后继续执行后续代码
  const ms = Date.now() - start;
  ctx.set('X-Response-Time', `${ms}ms`);
});

链式调用:

app.use(someMiddleware)
app.use(someOtherMiddleware)
app.listen(3000)

等同于

app.use(someMiddleware)
  .use(someOtherMiddleware)
  .listen(3000)

🌟app.listen(…)

Koa 应用程序不是 HTTP 服务器的1比1实现。 可以将一个或多个 Koa 应用程序安装在一起以形成具有单个HTTP服务器的更大应用程序。

创建并返回 HTTP 服务器,将给定的参数传递给 Server#listen()

以下是一个无作用的 Koa 应用程序被绑定到 3000 端口:

const Koa = require('koa');
const app = new Koa();
app.listen(3000);

这里的 app.listen(...) 方法只是以下方法的语法糖:

const http = require('http');
const Koa = require('koa');
const app = new Koa();
http.createServer(app.callback()).listen(3000);

这意味着您可以将同一个应用程序同时作为 HTTPHTTPS 或多个地址:

const http = require('http');
const https = require('https');
const Koa = require('koa');
const app = new Koa();
http.createServer(app.callback()).listen(3000);
https.createServer(app.callback()).listen(3001);

🌟应用程序设置

应用程序设置是 app 实例上的属性,目前支持如下:

  • app.env 默认是 NODE_ENV"development"
  • app.keys 签名的 cookie 密钥数组
  • app.proxy 当真正的代理头字段将被信任时
  • 忽略 .subdomainsapp.subdomainOffset 偏移量,默认为 2
  • app.proxyIpHeader 代理 ip 消息头, 默认为 X-Forwarded-For
  • app.maxIpsCount 从代理 ip 消息头读取的最大 ips, 默认为 0 (代表无限)

可以将设置传递给构造函数:

const Koa = require('koa');
const app = new Koa({ proxy: true });

或动态的:

const Koa = require('koa');
const app = new Koa();
app.proxy = true;

🌟上下文(Context)

Koa Contextnoderequestresponse 对象封装到单个对象中,为编写 Web 应用程序和 API 提供了许多有用的方法。 这些操作在 HTTP 服务器开发中频繁使用,它们被添加到此级别而不是更高级别的框架,这将强制中间件重新实现此通用功能。

每个请求都将创建一个 Context,并在中间件中作为接收器引用,或者 ctx 标识符,如以下代码片段所示:

app.use(async ctx => {
  ctx; // 这是 Context
  ctx.request; // 这是 koa Request
  ctx.response; // 这是 koa Response
});

为方便起见许多上下文的访问器和方法直接委托给它们的 ctx.requestctx.response ,不然的话它们是相同的。 例如 ctx.typectx.length 委托给 response 对象,ctx.pathctx.method 委托给 request

属性名描述
ctx.reqNode 的 request 对象.
ctx.resNode 的 response 对象.
ctx.requestkoa 的 Request 对象.
ctx.responsekoa 的 Response 对象.
ctx.state推荐的命名空间,用于通过中间件传递信息和你的前端视图。ctx.state.user = await User.find(id);
ctx.app应用程序实例引用
ctx.cookies.get(name, [options])通过 options 获取 cookie name
ctx.cookies.set(name, value, [options])通过 options 设置 cookie name 的 value
ctx.throw([status], [msg], [properties])用来抛出一个包含 .status 属性错误的帮助方法,其默认值为 500。这样 Koa 就可以做出适当地响应。

🌟路由

所谓的路由就是用来跟后端服务器进行交互的一种方式,通过不同的路径,来请求不同的资源。

🌟koa-router

koa-router koa 的一个路由中间件,它可以将请求的URL和方法(如:GET 、 POST 、 PUT 、 DELETE 等) 匹配到对应的响应程序或页面。可以把路由分发到各个文件里,起到分层的作用。

🌟安装

$ npm install --save koa-router

🌟Router类

创建一个路由对象:

var router = new Router([opts])

参数:

ParamTypeDescription
[opts]Object可选参数,路由配置对象
[opts.prefix]String设置路由前缀,之后匹配的请求都会自动添加这个前缀
[opts.methods] \Array[String]默认设置为[‘HEAD’,‘OPTIONS’,‘GET’,‘PUT’,‘PATCH’,‘POST’,‘DELETE’] 设置路由可以支持的METHOD
router对象方法
方法描述
router.prefix(prefix)为已经初始化的路由器实例设置路径前缀
router.routes()返回分配给与请求匹配的路由的路由器中间件
router.allowedMethods([options])返回单独的中间件函数, 用于处理响应选项请求, 其中包含允许的方法和运行的头部字段。
router.redirect(source, destination, [code])用可选的 30x 状态代码重定向 source 到 destination 路径。
router.use([path], middleware)给路由绑定中间件

🌟router.prefix(prefix)

为已经初始化的路由器实例设置路径前缀

router.prefix(prefix) => Router

示例:

// 初始化路由实例
const router = new Router()

// 设置路径前缀
router.prefix("/users");

router.get("/", ctx => {
  ctx.body = ctx.url;
});

router.get("/:id", ctx => {
  ctx.body = ctx.params;
});

// 注册路由中间件
app.use(router.routes()).use(router.allowedMethods());

🌟router.routes()

router.routes() => Function

返回分配给与请求匹配的路由的路由器中间件。

router.allowedMethods([options])

router.allowedMethods([options]) => Function

返回单独的中间件函数, 用于处理响应选项请求, 其中包含允许的方法和运行的头部字段。

示例:

const Koa = require("koa");
const Router = require("@koa/router");

const app = new Koa();
const router = new Router();

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

router.redirect(source, destination, [code])

router.redirect(source, destination, [code]) => Router

用可选的 30x 状态代码重定向 sourcedestination 路径。sourcedestination 都可以是路由名称。

// 初始化路由实例
const router = new Router();

router.get("/", ctx => {
  ctx.body = "Hello";
});

router.get("about", "/about", ctx => {
  ctx.body = "重定向到了这里";
});

router.redirect("/user", "about");

// 注册路由中间件
app.use(router.routes()).use(router.allowedMethods());

🌟基本使用

const Koa = require('koa');
const Router = require('koa-router');

// 实例化Koa对象 => app
const app = new Koa();

// 实例化路由对象 => router
const router = new Router();

// 对于任何请求,app将调用该异步函数处理请求:
app.use(async (ctx, next) => {
  console.log(`Process ${ctx.request.method} ${ctx.request.url}...`);
  await next();
});

router.get('/', async (ctx, next) => {
  ctx.response.body = `<h1>Hello, Koa2</h1>`;
});

router.get('/hello/:name', async (ctx, next) => {
  let name = ctx.params.name;
  ctx.response.body = `<h1>Hello, ${name}</h1>`
});

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

// 在端口3000监听:
app.listen(3000);
console.log('app started at port 3000...');

🌟请求方式

koa-router 请求方式: get put postdeletedel ,而使用方法就是 router.METHOD() ,比如 router.get() router.post() 。而 router.all()会匹配所有的请求方法。

router.METHOD(path,[middleware],callback) => Router

当匹配成功就会执行回调函数。

ParamTypeDescription
pathString
[middleware]function路由中间件列表
callbackfunction路由匹配成功回调函数
router.get('/', async (ctx, next) => {
  ctx.response.body = `<h1>Hello, Koa2</h1>`;
});

router.post('/', async (ctx, next) => {
  ctx.response.body = `<h1>Hello, Koa2</h1>`;
});

🌟路由参数

路由参数是客户端通过URL传递参数的一种方式。可以将URL中的指定参数捕获到并填充到ctx.params对象中,URL中的指定参数的名称作为ctx.params的各自的键名。

访问连接:localhost:3000/users/100

router.get("/users/:id", ctx => {
  ctx.body = ctx.params;  // {id:100}
});

🌟设置路由前缀

在实例化 Router 的时候可以设置路由前缀,之后匹配的请求都会自动添加这个前缀。

访问链接:localhost:3000/user/string

const router = new Router({ //设置前缀
    prefix: '/user'
});

//匹配链接 localhost:3000/user/string
router.get('/string', async (ctx, next) => {
    ctx.body = 'user'
})

注意:如果prefix以/结尾,则路由的注册就可以省去前缀的/了,不然会出现/重复的情况

🌟路由模块化

当项目的路由太多时,在app.js文件过多的注册路由不便于开发与维护,可以创建模块化、可安装的路由处理程序。

app 目录下创建一个名为 routes 的目录并创建 users.js文件,该文件内容如下:

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

router.prefix('/users')

router.get('/', function (ctx, next) {
  ctx.body = 'this is a users response!'
})

router.get('/bar', function (ctx, next) {
  ctx.body = 'this is a users/bar response'
})

module.exports = router

然后,在应用程序中加载路由器模块:

const users = require('./routes/users')

// ...

app.use(users.routes(), users.allowedMethods())

🌟写在最后

更多Node知识以及API请大家持续关注,尽请期待。各位小伙伴让我们 let’s be prepared at all times!

✨原创不易,还希望各位大佬支持一下!
👍 点赞,你的认可是我创作的动力!
⭐️ 收藏,你的青睐是我努力的方向!
✏️ 评论,你的意见是我进步的财富!

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

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

相关文章

电脑c盘满了变成红色了怎么清理?看看这7个方法

当C盘出现红色标识提示时&#xff0c;表示该分区的可用存储空间已经极度不足&#xff0c;可能会影响系统稳定性和性能。如果您需要清理C盘并腾出更多的存储空间&#xff0c;可以采取以下措施&#xff1a; 一、电脑c盘7种清理方法 方法1&#xff1a;清空回收站 演示机型&#…

pytorch优化器——add_param_group()介绍及示例、Yolov7 优化器代码示例

系列文章目录 基础函数2——enumerate()、hasattr()、isinstance() pytorch学习率设置——optimizer.param_groups、对不同层设置学习率、动态调整学习率。 文章目录 系列文章目录前言1、关于pytorch优化器2、add_param_group()3、pytorch优化器4、pytorch优化器测试总代码5、…

如何保证 RabbitMQ 的消息可靠性

前言 项目开发中经常会使用消息队列来完成异步处理、应用解耦、流量控制等功能。虽然消息队列的出现解决了一些场景下的问题&#xff0c;但是同时也引出了一些问题&#xff0c;其中使用消息队列时如何保证消息的可靠性就是一个常见的问题。如果在项目中遇到需要保证消息一定被…

大数据技术之Hadoop-入门

第1章 Hadoop概述 1.1 Hadoop是什么 分布式&#xff1a;多台服务器共同完成某一项任务。 1.2 Hadoop发展历史 1.3 Hadoop三大发行版本 Hadoop三大发行版本&#xff1a;Apache、Cloudera、Hortonworks。 Apache版本最原始&#xff08;最基础&#xff09;的版本&#xff0c…

【三十天精通Vue 3】第二十六天 Vue3 与 TypeScript 最佳实践

✅创作者&#xff1a;陈书予 &#x1f389;个人主页&#xff1a;陈书予的个人主页 &#x1f341;陈书予的个人社区&#xff0c;欢迎你的加入: 陈书予的社区 &#x1f31f;专栏地址: 三十天精通 Vue 3 文章目录 引言一、为什么使用TypeScript&#xff1f;二、Vue 3和TypeScript…

Golang每日一练(leetDay0055)

目录 159.至多包含两个不同字符的最长子串 Longest-substring-with-at-most-two-distinct-characters &#x1f31f;&#x1f31f; 160. 相交链表 Intersection-of-two-linked-lists &#x1f31f; &#x1f31f; 每日一练刷题专栏 &#x1f31f; Golang每日一练 专栏 …

Stable Diffusion +ChatGPT+文本转语音+剪映制作视频

目录 chatgpt免费体验入口网址 模型下载 huggingface.co civitai.com 使用Deliberate模型案例 StableDeffusion做的图片&#xff0c;chatGPT出的文案&#xff0c;微软文本转语音配的音&#xff0c;使用剪映做的视频 chatgpt免费体验入口网址 http://chat.xutongbao.top …

【Java数据结构】顺序表、队列、栈、链表、哈希表

顺序表 定义 存放数据使用数组但是可以编写一些额外的操作来强化为线性表&#xff0c;底层依然采用顺序存储实现的线性表&#xff0c;称为顺序表 代码实现 创建类型 先定义一个新的类型 public class ArrayList<E> {int capacity 10; //顺序表的最大容量int size …

UNIX环境高级编程——信号

10.1 引言 信号是软件中断&#xff1b;信号提供了一种处理异步事件的方法。 10.2 信号概念 每个信号都有一个名字&#xff0c;这些名字都以3个字符SIG开头&#xff1b;在头文件<signal.h>中&#xff0c;信号名都被定义为正整数常量&#xff08;信号编号&#xff09;&a…

架构设计-高性能篇

大家好&#xff0c;我是易安&#xff01;今天我们谈一谈架构设计中的高性能架构涉及到的底层思想。本文分为缓存架构&#xff0c;单服务器高性能模型&#xff0c;集群下的高性能模型三个部分&#xff0c;内容很干&#xff0c;希望你仔细阅读。 高性能缓存架构 在某些复杂的业务…

代码审计笔记之java多环境变量设置

在做java代码审计时&#xff0c;为了要成功运行目标环境&#xff0c;时长要对于jdk版进行切换&#xff0c;且在装多个jdk时还时长会遇到安装配置后环境变量不生效的情况&#xff0c;下文介绍&#xff1b; 1、为什么安装了新的jdk&#xff0c;有的时候环境变量中的jdk版本确还是…

如何设计出好的测试用例?

软件测试培训之如何设计出好的测试用例? 一句话概括&#xff1a;对被测软件的需求有深入的理解。 深入理解被测软件需求的最好方法是&#xff0c;测试工程师在需求分析和设计阶段就开始介入&#xff0c;因为这个阶段是理解和掌握软件的原始业务需求的最好时机。 只有真正理解了…

【VAR模型 | 时间序列】帮助文档:VAR模型的引入和Python实践(含源代码)

向量自回归 (VAR) 是一种随机过程模型&#xff0c;用于捕获多个时间序列之间的线性相互依赖性。 VAR 模型通过允许多个进化变量来概括单变量自回归模型&#xff08;AR 模型&#xff09;。 VAR 中的所有变量都以相同的方式进入模型&#xff1a;每个变量都有一个方程式&#xff…

轻松掌握在已有K8s环境上安装KubeSphere

官方文档地址&#xff1a;https://kubesphere.io/zh/docs/v3.3/quick-start/minimal-kubesphere-on-k8s/ 1、基于已有K8s环境上安装KubeSphere 1、前置环境 1、安装nfs及动态存储类PV/PVC 安装默认存储类型&#xff0c;这里使用nfs&#xff0c;关于nfs的安装在PV/PVC的文章…

出道的第八年,依然AI着......

今天&#xff0c;是数说故事8周岁的生日 8年&#xff0c;和您一起走过2,922天 8年&#xff0c;我们对AI的探索从未停止 8年&#xff0c;我们将数据的热爱进行到底 因为热“AI” 我们与您的故事有了连接 8年的连接&#xff0c;我们与您也擦出了无数花火 我们将每一个闪烁的…

Optional参数类使用

目录 介绍 使用 常用方法 是否为空 对象比较 Optional 是一个对象容器&#xff0c;具有以下两个特点&#xff1a; 使用 1. 创建 2. 获取&#xff1a; 3. 判断&#xff1a; 4. 过滤&#xff1a; 5. 映射&#xff1a; 介绍 在使用值判断的时候使用方便 使用 import j…

linux系统TP-ti,tsc2046外设调试

一、整体调试思路 tp外设属于比较常见且比较简单的外设&#xff0c;今天以ti,tsc2046这款为例简述下tp外设的调试。 整体思路 1、配置设备树----驱动调试的device部分 2、tp驱动编译及匹配—driver部分 3、驱动整体调试 二、配置设备树 对于ti,tsc2046我们可以参考内核Docum…

复杂美科技多项区块链技术产品被纳入《2021-2022区块链产业图谱》区块链蓝皮书

2022年9月3日&#xff0c;由中国社会科学院社会科学文献出版社、北京金融科技产业联盟指导&#xff0c;北京区块链技术应用协会&#xff08;BBAA&#xff09;主办的 “Web 3.0发展趋势高峰论坛暨2022元宇宙、区块链、金融科技蓝皮书发布会” 在服贸会上成功举办。 大会隆重发布…

身份鉴别解读与技术实现分析(1)

6.1.4.1 身份鉴别 本项要求包括: a) 应对登录的用户进行身份标识和鉴别,身份标识具有唯一性,身份鉴别信息具有复杂度要求并定期更换; b) 应具有登录失败处理功能,应配置并启用结束会话、限制非法登录次数和当登录连接超时自动退出等相关措施 在等级保护体系中,级别越高…

数字时代下网络安全的重要性

在数字时代&#xff0c;网络安全比以往任何时候都更加重要。 随着我们越来越依赖技术来存储和传输敏感信息&#xff0c;网络攻击的风险也在增加。网络攻击可能来自世界任何地方&#xff0c;对个人和企业都可能是毁灭性的。 AkamaiTechnologies首席安全官BoazGelbord在最近的一…