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(没用过，如需使用请自行百度使用方法)进行安装 ps:mint是一个包管理器

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 文件

    CFBundleDevelopmentRegion
    $(DEVELOPMENT_LANGUAGE)
    CFBundleExecutable
    $(EXECUTABLE_NAME)
    CFBundleIdentifier
    $(PRODUCT_BUNDLE_IDENTIFIER)
    CFBundleInfoDictionaryVersion
    6.0
    CFBundleName
    $(PRODUCT_NAME)
    CFBundlePackageType
    FMWK
    CFBundleShortVersionString
    4.0
    CFBundleVersion
    $(CURRENT_PROJECT_VERSION)
    NSPrincipalClass
    

• 在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添加依赖

• 点击查看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的工具