Упрощение локализации в iOS

Всем доброго времени суток! Меня зовут Николай, я iOS-Lead в компании Touch Instinct. В процессе разработки часто приходится иметь дело с проектами, которые должны работать на нескольких языках. Расскажу, к какому подходу мы пришли при работе с локализацией.

Минусы базовых подходов

Есть несколько основных подходов для локализации iOS-приложения. Сперва стоит определиться, разрабатывается приложение с использованием storyboards или нет.

С использованием storyboards

Можно локализовывать строки напрямую в storyboard. Однако, при таком подходе есть ряд минусов:

• в случае наличия большого количества storyboards, локализованные строки разбросаны по проекту;
• невозможность использования атрибутных строк, а также строк, которые состоят из нескольких составных частей;
• вам всё равно придется часть строк локализовывать в коде. Это ведет к еще большему разбросу в приложении;
• фактически отсутствует возможность что-то проверить другому разработчику при проведении code review.

Без storyboards

В этом случае локализуем всё в коде. Однако и тут есть ряд минусов. Дело в том, что файлы со строками локализации localizable.strings — магические. При изменении таких файлов очень велика вероятность возникновения ошибки из-за человеческого фактора. Изменения нельзя отследить, пока ошибка не будет найдена в процессе тестирования.

Таким образом, хотя для локализации уже есть готовые механизмы в iOS SDK, они имеют существенные минусы. Более подробно смотрите здесь.

Разбираемся с целями

Если стандартные решения не справляются, не стоит сразу бросаться делать свой «велосипед». Сформулируйте цели, которые нужно достичь.

Основные критерии, которым должно удовлетворять будущее решение:

• объединение ресурсов локализации для всех мобильных платформ, которые поддерживаются на проекте. В мобильной разработке чаще всего делаем проект сразу под несколько платформ, обычно iOS+Android. Одно и то же приложение на разных платформах будет использовать одни и те же ресурсы для локализации. При этом должна быть возможность иметь специфические строки для каждой отдельной платформы.
• автоматическое добавление новых строк локализации в проекте без участия разработчика. Если приложение использует несколько языков, то ресурсы будет заполнять либо переводчик, либо посредник между переводчиком и проектом. Посредником может быть менеджер или другие участники команды. Давать доступ к коду нетехническим специалистам — моветон. Лучше всего держать ресурсы локализации где-то в стороннем месте. При этом необходимо, чтобы разработчики не добавляли каждый раз эти ресурсы «руками».
• обнаружение ошибок в проекте при изменении ресурсов локализации на этапе компиляции. Стандартный подход, при котором используется NSLocalizedString, предполагает, что если сама строка поменяется в localizable.strings, а изменений в коде не произойдет, то в продакшен выйдет приложение с ошибкой. Самым первым ситом по поиску ошибку должен являться процесс билда проекта. Изменения строк локализации, а также ошибки возникающие вследствие изменений, необходимо получать именно на этом этапе.
• отсутствие магических строк в проекте. Любое магическое значение в проекте это зло. Убирать их можно разными способами. Есть путь комментариев к коду или вынесения магических значений в константы с говорящими именами.

Локализация в Touch Instinct

Создаем репозиторий для строк

Для начала необходимо создать отдельный репозиторий в используемой вами системе контроля версий. Что должно храниться в данном репозитории? Всё просто. Здесь хранятся json файлы вида common_strings_eng.json/common_strings_ru.json/etc. Под каждый язык создается отдельный json файл.
Рассмотрим содержание таких файлов. Json представляет из себя текстовый формат описания данных в виде пар key-value, поэтому мы создаем ключ-наименование для каждой локализованной строки и используем его во всех файлах. Value же является локализованным значением и будет отображаться в самом приложении.
В нашей компании есть styleguide, чтобы унифицировать ключи во всех приложениях и сделать их консистентными в рамках каждого проекта.

У внимательного читателя может возникнуть несколько вопросов:

1) При заполнении файлов json можно допустить ошибку и, к примеру, забыть заполнить value для какого-то ключа в определенном языке?

Да, это верно. Однако здесь ответственность эскалируется уже на уровень переводчика или одного-единственного человека. При этом с легкостью можно создать скрипт, который пройдет по всем файлам json и покажет, где и чего не хватает в файлах.

2) В данной системе используется «старинная» система для работы с Plural. Удобно ли это?

Небольшой ликбез, что такое plural. Фактически, это формы существительного, зависящие от его количества. Пример: 1 день, 2 дня, 5 дней. Действительно, очень часто можно услышать от разработчиков, что работать с plural сложно. Однако, мы пришли к выводу, что таких ресурсов крайне мало в приложениях. Получая другие преимущества, этим можно пренебречь. Про работу стандартного механизма для работы с plural в виде словаря вы можете посмотреть здесь.

Теперь у нас есть отдельный репозиторий, в котором созданы локализованные ресурсы для проекта.

Пример:

{
    "common_global_error": "Ошибка",
    "common_notifications_no_new_notifications": "У вас нет новых уведомлений",
}

Локализуем приложение

Репозиторий со строками необходимо подключить как submodule к вашему проекту. Что это даёт? Если вам не нужна последняя версия строк, вы просто не обновляете версию submodule, а переводчик/дизайнеры/другие заинтересованные лица могут спокойно создавать ресурсы для следующих версий.

В процессе разработки наших проектов решили использовать локализацию в коде, даже если используются storyboards.

После подключения submodule, нам всё равно как-то необходимо получить строки в приложении, чтобы их использовать. Для этого создаём script и добавляем его в build phases как run script.
Для самого script’a будем использовать php. Однако его вы можете переписать на любой другой скриптовый язык.

Положим данный скрипт к нам в проект. Теперь добавляем в наш run script.

php ./common_strings/import_strings.php

Предварительно называете его, к примеру, «Localization». Очень часто приходится видеть сторонние проекты, в которые есть run scripts, которые никак не названы. Поэтому понять, что там происходит, сходу нельзя.

Заранее создайте в проекте пустые файлы localizable.strings, а также String+Localization.swift. После первого build (cmd+B) у нас в проекте есть заполненные файлы localizable.strings, а также файл String+Localization.swift. Если скрипт не выполняется или выполняется неправильно, убедитесь, что данные файлы у вас были заранее созданы, так как скрипт отвечает только за заполнение.

Пример готового файла Localizable.string (Russian)

Пример готового файла String+Localization.swift

Кроме этого, для простоты локализации создадим extension для String.

Теперь мы можем использовать строки из String+Localization в проекте. К примеру:

emptyLabel.text = .commonNotificationsNoNewNotifications

При этом, это уже не магическая строка. При наведении на неё можно также увидеть перевод слова на языке, который понятнее всего разработчикам проекта.

Если в проекте используется строка .commonNotificationsNoNewNotifications, а затем переводчик убирает её в новой версии, то у разработчика высветится ошибка компиляции. Потому что данной строки уже не существует в проекте и её нужно поправить. Мы предиктивно получили ошибку об изменении ресурса и не выпустили это в production/отдали тестировщикам/etc.

В результате мы получаем систему для работы с локализацией, которая отвечает всем поставленным целям. Таким способом сделали уже несколько проектов. Надеюсь, что эта техника поможет и вам упростить процесс локализации приложений, а также сделает его менее зависимым от разработчиков.