Ресурсы в общем коде

Введение

Разберем задачу: допустим, мы получаем от сервера enum - тип транспорта, и хотим отобразить локализированную строку с его названием.

enum class VehicleType {
    BOAT,
    CAR,
    PLANE
}

class MainViewModel : ViewModel() {
    val vehicleType: VehicleType
        get() = ...
}

Далее, на платформах нам нужно сделать маппинг - определить какие строки из ресурсов соответствуют каждому типу транспорта, чтобы использовать локализованные строки на UI.

Android:

val vehicleTitle = when (viewModel.vehicleType) {
    VehicleType.BOAT -> R.string.boatTitle
    VehicleType.CAR -> R.string.carTitle
    VehicleType.PLANE -> R.string.planeTitle
  }

iOS:

let vehicleTitle: String
switch(viewModel.vehicleType) {
case VehicleType.boat:
  vehicleTitle = NSLocalizedString("boatTitle", comment: "")
  break
case VehicleType.car:
  vehicleTitle = NSLocalizedString("carTitle", comment: "")
  break
case VehicleType.plane:
  vehicleTitle = NSLocalizedString("planeTitle", comment: "")
  break
}

Писать такой маппинг на обеих платформах для всех строк - рутина, еще и обновлять строки нужно будет на обеих платформах, что может приводить к багам из-за невнимательности.

Библиотека moko-resources

Описание

Эта библиотека позволяет хранить и использовать общие для платформ ресурсы (строки локализации, плюралы, шрифты, изображения, цвета) в common коде.

Используя moko-resources мы можем сделать маппинг из примера выше в самой вьюмодели, а на платформу будет предоставляться объекты StringDesc, из которого каждая платформа сможет получить необходимый ей ресурс:

class MainViewModel : ViewModel() {
  private val vehicleType: VehicleType get() = ...
  val vehicleTypeString: StringDesc
    get() = when (vehicleType) {
      VehicleType.BOAT -> MR.strings.boatTitle.desc()
      VehicleType.CAR -> MR.strings.carTitle.desc()
      VehicleType.PLANE -> MR.strings.planeTitle.desc()
    }
}

Важно!

В общем коде должны находиться только те ресурсы, которые им и управляются, как из примера выше.
Все остальные ресурсы должны находиться на платформе, не нужно с платформы обращаться к ресурсам из MR.

Ознакомьтесь детальнее с ней по материалам на странице moko-resources.

Подключение и настройка:

Выполните следующие шаги, ориентируясь на README библиотеки:

Настройте root build.gradle:
- подключите resources-generator плагин
Настройте build.gradle для каждого модуля:
- подключите плагин "dev.icerock.mobile.multiplatform-resources"
- подключите зависимость "dev.icerock.moko:resources:$MOKO_RESOURCES_VERSION"
- добавьте и настройте блок multiplatformResources
Настройка iOS:
- добавьте и настройте Localizations в infoPlist
- добавьте Build Phase, не забудьте изменить yourframeworkproject
пример добавления строк

Использование Google Sheets для генерации строк

Для строк локализации мы используем интеграцию с Google Sheets. Строки локализации описываются в таблицах и на их основе генерируются в проект. Делается это при помощи плагина sheets-localizations-generator.

В проектах, созданных на основе шаблона есть файл master.sh, в нем находится скрипт localize, который и генерирует строки на основе таблицы. Для использования скрипта, в нем необходимо заменить GSHEET_ID_HERE на ID реальной таблицы. После добавления строк в таблицу, выполните скрипт localize в терминале: ./master.sh localize и строки добавятся в проект.

Практическое задание

Используйте проект, готовый после раздела MVVM
Подключите moko-resources
MR подключайте к mpp-library
Вынесите в MR только те ресурсы, управление которыми происходит из общего кода
Используйте sheets-localizations-generator для доступа к строкам локализации из Google Sheets
Настройте проброс ресурсов из mpp-library во вьюмодели фичей
Обеспечьте поддержку русского и английского языков

Ресурсы в общем коде

Введение​

Библиотека moko-resources​

Описание​