SwiftGen 自动生成资源代码

简介: SwiftGen 自动生成资源代码

对比


在 github 上有两个比较好用的库  R.Swift  和  SwiftGen,都很好的解决了从 字符串Strongly typed identifiers 的自动工作。

  • SwiftGen 相对来说依赖少一点,可配置空间更大,适合老项目引入并资源局部管理。
  • R.Swift 配置简单且管理全面,适合新项目引入并资源全局管理。

最终的使用效果如下:

// SwiftGen
let image = Asset.icon_return.image
let font = FontFamily.SanFranciscoDisplay.semibold.font(size: 18)
// R.Swift
let image = R.image.icon_return()
let font = R.font.sanFrancisco(size: 18)


安装


官方新版本推荐通过 brew 进行安装。

实测下来,也是 brew 安装问题最少,下载二进制包有权限问题,pod 集成有找不到 SwiftGen 的情况,别问我是怎么知道的...

brew update
brew install swiftgen


使用


基础:生成代码

在项目根目录下,创建 Templates 文件夹,将下面的模板文件放入其中。

Xcassets.stencil 和 Fonts.stencil 上传到 Github 了,地址:github.com/ReverseScal…

Xcode 中添加一个 New Run Script Phase,将 Run Script 拖动到 Check Pods Manifest.lock 的下面,脚本内容如下,其中 ZGERPHomeModule 和路径需要根据项目调整:

swiftgen run xcassets $PROJECT_DIR/../ZGERPHomeModule/Assets/Media.xcassets --templatePath $PROJECT_DIR/../Templates


image.png


如需使用第三方字体,可以同时设置字体脚本。

swiftgen run fonts $PROJECT_DIR/../ZGERPHomeModule/Assets/ --templatePath $PROJECT_DIR/../Templates/Fonts.stencil --param bundleName=ZGERPHomeModule --output $PROJECT_DIR/../ZGERPHomeModule/Classes/SwiftGen/Fonts.swift

Command + B/R 脚本会根据模块中 Media.xcassets 中的资源,自动生成对应代码。


image.png


// SwiftGen xcassets template for Asprin
import UIKit
enum Asset {
  static let closedIcon = ImageAsset(name: "closed_icon")
  static let iconReturn = ImageAsset(name: "icon_return")
}
struct ImageAsset {
    fileprivate var name: String
    var image: UIImage {
        let bundle = ZGERPModuleAssets.currentBundle()
        let image = UIImage(named: name, in: bundle, compatibleWith: nil)
        guard let result = image else { 
            fatalError("Unable to load image named \(name).") 
        }
        return result
    }
}
class ZGERPModuleAssets: NSObject {
    /// 获取当前库包
    internal class func currentBundle() -> Bundle {
        let podBundle = Bundle(for: ZGERPHomeModule.self)
        if let bundleURL = podBundle.url(forResource: "ZGERPHomeModule", withExtension: "bundle") {
            if let bundle = Bundle(url: bundleURL) {
                return bundle
            } else {
                return podBundle
            }
        } else {
            return podBundle
        }
    }
}


进阶:生成 xcassets 文件

上面我们通过 xcassets 文件中的资源自动生成了引入代码,但是设计师小姐姐给到我们的素材都是 xxx@2x.pngxxx@3x.png 这个样子滴,如果能自动生成 xcassets 文件就好了。


image.png


1)让我在上面的 Script 文件夹下,再添加下面这个文件(上面提到的 Github 中有滴)。

2)在跟目录下创建配套的 ImageFolder,ImageFolderBackup 和 Resource 文件夹。

Demo
- Templates
 - AutoAsset // 二进制脚本
 - Fonts.stencil // 字体模板
 - Xcassets.stencil // 图片模板
- ImageFolder // 图片文件夹
- ImageFolderBackup // 图片备份文件夹
- Resource // 输出路径

3)还是我们熟悉的添加脚本。

$PROJECT_DIR/script/AutoAsset $PROJECT_DIR/synchronizeImageFolder $PROJECT_DIR/synchronizeImageFolder_backup $PROJECT_DIR



image.png


4)如果要配合自动生成代码,就继续在下面添加脚本。

$PODS_ROOT/SwiftGen/bin/swiftgen  xcassets $PROJECT_DIR/ResourceManageDemo/Assets.xcassets --templatePath $PROJEC


image.png


同时可以编写 Podfile 文件,把 Xcode Build Phases 加入。

source 'https://cdn.cocoapods.org/'
use_frameworks!
inhibit_all_warnings!
platform :ios, '9.0'
target 'Demo' do
  pod 'SwiftGen'
  script_phase :name => '[CP-User] Create Xcassets', :script => '$PROJECT_DIR/Script/AutoAsset $PROJECT_DIR/ImageFolder $PROJECT_DIR/ImageFolderBackup $PROJECT_DIR/Resource/Assets.xcassets', :execution_position => :before_compile
end

SwiftGen 生成的产物,可以运行 swiftgen config lint 进行校验。

Linting swiftgen.yml
> Common parent directory used for all input paths:  <none>
> Common parent directory used for all output paths: <none>
> 1 entry for command xcassets:
$ swiftgen xcassets --templateName swift4 --output UIImage+Assets.swift Media.xcassets


目录
相关文章
|
JSON API 开发工具
API参考—实例管理—CreateDBInstance
API参考—实例管理—CreateDBInstance
155 0
|
XML JSON API
API参考—实例管理—DeleteDBInstance
调用DeleteDBInstance接口释放实例。
100 0
|
XML JSON API
API参考—实例管理—ModifyDBInstanceMaintainTime
调用ModifyDBInstanceMaintainTime接口修改实例可维护时间。
|
XML JSON API
API参考—实例管理—ModifyDBInstanceDescription
调用ModifyDBInstanceDescription接口修改实例描述。
|
XML JSON API
API参考—实例管理—DescribeDBInstances
调用DescribeDBInstances接口查看实例列表详情。
|
XML JSON API
API参考—实例管理—RestartDBInstance
调用RestartDBInstance接口重启实例。
111 0
|
6月前
|
自然语言处理 搜索推荐 iOS开发
Mac安装和使用GitBook
Mac安装和使用GitBook
|
弹性计算 开发工具 Android开发
阿里云APP备案操作流程_亲测
阿里云APP备案操作流程_亲自测试,一共6个步骤即可完成APP备案
13927 2
|
Unix iOS开发 Ruby
Mac 从零安装cocoapods
最近申请换了台 MacBook Pro(之前用的是MacBook Air),一台干净的像小孩子屁股一样的电脑,iOS开发相关的常用软件一个也没有。当下载了item2(本人很不喜欢Mac自带的终端,所以还是习惯的下载了item2,如果有小伙伴需要了解,请点击https://www.jianshu.com/p/93f5c3491954)Xcode和项目后,由于我们项目用了cocoapods,所以不得不安装它。关于cocoapods的介绍就不多说了,下面直接开始安装步骤吧!
Mac 从零安装cocoapods
|
vr&ar Swift
大师学SwiftUI第9章Part 1 - 异步并发之Task、Async、Await和错误
苹果系统借助现代处理器的多核可同步执行多条代码,提升同一时间内程序所能执行的任务。例如,一段代码从网上下载文件,另一段代码可以在屏幕上显示进度。此时,我们不能等待第一个执行完后再执行第二个,而必须要同步执行这两个任务。
177 0