Skip to content

HTTP/2 ​

代码示例:http2-netty、http2-jetty

HTTP/2 是一种现代二进制多路复用协议,旨在替代 HTTP/1.x。

Ktor 在 Jetty 和 Netty 服务器引擎上支持 HTTP/2。不过,两者存在显著差异,且每个引擎都需要额外的配置。配置好主机后,HTTP/2 支持将自动激活。

对于基于 TLS 的 HTTP/2,通常需要:

Netty 引擎支持基于明文的 HTTP/2 (h2c),且不需要 SSL 或 ALPN 配置。

配置 SSL 证书 ​

HTTP/2 本身不强制要求 TLS,但浏览器通常仅在加密连接上支持 HTTP/2。要在 TLS 上使用 HTTP/2,需要为服务器配置 SSL 证书。

进行测试时,可以使用 JDK 的 keytool 实用程序生成自签名证书:

bash
keytool -keystore test.jks -genkeypair -alias testkey -keyalg RSA -keysize 4096 -validity 5000 -dname 'CN=localhost, OU=ktor, O=ktor, L=Unspecified, ST=Unspecified, C=US'

你也可以使用 buildKeyStore() 函数以编程方式创建密钥库。

然后,在 application.conf 或 application.yaml 配置文件中配置 Ktor 使用该密钥库:

shell
ktor {
    deployment {
        port = 8080
        sslPort = 8443
    }

    application {
        modules = [ com.example.ApplicationKt.main ]
    }

    security {
        ssl {
            keyStore = test.jks
            keyAlias = testkey
            keyStorePassword = foobar
            privateKeyPassword = foobar
        }
    }
}
yaml
ktor:
    deployment:
        port: 8080
        sslPort: 8443
    application:
        modules:
            - com.example.ApplicationKt.main

    security:
        ssl:
            keyStore: test.jks
            keyAlias: testkey
            keyStorePassword: foobar
            privateKeyPassword: foobar

配置 ALPN ​

基于 TLS 的 HTTP/2 使用应用层协议协商 (Application-Layer Protocol Negotiation, ALPN) 在客户端与服务器之间协商协议。ALPN 的配置取决于具体的服务器引擎。

Jetty ​

Jetty 引擎无需额外的 Ktor 配置即可处理 ALPN。 要在 Jetty 中使用基于 TLS 的 HTTP/2:

  1. 使用 Jetty 引擎创建服务器。
  2. 配置 SSL 证书。
  3. 配置 sslPort。

有关 Jetty 与 HTTP/2 的完整可运行示例,请参阅 http2-jetty。

Netty ​

要在 Netty 中使用基于 TLS 的 HTTP/2,请添加 Netty tcnative OpenSSL 绑定。

以下示例将静态链接的 BoringSSL 实现添加到 build.gradle.kts 文件中:

kotlin
val osName = System.getProperty("os.name").lowercase()
val tcnative_classifier = when {
    osName.contains("win") -> "windows-x86_64"
    osName.contains("linux") -> "linux-x86_64"
    osName.contains("mac") -> "osx-x86_64"
    else -> null
}
dependencies {
    if (tcnative_classifier != null) {
        implementation(variantOf(libs.netty.tcnative.boringssl.static) { classifier(tcnative_classifier) })
    } else {
        implementation(libs.netty.tcnative.boringssl.static)
    }
}

tc.native.classifier 可以是 linux-x86_64、osx-x86_64 或 windows-x86_64。

有关 Netty 与 HTTP/2 的完整可运行示例,请参阅 http2-netty。

不使用 TLS 的 HTTP/2 ​

Netty 引擎支持基于明文的 HTTP/2 (h2c),允许在不使用 TLS 的情况下进行 HTTP/2 通信。 这在不需要加密的专用网络中非常有用。

客户端可以直接使用 h2c 进行连接,也可以将 HTTP/1.1 连接升级到 HTTP/2。

要启用 h2c,请在引擎配置中将 enableH2c 和 enableHttp2 选项均设置为 true:

kotlin
embeddedServer(Netty, configure = {
    connector {
        port = 8080
    }
    enableHttp2 = true
    enableH2c = true
})

你可以在同一台服务器上同时启用 h2c 和基于 TLS 的 HTTP/2。明文连接器接受 h2c 连接,而 SSL 连接器则使用基于 TLS 的 HTTP/2。