Ktor 文档

Ktor 是一个用于轻松构建异步服务器端和客户端应用程序的框架。

Ktor 服务器端入门

了解如何使用 Ktor 创建、运行和测试服务器应用程序。

Ktor 客户端入门

了解如何使用 Ktor 创建、运行和测试客户端应用程序。

Ktor 服务器端

处理请求并生成响应

通过创建任务管理器应用程序，了解 Ktor 中的路由和请求如何工作。

创建 RESTful API

了解如何使用 Ktor 构建 RESTful API。本教程涵盖了在实际示例上的设置、路由和测试。

创建网站

了解如何使用 Kotlin、Ktor 和 Thymeleaf 模板构建网站。

创建 WebSocket 应用程序

了解如何利用 WebSocket 的强大功能来发送和接收内容。

集成数据库

了解使用 Exposed SQL 库将 Ktor 服务连接到数据库版本库的过程。

服务器配置

创建、打开和运行新的 Ktor 项目

了解如何使用 Ktor 打开、运行和测试服务器应用程序。

添加服务器依赖项

了解如何将 Ktor 服务器依赖项添加到现有 Gradle/Maven 项目。

创建服务器

了解如何根据应用程序部署需求创建服务器。

代码配置

了解如何在代码中配置各种服务器参数。

文件配置

了解如何在配置文件中配置各种服务器参数。

服务器插件

插件提供常见功能，例如序列化、内容编码、压缩等。

路由

路由

路由是用于处理服务器应用程序中传入请求的核心插件。

类型安全的路由

Resources 插件允许您实现类型安全的路由。

应用程序结构

了解如何构建应用程序，以在应用程序增长时保持其可维护性。

处理请求

了解如何在路由处理器内部处理传入请求。

发送响应

了解如何发送不同类型的响应。

提供静态内容

了解如何提供静态内容，例如样式表、脚本、图像等。

插件

Ktor 服务器端中的内容协商和序列化

ContentNegotiation 插件主要有两个目的：协商客户端和服务器之间的媒体类型，以及以特定格式序列化/反序列化内容。

模板

了解如何使用 HTML/CSS 或 JVM 模板引擎构建视图。

Ktor 服务器端中的认证和授权

Authentication 插件处理 Ktor 中的认证和授权。

会话

Sessions 插件提供了一种在不同 HTTP 请求之间持久化数据的机制。

Ktor 服务器端中的 WebSocket

Websockets 插件允许您在服务器和客户端之间创建多向通信会话。

Ktor 服务器端中的服务器发送事件

SSE 插件允许服务器通过 HTTP 连接向客户端发送基于事件的更新。

Swagger UI

SwaggerUI 插件允许您为项目生成 Swagger UI。

/

OpenAPI

OpenAPI 插件允许您为项目生成 OpenAPI 文档。

自定义服务器插件

了解如何创建自己的自定义插件。

运行、调试和测试

运行

了解如何运行服务器 Ktor 应用程序。

自动重载

了解如何使用自动重载在代码更改时重新加载应用程序类。

Ktor 服务器端测试

了解如何使用专用测试引擎测试服务器应用程序。

部署

创建 Fat JAR

了解如何使用 Ktor Gradle 插件创建和运行可执行的 fat JAR。

WAR

了解如何使用 WAR 归档在 Servlet 容器中运行和部署 Ktor 应用程序。

GraalVM

了解如何在不同平台上使用 GraalVM 创建原生镜像。

Docker

了解如何将应用程序部署到 Docker 容器。

Google App Engine

了解如何将项目部署到 Google App Engine 标准环境。

Heroku

了解如何准备 Ktor 应用程序并将其部署到 Heroku。

Ktor 客户端

创建客户端应用程序

使用 Ktor 创建客户端应用程序。

创建跨平台移动应用程序

创建 Kotlin 多平台移动应用程序，并了解如何使用 Ktor 客户端发送请求和接收响应。

客户端设置

创建客户端应用程序

创建您的第一个客户端应用程序，用于发送请求和接收响应。

添加客户端依赖项

了解如何将客户端依赖项添加到现有项目。

创建和配置客户端

了解如何创建和配置 Ktor 客户端。

客户端引擎

了解处理网络请求的引擎。

客户端插件

了解提供常见功能（例如日志记录、序列化、授权等）的插件。

请求

发出请求

了解如何发出请求并指定各种请求参数：请求 URL、HTTP 方法、请求头和请求体。

类型安全的请求

了解如何使用 Resources 插件发出类型安全的请求。

默认请求

DefaultRequest 插件允许您为所有请求配置默认参数。

重试失败的请求

HttpRequestRetry 插件允许您配置失败请求的重试策略。

响应

接收响应

了解如何接收响应、获取响应体以及获取响应参数。

响应验证

了解如何根据响应的状态码验证响应。

插件

Ktor 客户端中的认证和授权

Auth 插件处理客户端应用程序中的认证和授权。

Cookies

HttpCookies 插件自动处理 Cookie，并将它们保存在存储中，以便在调用之间使用。

内容编码

ContentEncoding 插件允许您启用指定的压缩算法（例如“gzip”和“deflate”）并配置其设置。

BOM 移除器

BOMRemover 插件允许您从响应体中删除字节顺序标记（BOM）。

缓存

HttpCache 插件允许您将先前获取的资源保存在内存缓存或持久缓存中。

Ktor 客户端中的 WebSocket

Websockets 插件允许您在服务器和客户端之间创建多向通信会话。

Ktor 客户端中的服务器发送事件

SSE 插件允许客户端通过 HTTP 连接从服务器接收基于事件的更新。

自定义客户端插件

了解如何创建自己的自定义客户端插件。

测试

Ktor 客户端测试

了解如何使用 MockEngine 通过模拟 HTTP 调用来测试您的客户端。

集成

使用 Kotlin Multiplatform 构建全栈应用程序

了解如何使用 Kotlin 和 Ktor 开发跨平台全栈应用程序。

Kotlin RPC 初步

了解如何使用 Kotlin RPC 和 Ktor 创建您的第一个应用程序。