iOS項目國際化方案之集成SwiftGen處理本地化文件

使用SwfitGen達成目標

只需在strings文件中添加對應本地化key=value箱舞,編譯項目后即可自動生成string擴展屬性患膛,使用時可以使用點語法獲取本地化key。

依賴庫簡介

SwiftGen

SwiftGen是一個強大的開源工具蚁署,它允許開發(fā)者利用 Swift 的強類型和模式匹配能力自動化生成常量恶座、枚舉搀暑、結(jié)構(gòu)體等靜態(tài)類,極大地提高了開發(fā)效率和代碼可維護性跨琳。通過解析資源文件(如本地化字符串自点、顏色、字體湾宙、圖像等)和 storyboard 文件樟氢,SwiftGen 可以幫助我們避免手動輸入這些重復代碼,從而專注于更有價值的工作侠鳄。

Stencil

Stencil 是一款靈感來源于Django和Mustache的輕量級模板引擎埠啃,專為Swift開發(fā)者設計∥岸瘢可用于Markdown渲染碴开、Swift代碼生成、自動化工具等博秫,==SwiftGen依賴Stencil生成代碼==潦牛。

集成步驟

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

pod 'SwiftGen'
# 通過 Homebrew 安裝
brew install swiftgen

2. 初始化yml文件

yml文件是SwiftGen必須的配置文件,用于配置必要文件路徑挡育、參數(shù)等巴碗。
文件創(chuàng)建方式

  • 命令行生成
swfitgen init
  • 手動創(chuàng)建文件改后綴名為.yml

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

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

3. 創(chuàng)建stencil模板文件

  • 創(chuàng)建方式
    手動創(chuàng)建文件改后綴名為.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文件內(nèi)容,數(shù)組格式即寒,遍歷數(shù)組元素橡淆,獲取到其中的鍵值對召噩,使用點語法可根據(jù)key讀取到對應的value值,依次獲取到所需要的內(nèi)容逸爵,生成對應代碼具滴,次格式為通用固定格式。想要知道tables中都包含什么內(nèi)容师倔,可以使用{{ 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指定腳本運行環(huán)境,execution_position指定編譯前還是編譯后執(zhí)行
  s.script_phase = { :name => 'swiftgen script', :script => script, :shell_path =>'/bin/sh', :execution_position => :before_compile }
  
  s.dependency 'SwiftGen'

配置簡單說明:

注意swiftgen路徑及yml配置文件路徑是否正確

6. 后期規(guī)劃

需整理出一個csv或Excel文件,用于統(tǒng)一管理key對應的各個國家語言翻譯致稀,使用腳本自動生成strings文件冈闭,再配合SwiftGen,將極大減少工作量抖单。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市遇八,隨后出現(xiàn)的幾起案子矛绘,更是在濱河造成了極大的恐慌,老刑警劉巖刃永,帶你破解...
    沈念sama閱讀 222,183評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件货矮,死亡現(xiàn)場離奇詭異,居然都是意外死亡斯够,警方通過查閱死者的電腦和手機囚玫,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,850評論 3 399
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來读规,“玉大人抓督,你說我怎么就攤上這事∈鳎” “怎么了铃在?”我有些...
    開封第一講書人閱讀 168,766評論 0 361
  • 文/不壞的土叔 我叫張陵,是天一觀的道長碍遍。 經(jīng)常有香客問我定铜,道長,這世上最難降的妖魔是什么怕敬? 我笑而不...
    開封第一講書人閱讀 59,854評論 1 299
  • 正文 為了忘掉前任揣炕,我火速辦了婚禮,結(jié)果婚禮上东跪,老公的妹妹穿的比我還像新娘畸陡。我一直安慰自己鹰溜,他們只是感情好,可當我...
    茶點故事閱讀 68,871評論 6 398
  • 文/花漫 我一把揭開白布罩锐。 她就那樣靜靜地躺著奉狈,像睡著了一般。 火紅的嫁衣襯著肌膚如雪涩惑。 梳的紋絲不亂的頭發(fā)上仁期,一...
    開封第一講書人閱讀 52,457評論 1 311
  • 那天,我揣著相機與錄音竭恬,去河邊找鬼跛蛋。 笑死,一個胖子當著我的面吹牛痊硕,可吹牛的內(nèi)容都是我干的赊级。 我是一名探鬼主播,決...
    沈念sama閱讀 40,999評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼岔绸,長吁一口氣:“原來是場噩夢啊……” “哼理逊!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起盒揉,我...
    開封第一講書人閱讀 39,914評論 0 277
  • 序言:老撾萬榮一對情侶失蹤晋被,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后刚盈,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體羡洛,經(jīng)...
    沈念sama閱讀 46,465評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,543評論 3 342
  • 正文 我和宋清朗相戀三年藕漱,在試婚紗的時候發(fā)現(xiàn)自己被綠了欲侮。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,675評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡肋联,死狀恐怖威蕉,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情牺蹄,我是刑警寧澤忘伞,帶...
    沈念sama閱讀 36,354評論 5 351
  • 正文 年R本政府宣布,位于F島的核電站沙兰,受9級特大地震影響氓奈,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜鼎天,卻給世界環(huán)境...
    茶點故事閱讀 42,029評論 3 335
  • 文/蒙蒙 一舀奶、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧斋射,春花似錦育勺、人聲如沸但荤。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,514評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽腹躁。三九已至,卻和暖如春南蓬,著一層夾襖步出監(jiān)牢的瞬間纺非,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,616評論 1 274
  • 我被黑心中介騙來泰國打工赘方, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留烧颖,地道東北人。 一個月前我還...
    沈念sama閱讀 49,091評論 3 378
  • 正文 我出身青樓窄陡,卻偏偏與公主長得像炕淮,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子跳夭,可洞房花燭夜當晚...
    茶點故事閱讀 45,685評論 2 360

推薦閱讀更多精彩內(nèi)容