iOS 国际化全解-swift与OC

作者: 雨三楼 | 来源:发表于2016-11-21 19:15 被阅读1308次

    前言

    iOS国际化是个很头疼的问题,尤其是项目更新了N个版本突然要加入国际化需求的时候。(大部分都是这样吧...)


    (吐槽结束)那么开始吧

    首先项目的国际化分为 代码部分StoryBoard部分


    先生成Localizable.strings文件 【比较简单】

    • 代码部分

      • 需要对代码中的中文可视的字符串进行国际化,这是一件苦力活!
     // swift 
     NSLocalizedString("str", comment: "字符串")
     // OC
     NSLocalizedString(@"str", "字符串")
    
    第一个参数: 原来的字符串
    第二个参数: 字符串的注解
    
    这里需要注意的是
    1、尽量不要为了方便书写自定义宏或者封装【会对批量生成命令产生影响,后面会讲到】
    2、参数不支持变量!【单纯的字符串就好】
    3、参数是支持中文的(不过时间充裕的话最好是前面换成英文标示,后面写上中文注解)
      NSLocalizedString("example", comment: "例子")
    

    代码处理

    • 然而如此多的字符串要怎么替换呢?

    这时候可以用xcode强大的查找替换功能!

    然后需要这两个正则:
    swift
    ("[^\x00-\xff]+")
    NSLocalizedString($1, comment: ""))
    OC
    (@"[^\x00-\xff]+")
    NSLocalizedString($1, comment: "")

    这个正则是查找所有中文编码的字符串,当然肯定会漏掉一些中文和英文字符混合的字符串 ,然后我不会这种正则 orz

    0_0!

    好在项目里这种字符串不太多,这里还需要注意,不要手贱把图片啥的也替换了 😂

    如果对python等脚本语言熟悉的话可以写个脚本,全自动完成


    • 字符串都替换完之后
      接下来进行至关重要的一步,也很简单
      打开终端工具,cd到项目的根目录,然后看下【先不要运行】下面这个命令:
      $ find ./ -name *.m -print0 | xargs -0 genstrings -o en.lproj

    这个命令会找到项目里所有的.m文件列表,然后xargs会分步执行genstrings命令
    -o 表示将结果直接输出到后面的文件目录中,且直接覆盖。

    后续的迭代开发中可以用这个命令替代,自动追加:
    $ find ./ -name *.m -print0 | xargs -0 genstrings -o en.lproj

    这个en.lproj表示输出到Localizable.strings(English)文件中【英文文版本】

    $ find ./ -name *.m -print0 | xargs -0 genstrings -o zh-Hans.lproj
    这个en.lproj表示输出到Localizable.strings(Simplified)文件【中文版本】

    以上是OC文件的处理,swift需要对命令稍微修改一下:
    $ find ./ -name "*.swift" | xargs genstrings -o en.lproj

    这里需要注意,如果项目里有对NSLocalizedString函数的封装,或者宏定义,命令会报错,且定位错误,直接暂时删掉就好了,以后可以在加上

    做完这些打开项目里的Localizable.strings,就会发现项目里需要翻译的字符串都在里面了

    /* No comment provided by engineer. */
    "喜欢" = "Like"; 
    

    注释里是注解,因为我滞空了,所以提示“No comment provided by engineer”

    接下来直接把English中的直接给翻译人员,坐等翻译……

    需要注意的是注释可以不要,但是 "喜欢" = "Like"; 格式一定要对,字符串 = 字符串 分号 。如果万一弄错了,错误很难发现。*

    xcode高兴了给你的格式错误的提示【但是定位不到哪一行,我们项目两千多行。。。】,但很多情况下,xcode不报错,但是国际化直接失效或者部分失效,不多说了,找了三天的很肝疼……

    以上就是代码部分的,写的比较匆忙,欢迎指正错误 O(∩_∩)O~


    接下来是storyboard部分

    比起代码,storyboard要稍微复杂一点,不过难度也不大。

    这里我大部分参考的这篇文章

    前辈写的很好,但是对于脚本部分所述不详,而且使用过程中也有些问题。

    storyboard基本国际化非常简单

    • 第一步:设置需要的语音


    • 第二步:打钩


    • 完成。

    然后这只能满足一次开发,在后续迭代storyboard中的内容会越来越多,可悲剧的是storyboard不会自动同步内容到 storyboard.strings 中!

    所以我们需要一个脚本,来帮我们同步

    • 而脚本需要做的就是执行这个命令:
      $ ibtool Main.storyboard --generate-strings-file ./NewTemp.string

    我是脚本

    • 先把下载下来的脚本放到文件的项目目录
      ProjectName/RunScript/AutoGenStrings.py
    • 然后target-Build Phases



      添加一个执行脚本的命令



      到这里基本上就完成了,测试的时候可以把Run script only when installing 的勾取消【只在打包的时候运行】
      这样每次bulid都会执行脚本。

    python ${SRCROOT}/${TARGET_NAME}/RunScript/AutoGenStrings.py ${SRCROOT}/${TARGET_NAME}/StoryBoard

    • 这里需要注意的是
      ${SRCROOT}/${TARGET_NAME}/RunScript/AutoGenStrings是运行语句,后面是参数,这个参数会在py脚本里起很重要的作用!

    但是运行一次发现,脚本没有运行,或者报错

    这里我们就需要对脚本进行分析了。

    • 先看这几个参数:


    Base.lproj/*.stroyboard —— Base.lproj目录下所有的storyboard文件
    kTargetFile —— *.stirngs文件

    KGenerateStringFile —— 不管他(🙄)

    ColonRegex —— 正则 匹配字符串的

    KeyParamRegex —— 正则 匹配 "喜欢" = "Like"; 格式的

    AnotationRegexPrefix —— 匹配注释/* */ 【修改了一下源码】

    • 我们先说第一个问题
      glob 遍历文件的问题,glob是一个python模板,用于查找匹配的文件的

    然后我们来看mian函数

    $python
    filePath = sys.argv[1]
        sourceFilePath = filePath + '/' + KSourceFile 
        sourceFile_list = glob.glob(sourceFilePath)
    

    这里的filePath就是我们在xcode的RunScript中的写的参数 这里等同于
    ~/StoryBoard/Base.lproj/*.storyboard
    看一下自己项目的stroyBoard目录【我们项目的storyboard都放在了storyboard这个group中】

    • 一般都是这样的:



      storyboard就存在Base.lproj文件夹中

    所以这里的参数需要注意,一定要填对

    • 接下来我们看第二个问题:
      如果在storyboard目录下,有子文件夹,里面分别存放着不同的storyboard,那么就会出现storyboard遍历不到的问题!
      因为对python不熟,所以我的方法暂时是这样的:
    $python
    sourceFilePath = filePath + '/*/' + KSourceFile
        onesourceFilePath =  filePath + '/' + KSourceFile
        sourceFile_list = glob.glob(sourceFilePath)
        onesourceFile_list = glob.glob(onesourceFilePath)
        for source in onesourceFile_list:
            sourceFile_list.append(source)
    

    因为我们项目里这有两层目录有storyboard,所以这里只是简单的拼接了一下,小伙伴们可以写个遍历函数,这里就不献丑了😂

    这样第二个问题就解决了~

    • 目前发现的最后一个问题:
      出现在getAnotationOfString函数里,脚本一直崩溃于re.search(anotationRegex,string_txt)
      这是个简单的正则查找的函数,报错的缘由是因为正则语句的问题。
      经过一番排查发现是storyboard中有特殊字符 "*"

    坑!

    我们需要对它进行转义

    def constructAnotationRegex(str):   
    #对*进行处理   
    newStr = str.replace("*","\*")   
    return AnotationRegexPrefix + '\n' + newStr
    

    修改完这个函数,基本上就搞定了!

    最新命令行工具,一个命令搞定swift,objc文件的国际化:
    star: https://github.com/BackNotGod/localizationCommand
    运行,搞定!
    欢迎拍砖!😂

    相关文章

      网友评论

        本文标题:iOS 国际化全解-swift与OC

        本文链接:https://www.haomeiwen.com/subject/dzuupttx.html