溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
這篇文章將為大家詳細講解有關spring boot中如何實現整合ktor，文章內容質量較高，因此小編分享給大家做個參考，希望大家閱讀完這篇文章后對相關知識有一定的了解。
背景
在用了一陣子 Ktor 之后，深感基于協程的方便，但是公司的主要技術棧是 SpringBoot，雖然已經整合了 Kotlin，但是如果有 Ktor 加持則會更加的方便。因此作了一番研究后，也完全可以實現這樣的整合了。
建立一個 starter
首先新建一個 Kotlin 項目，在其 build.gradle 內加入對 SpringBoot 和 Ktor 的依賴，并同時加入對打為 jar 包的代碼:
dependencies {
implementation "org.springframework.boot:spring-boot-starter-aop:${springBootVersion}"
implementation "io.ktor:ktor-jackson:${ktorVersion}"
compile "io.ktor:ktor-server-netty:${ktorVersion}"
compile "io.ktor:ktor-html-builder:${ktorVersion}"
testImplementation "org.springframework.boot:spring-boot-starter-test:${springBootVersion}"
testCompile "io.ktor:ktor-client-apache:${ktorVersion}"
testCompile "io.ktor:ktor-server-test-host:${ktorVersion}"
}
jar {
from {
configurations.runtime.collect { zipTree(it) }
}
}
task sourceJar(type: Jar) {
from sourceSets.main.allSource
classifier 'sources'
}對于 SpringBoot 來說，工程內的 Configuration，Controller，Module 都是必要的，因此也需要 Ktor 可以符合這些約定俗成的組件。
那么就簡單來實現一下吧，首先實現 Controller 的代碼，我們只需要讓 SpringBoot 的 Controller 支持 Ktor 的路由寫法就可以了：
interface KRouter {
fun Routing.route()
}
@ContextDsl
fun Routing.request(
path: String,
body: PipelineInterceptor<Unit, ApplicationCall>
) = route(path) { handle(body) }然后實現基礎的 Module：
interface KModule {
fun Application.defaultRegister(
useCompress: Boolean = false,
redirectHttps: Boolean = false,
headers: String = ""
) {
install(ContentNegotiation) { jackson { } }
install(PartialContent) { maxRangeCount = 10 }
if (useCompress) {
install(Compression) {
gzip { priority = 1.0 }
deflate {
priority = 10.0
minimumSize(1024)
}
}
}
if (redirectHttps) {
install(HttpsRedirect) {
sslPort = URLProtocol.HTTPS.defaultPort
permanentRedirect = true
}
}
if (headers != "") {
install(DefaultHeaders) {
headers.toCookieMap().forEach { (t, u) -> header(t, "$u") }
}
}
}
@ContextDsl
fun Application.register()
}在這個 Module 內，defaultRegister 是通過讀取 application.yml 內的配置的參數來決定的，register 是用來讓用戶覆蓋，并實現額外的模塊注冊。
最后只需要實現 Configuration 就可以了，這里實現讀取 yml 并且調用 defaultRegister 等方法：
/** * spring.ktor 配置項 * @param host 服務器主機名 * @param port 綁定端口 * @param compress 是否啟用壓縮 * @param redirectHttps 是否自動重定向到 https * @param headers 默認的請求頭 */ @ConfigurationProperties(prefix = "spring.ktor") open class KProperties( open var host: String = "0.0.0.0", open var port: Int = 8080, open var compress: Boolean = false, open var redirectHttps: Boolean = false, open var headers: String = "" )
用這個類來映射 yml 內的配置，并且在取值后即可實現對模塊，路由等的初始化:
@Configuration
@EnableConfigurationProperties(KProperties::class)
open class KConfiguration {
@Resource
private lateinit var properties: KProperties
@Bean
@ConditionalOnMissingBean
open fun engineFactory() = Netty
@Bean
@ConditionalOnMissingBean
open fun applicationEngine(
engineFactory: ApplicationEngineFactory<ApplicationEngine, out ApplicationEngine.Configuration>,
context: ApplicationContext
): ApplicationEngine {
return embeddedServer(engineFactory, host = properties.host, port = properties.port) {
val modules = context.getBeansOfType(KModule::class.java).values
val routes = context.getBeansOfType(KRouter::class.java).values
modules.forEach { it.apply {
defaultRegister(
useCompress = properties.compress,
redirectHttps = properties.redirectHttps,
headers = properties.headers)
register()
} }
routing { routes.forEach { it.apply { route() } } }
}.start()
}
@Bean
@ConditionalOnMissingBean
open fun application(
applicationEngine: ApplicationEngine,
context: ApplicationContext
): Application = applicationEngine.environment.application
}好了，一個簡單的 starter 就完成了，最后加入一些配置就可以完成:
spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.isyscore.ktor.starter.configuration.KConfiguration
然后加入對配置項的描述:
additional-spring-configuration-metadata.json
{
"properties": [
{
"name": "spring.ktor.port",
"type": "java.lang.Integer",
"description": "服務啟動時使用的端口號."
},
{
"name": "spring.ktor.host",
"type": "java.lang.String",
"description": "服務的主機IP或域名."
},
{
"name": "spring.ktor.compress",
"type": "java.lang.Boolean",
"description": "是否啟用壓縮."
},
{
"name": "spring.ktor.redirectHttps",
"type": "java.lang.Boolean",
"description": "是否自動重定向到 https."
},
{
"name": "spring.ktor.headers",
"type": "java.lang.String",
"description": "默認的請求頭，以分號隔開."
}
]
}最后我們只需要將這個 starter 發布到私有的 nexus 就完成了:
$ gradle publish
使用 starter
新建一個 SpringBoot 項目，并引入 starter：
implementation "com.rarnu:spring-boot-starter-ktor:0.0.1"
此時可以先在 yml 內加入配置項:
spring: ktor: port: 9000 compress: true headers: X-Engine=Ktor
然后來實現 Configuration，Controller 和 Module：
TestConfiguration.kt
class TestConfiguration {
@Bean
fun engineFactory() = TestEngine
}TestModule.kt
@Component
class TestModule : KModule {
override fun Application.register() {
// TODO: install custom plugins
}
}TestController.kt
@Controller
class TestController : KRouter {
override fun Routing.route() {
request("/") {
call.respond(mapOf("code" to "001", "msg" to "操作成功。"))
}
get("/hello") {
call.respondText { "OK" }
}
}
}完成后我們只需要寫一個 Application，并且啟動服務即可:
SpringKtorApplication.kt
@SpringBootApplication
open class SpringKtorApplication
fun main(args: Array<String>) {
runApplication<SpringKtorApplication>(*args)
}現在就可以編譯項目并且運行程序了：
$ gradle clean build $ java -jar test-ktor.jar
關于spring boot中如何實現整合ktor就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
