Open AIDoc

简体中文

繁體中文
日本語
한국어

简体中文

繁體中文
日本語
한국어

Appearance

Azure App Service ​

本教程将展示如何构建、配置并将您的 Ktor 应用程序部署到 Azure App Service。

前提条件 ​

在开始本教程之前，您需要准备以下各项：

创建示例应用程序 ​

按照创建、打开和运行新的 Ktor 项目中的说明创建一个示例应用程序。此示例展示的代码和命令基于以下项目：embedded-server 和 engine-main。

上述教程提供了两种配置应用程序的方式：直接在代码中指定值，或使用配置文件。在这两种情况下，关键配置都是服务器监听传入请求的端口。

设置应用程序 ​

步骤 1：设置端口 ​

在 Azure App Service 中，环境变量 PORT 包含用于传入请求的端口号。根据您在配置 Ktor 服务器中创建应用的方式，您需要更新代码以在以下两个位置之一读取此环境变量：

  • 如果您使用的是代码内端口配置示例，则可以通过 System.getenv() 读取 PORT 环境变量，并通过 .toIntOrNull() 解析为整数。打开 Application.kt 文件，并如下所示更改端口号：
kotlin
fun runBasicServer() {
   val port = System.getenv("PORT")?.toIntOrNull() ?: 8080
   embeddedServer(Netty, port = port) {
       // ...
   }.start(wait = true)
}
 ```
*   如果服务器配置是**在配置文件** `application.conf` 中定义的，请更新它以读取 `PORT` 环境变量，如下例所示：

ktor { deployment { port = ${PORT:8080} } }



### 步骤 2：添加插件 {id="plugins"}
打开 `build.gradle.kts` 文件，并将以下行添加到 `plugins` 部分：
```kotlin
plugins {
 application
 kotlin("jvm")
 id("io.ktor.plugin") version "3.3.2" // ADDED
 id("com.microsoft.azure.azurewebapp") version "1.10.0" // ADDED
}

io.ktor.plugin 将提供用于创建 fat JAR 的任务，而 Azure WebApp Plugin for Gradle 将用于轻松地在 Azure 中创建所有必需的资源。

确保在 application 部分中定义了 mainClass，以便您的 fat JAR 有一个明确的入口点：

kotlin
application {
    mainClass.set("com.example.ApplicationKt")
}

如果您使用 engine-main 模板创建项目，则主类将如下所示：

kotlin
application {
    mainClass.set("io.ktor.server.netty.EngineMain")
}

步骤 3：配置 ​

如果您已经创建了一个想要部署到的 App Service 中的 Java Web 应用，则可以跳过此步骤。

否则，将以下条目添加到 build.gradle.kts 文件末尾，以便 Azure Webapp Plugin 为您创建一个：

kotlin
 // Rename the fat JAR to the name that the deploy task expects
ktor {
    fatJar {
        archiveFileName.set("embedded-server.jar")
    }
}

// Disable the `jar` task that Azure Plugin would normally run
// to deploy the archive created by the `fatJar` task instead
tasks.named("jar") {
    enabled = false
}

// Ensure the deploy task builds the fat JAR first
tasks.named("azureWebAppDeploy") {
    dependsOn("buildFatJar")
}

// Azure Webapp Plugin configuration
azurewebapp {
  subscription = "YOUR-SUBSCRIPTION-ID"
  resourceGroup = "RESOURCE-GROUP-NAME"
  appName = "WEBAPP-NAME"
  pricingTier = "YOUR-PLAN" // e.g. "F1", "B1", "P0v3", etc.
  region = "YOUR-REGION" // e.g. "westus2"
  setRuntime(closureOf<com.microsoft.azure.gradle.configuration.GradleRuntimeConfig> {
    os("Linux") // Or "Windows"
    webContainer("Java SE")
    javaVersion("Java 21")
  })
  setAuth(closureOf<com.microsoft.azure.gradle.auth.GradleAuthConfig> {
    type = "azure_cli"
  })
}

有关可用配置属性的详细描述，请参阅 Webapp 配置文档。

  • pricingTier（服务计划）的值可以在 Linux 和 Windows 上找到。
  • region 的值列表可以通过以下 Azure CLI 命令获取：az account list-locations --query "[].name" --output tsv，或者在 产品可用性表 中搜索“App Service”。

部署应用程序 ​

部署到新的 Web 应用 ​

Azure Web App Deploy 插件使用的身份验证方法是 Azure CLI。如果您尚未登录，请使用 az login 登录一次并按照说明操作。

最后，通过运行 azureWebAppDeploy 任务来部署应用程序，该任务会先构建 fat JAR，然后进行部署：

此任务将创建资源组、计划和 Web 应用，然后部署 fat JAR。部署成功后，您应该会看到类似以下的输出：

text
> Task: :embedded-server:azureWebAppDeploy
Auth type: AZURE_CLI
Username: some.username@example.com
Subscription: Some Subscription(13936cf1-cc18-40be-a0d4-177fe532b3dd)
Start creation Resource Group(resource-group) in region (Some Region)
Resource Group (resource-group) is successfully created.
Start creating App Service plan (asp-your-webapp-name)...
App Service plan (asp-your-webapp-name) is successfully created
Start creating Web App(your-webapp-name)...
Web App(your-webapp-name) is successfully created
Trying to deploy artifact to your-webapp-name...
Deploying (C:\docs\ktor-documentation\codeSnippets\snippets\embedded-server\build\libs\embedded-server.jar)[jar] ...
Application url: https://your-webapp-name.azurewebsites.net

部署完成后，您应该能够通过上述 URL 看到您新的 Web 应用正在运行。

部署到现有 Web 应用 ​

如果您在 Azure App Service 中已经有一个现有的 Java Web 应用，首先通过执行 Ktor 插件提供的 buildFatJar 任务来构建 fat JAR：

然后，使用 Azure CLI 的以下命令部署之前创建的 fat JAR：

bash
az webapp deploy -g RESOURCE-GROUP-NAME -n WEBAPP-NAME --src-path ./path/to/embedded-server.jar --restart true

此命令将上传 JAR 文件并重启您的 Web 应用。一段时间后，您应该会看到部署结果：

text
Deployment type: jar. To override deployment type, please specify the --type parameter. Possible values: war, jar, ear, zip, startup, script, static
Initiating deployment
Deploying from local path: ./snippets/embedded-server/build/libs/embedded-server.jar
Warming up Kudu before deployment.
Warmed up Kudu instance successfully.
Polling the status of sync deployment. Start Time: 2025-09-07 00:07:14.729383+00:00 UTC
Status: Build successful. Time: 5(s)
Status: Starting the site... Time: 23(s)
Status: Starting the site... Time: 41(s)
Status: Site started successfully. Time: 44(s)
Deployment has completed successfully
You can visit your app at: http://your-app-name.some-region.azurewebsites.net

Copyright © 2025 Open AIDoc.