一、搜索路径设置
$(SRCROOT)
宏和$(PROJECT_DIR)
宏都指xxx.xcodeproj所在的目录
$(default)
代替 /Users/xxx/Library/Developer/Xcode/DerivedData/xxxxx-erpfssifaoxedbccegoqjiclrfds ,这个路径受 xcode->Preferences->locations
影响。本文只讨论默认情况这种。
$(SYMROOT)
= $(default)/Build
$(BUILD_ROOT)
、$(BUILD_DIR)
= $(SYMROOT)/products
= $(default)/Build/products
$(CONFIGURATION)
当前的Build configuration,Debug时值为Debug。
$(EFFECTIVE_PLATFORM_NAME)
当前平台的名字,模似器时为值为-iphonesimulator
,当为真机时为-iphoneos
$(CONFIGURATION_BUILD_DIR)
= $(BUILD_DIR)/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)
= $(default)/Build/products/Debug-iphoneos
(Build configuration为debug,平台为真机情况)
在编译时,编译器会将相对路径替换成绝对路径,因此,头文件绝对路径=搜索路径+相对路径。
Framework Search Paths
:框架文件搜索路径设置(.framework文件)
Header Search Paths
:头文件搜索路径设置(.h文件)
Library Search Paths
:库搜索路径设置(静态库.a文件)
Header Search Paths
设置系统目录空间头文件(.h文件)搜索路径。
例如:引用工程中,路径为:xxx/testDemo/scr/test.h 的头文件,目录结构如下:
如果在Header Search Paths
中添加$(SRCROOT)
,则引用头文件时,需要写为#include "scr/test.h"
如果在Header Search Paths
中添加$(SRCROOT)/scr
,那么头文件引用直接引用 #include "test.h"
System Header Search Paths
和Header Search Paths
基本一样,区别只在于Header Search Paths
以一种抑制系统搜索路径中找到的标头的大多数警告的方式传递给编译器。
This setting is very similar to "Header Search Paths", except that headers are passed to the compiler in a way that suppresses most warnings for headers found in system search paths.
所以通常使用Header Search Paths
来设置,下文也忽略这个设置。
User Header Search Paths
设置用户目录空间头文件(.h文件)搜索路径。
和Header Search Paths
的区别如下:
当import时, 有两种方式:
#import <SomeClass.h>
#import "SomeClass.h"
在Header Search Paths中设置SomeClass的路径
我们知道,在C语言中,使用尖括号引用,预处理器会从系统目录空间(对应Header Search Paths)中搜索文件,所以此时可以正确引用到。同样,使用双引号引用,预处理器会先从用户目录空间(对应 User Header Search Paths)搜索,如果没有找到,再从系统目录空间(对应Header Search Paths)中搜索文件,所以也可以正确正确引用到。在User Header Search Paths中设置SomeClass的路径
使用尖括号引用就会报错,因为找不到对应的头文件。使用双引号则可以正常引用。原理同上。
所以,当需要设置头文件引用路径的时候,不推荐设置这里,推荐设置Header Search Paths
。
Always Search User Paths
设置是否总是搜索用户目录空间,如果设置为YES,则上文中的例子,在User Header Search Paths中设置SomeClass的路径,也可以使用#import <SomeClass.h>
这种方式引用。这个设置已被弃用,不推荐设置。
Framework Search Paths
设置框架文件(.framework文件)搜索路径
需要在Framework Search Paths
中添加对应framework所在目录的路径,引用时,需要写为#include <aaa/aaa.h>
这里需要注意,设置了Framework Search Paths
,仅仅是在编译的时候可以找到对应的头文件,具体是否将framework链接进当前target,还需要看是否设置Link Binary With Library 或 对应的Other Linker Flags
Library Search Paths
设置静态库(.a文件)搜索路径
这里需要注意,设置了Library Search Paths
,就会导致当前静态库被链接进当前target
二、模块化导入(语义导入)
也就是所谓的@import aaa;
模块化导入具体有什么优缺点,网上一堆资料,同学们可以自行百度,这里引用了一段stackoverflow上的回答
It's a new feature called Modules or "semantic import". There's more info in the WWDC 2013 videos for Session 205 and 404. It's kind of a better implementation of the pre-compiled headers. You can use modules with any of the system frameworks in iOS 7 and Mavericks. Modules are a packaging together of the framework executable and its headers and are touted as being safer and more efficient than
#import
.
One of the big advantages of using@import
is that you don't need to add the framework in the project settings, it's done automatically. That means that you can skip the step where you click the plus button and search for the framework (golden toolbox), then move it to the "Frameworks" group. It will save many developers from the cryptic "Linker error" messages.
You don't actually need to use the@import
keyword. If you opt-in to using modules, all#import
and#include
directives are mapped to use@import
automatically. That means that you don't have to change your source code (or the source code of libraries that you download from elsewhere). Supposedly using modules improves the build performance too, especially if you haven't been using PCHs well or if your project has many small source files.
Modules are pre-built for most Apple frameworks (UIKit, MapKit, GameKit, etc). You can use them with frameworks you create yourself: they are created automatically if you create a Swift framework in Xcode, and you can manually create a ".modulemap" file yourself for any Apple or 3rd-party library.
这里主要说下,怎么设置自己的库可以被语义导入。
在XCode的build setting内,Packaging内有以下设置module map的选项
Defines Module (DEFINES_MODULE) :
如果设置为YES,会认为项目自定义自己的组件,允许项目通过组件的方式引入Module Map File (MODULEMAP_FILE)
用来管理LLVM的module map,定义编译器组件结构.如果defines module为YES的时候,如果Module Map File没填,会自动生成.
在Cocoapod中,我们可以在podfile内添加use_modular_headers!
允许所有pod语义导入.也可以通过:modular_headers => true
配置特定的pod.
三、头文件引用方式总结
iOS中头文件,有5种引用方式
#import "aaa.h"
#import "aaa/aaa.h"
#import <aaa.h>
#import <aaa/aaa.h>
@import aaa;
#import "aaa.h"
这种引用方式,可以引用到的头文件,有3种。
-
Header Search Paths
中对应目录的文件。 -
User Header Search Paths
中对应目录的文件。 - 当前project中包含的头文件,也即
project.pbxproj
文件中包含的头文件。
#import "aaa/aaa.h"
这种引用方式,可以引用到的头文件,只有2种。
-
Header Search Paths
中对应目录的文件。 -
User Header Search Paths
中对应目录的文件。
#import <aaa.h>
这种引用方式,可以只可以引用到 Header Search Paths
中对应目录的文件。
#import <aaa/aaa.h>
这种引用方式,可以引用到的头文件
-
Header Search Paths
中对应目录的文件。 -
Framework Search Paths
中,对应framework的头文件 - 上文中,通过语义导入的模块,使用这种方式,Xcode可以自动解析为语义导入,其他方式不行。
@import aaa;
这种引用方式,只可以引用到开启了模块导入的模块,即Defines Module设置为YES的库,如果没有开启模块导入,则会报错。
综合上述5中情况,我们可以看出,#import <aaa/aaa.h>
和#import "aaa.h"
这两种情况,是更优的选择。
结合Cocoapods来看,一般来说,当我们使用Cocoapod的时候,Cocoapod会自动给我们添加对应的Header Search Path
。
Cocoapod自动生成的目录结构如下
所以当我们使用#import <Masonry/Masonry.h>
这种方式引用的时候,实际上我们用到的Header Search Paths
是"${PODS_ROOT}/Headers/Public"
这个路径。同理,可以使用#import <Masonry.h>
导入,使用用到的Header Search Paths
是"${PODS_ROOT}/Headers/Public/Masonry"
路径。
所以一般情况下,我们使用Cocoapod,上述5中引用方式,除了语义导入,都可以正常使用。
Cocoapod支持非常多种设置,例如:
- 当我们
:generate_multiple_pod_projects=>true
设置,开启多project结构,此时每个Pod都是自己单独的project,也就是说不是在同一个Pod.project
中。#import "aaa.h"
没法通过同project索引头文件,和#import <aaa/aaa.h>
一样,可以通过Header Search Path
索引头文件。 - 当我们使用
use_frameworks!
,此时Cocoapod不会设置Header Search Path
,而是会设置Framework Search Path
,此时可以使用#import <aaa/aaa.h>
正常引用。如果没有使用多project结构,那么Pod.project
目录下的各个Pod库,还可以使用#import "aaa.h"
互相引用,因为他们都是一个project下的。但是主工程和Pod工程不是一个工程下的,所以主工程中引用Pod库文件,不可以使用#import "aaa.h"
。同理,如果结合多project结构,不同Pod库之间,也不可以使用#import "aaa.h"
引用,因为此时不再在同一个project下。 - 当我们使用
use_modular_headers!
,此时Cocoapod设置Header Search Path
,此时#import <aaa/aaa.h>
和#import "aaa.h"
都可以通过Header Search Path
索引头文件。但是如果使用#import <aaa/aaa.h>
,会被Xcode自动替换为语义导入,即@import aaa;
。具有更优的性能,所以推荐使用#import <aaa/aaa.h>
综上所述,当我们使用Cocoapod的时候。
- 如果需要引用别的Pod库中的头文件,推荐使用
#import <aaa/aaa.h>
。 - 当Pod库引用自己的头文件的时候,推荐使用
#import "aaa.h"