R.swift 让iOS项目像Android R 一样管理资源 - 轻松解决国际化

逃离我推掉我的手 2022-06-08 09:29 338阅读 0赞

\#\#什么是 R.Swift

搞过的Android开发同学都知道，在Android开发中，其对于资源的引用非常方便，我们可以通过"R机制"来对Android中的图片(Drawable)、布局(Layout)、动画配置(Anim)、国际化字符串(String)、尺寸(Dimen)等等资源进行非常方便快捷的引用。

开妈搞iOS的时候，我瞬间觉得iOS的资源引用略为恶心，跟Android比起来，它更加蛋疼麻烦。

`R.Swift`是一款基于`Swift`平台，针对iOS以及TVOS开发的仿`Android`资源引用框架。它所针对的问题，就是类似于刚刚我在上方提到的一样，避免使用字符串来构造某些资源实例。`R.Swift`能够在我们修改项目资源后动态地进行配置，最终，你能够使用类似语法R.资源类型.资源名称来对某资源进行引用构建。`R.Swift`有着动态生成代码的机制，由此，它具有以下极具魅力的优点：

1.  代码自动补全 ：就像输入其他的代码一样，R.Swift支持IDE的代码自动补全，当你的资源量非常庞大时，你只需把资源调用语法的前沿部分敲出来，IDE就会自动给予代码提示以及补全，这对资源的引用效率有着显著的提高。
2.  自动检测 ： 当我们写入某些错误的代码时，IDE会向我们反馈错误以及警告，如我们调用某个类中不存在的方法时，IDE就会立即检测出代码的错误，并给予反馈。在R.Swift中，若我们将资源重命名，或干脆将资源删除了，R.Swift会自动重新进行配置，而在之前我们对该资源进行引用的地方，IDE也会相应的向我们报错，表明资源的不存在，如此一来，我们就不必担心资源的修改删除对代码的蝴蝶效应了。

## R.Swift的安装配置 ##

[传送门: https://github.com/mac-cain13/R.swift][https_github.com_mac-cain13_R.swift]

在这里我们使用的是`CocoaPods`来对`R.Swift`进行安装，相关的步骤也不必累赘说明，一句`pod install`后我们把`R.Swift`安装进来了。

pod 'R.swift'

进入终端执行：

pod install

下面要进行R.Swift的配置，主要有几个步骤：

1.  进入项目的配置界面，在左边的TARGETS项下面选择我们的项目，并在右边点击Build Phases这个tab。
2.  进入Build Phases这个tab后，我们看到左上角有一个"+"按钮，点击并在弹出的选项卡中选择New Run Script Phase。
3.  我们会看到界面的下方多出了一个Run Script项，展开它，并在脚本输入区域输入`"$PODS_ROOT/R.swift/rswift" generate "$SRCROOT/R.generated.swift"` (第二对双引号括起来所代码的是项目的根目录，你也可以放到根目录下的其他目录中，只需将其修改为`"$SRCROOT/XXX"，XXX为目标目录名)`。这里把生成的 `R.generated.swift` 放在了工程的`main`路径下

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3J1Z2xjYw_size_16_color_FFFFFF_t_70]

1.  添加 $TEMP\_DIR/rswift-lastrun to the “Input Files” and $SRCROOT/R.generated.swift to the “Output Files” of the Build Phase
2.  我们按住新建的这个Run Script项向上移动，移到Compile Source项的上方，不过也要保证此时它也在Check Pods Manifest.lock项的下方。
3.  Command + B，编译一下，编译成功后，在Finder进入到刚刚我们制定的目录中，此时我们会看到一个名为R.generated.swift的文件已经创建了，直接把此文件拖入Xcode项目中，记住不要勾选Copy items if needed项。

配置到此完成，我们可以构建自己的项目了

\#\#R.Swift的使用

在这里要说明一下，每当我们修改了资源，我们需要Command + B来编译一下项目从而让R.Swift自动进行配置更新。

下面就来用实例演示一下R.Swift的使用，并与原生的API进行比对：

### Image - 图片 ###

//  不使用R.Swift
    let pImage = UIImage(named: "image_test")
    //  使用R.Swift
    let nImage = R.image.image_test()
    File - 数据文件
    
    //  不使用R.Swift
    let pFile = NSBundle.mainBundle().pathForResource("DataFile", ofType: "json")
    //  使用R.Swift
    let nFile = R.file.dataFileJson.path()

### Font - 字体 ###

//  不使用R.Swift
    let pFont = UIFont(name: "chalkduster", size: 35)
    //  使用R.Swift
    let nFont = R.font.chalkduster(size: 35)
    //  你看，非常神奇，在上面的方法中你不仅可以选择字体类型，还能设置字体大小

### Nib ###

//  不使用R.Swift
    tableView.registerNib(UINib(nibName: "TanTableViewCell", bundle: nil), forCellReuseIdentifier: CELL_IDENTIFIER)
    //  使用R.Swift
    tableView.registerNib(R.nib.tanTableViewCell(), forCellReuseIdentifier: CELL_IDENTIFIER)

\#\#\#Color - 颜色

颜色这里我觉得有必要细讲一下，一个较为庞大的项目，其颜色资源配置也是相应比较复杂，如某些视图的背景颜色、字体的颜色等等，以往我们进行颜色资源的配置，一般会定义一个全局的Config文件或类，里面就存有各种颜色，每种颜色用有意义的名称去标识。R.Swift与其不同的是，它还能有更赞的方式导入颜色资源： Color Palette

呵呵，这个方式可以说是非常的花式，配合R.Swift使用起来简直6得飞起！  
当我们在可视化视图编辑界面（如Storyboard）中为一个视图配置某些颜色时，我们可以进入颜色调色板来选择更多的颜色，如图：

新建一个调色板  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3J1Z2xjYw_size_16_color_FFFFFF_t_70 1]

找到该调色板文件

`/Library/Colors`

将该调色板文件复制到项目，并确保其中资源编译列表中

// 当调色板文件名为app.clr
    let clr = R.color.app.base()

## 参考文章 ##

[http://www.jianshu.com/p/10461449bb77][http_www.jianshu.com_p_10461449bb77]  
[https://github.com/mac-cain13/R.swift][https_github.com_mac-cain13_R.swift]  
[https://blog.csdn.net/mazy\_ma/article/details/73024576][https_blog.csdn.net_mazy_ma_article_details_73024576]

[Swift-颜色设置技巧和(.clr)文件的创建和使用][https_blog.csdn.net_mazy_ma_article_details_73024576]

[https_github.com_mac-cain13_R.swift]: https://github.com/mac-cain13/R.swift
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3J1Z2xjYw_size_16_color_FFFFFF_t_70]: /images/20220608/5319e8fd177e46c8958990b2626d1785.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3J1Z2xjYw_size_16_color_FFFFFF_t_70 1]: /images/20220608/12602255cba54cf9a7c1dc7a51fde905.png
[http_www.jianshu.com_p_10461449bb77]: http://www.jianshu.com/p/10461449bb77
[https_blog.csdn.net_mazy_ma_article_details_73024576]: https://blog.csdn.net/mazy_ma/article/details/73024576