使用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脚本简单说明:
"{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,将极大减少工作量。