"Marshroute: удобный и расширяемый роутинг в iOS-приложении" Тимур Юсипов (Avito)

Удобный и расширяемый
роутинг в iOS-приложении
Юсипов Тимур

Историческая справка
(2011 .. 2014) Outsource
(2014 .. 2016) In-house
VIPER
121 662
70 187
lines of code
22.09.2016
29.05.2016
39 051
24 334
lines of code

Введем понятие Router
Как будет проходить презентация?
Рассмотрим необычные задачи Routing’а
Попробуем написать Router
Адаптируем Router под iPad
Сформулируем общие архитектурные правила Routing’а
Посмотрим демо

Что такое Module?
Router
View
Controller
MVC
Model View View Interactor
Router
Presenter Entity
VIPER
RouterRouter
View
Controller
MVC
Model View View InteractorPresenter Entity
VIPER

Что такое DeepLink?
ru.navigation.demo://categories?categoryId=182
ru.navigation.demo://authorize
ru.navigation.demo://search?categoryId=182&query=mazda

final class ViewController: UIViewController {
@objc private func onAuthorizationButtonTap(sender: UIBarButtonItem) {
let authorizationController = AuthorizationViewController()
let navigationController = UINavigationController(
rootViewController: authorizationController
)
presentViewController(navigationController, animated: true, completion: nil)
}
}
Что не так с этим кодом?
)
}
}
)
}
}
)
}
}
)
}
}
Добавим слой Router

protocol RouterProtocol: class {
func showAuthorization()
}
Пробуем написать Router
}
final class RouterProtocolImpl: RouterProtocol {
weak var navigationController: UINavigationController?
weak var rootViewController: UIViewController?
func showAuthorization() {
let router = AuthorizationRouterImpl()
router.navigationController = navigationController
router.rootViewController = authorizationController
authorizationController.router = router
navigationController?.pushViewController(authorizationController, animated: true)
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
Добавим слой Assembly

Добавляем слой Assembly
protocol AssemblyFactory: class {
func authorizationAssembly() -> AuthorizationAssembly
}
}
protocol AuthorizationAssembly: class {
func module(navigationController: UINavigationController) -> UIViewController
}
}
protocol AuthorizationAssembly: class {
func module(navigationController: UINavigationController) -> UIViewController
}

Пробуем написать Router c Assembly
}
let assemblyFactory: AssemblyFactory
}
}
}
}
}
}
if let navigationController = navigationController {
let authorizationAssembly = assemblyFactory.authorizationAssembly()
let authorizationController = authorizationAssembly.module(navigationController)
navigationController.pushViewController(authorizationController, animated: true)
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
Добавим
базовый класс

}
}
}
}
Пробуем написать Router c Assembly
Добавим
базовый класс
Пробуем написать Router с базовым классом
}
final class RouterProtocolImpl: BaseRouter, RouterProtocol {
}
}
}
}
}
}
}
}
}
}
}
Вынесем в базовый
класс

}
}
}
}
Вынесем в базовый
класс
Пробуем написать Router с базовым классом
}
pushViewControllerDerivedFrom { navigationController -> UIViewController in
return authorizationController
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
presentModalViewControllerDerivedFrom { navigationController -> UIViewController in
}
}
}
Хороший фасад

Базовый класс
class BaseRouter {
func pushViewControllerDerivedFrom(deriveViewController: UINavigationController -> UIViewController) {
let viewController = deriveViewController(navigationController)
navigationController.pushViewController(viewController, animated: true)
}
}
}
class BaseRouter {
func pushViewControllerDerivedFrom(deriveViewController: UINavigationController -> UIViewController) {
}
}
}
Что делать
с Master-detail модулем?
Для Master-detail нужен второй
навигационный контроллер

