使用BUCK進行iOS項目打包

關於BUCK

BUCK是Facebook開源的快速打包工具，能夠用於多種語言及平臺的項目打包，例如：C、C++、Java、iOS、Android等等。用於大型的iOS、Android項目，能夠顯著提高打包效率。

關於BUCK介紹的一些連接以下：

BUCK官網

What Makes Buck so Fast?：介紹了BUCK如何作到性能提高

BUCK源碼： 裏面有源碼和大量Unit Test提供了不少示例，同時查看Issues能夠找到不少問題的解決方案

iOS快速編譯BUCK

基於Facebook Buck改造Android構建系統之初體驗

 

核心概念

Build Rule

A build rule is a procedure for producing an output file from a set of input files.

Build Target

A build target is a string that is used to identify a build rule in your project.

Build File 

A build file is a file named BUCK that defines one or more build rules.

.buckconfig

The root of your project must contain a configuration file named  .buckconfig.

 

iOS打包相關Rule

Rule	產出	做用
apple_asset_catalog()	沒有特定產出，能夠做爲apple_bundle()的依賴	Contains resources stored in Apple asset catalog directories
apple_binary()	靜態庫：.a file	An apple_binary() rule builds a native executable from the supplied set of Objective-C/C++ source files
apple_bundle()	.app 或者 .appex (apple watch extension)	An apple_bundle() rule takes an Apple binary and all of the resources and asset catalogs in the rule's transitive dependencies and generates a bundle containing all of those files.
apple_library()	靜態庫：.a file	An apple_library() rule represents a set of Objective-C/C++ source files
apple_package()	ipa file	An apple_package() rule takes the output of an apple_bundle() rule and compresses it in an IPA (iOS App Store Package) file.
apple_resource()	This rule does not have any output on its own and can be built only as a dependency (either direct or transitive) of an apple_bundle() rule.	An apple_resource() rule contains sets of resource directories, files and file variants that can be bundled in an application bundle.
apple_test()	無	An apple_test() rule contains Objective-C/C++ code which can be built and used to test code contained in other rules.
core_data_model()	This rule does not have any output on its own and can be built only as a dependency (either direct or transitive) of an apple_bundle() rule, in which case all core_data_model() rules that the bundle rule depends on are merged and placed into the final output bundle together.	An core_data_model() rule contains models for Apple's Core Data framework.
prebuilt_apple_framework()	無	引用.framework庫

 

使用BUCK用於iOS工程打包

目錄組織結構

對於一個多個子工程組成，經過依賴關係最終集成爲單個可執行文件。使用BUCK，須要爲每個子工程都建立BUCK文件，在根目錄配置.buckconfig。大體目錄結構以下：

 

|—.buckconfig

|—BUCK

|—SubProject1

|---------src

|---------BUCK

|—SubProject2

|---------src

|---------BUCK

|—SubProject3

|---------src

|---------BUCK

|—SubProject4

|---------src

|---------BUCK

......

 

每一個子工程的BUCK文件，負責配置build rule，生成靜態.a 文件，而後最終經過根目錄中的BUCK，來生成.ipa文件。

 

.buckconfig配置

[cache]
  mode = dir
 
[cxx]
    cflags = -std=gnu11
    cxxflags = -std=c++14 -stdlib=libc++
    default_platform = iphonesimulator-x86_64
    combined_preprocess_and_compile = true
 
[alias]
  SubProject1 = //SubProject1: SubProject1Lib
  SubProject2 = //SubProject2: SubProject2Lib
  SubProject3 = //SubProject3: SubProject3Lib
  SubProject4 = //SubProject4: SubProject4Lib
  
 
[apple]
  xctool_zip_target = //third-party/ios/xctool:xctool-minimal-zip
 
[project]
    ignore = .buckd, \
             .hg, \
             .git, \
             .idea, \
             buck-cache, \
             buck-out, \

 

cxx：定義了一些C++編譯的參數

alias: 定義了一些build target的別名。例如CTFoundation爲例，在CTFoundation中的BUCK文件中定義了CTFoundationLib的rule，因此若是要打包CTFoundation，能夠經過別名的方式，命令以下：

# 未用別名
buck build //SubProject1:SubProject1Lib
  
# 使用別名
buck build SubProject1

 

apple: 指定了xctool的文件地址。Buck的iOS打包是依賴於xctool，因此須要把xctool的相關代碼引入，具體內容能夠參考示例： 

git clone git@github.com:fbsamples/bucksamples.git
cd bucksamples/cross-platform-scale-2015-demo/

 

 

BUCK文件配置

獨立子工程的BUCK配置

