Xcodegen构建Xcode Project

xcodeprojects存在问题?

Xcode 使用项目文件.xcodeproj文件来捆绑 IDE 的源代码和资源.在大多数情况下是正常工作的,但它有以下几个缺点:
  • 在不同的分支上添加了源码文件或资源后无法确定文件是否正确,虽然说你可以手动去解决.xcodeproj文件中的合并冲突。

  • 如果想要同步电脑上的文件夹结构或者项目中的group结构,我们往往是通过人工手动来决定,这就难免会造成混淆。幸运的是已经有工具可以来解决这个问题了,比如synx或xcodeproj gem的排序功能。

  • Xcode 只会在编译后才会提示你项目中存在文件的丢失。

  • 编写依赖关系并构建多个目标的脚本可能会变得非常麻烦。

xcodegen 简介

xcodegen是一个工具,它允许我们从名为project.yml的文件中的定义生成xcodeproj文件。

由于xcodeproj文件可以随时生成,我们甚至不必将它保存在我们的git中并且可以忽略它。

以下是xcodegen的两个最重要的功能:

  • 可以通过这种方式为各种平台(iOS,tvOS,macOS,watchOS)定义各种 Xcode target(application,frameworks 等)。

  • 它还允许将源文件的文件夹连接到目标,从而更容易管理哪些源代码文件包含在哪个目标中。

如何安装 GitHub

  • 使用 homebrew进行安装
brew install xcodegen
mint install yonaskolb/xcodegen

生成一个App Project

  • 首先, 创建一个空的swift 工程 就可能得到所有的.swift 和.xcassets 文件.


    XcodegenApp.png
  • 在工程的根目录创建一个 project.yml 文件内容如下,并保存文件(我使用的是Sublime Text)

name: XcodegenApp # The name of the App
options: # Some general settings for the project
  createIntermediateGroups: true # If the folders are nested, also nest the groups in Xcode
  indentWidth: 2 # indent by 2 spaces
  tabWidth: 2 # a tab is 2 spaces
  bundleIdPrefix: "com.SkyMing"
targets: # The List of our targets
  XcodegenApp:
    type: application
    platform: iOS
    deploymentTarget: "10.3"
    sources:
      #Sources
      - path: XcodegenApp
project.yml 文件内容
  • 重命名.xcodeproj文件 ( 这样你可以进行对比文件的修改)


    重命名.xcodeproj文件
  • 打开终端,进入到你的工程目录

cd ~/Desktop/XcodegenApp
  • 执行xcodegen
xcodegen
终端运行
  • 打开XcodegenApp.xcodeproj并运行, 你可以看到和原来的工程一样可正常运行


    XcodegenApp.xcodeproj

生成 TestTargets

  • 在project.yml 文件中添加target ,并保存文件
  XcodegenApp-iOS-Tests:
    type: bundle.unit-test
    platform: iOS
    deploymentTarget: "10.3"
    sources:
      - path: XcodegenAppTests
    dependencies:
      - target: XcodegenApp
project.yml添加TestTargets
  • 关闭xcode(在xcode 工程打开的时候 进行修改文件可能有异常情况出现.)

  • 执行xcodegen,生成工程文件, 打开并运行:正常!

xcodegen
  • 在project.yml 文件中添加 UI Tests target,并保存文件
  XcodegenApp-iOS-UITests:
    type: bundle.ui-testing
    platform: iOS
    sources:
      - path: XcodegenAppUITests
    dependencies:
      - target: XcodegenApp
屏幕快照 2019-07-04 上午11.20.34.png
  • 执行xcodegen,生成工程文件, 打开并运行:正常!
xcodegen

生成一个 Framework 工程

创建了一个XcodegenAppCore框架,其中包含经典的水果枚举:

  • 在根目录创建一个文件夹XcodegenAppqCore

  • 在XcodegenAppCore目录中创建一个Fruit.swift 文件,加入下面的代码

