Skip to content

dsl.md

Latest commit

 

History

History
127 lines (86 loc) · 9.32 KB

dsl.md

File metadata and controls

127 lines (86 loc) · 9.32 KB
Raw

Главная страница репозитория

MVI DSL

Для упрощения работы с MVI-модулем и уменьшения количества шаблонного кода, было решено добавить DSL-методы для трансформации потока потока событий, проходящего через middleware.

Начало работы

Для того, чтобы начать работать с DSL, необходимо унаследовать Middleware, использующийся в проекте, от BaseDslRxMiddleware, и переопределить метод transform(eventStream) следующим образом:

override fun transform(eventStream: Observable<ComplexListEvent>): Observable<out ComplexListEvent> {
    return transformations(eventStream) {
        //Здесь будут перечислены возможные трансформации
    }

Трансформация потока (для Middleware<T>) - это Observable<out T>, то есть, Observable с обновленным событием.

Добавление трансформаций

Для того, чтобы добавить эти трансформации, нужно вызвать либо метод addAll(vararg transformations: Observable<T>) либо унарный плюс: +Observable<T> для добавления по очереди.

Фильтрация по классу

Трансформации можно применять только к событиям определенных классов со следующим синтаксисом:

<Класс события> <тип трансформации> <трансформация>

Например, с помощью записи ниже, мы обновляем данные, как только получаем событие Reload:

Reload::class eventMapTo { loadData() }

Типы трансформаций

  • react: Реакция на событие типа T. Следует использовать, когда нам не нужно трансформировать T в поток данных, а нужно просто выполнить какое-то действие (например, для открытия экрана или отправки аналитики).

    Использование:

        ButtonClicked::class reactTo { event -> 
        analyticsService.sendEvent(TEXT_CHANGED, event.text) 
    }

  • map: Маппинг события типа T в другой тип. Используется, когда нам нужно запустить событие при получении другого события, например, когда при получении события ButtonClicked нужно эмитить событие OpenSelectPhotoDialog.

    Использование:

    ButtonClicked::class mapTo { OpenSelectPhotoDialog() }

  • eventMap: Маппинг события типа T в Observable, где R - подтип эвента, используемого на экране. Используется, когда нам нужно трансформировать событие в поток (аналог flatMap), например, когда при получении события ButtonClicked нужно начать загрузку данных с i-слоя.

    Использование:

        ReloadBtnClicked::class eventMapTo { 
        interactor.loadData()
            .io()
            .asRequest(LoadDataEvent())
    }

  • streamMap: Маппинг Observable в Observable, где R - подтип эвента, используемого на экране. Используется, когда eventMap недостаточно, и на цепочку нужно навесить модификаторы от Observable. Например, при получении события TextChanged добавить debounce и distinctUntilChanged перед отправкой запроса. Использование:

        TextChanged::class streamMapTo { textChangedObservable -> 
        textChangedObservable
            .map { it.text } 
            .debounce(300L, TimeUnit.MILLISECONDS)
            .distinctUntilChanged()
            .map { TextChangedDebounced(it) } 
        }

    Либо

Middleware cо списком трансформаций может выглядеть следующим образом:

   override fun transform(eventStream: Observable<ComplexListEvent>): Observable<out ComplexListEvent> {
    return transformations(eventStream) {
        //Здесь будут перечислены возможные трансформации
    }

Добавление новых типов трансформаций

Если вам не хватает типов трансформаций, расположенных в базовом классе EventTransformerList, вы можете добавить новые.

Для этого, нужно расширить базовый класс трансформации - StreamTransformer, и описать там нужную логику, расширить класс EventTransformerList для добавления методов обработки новой трансформации, и расширить класс DslRxMiddleware с указанием в параметре типа новый класса.

Middleware Builders

Так же в модуле доступны интерфейсы для Middleware, позволяющие добавлять новую логику через их наследование:

  • FlatMapMiddleware: Middleware, которое поддерживает простейшее преобразование событий (похожее на flatMap из RxJava) - преобразовывает event типа T в Observable, и содержит единственный метод:

    fun flatMap(event: T): Observable<out T>

  • LifecycleMiddleware: Middleware, реагирующий на события жизненного цикла родительского экрана. Содержит функции onCreate()...onDestroy() : Observable<T>, которые вызываются в момент получения коллбеков ЖЦ. Для того, чтобы класс получал эти события, необходимо, чтобы связанный с ним EventHub реализовывал интерфейс LifecycleEventHub.

Пример реального метода с трансформациями

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

override fun transform(eventStream: Observable<ComplexListEvent>): Observable<out ComplexListEvent> {
    return transformations(eventStream) {
        addAll(
                onCreate() eventMap { loadData() },
                mapPagination(FilterNumbers()) { sh.list.canGetMore() },
                eventMap<SwipeRefresh> { loadData(isSwr = true) },
                SwipeRefresh::class eventMapTo { loadData(isSwr = true) },
                LoadNextPage::class eventMapTo { loadData(sh.list.data.nextPage) },
                Reload::class eventMapTo { loadData() },
                QueryChanged::class streamMapTo (::debounceQuery),
                QueryChangedDebounced::class mapTo { FilterNumbers() }
        )
    }