下面以一個獨立的子工程做爲示例，並且沒有其餘依賴，因此能夠做爲第一個示例。它的BUCK文件配置以下：

apple_library(
  name = 'SubProject1Lib',
  preprocessor_flags = ['-fobjc-arc','-Wno-deprecated-declarations','-fmodules'],
  compiler_flags = ['-Wno-objc-designated-initializers','-fembed-bitcode'],
  linker_flags = [
        '-F$DEVELOPER_DIR/Platforms/iPhoneSimulator.platform/Developer/Library/PrivateFrameworks',
        '-F$DEVELOPER_DIR/../SharedFrameworks',
        '-F$DEVELOPER_DIR/Library/PrivateFrameworks',
  ],
 
  srcs = glob(['src/**/**/**/*.m',]),
 
  frameworks = [
        '$SDKROOT/System/Library/Frameworks/Foundation.framework',
  ],
   
  exported_headers = {
    'xxx1.h': './src/xxx.h',
    'xxx2.h': './src/xxx2.h',
    ...
  },
 
  #header_namespace = '',
  visibility = [
    'PUBLIC',
  ],
)

 

整個BUCK文件就一個apple_library，產出libCTLocation.a文件。能夠看到裏面能夠指定一下編譯的flags、依賴的framework、源代碼、對外暴露的頭文件等等。

經過命令 buck build CTLocation就能夠打包查看，在buck-out目錄中能夠看到生成出來的.a文件。

 

須要注意的exported_headers的配置：

The set of header files that are made available for inclusion to the source files in this target and all targets that transitively depend on this one. These should be specified as either a list of header files or a dictionary of header names to header files. The header names can contain forward slashes (/). If a list of header files is specified, the headers can be imported with #import "$HEADER_PATH_PREFIX/$HEADER_NAME" or, if a header file that belongs to the same rule is being imported, with #import "$HEADER_NAME", where $HEADER_PATH_PREFIX is the value of the target's header_path_prefix attribute, and $HEADER_NAME is the filename of the header file. If a dictionary is specified, each header can be imported with #import "$HEADER_NAME", where $HEADER_NAME is the key corresponding to this file. In this case, the header_path_prefix attribute is ignored. In either case, quotes in the import statements can be replaced with angle brackets.

 

能夠有兩種配置格式，數組和字典。

使用數組的時候，其餘代碼引用是須要加上前綴例如：#import "SubProject1/xxx.h"，默認前綴和apple_library的name一致，能夠經過設置header_path_prefix改變。

使用字典的時候，其餘代碼引用時候能夠經過key來引用，例如：

// BUCK配置：
exported_headers = {
 'xxx.h': './src/xxx.h',
}
  
// 其餘代碼引用
#import "xxx.h"

 

依賴資源文件

若是代碼中有資源文件，須要經過apple_resource來引用

apple_resource(
    name = 'SubProject1Resource',
    files = glob(['*.png']),
    dirs = [],
)

 

特殊的Compiler flag

在iOS中，有些源代碼須要一些特殊的compiler flag，例如非ARC的源碼。在src裏面能夠進行配置:

srcs = glob(['SubProject1/**/**/**/*.m',], excludes = ['**/**/xxx1.m','**/**/xxx2.m'])+
  [('src/xxx1.m', ['-Wno-shorten-64-to-32']),
  ('src/xxx2.m', ['-fno-objc-arc'])]

 

引用外部framework

prebuilt_apple_framework(
    name = 'BuckTest',
    framework = 'BuckTest.framework',
    preferred_linkage = 'shared',
    visibility = ['PUBLIC'],
)

 

引用外部.a 靜態庫

以下項目有依賴外部的.a庫，能夠經過如下方法引用

cxx_library(
  name = 'lib1',
  srcs = [],
  exported_headers = {
    'xxx.h': 'libs/xxx.h',
  },
  visibility = ['PUBLIC'],
)
  
apple_library(
  name = 'SubProject1Lib',
  deps = [':lib1'],
  ...
  libraries = [
    'libs/xxx.a',
  ],

 

當前BUCK的侷限性

BUCK自己目前還在快速迭代中，因此不少rule尚未完善、文檔不全，社區也夠活躍，遇到問題會比較難找到解決方案。

目前iOS項目中碰到的一些限制問題：

• 自定義的script，在XCode的build phase中能夠自定義一些shell腳本，可是在BUCK中沒有找到對應的方式
• 沒法生成.bundle資源包，iOS打包過程當中每一個子工程都會產出一個.a和.bundle文件，可是BUCK打包不會產出.bundle文件只會有.a，資源文件只能經過apple_resource()來管理做爲其餘rule的依賴。
• 經過apple_library()生成.a文件彷佛目前還沒辦法指定valid architectures。