public enum Fruit: String {
  case apple
  case banana
  case cherry
}
XcodegenAppCore
  • 在XcodegenAppCore目录中添加一个 Info.plist 文件
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>CFBundleDevelopmentRegion</key>
    <string>$(DEVELOPMENT_LANGUAGE)</string>
    <key>CFBundleExecutable</key>
    <string>$(EXECUTABLE_NAME)</string>
    <key>CFBundleIdentifier</key>
    <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
    <key>CFBundleInfoDictionaryVersion</key>
    <string>6.0</string>
    <key>CFBundleName</key>
    <string>$(PRODUCT_NAME)</string>
    <key>CFBundlePackageType</key>
    <string>FMWK</string>
    <key>CFBundleShortVersionString</key>
    <string>4.0</string>
    <key>CFBundleVersion</key>
    <string>$(CURRENT_PROJECT_VERSION)</string>
    <key>NSPrincipalClass</key>
    <string></string>
</dict>
</plist>
  • 在project.yml文件中添加target
XcodegenAppCore:
  type: framework
  platform: iOS
  deploymentTarget: "10.3"
  sources:
    - path: XcodegenAppCore
project.yml添加XcodegenAppCore
  • 在XcodegenApp中添加dependencies
dependencies:
    - target: XcodegenAppCore
project.yml添加dependencies
  • 执行xcodegen,生成工程文件, 打开并运行:正常!
xcodegen
  • 测试XcodegenAppCore的使用(在 ViewController 文件中添加如下代码,在debug 日志中可以看到输出 framework的所有者)
import UIKit

import XcodegenAppCore

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view.
      print(Fruit.apple)
    }
}
XcodegenAppCore的使用
  • 最后删除XcodegenApp-Backup.xcodeproj文件

使用CocoaPods添加依赖

1. 使用终端cd到工程目录下
2. 创建Podfile文件
pod init
3. 在项目目录里打开Podfile文件
open Podfile
4. 添加SnapKit
pod 'SnapKit', '~> 5.0.0'
5. 保存后退出
6. 开始下载第三方库
pod install
pod install

调整项目文件位置

屏幕快照 2019-07-04 下午2.36.55.png
  • 打开XcodegenApp.xcworkspace文件
XcodegenApp.xcworkspace
  • 点击XcodegenApp.xcodeproj文件 修改Location位置

  • 点击XcodegenApp.xcodeproj
  • 修改Location位置
  • 关闭程序.重新打开XcodegenApp.xcworkspace文件

  • 修改成功后

编写genProj脚本忽略xcuserdata与xcworkspace文件并重新生成程序

  • project.xcworkspace说明:is a directory of files describing the workspace or projects. Although some of the answers here indicate it is unnecessary and should be ignored for source control, I don't agree, but it's going to be highly dependent upon how you use your environment. Generally, the contents of the project.xcworkspace directory contains the contents.xcworkspace data file, which lists the projects that are included as top-level entities in your project。

  • xcuserdata说明:You can safely delete the xcuserdata directories. It basically contains personal settings like breakpoints, user interface layout, open files, automatic snapshots configuration and so on。

  • genProj脚本编写

#!/bin/bash

rm -rf XcodegenApp.xcworkspace/xcuserdata
rm -rf Pods/Pods.xcodeproj/xcuserdata

cd XcodegenApp
rm -rf XcodegenApp.xcodeproj
xcodegen --project .
cd XcodegenApp.xcodeproj
rm -rf project.xcworkspace
rm -rf xcuserdata
# rm -rf xcshareddata
  • 使用终端执行脚本
sh genProj
  • 使用终端执行脚本
  • 最终项目的结构

参考

Better iOS projects: Getting (nearly) rid of Xcodeproject - A (not so) short Introduction to Xcodegen

Xcodegen介绍 | 一款可以帮助你更好的构建Xcode Project的工具

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

推荐阅读更多精彩内容