spring boot與ktor整合的實(shí)現(xiàn)方法

更新時(shí)間：2020年09月02日 08:42:55 作者：貓哥不懂技術(shù)

這篇文章主要給大家介紹了關(guān)于spring boot與ktor整合的實(shí)現(xiàn)方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

背景

在用了一陣子 Ktor 之后，深感基于協(xié)程的方便，但是公司的主要技術(shù)棧是 SpringBoot，雖然已經(jīng)整合了 Kotlin，但是如果有 Ktor 加持則會(huì)更加的方便。因此作了一番研究后，也完全可以實(shí)現(xiàn)這樣的整合了。

建立一個(gè) starter

首先新建一個(gè) Kotlin 項(xiàng)目，在其 build.gradle 內(nèi)加入對(duì) SpringBoot 和 Ktor 的依賴(lài)，并同時(shí)加入對(duì)打?yàn)?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'
}

對(duì)于 SpringBoot 來(lái)說(shuō)，工程內(nèi)的 Configuration，Controller，Module 都是必要的，因此也需要 Ktor 可以符合這些約定俗成的組件。

那么就簡(jiǎn)單來(lái)實(shí)現(xiàn)一下吧，首先實(shí)現(xiàn) Controller 的代碼，我們只需要讓 SpringBoot 的 Controller 支持 Ktor 的路由寫(xiě)法就可以了：

interface KRouter {
  fun Routing.route()
}

@ContextDsl
fun Routing.request(
 path: String, 
 body: PipelineInterceptor<Unit, ApplicationCall>
) = route(path) { handle(body) }

然后實(shí)現(xiàn)基礎(chǔ)的 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()
}

在這個(gè) Module 內(nèi)，defaultRegister 是通過(guò)讀取 application.yml 內(nèi)的配置的參數(shù)來(lái)決定的，register 是用來(lái)讓用戶(hù)覆蓋，并實(shí)現(xiàn)額外的模塊注冊(cè)。

最后只需要實(shí)現(xiàn) Configuration 就可以了，這里實(shí)現(xiàn)讀取 yml 并且調(diào)用 defaultRegister 等方法：

/**
 * spring.ktor 配置項(xiàng)
 * @param host 服務(wù)器主機(jī)名
 * @param port 綁定端口
 * @param compress 是否啟用壓縮
 * @param redirectHttps 是否自動(dòng)重定向到 https
 * @param headers 默認(rèn)的請(qǐng)求頭
 */
@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 = ""
)

用這個(gè)類(lèi)來(lái)映射 yml 內(nèi)的配置，并且在取值后即可實(shí)現(xiàn)對(duì)模塊，路由等的初始化:

@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
}

好了，一個(gè)簡(jiǎn)單的 starter 就完成了，最后加入一些配置就可以完成:

spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.isyscore.ktor.starter.configuration.KConfiguration

然后加入對(duì)配置項(xiàng)的描述:

additional-spring-configuration-metadata.json

{
 "properties": [
  {
   "name": "spring.ktor.port",
   "type": "java.lang.Integer",
   "description": "服務(wù)啟動(dòng)時(shí)使用的端口號(hào)."
  },
  {
   "name": "spring.ktor.host",
   "type": "java.lang.String",
   "description": "服務(wù)的主機(jī)IP或域名."
  },
  {
   "name": "spring.ktor.compress",
   "type": "java.lang.Boolean",
   "description": "是否啟用壓縮."
  },
  {
   "name": "spring.ktor.redirectHttps",
   "type": "java.lang.Boolean",
   "description": "是否自動(dòng)重定向到 https."
  },
  {
   "name": "spring.ktor.headers",
   "type": "java.lang.String",
   "description": "默認(rèn)的請(qǐng)求頭，以分號(hào)隔開(kāi)."
  }
 ]
}

最后我們只需要將這個(gè) starter 發(fā)布到私有的 nexus 就完成了:

$ gradle publish

使用 starter

新建一個(gè) SpringBoot 項(xiàng)目，并引入 starter：

implementation "com.rarnu:spring-boot-starter-ktor:0.0.1"

此時(shí)可以先在 yml 內(nèi)加入配置項(xiàng):

spring:
 ktor:
  port: 9000
  compress: true
  headers: X-Engine=Ktor

然后來(lái)實(shí)現(xiàn) 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" }
    }
  }
}

完成后我們只需要寫(xiě)一個(gè) Application，并且啟動(dòng)服務(wù)即可:

SpringKtorApplication.kt

@SpringBootApplication
open class SpringKtorApplication

fun main(args: Array<String>) {
  runApplication<SpringKtorApplication>(*args)
}

現(xiàn)在就可以編譯項(xiàng)目并且運(yùn)行程序了：

$ gradle clean build
$ java -jar test-ktor.jar

總結(jié)

現(xiàn)在即可使用 Ktor 的寫(xiě)法來(lái)編寫(xiě) SpringBoot 的路由了

可以使用 Ktor 協(xié)程

可以使用各種方便的 Ktor 插件

用上 Ktor 后，代碼不麻煩了，心情也好了，效率更高了 :)

到此這篇關(guān)于spring boot與ktor整合的文章就介紹到這了,更多相關(guān)spring boot與ktor整合內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

spring boot與ktor整合的實(shí)現(xiàn)方法

相關(guān)文章

最新評(píng)論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具