使用SwfitGen達(dá)成目標(biāo)

只需在strings文件中添加對(duì)應(yīng)本地化key=value，編譯項(xiàng)目后即可自動(dòng)生成string擴(kuò)展屬性，使用時(shí)可以使用點(diǎn)語法獲取本地化key。

依賴庫簡介

SwiftGen

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

Stencil

Stencil 是一款靈感來源于Django和Mustache的輕量級(jí)模板引擎，專為Swift開發(fā)者設(shè)計(jì)?？捎糜贛arkdown渲染、Swift代碼生成、自動(dòng)化工具等，==SwiftGen依賴Stencil生成代碼==。

集成步驟

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

pod 'SwiftGen'

# 通過 Homebrew 安裝
brew install swiftgen

2. 初始化yml文件

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

• 命令行生成

swfitgen init

• 手動(dòng)創(chuàng)建文件改后綴名為.yml

• 項(xiàng)目中用到的配置示例如下：

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

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

• 創(chuàng)建方式
  手動(dòng)創(chuàng)建文件改后綴名為.stencil
• 項(xiàng)目中用到的模板示例如下：

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ù)組元素，獲取到其中的鍵值對(duì)，使用點(diǎn)語法可根據(jù)key讀取到對(duì)應(yīng)的value值，依次獲取到所需要的內(nèi)容，生成對(duì)應(yīng)代碼，次格式為通用固定格式。想要知道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}/項(xiàng)目名/LocalizableConfig/swiftgen.yml
else
  echo "warning: SwiftGen is not installed. Run 'pod install --repo-update' to install it."
fi

shell腳本簡單說明：

"{SRCROOT}/項(xiàng)目名/LocalizableConfig/swiftgen.yml為yml配置文件路徑

5. 組件中使用SwiftGen

流程同上，唯一需要的是shell腳本的配置，需要再podspec中添加對(duì)應(yīng)腳本配置，配置如下：

#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指定腳本運(yùn)行環(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ī)劃

需整理出一個(gè)csv或Excel文件，用于統(tǒng)一管理key對(duì)應(yīng)的各個(gè)國家語言翻譯，使用腳本自動(dòng)生成strings文件，再配合SwiftGen，將極大減少工作量。