R.swift优雅的引入项目中的资源文件

发表于 更新于 分类于

R.swift是一个高效引入iOS资源的框架,避免了使用字符串引入资源文件导致程序崩溃的尴尬。
目前R.swift支持到Swift3.0版本

优势

使用代码的方式来引入资源:

  • 类型完整: 减少推断和转换方法返回值的类型
  • 编译时检查: 不会再因为不正确的字符串导致App产生运行时崩溃
  • 自动补全: 不再需要输入图片名称

示例：

1
2
3
4
5
之前: 
let image = UIImage(named: "imageName")

R.swift: 
let image = R.image.imageName()

功能

使用R.swift之后,可以使用R结构体来获取资源文件。如若资源文件发生改变,R.swift会正确的清除\改变\增加资源。

R.swift目前支持如下几种资源:

  • Images
  • Fonts
  • Resource files
  • Colors
  • Localized String
  • StoryBoard
  • Segues
  • Nibs
  • Reuseable cells

接入方式

CocoaPods

  1. 添加pod R.swift至Podfile文件中之后终端执行pod install
  2. Xcode配置:在当前项目的targets中选择Build phrase,点击+号选择添加New Run Script Phase,
  3. 将Run Script移动至Compile sources之上,Check Pods Manifest.lock之下。在Run Script中添加:"$PODS_ROOT/R.swift/rswift" "$SRCROOT",
  4. 编译你的项目,在Finder中你会看到R.generated.swift在Pod文件中,将该文件拖动至项目中,切记千万不要勾选Copy items if needed,
  5. 新增\删除\修改资源文件之后都需要重新command+B编译项目,保证正确引用。

使用方式

1、Images

之前:

1
2
let png = UIImage(named: "png")
let jpg = UIImage(named: "jpg.jpg")

R.swift:

1
2
let png = R.image.png()
let jpg = R.imgae.jpgJpg()

2、Custom fonts

之前:

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

R.swift:

1
let customFont = R.font.acmeLight(size: 22)

3、Resource files

之前 :

1
2
let jsonURL = Bundle.main.url(forResource: "seed-data", withExtension: "json")
let jsonPath = Bundle.main.path(forResource: "seed-data", ofType: "json")

R.swift:

1
2
let jsonURL = R.file.seedDataJson()
let jsonPath = R.file.seedDataJson.path()

4、Localized Strings

之前:

1
2
3
4
5
let welcomeMessage = NSLocalizedString("welcome.message", comment: "")
let settingsTitle = NSLocalizedString("title", tableName: "Settings", comment: "")
let welcomeName = String(format: NSLocalizedString("welcome.withName", comment: ""), locale: NSLocale.current, "Alice")
let progress = String(format: NSLocalizedString("copy.progress", comment: ""), locale: NSLocale.current, 4, 23)

R.swift:

1
2
3
4
let welcomeMessage = R.string.localizable.welcomeMessage()
let settingsTitle = R.string.settings.title()
let welcomeName = R.string.localizable.welcomeWithName("Alice")
let progress = R.string.localizable.copyProgress(completed: 4, total: 23)

5、Segues

之前:

1
2
3
4
5
6
7
8
9
performSegue(withIdentifier: "openSettings", sender: self)

override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
    if let settingsController = segue.destination as? SettingsController,
       let segue = segue as? CustomSettingsSegue, segue.identifier == "openSettings" {
      segue.animationType = .LockAnimation
      settingsController.lockSettings = true
    }
  }

R.swift:

1
2
3
4
5
6
7
performSegue(withIdentifier: R.segue.overviewController.openSettings, sender: self)

override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
  if let typedInfo = R.segue.overviewController.openSettings(segue: segue) {
    typedInfo.segue.animationType = .LockAnimation
    typedInfo.destinationViewController.lockSettings = true
  }

6、Nibs

之前:

1
2
3
4
5
let nameOfNib = "CustomView"
let customViewNib = UINib(nibName: "CustomView", bundle: nil)
let rootViews = customViewNib.instantiate(withOwner: nil, options: nil)
let customView = rootViews[0] as? CustomView
let viewControllerWithNib = CustomViewController(nibName: "CustomView", bundle: nil)

R.swift:

1
2
3
4
5
6
let nameOfNib = R.nib.customView.name
let customViewNib = R.nib.customView()
let rootViews = R.nib.customView.instantiate(withOwner: nil)
let customView = R.nib.customView.firstView(owner: nil)

let viewControllerWithNib = CustomViewController(nib: R.nib.customView)

7、Reusable table view cells

UITableView

之前:

1
2
3
4
5
6
7
8
9
10
11
12
13
class FaqAnswerController: UITableViewController {
  override func viewDidLoad() {
    super.viewDidLoad()
    let textCellNib = UINib(nibName: "TextCell", bundle: nil)
    tableView.register(textCellNib, forCellReuseIdentifier: "TextCellIdentifier")
  }

  override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
    let textCell = tableView.dequeueReusableCell(withIdentifier: "TextCellIdentifier", for: indexPath) as! TextCell
    textCell.mainLabel.text = "Hello World"
    return textCell
  }
}

R.swift:

1
2
3
4
5
6
7
8
9
10
11
12
class FaqAnswerController: UITableViewController {
  override func viewDidLoad() {
    super.viewDidLoad()
    tableView.register(R.nib.textCell)
  }

  override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
    let textCell = tableView.dequeueReusableCell(withIdentifier: R.nib.textCell.identifier, for: indexPath)!
    textCell.mainLabel.text = "Hello World"
    return textCell
  }
}

UICollectionView

之前:

1
2
3
4
5
6
7
8
9
10
11
12
13
class RecentsController: UICollectionViewController {
  override func viewDidLoad() {
    super.viewDidLoad()
    let talkCellNib = UINib(nibName: "TalkCell", bundle: nil)
    collectionView?.register(talkCellNib, forCellWithReuseIdentifier: "TalkCellIdentifier")
  }

  override func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
    let cell = collectionView.dequeueReusableCell(withReuseIdentifier: "TalkCellIdentifier", for: indexPath) as! TalkCell
    cell.configureCell("Item \(indexPath.item)")
    return cell
  }
}

R.swift:

1
2
3
4
5
6
7
8
9
10
11
12
class RecentsController: UICollectionViewController {
  override func viewDidLoad() {
    super.viewDidLoad()
    collectionView?.register(R.nib.talkCell)
  }

  override func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
    let cell = collectionView.dequeueReusableCell(withReuseIdentifier: R.reuseIdentifier.talkCell, for: indexPath)! // 此处跟tableView的使用方式还是有很大区别
    cell.configureCell("Item \(indexPath.item)")
    return cell
  }
}

相关链接

https://github.com/mac-cain13/R.swift