从 Express 迁移到 Ktor
在本指南中,我们将了解在基本场景下如何将 Express 应用程序迁移到 Ktor:从生成应用程序、编写您的第一个应用程序,到创建用于扩展应用程序功能的中间件。
生成应用
| Express | 您可以使用 shell |
| Ktor | Ktor 提供了以下几种生成应用程序骨架的方式:
有关详细说明,请参阅创建、打开和运行新的 Ktor 项目了解如何使用 Ktor 打开、运行和测试服务器应用程序。教程。 |
Hello world
在本节中,我们将了解如何创建最简单的服务器应用程序,该程序接收 GET 请求并响应预定义的纯文本。
| Express | 以下示例展示了启动服务器并侦听端口 3000 连接的 Express 应用程序。 javascript 有关完整示例,请参阅 1_hello 项目。 |
| Ktor | 在 Ktor 中,您可以使用 embeddedServer 函数在代码中配置服务器参数并快速运行应用程序。 kotlin 有关完整示例,请参阅 1_hello 项目。 您还可以在采用 HOCON 或 YAML 格式的外部配置文件中指定服务器设置。 |
请注意,上述 Express 应用程序添加了 Date、X-Powered-By 和 ETag 响应头,可能如下所示:
Date: Fri, 05 Aug 2022 06:30:48 GMT
X-Powered-By: Express
ETag: W/"c-Lve95gjOVATpfV8EL5X4nxwjKHE"要在 Ktor 的每个响应中添加默认的 Server 和 Date 标头,您需要安装 DefaultHeaders必需依赖项:io.ktor:ktor-server-default-headers 插件。ConditionalHeaders所需依赖项:io.ktor:ktor-server-conditional-headers 插件可用于配置 Etag 响应头。
提供静态内容
在本节中,我们将了解如何在 Express 和 Ktor 中提供静态文件,例如图像、CSS 文件和 JavaScript 文件。假设我们有一个包含主 index.html 页面和一组关联资源的 public 文件夹。
public
├── index.html
├── ktor_logo.png
├── css
│ └──styles.css
└── js
└── script.js| Express | 在 Express 中,将文件夹名称传递给 express.static 函数。 javascript 有关完整示例,请参阅 2_static 项目。 |
| Ktor | 在 Ktor 中,使用 kotlin 有关完整示例,请参阅 2_static 项目。 |
在提供静态内容时,Express 会添加几个响应头,可能如下所示:
Accept-Ranges: bytes
Cache-Control: public, max-age=0
ETag: W/"181-1823feafeb1"
Last-Modified: Wed, 27 Jul 2022 13:49:01 GMT要在 Ktor 中管理这些标头,您需要安装以下插件:
Accept-Ranges :PartialContent所需依赖项:io.ktor:ktor-server-partial-content
Cache-Control :CachingHeaders必需依赖项:io.ktor:ktor-server-caching-headers
ETag 与 Last-Modified : ConditionalHeaders所需依赖项:io.ktor:ktor-server-conditional-headers
路由
路由路由是处理服务器应用程序中传入请求的核心插件。允许处理发送到特定端点的传入请求,该端点由特定的 HTTP 请求方法(GET、POST 等)和路径定义。以下示例展示了如何处理发送到 / 路径的 GET 和 POST 请求。
| Express | javascript 有关完整示例,请参阅 3_router 项目。 |
| Ktor | kotlin 请参阅接收请求,了解如何接收 有关完整示例,请参阅 3_router 项目。 |
以下示例演示了如何按路径对路由处理程序进行分组。
| Express | 在 Express 中,您可以使用 javascript 有关完整示例,请参阅 3_router 项目。 |
| Ktor | Ktor 提供了 kotlin 有关完整示例,请参阅 3_router 项目。 |
这两个框架都允许您将相关路由分组在单个文件中。
| Express | Express 提供了 javascript javascript 有关完整示例,请参阅 3_router 项目。 |
| Ktor | 在 Ktor 中,一种常见的模式是在 kotlin kotlin 有关完整示例,请参阅 3_router 项目。 |
除了将 URL 路径指定为字符串外,Ktor 还支持实现类型安全路由Resources 插件允许您实现类型安全路由。。
路由与查询参数
本节将向我们展示如何访问路由参数和查询参数。
路由(或路径)参数是命名的 URL 片段,用于捕获在 URL 对应位置指定的值。
| Express | 要在 Express 中访问路由参数,可以使用 javascript 有关完整示例,请参阅 4_parameters 项目。 |
| Ktor | 在 Ktor 中,路由参数使用 kotlin 有关完整示例,请参阅 4_parameters 项目。 |
下表比较了如何访问查询字符串的参数。
| Express | 要在 Express 中访问路由参数,可以使用 javascript 有关完整示例,请参阅 4_parameters 项目。 |
| Ktor | 在 Ktor 中,路由参数使用 kotlin 有关完整示例,请参阅 4_parameters 项目。 |
发送响应
在前面的章节中,我们已经了解了如何响应纯文本内容。下面我们来看看如何发送 JSON、文件和重定向响应。
JSON
| Express | 要在 Express 中发送带有适当内容类型的 JSON 响应,请调用 javascript 有关完整示例,请参阅 5_send_response 项目。 |
| Ktor | 在 Ktor 中,您需要安装 ContentNegotiationContentNegotiation 插件有两个主要用途:在客户端和服务器之间协商媒体类型,以及以特定格式序列化/反序列化内容。 插件并配置 JSON 序列化器: kotlin 要将数据序列化为 JSON,您需要创建一个带有 kotlin 然后,您可以使用 kotlin 有关完整示例,请参阅 5_send_response 项目。 |
文件
| Express | 要在 Express 中响应一个文件,请使用 javascript 有关完整示例,请参阅 5_send_response 项目。 |
| Ktor | Ktor 提供了 kotlin 有关完整示例,请参阅 5_send_response 项目。 |
Express 应用程序在响应请求提供文件时会添加 Accept-Ranges HTTP 响应头。服务器使用此标头声明其支持客户端的部分请求以进行文件下载。在 Ktor 中,您需要安装 PartialContent所需依赖项:io.ktor:ktor-server-partial-content 插件来支持部分请求。
文件附件
| Express |
javascript 有关完整示例,请参阅 5_send_response 项目。 |
| Ktor | 在 Ktor 中,您需要手动配置 Content-Disposition 标头以将文件作为附件传输: kotlin 有关完整示例,请参阅 5_send_response 项目。 |
重定向
| Express | 要在 Express 中生成重定向响应,请调用 javascript 有关完整示例,请参阅 5_send_response 项目。 |
| Ktor | 在 Ktor 中,使用 kotlin 有关完整示例,请参阅 5_send_response 项目。 |
模板
Express 和 Ktor 都支持通过模板引擎来处理视图。
| Express | 假设我们在 views 文件夹中具有以下 Pug 模板: 要使用此模板进行响应,请调用 javascript 有关完整示例,请参阅 6_templates 项目。 |
| Ktor | Ktor 支持多种 JVM 模板引擎了解如何使用 HTML/CSS 或 JVM 模板引擎构建的视图。,例如 FreeMarker、Velocity 等。例如,如果您需要使用放置在应用程序资源中的 FreeMarker 模板进行响应,请安装并配置 kotlin 有关完整示例,请参阅 6_templates 项目。 |
接收请求
本节将展示如何接收不同格式的请求体。
原始文本
以下 POST 请求向服务器发送文本数据:
POST http://0.0.0.0:3000/text
Content-Type: text/plain
Hello, world!让我们看看如何在服务器端将此请求的请求体作为纯文本接收。
| Express | 要在 Express 中解析传入的请求体,您需要添加 javascript 在 javascript 有关完整示例,请参阅 7_receive_request 项目。 |
| Ktor | 在 Ktor 中,您可以使用 kotlin 有关完整示例,请参阅 7_receive_request 项目。 |
JSON
在本节中,我们将了解如何接收 JSON 请求体。以下示例展示了一个请求体中带有 JSON 对象的 POST 请求:
POST http://0.0.0.0:3000/json
Content-Type: application/json
{
"type": "Fiat",
"model" : "500",
"color": "white"
}| Express | 要在 Express 中接收 JSON,请使用 javascript 有关完整示例,请参阅 7_receive_request 项目。 |
| Ktor | 在 Ktor 中,您需要安装 ContentNegotiationContentNegotiation 插件有两个主要用途:在客户端和服务器之间协商媒体类型,以及以特定格式序列化/反序列化内容。 插件并配置 kotlin 要将接收到的数据反序列化为对象,您需要创建一个数据类: kotlin 然后,使用接受该数据类作为参数的 kotlin 有关完整示例,请参阅 7_receive_request 项目。 |
URL 编码
现在让我们看看如何接收使用 application/x-www-form-urlencoded 类型发送的表单数据。下面的代码片段展示了一个带有表单数据的 POST 请求示例:
POST http://localhost:3000/urlencoded
Content-Type: application/x-www-form-urlencoded
username=JetBrains&email=example@jetbrains.com&password=foobar&confirmation=foobar| Express | 与纯文本和 JSON 一样,Express 需要 javascript 有关完整示例,请参阅 7_receive_request 项目。 |
| Ktor | 在 Ktor 中,使用 kotlin 有关完整示例,请参阅 7_receive_request 项目。 |
原始数据
下一个用例是处理二进制数据。以下请求向服务器发送了一个带有 application/octet-stream 的 PNG 图像:
POST http://localhost:3000/raw
Content-Type: application/octet-stream
< ./ktor_logo.png| Express | 要在 Express 中处理二进制数据,请将解析器类型设置为 javascript 有关完整示例,请参阅 7_receive_request 项目。 |
| Ktor | Ktor 提供了 kotlin 有关完整示例,请参阅 7_receive request 项目。 |
多部分 (Multipart)
在最后一部分中,我们来看看如何处理 multipart 请求体。以下 POST 请求使用 multipart/form-data 类型发送附带描述的 PNG 图像:
POST http://localhost:3000/multipart
Content-Type: multipart/form-data; boundary=WebAppBoundary
--WebAppBoundary
Content-Disposition: form-data; name="description"
Content-Type: text/plain
Ktor logo
--WebAppBoundary
Content-Disposition: form-data; name="image"; filename="ktor_logo.png"
Content-Type: image/png
< ./ktor_logo.png
--WebAppBoundary--| Express | Express 需要一个单独的模块来解析多部分数据。在以下示例中,使用 multer 将文件上传到服务器: javascript 有关完整示例,请参阅 7_receive_request 项目。 |
| Ktor | 在 Ktor 中,如果您需要接收作为多部分请求一部分发送的文件,请调用 kotlin 有关完整示例,请参阅 7_receive_request 项目。 |
创建中间件
最后我们要看的是如何创建用于扩展服务器功能的中间件。以下示例展示了如何使用 Express 和 Ktor 实现请求日志记录。
| Express | 在 Express 中,中间件是通过 javascript 有关完整示例,请参阅 8_middleware 项目。 |
| Ktor | Ktor 允许您使用自定义插件了解如何创建您自己的自定义插件。来扩展其功能。以下代码示例展示了如何处理 kotlin 有关完整示例,请参阅 8_middleware 项目。 |
后续步骤
本指南中仍有许多用例未涉及,例如会话管理、授权、数据库集成等。对于其中的大多数功能,Ktor 都提供了专用的插件,可以将其安装在应用程序中并根据需要进行配置。要继续您的 Ktor 之旅,请访问 Learn 页面,其中提供了一系列分步指南和开箱即用的示例。
