iOS项目国际化方案之集成SwiftGen处理本地化文件

使用SwfitGen达成目标

只需在strings文件中添加对应本地化key=value,编译项目后即可自动生成string扩展属性,使用时可以使用点语法获取本地化key。

依赖库简介

SwiftGen

SwiftGen是一个强大的开源工具,它允许开发者利用 Swift 的强类型和模式匹配能力自动化生成常量、枚举、结构体等静态类,极大地提高了开发效率和代码可维护性。通过解析资源文件(如本地化字符串、颜色、字体、图像等)和 storyboard 文件,SwiftGen 可以帮助我们避免手动输入这些重复代码,从而专注于更有价值的工作。

Stencil

Stencil 是一款灵感来源于Django和Mustache的轻量级模板引擎,专为Swift开发者设计。可用于Markdown渲染、Swift代码生成、自动化工具等,==SwiftGen依赖Stencil生成代码==。

集成步骤

1. pod集成SwiftGen或使用Homebrew安装

pod 'SwiftGen'
# 通过 Homebrew 安装
brew install swiftgen

2. 初始化yml文件

yml文件是SwiftGen必须的配置文件,用于配置必要文件路径、参数等。
文件创建方式

  • 命令行生成
swfitgen init
  • 手动创建文件改后缀名为.yml

  • 项目中用到的配置示例如下:

## 注:路径是基于yml文件路径配置
 strings:
   inputs:
     - ../Resources/zh-Hant.lproj ##本地化strings文件路径
   outputs:
     - templatePath: StringExtension.stencil ##stencil模板路径
       output: LocalizedString.swift ##Swift代码文件输出路径

3. 创建stencil模板文件

  • 创建方式
    手动创建文件改后缀名为.stencil
  • 项目中用到的模板示例如下:
import Foundation
import Localize_Swift

extension String {
{% for table in tables %}
    {% for d in table.levels.strings %}
    /// {{ d.translation }}
    static let {{ d.key }} = "{{ d.name }}".localized()
    {% endfor %}
{% endfor %}
}

模板示例简单说明:

tables为strings文件内容,数组格式,遍历数组元素,获取到其中的键值对,使用点语法可根据key读取到对应的value值,依次获取到所需要的内容,生成对应代码,次格式为通用固定格式。想要知道tables中都包含什么内容,可以使用{{ tables }}查看。

4. 配置shell脚本

在主工程TARGETS->Build Phases中新增New Run Script Phases, 添加如下脚本:

if [[ -f "${PODS_ROOT}/SwiftGen/bin/swiftgen" ]]; then
  ${PODS_ROOT}/SwiftGen/bin/swiftgen  config run --config ${SRCROOT}/项目名/LocalizableConfig/swiftgen.yml
else
  echo "warning: SwiftGen is not installed. Run 'pod install --repo-update' to install it."
fi

shell脚本简单说明:

"{PODS_ROOT}/SwiftGen/bin/swiftgen"为swiftgen安装路径{SRCROOT}/项目名/LocalizableConfig/swiftgen.yml为yml配置文件路径

5. 组件中使用SwiftGen

流程同上,唯一需要的是shell脚本的配置,需要再podspec中添加对应脚本配置,配置如下:

#script_phase
  script = <<-CMD
  if [[ -f "${PODS_ROOT}/SwiftGen/bin/swiftgen" ]]; then
    ${PODS_ROOT}/SwiftGen/bin/swiftgen config run --config ${PODS_ROOT}/../../TO_Modules/组件名/组件名/Classes/LocalizableConfig/swiftgen.yml
  else
    echo "warning: SwiftGen is not installed. Run 'pod install --repo-update' to install it."
  fi
  CMD
  #shell_path指定脚本运行环境,execution_position指定编译前还是编译后执行
  s.script_phase = { :name => 'swiftgen script', :script => script, :shell_path =>'/bin/sh', :execution_position => :before_compile }
  
  s.dependency 'SwiftGen'

配置简单说明:

注意swiftgen路径及yml配置文件路径是否正确

6. 后期规划

需整理出一个csv或Excel文件,用于统一管理key对应的各个国家语言翻译,使用脚本自动生成strings文件,再配合SwiftGen,将极大减少工作量。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容