R.swift:以一种优雅安全的方式使用资源文件

引言:当前使用资源文件存在的问题

先来看下目前如果我们要使用资源文件时代码是如何调用的:
<pre><code>let icon = UIImage(named: "settings-icon")

let font = UIFont(name: "San Francisco", size: 42)

performSegueWithIdentifier("openSettings")</code></pre>
这种通过传入字符串来获取资源有很大的潜在的风险:

  • 最常见的就是资源名称拼写错误。如果项目资源很多检查拼写正确也是颇费时间
  • 如果删除了一个资源文件,只能通过全局搜索资源名称来判断是否已经没有使用这个资源

R.swift的解决方案

先看下上面的逻辑用R.swift代码调用:
<pre><code>let icon = R.image.settingsIcon

let font = R.font.sanFrancisco(size:42)

performSegueWithIdentifier(R.segue.openSettings)</code></pre>
R如何解决上面的问题:

  • 强类型
    使用一个资源前,先声明是什么类型。如果是一个图片资源就是R.image.xx。这样每次明确知道使用的资源类型。(swift是一门强类型语言,强类型的一个好处就是很多错误可以在编译时就发现)
  • 编译时检查资源文件是否存在
  • 自动填充资源名称
    因为会自动根据资源文件生成结构体,所以可以直接使用,不用自己拼写资源名

支持的资源类型

<pre><code>
//使用R.swift之前

let settingsIcon = UIImage(named: "settings-icon")

let gradientBackground = UIImage(named: "gradient.jpg")

//使用R.swift

let settingsIcon = R.image.settingsIcon

let gradientBackground = R.image.gradientJpg</code></pre>

<pre><code>
//使用R.swift之前

let storyboard = UIStoryboard(name: "Main", bundle: nil)

let initialTabBarController = storyboard.instantiateInitialViewController() as? UITabBarController

let settingsController = self.instantiateViewControllerWithIdentifier("settingsController") as? SettingsController

//使用R.swift

let storyboard = R.storyboard.main.instance

let initialTabBarController = R.storyboard.main.initialViewController

let settingsController = R.storyboard.main.settingsController

//通过这个代码来校验运行时storyboard的图片是否都能被加载

// 只在debug模式下有效,会通过断言来提示

R.storyboard.main.validateImages()

//在运行时校验所有的viewController能够被正常加载

mode.R.storyboard.main.validateViewControllers()
</code></pre>

<pre><code>
//使用R.swift之前

performSegueWithIdentifier("openSettings")

//使用R.swift

performSegueWithIdentifier(R.segue.openSettings)

</code></pre>

<pre><code>
//使用R.swift之前

let nameOfNib = "CustomView"

let customViewNib = UINib(nibName: "CustomView", bundle: nil)

let rootViews = customViewNib.instantiateWithOwner(nil, options: nil)

let customView = rootViews[0] as? CustomView

let viewControllerWithNib = CustomViewController(nibName: "CustomView", bundle: nil)

//使用R.swift

let nameOfNib = R.nib.customView.name

let customViewNib = R.nib.customView

let rootViews = R.nib.customView.instantiateWithOwner(nil, options: nil)

let customView = R.nib.customView.firstView(nil, options: nil)

let viewControllerWithNib = CustomViewController(nib: R.nib.customView)
</code></pre>

<pre><code>
//使用R.swift之前

let textCellNib = UINib(nibName: "TextCell", bundle: nil)

tableView.registerNib(textCellNib, forCellReuseIdentifier: "TextCellIdentifier")

//使用R.swift

tableView.registerNib(R.nib.textCell)

//cellForRowAtIndexPath中获取cell

let textCell = tableView.dequeueReusableCellWithIdentifier(R.nib.textCell.reuseIdentifier, forIndexPath: indexPath)
</code></pre>

<pre><code>
//使用R.swift之前

let lightFontTitle = UIFont(name: "Acme-Light", size: 22)

//使用R.swift

let lightFontTitle = R.font.acmeLight(size: 22)

</code></pre>

<pre><code>
//使用R.swift之前

let jsonURL = NSBundle.mainBundle().URLForResource("seed-data", withExtension: "son")

//使用R.swift

let jsonURL = R.file.seedDataJson

</code></pre>

和同类型的其他开源库对比的优势

其他同类型的第三方库有: Shark, Natalie , SwiftGen
R.swift的优势有:

  • 通过项目文件(Xcodeproj)来检测资源而不是通过扫描文件里的资源
  • 支持多种资源类型
  • 设计之初接口就希望接近苹果原生API,让你快速上手

支持iOS7.0+

强烈建议项目只支持稳定的iOS8,但是这个库确实支持iOS7

运行原理

每当项目build时,R.swift开始运行。它会侦测工程文件里包含的资源文件,接着生成一个 <code>R.generated.swift</code>的文件。这个文件根据项目里的资源文件按照类型生成结构体。

安装

因为R.swift是在每次项目编译时运行,所以配置和其他第三方库有些区别。这里单独写了一篇介绍Installation:如何安装R.swift

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,026评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,655评论 1 296
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,726评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,204评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,558评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,731评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,944评论 2 314
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,698评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,438评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,633评论 2 247
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,125评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,444评论 3 255
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,137评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,103评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,888评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,772评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,669评论 2 271

推荐阅读更多精彩内容