Второй базовый класс
class BaseMasterDetailRouter {
weak var masterNavigationController: UINavigationController?
weak var detailNavigationController: UINavigationController?
func pushMasterViewControllerDerivedFrom(deriveViewController: UINavigationController -> UIViewController) {
if let navigationController = masterNavigationController {
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
Добавим структурку
для передачи
всех нужных роутеру
параметров

Добавляем структурки
struct RouterSeed {
let navigationController: UINavigationController
}
struct RouterSeed {
let navigationController: UINavigationController
}
struct MasterDetailRouterSeed {
let masterNavigationController: UINavigationController
let detailNavigationController: UINavigationController
}
Теперь рефакторить
будет удобней

Улучшенный фасад
pushViewControllerDerivedFrom { routerSeed -> UIViewController inpushViewControllerDerivedFrom { routerSeed -> UIViewController in
pushMasterViewControllerDerivedFrom { routerSeed -> UIViewController in
pushViewControllerDerivedFrom { routerSeed -> UIViewController in
setDetailViewControllerDerivedFrom { routerSeed -> UIViewController in
presentModalNavigationControllerWithRootViewControllerDerivedFrom { routerSeed -> UIViewController in
presentModalNavigationControllerWithRootViewControllerDerivedFrom { routerSeed -> UIViewController in
presentPopoverWithNavigationControllerFromBarButtonItem(buttonItem) { routerSeed -> UIViewController in

So far, so good
Модуль авторизации из всех модулей
Поддержка DeepLinks
Bonus: (Push’ы, Alert’ы)
Нужно научить
базовые роутеры
искать верхний модуль
So far, so good, но что если

Поиск верхнего модуля
protocol TopViewControllerFinder: class {
func topViewController() -> UIViewController?
}
final class TopViewControllerFinderImpl: TopViewControllerFinder {
}
func topViewController() -> UIViewController? {
var result = rootViewController
while let presentedViewController = result?.presentedViewController {
result = presentedViewController
}
return result
}
}
}
return result
}
}
}
if let selectedTabController = (result as? UITabBarController)?.selectedViewController {
if let detailController = (selectedTabController as? UISplitViewController)?.viewControllers.last {
if let detailNavigationController = detailController as? UINavigationController {
result = detailNavigationController.viewControllers.last
} else {
result = detailController
}
} else {
result = selectedTabController
}
}
return result
}
}
}
if let selectedTabController = (result as? UITabBarController)?.selectedViewController {
if let detailController = (selectedTabController as? UISplitViewController)?.viewControllers.last {
if let detailNavigationController = detailController as? UINavigationController {
result = detailNavigationController.viewControllers.last
} else {
result = detailController
}
} else {
result = selectedTabController
}
}
return result
}
}
Нужна своя
система навигации

Зачем нужна своя система навигации?
Хранение истории переходов
Поддержка Third-party контроллеров
Bonus: проверка, что модуль был на экране
Bonus: расстояние между модулями
Поиск верхнего модуля
Обертка над UIKit
Реакция на изменение SDK

Свежий взгляд на базовый Router
class BaseRouter {
}
class BaseRouter {
}
Нужно абстрагировать Router
от UIKit
Не у каждого роутера будет UINavigationController
Код вида .pushViewController() сильно завязывает Router на UIKit
Для каждого ThirdPartyNavigationController нужна будет своя пара базовых Router’ов

Абстрагируем Router от UIKit
protocol TransitionsHandler: class {
}
typealias TransitionId = String Идентификатор
перехода
Возвращение на модуль
Закрытие модуля
Отменяемый переход
func performTransition(context context: PresentationTransitionContext)
}
Неотменяемый переход
func resetWithTransition(context context: ResettingTransitionContext)
}
func undoTransitionsAfter(transitionId transitionId: TransitionId)
}
func undoTransitionsAfter(transitionId transitionId: TransitionId)
func undoTransitionWith(transitionId transitionId: TransitionId)
}
Router общается с
обработчиком переходов

Обработчик переходов оборачивает UIViewController
Виды модулей
Анимирующие
AnimatingTransitionsHandlerImpl
NavigationTransitionsHandlerImpl
ContainerTransitionsHandlerImpl
SplitViewTransitionsHandlerImpl
TabBarTransitionsHandlerImpl
Контейнеры
pushViewController(_:animated:)
presentViewController(_:animated:completion:)
visibleAnimatingTransitionsHandlers()
allAnimatingTransitionsHandlers()
Легко добавить
Third-party контроллер

