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

简介: Node框架 【Koa】开发框架、路由

🌟前言

哈喽小伙伴们,新的专栏 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 当真正的代理头字段将被信任时

忽略 .subdomains 的 app.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 Context 将 node 的 request 和 response 对象封装到单个对象中,为编写 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

1685516905605.png


🌟路由

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


🌟koa-router

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


🌟安装


$ npm install --save koa-router

🌟Router类

创建一个路由对象:

var router = new Router([opts])

参数:

1685516980311.png1685516996328.png

🌟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 、 post 、 delete 、 del ,而使用方法就是 router.METHOD() ,比如 router.get() 和 router.post() 。而 router.all()会匹配所有的请求方法。

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

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

Param Type Description
path String
[middleware] function 路由中间件列表
callback function 路由匹配成功回调函数


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!

目录
相关文章
|
5天前
|
Web App开发 JavaScript 前端开发
构建高效后端服务:Node.js与Express框架的实战指南
【9月更文挑战第6天】在数字化时代的潮流中,后端开发作为支撑现代Web和移动应用的核心,其重要性不言而喻。本文将深入浅出地介绍如何使用Node.js及其流行的框架Express来搭建一个高效、可扩展的后端服务。通过具体的代码示例和实践技巧,我们将探索如何利用这两个强大的工具提升开发效率和应用性能。无论你是后端开发的新手还是希望提高现有项目质量的老手,这篇文章都将为你提供有价值的见解和指导。
|
5天前
|
存储 JavaScript 安全
深入浅出Node.js后端开发
【9月更文挑战第6天】在数字化浪潮中,后端开发作为技术架构的支柱,承载着数据存储、业务逻辑处理和用户交互等核心功能。Node.js,作为一个轻量级、高效的JavaScript运行环境,已经成为许多开发者的首选工具。本文将深入探讨Node.js的基础知识、实战应用以及面临的挑战,旨在为初学者和经验丰富的开发者提供一份全面的指南。从搭建开发环境到部署应用程序,我们将一步步揭示Node.js的魅力所在,同时也会触及性能优化和安全防护等高级话题。无论你是初涉后端开发的新手,还是希望深化对Node.js的理解,这篇文章都将是你的宝贵资源。
|
7天前
|
JavaScript API 数据库
深入理解Node.js事件循环及其在后端开发中的应用
【9月更文挑战第3天】本文将深入浅出地介绍Node.js的事件循环机制,探讨其非阻塞I/O模型和如何在后端开发中利用这一特性来处理高并发请求。通过实际的代码示例,我们将看到如何有效地使用异步操作来优化应用性能。文章旨在为读者揭示Node.js在后端开发中的核心优势和应用场景,帮助开发者更好地理解和运用事件循环来构建高性能的后端服务。
|
7天前
|
Web App开发 JavaScript 前端开发
深入浅出Node.js后端开发
【9月更文挑战第3天】本文将带你走进Node.js的世界,通过深入浅出的方式,让你了解Node.js的基本概念、特性以及如何在后端开发中应用。我们将从Node.js的安装开始,逐步深入到异步编程模型、事件驱动机制等核心概念,最后通过一个简单的Web服务器示例,让你对Node.js有一个全面的认识。无论你是前端开发者还是后端开发者,只要你对Node.js感兴趣,这篇文章都将为你打开一扇新的大门。
|
11天前
|
Kubernetes JavaScript Cloud Native
深入浅出Node.js后端开发
【8月更文挑战第31天】在数字化浪潮中,云原生技术如同星辰大海中的航船,引领企业乘风破浪。本文将带你从Docker容器的基础出发,探索至Kubernetes集群的奥秘,用代码示例点亮技术的灯塔,助你在云原生的海洋中找到属于自己的航道。
|
11天前
|
JavaScript 开发者
深入理解Node.js事件循环及其在后端开发中的应用
【8月更文挑战第31天】 本文将带你走进Node.js的事件循环机制,通过浅显易懂的语言和实例代码,揭示其背后的工作原理。我们将一起探索如何高效利用事件循环进行异步编程,提升后端应用的性能和响应速度。无论你是Node.js新手还是有一定经验的开发者,这篇文章都能给你带来新的启发和思考。
|
11天前
|
开发者 Java 存储
JSF 与 CDI 携手共进,紧跟技术热点,激发开发者情感共鸣,开启高效开发新征程
【8月更文挑战第31天】JavaServer Faces (JSF) 与 Contexts and Dependency Injection (CDI) 在 Java EE 领域中紧密协作,助力开发者高效构建现代 Web 应用。JSF 凭借其丰富的组件库和页面导航功能受到青睐,而 CDI 则优雅地管理对象生命周期并实现依赖注入。两者结合,不仅简化了复杂企业应用的开发,还实现了松耦合架构,增强了代码的灵活性、可维护性和可扩展性。通过示例展示了如何利用 CDI 将业务服务对象注入 JSF Managed Bean,以及如何在不同页面间共享数据,突显了这一组合的强大功能。
26 0
|
11天前
|
大数据 数据处理 分布式计算
JSF 逆袭大数据江湖!看前端框架如何挑战数据处理极限?揭秘这场技术与勇气的较量!
【8月更文挑战第31天】在信息爆炸时代,大数据已成为企业和政府决策的关键。JavaServer Faces(JSF)作为标准的 Java Web 框架,如何与大数据技术结合,高效处理大规模数据集?本文探讨大数据的挑战与机遇,介绍 JSF 与 Hadoop、Apache Spark 等技术的融合,展示其实现高效数据存储和处理的潜力,并提供示例代码,助您构建强大的大数据系统。
21 0
|
11天前
|
Web App开发 JavaScript 前端开发
深入浅出Node.js后端开发
【8月更文挑战第31天】在数字时代的浪潮中,Node.js以其非阻塞、事件驱动的特性,成为炙手可热的后端技术。本文将带你领略Node.js的魅力所在,从搭建开发环境到实战演练,我们用浅显易懂的语言和生动的例子,让你轻松掌握Node.js后端开发的精髓。无论你是新手还是有经验的开发者,这篇文章都将为你的技术之路添砖加瓦。
|
11天前
|
SQL 缓存 JavaScript
深入浅出Node.js后端开发
【8月更文挑战第31天】本文将带你走进Node.js的世界,从基础到进阶,逐步深入探讨如何在后端开发中利用Node.js的异步特性和丰富的库来构建高效、可扩展的应用。我们将通过实际代码示例,展示如何搭建一个简单的RESTful API,并讨论最佳实践和性能优化策略。无论你是初学者还是有一定经验的开发者,这篇文章都将为你提供宝贵的知识和技能。