Kotlin и WebFlux в космосе

space.base.url = https: //megacorp.jetbrains.space
space.api.url = $ {space.base.url} / api / http

spring.security.oauth2 .client.registration.HELLO.authorization-grant-type = client_credentials
spring.security.oauth2.client.registration.HELLO.client-id = 1234
spring.security.oauth2.client.registration.HELLO .client-secret = 5678
spring.security.oauth2.client.registration.HELLO.scope = **
spring.security.oauth2.client.provider.HELLO.token-uri = $ {пробел. base.url} / oauth / токен

Обратите внимание, что имена свойств определяются модулем Spring OAuth2. Но предпоследняя часть имени каждого свойства - это идентификатор, который мы можем использовать в нашем коде, чтобы получить группу связанных настроек. В этом случае идентификатор - HELLO.

Завершение кода

Заключительный этап процесса - тот, который мы все любим. Кодировка :-)

Мы начинаем с создания типов Kotlin для представления данных, которые будет возвращать Space. Краткий синтаксис Kotlin делает его намного короче, чем эквивалентный код на более старых объектно-ориентированных языках.

class Name(var firstName: String,
           var lastName: String) {
    override fun toString() = "$firstName $lastName"
}

class Profile(var id: String,
              var username: String,
              var name: Name) {
    override fun toString() = "$id is $name with username $username"
}

class AllProfilesResponse(var next: String,
                          var totalCount: String,
                          var data: List<Profile>)

Следующая часть самая сложная. Нам нужно создать метод Bean Provider, который будет производить для нас объект WebClient. Обычно это было бы тривиально, но здесь мы должны использовать поддержку OAuth2 в Spring, чтобы гарантировать, что клиент автоматически войдет в нас.

Вот как это делается. Для ясности я поместил этот метод в отдельный класс Configuration:

@Configuration
class SpaceAppConfig {
    @Bean
    fun oauthWebClient(
          clientRegistrations: ReactiveClientRegistrationRepository,
          @Value("\${space.api.url}") baseUrl: String
        ): WebClient {

        val clientService = InMemoryReactiveOAuth2AuthorizedClientService(clientRegistrations)
        val manager = AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager(clientRegistrations, clientService)
        val oauth = ServerOAuth2AuthorizedClientExchangeFilterFunction(manager)
        oauth.setDefaultClientRegistrationId("HELLO")

        return WebClient.builder()
                .filter(oauth)
                .baseUrl(baseUrl)
                .build()
    }
}

Обратите внимание, что:

• Мы используем аннотацию Value для передачи URL-адреса экземпляра Space, определенного в файле application.properties. Тем самым избегая дублирования.
• Мы используем идентификатор HELLO, чтобы указать, какие настройки мы хотим, чтобы модуль OAuth2 использовал из файла конфигурации. В реальном решении нам может потребоваться аутентификация со многими удаленными службами, поэтому нам нужен способ поддержки произвольных групп свойств.

Теперь, когда у нас есть объект WebClient, который может взаимодействовать с экземпляром Space, мы можем написать метод, который извлекает все доступные профили:

fun retrieveSpaceProfiles(webClient: WebClient) = webClient
        .get()
        .uri("/team-directory/profiles")
        .retrieve()
        .bodyToFlux(AllProfilesResponse::class.java)
        .flatMap { Flux.fromIterable(it.data) }

Как видите, этот код использует реактивные потоки Springs, более известные как Flux. Тип WebClient ориентирован на будущее (без каламбура), когда все API будут реактивными. Это ожидалось, но пока не реализовано. В частности, WebClient предполагает, что сервер захочет отправлять нам элементы постепенно, через такой протокол, как SSE, WebSockets или RSocket.

Поскольку в данном случае это не так, нам необходимо:

• Отправьте на сервер стандартный GET-запрос
• Маршалировать данные, возвращаемые в AllProfilesResponse
• Преобразуйте список профилей внутри этого в Flux

Наконец, нам нужно расширить наш консольный метод следующим образом:

@Bean
fun console(webClient: WebClient) = CommandLineRunner {

    val header = Mono.just("Details of all the profiles:")
    val profiles = retrieveSpaceProfiles(webClient).map { "\t $it" }
    val footer = Mono.just("All done - hit return to exit")

    val values = header
            .concatWith(profiles)
            .concatWith(footer)

    values.subscribe(::println)

    //Because this is a console app we need to keep the
    // main thread alive. Otherwise Spring would exit.
    readLine()
}

Как видите, теперь метод поставщика компонентов принимает WebClient в качестве параметра. Это будет создано и передано через внедрение зависимостей. Нам нужно помнить, что действия в WebClient будут происходить асинхронно с основным потоком. Итак, войдя в мир стримов, лучше продолжать.

Мы создаем единый поток элементов (также известный как Mono) для первого и последнего сообщений, которые хотим отправить, а затем объединяем их с потоком профилей. Затем на объединенный поток можно подписаться. Нам нужно только указать обработчик событий для завершенных значений. В случае нашей простой демонстрации это просто println.

Поскольку это консольное приложение, а Spring ApplicationContext управляется в основном потоке, нам нужно поддерживать этот поток работающим до тех пор, пока не будут отображены все результаты. Очевидно, этого не было бы, если бы этот код выполнялся в контроллере WebFlux, выполняющемся в Netty.

Вот готовый код, работающий с образцом экземпляра Spring:

Выводы

Надеюсь, это руководство показало вам, что войти в экземпляр Space и удаленно управлять им не так уж сложно. Это особенно верно, когда мы используем Kotlin для удаления ненужных шаблонов и упрощения реактивного подключения. В следующем руководстве я покажу, как мы используем API в Instil для настройки пользовательских экземпляров Space для курсов, семинаров и хакатонов.