class BaseRouter {
}
Новый базовый Router
class BaseRouter {
let transitionsHandlerBox: TransitionsHandlerBox // weak var navigationController: UINavigationController?
let transitionId: TransitionId // weak var rootViewController: UIViewController?
}
class BaseRouter {
}
class BaseRouter {
}
class BaseRouter {
}
enum TransitionsHandlerBox {
case Animating(AnimatingTransitionsHandlerImpl)
case Containing(ContainingTransitionsHandlerImpl)
}
Такой Router
можно использовать
с любым UIViewController’ом

Схема выполнения отменяемых переходов
Transitions handler
box
выполни
отменяемый
переход
Router
presentation
context
transitions
handler
box Transitions
Coordinator
Top animating
transitions handlerзапусти
анимацию
presentation
context

Взглянем еще раз на новый базовый Router
class BaseRouter {
}
Нужна ссылка
на обработчика переходов,
показавшего модуль Router’а
class BaseRouter {
weak var presentingTransitionsHandler: TransitionsHandler?
}
class BaseRouter {
weak var presentingTransitionsHandler: TransitionsHandler?
}
Теперь Router может
закрывать свой модуль

Навигационная связь
Router
1
transition id
1
Transitions handler
1
Transitions handler
2
presenting
transitions
handler
Вернись на
модуль 1
Закрой
модуль 2
Router
2
transition id
2
Что лучше:
“Вернись на модуль 1”
или
“Закрой модуль 2”
?

Flow
Фильтр Города

Выход из Flow
Фильтр Города
Router
закрой модуль
городов

Усложненный ﬂow
Фильтр Регионы Города

Выход из усложненного Flow
Фильтр
модуль
регионов
закончил
ГородаРегионы
модуль
городов
закончил
Router
вернись на
наш модуль
“Вернись на модуль”
гибче, чем
“Закрой модуль”

Слой Router
Предварительные итоги
Подходы к выполнению обратных переходов
Поддержка DeepLinks
Слой Assembly
Базовые классы Router, поддержка iPad, master-detail
Простой Router (фасад, абстрация от UIKit)

Один UIViewController, много Router’ов
Выводы по демо
Проверка наличия модуля в истории (Авторизация)
Проверка isIpad()
Поиск верхнего модуля (Авторизация, DeepLink’и, Push’ы)
Проверка модулей на дубликаты (🍌, 🍏)
Аниматоры переходов
Проверка isIpad()

Выделите слой Router (определять стиль перехода)
Общие советы
Используйте “Вернись на модуль” вместо “Закрой модуль”
Выделите слой Assembly
Абстрагируйте Router от UIKit
Вынесите логику принятия решений в отдельный слой
Описывайте переходы в декларативном стиле

One more thing
https://github.com/avito-tech/Marshroute
Исходники Докладчик: Юсипов Тимур
https://vk.com/ma3tsa
tyusipov@avito.ru
ykylele@gmail.com
fizmatchelskype
personal mail
work mail
vk
Marshroute
Спасибо за внимание!
presentation.ﬁnish()
https://github.com/avito-tech/Marshroute/tree/master/Example
Демо

"Marshroute: удобный и расширяемый роутинг в iOS-приложении" Тимур Юсипов (Avito)

Recommended

Recommended

More Related Content

Viewers also liked

Viewers also liked (20)

Similar to "Marshroute: удобный и расширяемый роутинг в iOS-приложении" Тимур Юсипов (Avito)

Similar to "Marshroute: удобный и расширяемый роутинг в iOS-приложении" Тимур Юсипов (Avito) (20)

More from AvitoTech

More from AvitoTech (20)

Recently uploaded

Recently uploaded (20)

"Marshroute: удобный и расширяемый роутинг в iOS-приложении" Тимур Юсипов (Avito)