Module & Swift庫 (6)

Module

Module定義

Module(模塊)-最小的代碼單元趟薄。
一個(gè)Module是機(jī)器代碼和數(shù)據(jù)的最小單位刀疙，可以獨(dú)立于其他代碼單位進(jìn)行鏈接。
通常剧罩，Module是通過編譯單個(gè)源文件生成的目標(biāo)文件贷洲。例如，當(dāng)前的test.m被編譯成目標(biāo)文件test.o時(shí)缴啡，當(dāng)前的目標(biāo)文件就代表了一個(gè)Module。

但是瓷们，有一個(gè)問題业栅，Module在調(diào)用的時(shí)候會(huì)產(chǎn)生開銷秒咐，比如我們在使用一個(gè)靜態(tài)庫的時(shí)候.

include 與 import的區(qū)別

1. #import導(dǎo)入頭文件的好處 -> 頭文件會(huì)編譯生成一份二進(jìn)制文件, 只用編譯一份.
2. #include導(dǎo)入頭文件, 不同的文件會(huì)重新編譯導(dǎo)致編譯多份.

module腳本

1. 打開module原理工程
2. 運(yùn)行腳本module

   # -fmodules：允許使用module語言來表示頭文件
   # -fmodule-map-file：module map的路徑。如不指明默認(rèn)module.modulemap
   # -fmodules-cache-path：編譯后的module緩存路徑
   clang  -fmodules -fmodule-map-file=Cat.modulemap -fmodules-cache-path=../prebuilt -c use.c -o use.o
   

3. 文章參考
4. 終端運(yùn)行clang -fmodules -fmodule-map-file=module.modulemap -fmodules-cache-path=../prebuilt -c use.c -o use.o -> .o文件
5. 去緩存目錄里面找.pcm文件 -> 就是頭文件編譯之后的產(chǎn)物
6. .modulemap -> 描述頭文件跟module之間的映射關(guān)系

   // 用來描述頭文件與module之間映射的關(guān)系
   // A -> A.h
   module A {
      header "A.h"
   }
   
   // B -> B.h
   module B {
      header "B.h"
      //  導(dǎo)入 -> 重新導(dǎo)出(把使用的其他頭文件一并暴露出來) 通常使用通配符 export * 導(dǎo)出所有的
      export A
   }
   

看下AFNetworking的modulemap

module.modulemap

```
// framework module 名稱 AFNetworking
framework module AFNetworking {
    // umbrella <目錄> 傘柄  <目錄>/.h
    // AFNetworking-umbrella.h 傘柄 AFNetworking-umbrella.h/.h 傘骨
    umbrella header "AFNetworking-umbrella.h"

    // 重新導(dǎo)出
    export *
    // module： 子module*
    module * { export * }
    
    //explicit: 可以指定子module的名稱
    //explicit module ASControlNode_Subclasses {
        //header "ASControlNode+Subclasses.h"
        //export *
    //}
}
```

注意:

1. -fmodules是Xcode默認(rèn)開啟的
2. 當(dāng)開啟的時(shí)候 #include/#import/@import -> 轉(zhuǎn)化成 @import

Module實(shí)操

1. App 與 Framework放在一起
   1. File -> Save As Workspace -> 取名 -> 關(guān)閉工程重新從workspace打開
   2. 工程左下角 + -> 庫文件
   3. 編譯APP的時(shí)候,同時(shí)編譯庫文件
      1. 將庫文件的編譯產(chǎn)物.framework -> 拖拽到 -> APP的Targets/General/Frameworks
      2. 如果沒有編譯,也沒關(guān)系,手動(dòng)編譯一下庫文件
2. 手寫modulemap
   1. 配置Targets -> Build Settings -> module -> Module Map File
   2. 編譯 -> 默認(rèn)生成module.modulemap
3. APP使用
   1. 記得暴露庫的頭文件 -> 庫 -> Build Phases -> Headers -> 查看頭文件是否暴露

Swift庫使用Module與OC混編

1. swift -> 調(diào)用OC時(shí), 需要一個(gè)橋接文件, 但是在swift中是沒有橋接文件一說的.
2. 解決方法,定義modulemap文件LGSwiftFramework來暴露 -> 記得配置Build Settings -> module map file -> 編譯,可以正常使用OC文件 -> 問題:此時(shí)外面的使用Swift庫的也能使用了
3. 只有自己使用的情況LGSwiftFramework.private -> 注意命名中間一定要有private,這是是規(guī)則 -> 配置 private module map file ->注意:此時(shí)外界也是可以訪問到的,private只是有助于區(qū)分私有的

   //_Private固定寫法規(guī)則,私有的modulemap文件
   framework module LGSwiftFramework_Private {
       module LGOCStudent {
       header "LGOCStudent.h"
       export *
       }
   }
   

4. 還有一種方法, 這里只講理論 -> OC語言特性 協(xié)議 -> Swift -> 協(xié)議(暴露出去) -> OC

Swift庫

定義

在Xcode9之后, Swift開始支持靜態(tài)庫.
Swift沒有頭文件的概念, 那么我們外界要使用Swift中用public修飾的類和函數(shù)怎么辦?
Swift庫中引入了一個(gè)全新的文件.swiftmodule.
.swiftmodule包含序列化過的AST(抽象語法書, Abstract Syntax Tree), 也包含SIL(Swift中間語言, Swift Intermediate Language).

1. 兩個(gè)Swift庫

   1. 兩個(gè)庫都有同樣的swift命名文件
   2. 分別編譯(有腳本) -> 靜態(tài)庫
      1. 腳本的作用 -> 將編譯后的庫拷貝到一個(gè)文件夾(具體參考該工程設(shè)置)

2. libtool -static LGSwiftA LGSwiftB -o libLGSwiftC.a

   1. 注意將兩個(gè)庫拷貝出來
   2. 確定命令 -> 有警告 -> 兩個(gè)庫有相同的文件命名
      1. 注意: 用libtool會(huì)報(bào)沖突, 但是不會(huì)替換
      2. ar -t libLGSwiftC.a -> 列出合并庫的.o文件列表
   3. 然后就有問題了,兩個(gè)靜態(tài)庫的Headers文件以及Modules文件怎么處理
      1. OC可以不要Modules文件, 只把Header文件放在一起就可以
      2. 但是Swift會(huì)多生成swiftModule文件,是個(gè)合并難題
      3. 將兩個(gè)庫多余的數(shù)據(jù)刪除,只保留Headers和Module,跟libLGSwiftC.a合成一個(gè)文件
      4. image.png

3. 參考cocoapods的處理

   1. 會(huì)把所有庫的頭文件放在pods -> Headers 目錄下

4. 將合并的頭文件拖到項(xiàng)目中的Frameworks

   1. 新建xcconfig -> 告訴項(xiàng)目頭文件所在地方
   2. xcconfig文件配置如下

      HEADER_SEARCH_PATHS = $(inherited) "${SRCROOT}/LGSwiftC/Public/         LGSwiftA.framework/Headers" "${SRCROOT}/LGSwiftC/Public/LGSwiftB.framework/Headers"
      // OTHER_CFLAGS：傳遞給用來編譯C或者OC的編譯器碘裕，當(dāng)前就是clang
      // OTHER_CFLAGS -> 相當(dāng)于Build Setings里的Other C flag
      OTHER_CFLAGS="-fmodule-map-file=${SRCROOT}/LGSwiftC/Public/LGSwiftA.framework/module.modulemap" "-fmodule-map-file=${SRCROOT}/LGSwiftC/Public/LGSwiftB.framework/module.modulemap"
      
      // SWIFT_INCLUDE_PATHS: 傳遞給SwiftC編譯器反镇，告訴他去下面的路徑中查找module.file
      // SWIFT_INCLUDE_PATHS相當(dāng)于Build Setting -> 搜import path
      SWIFT_INCLUDE_PATHS="${SRCROOT}/LGSwiftC/Public/LGSwiftB.framework"  "${SRCROOT}/LGSwiftC/Public/LGSwiftA.framework"
      

   3. 以上編譯沒有問題, 但是swift運(yùn)行庫LGSwiftA文件會(huì)報(bào)錯(cuò)
      1. 因?yàn)樯厦娴腛THER_CFLAGS是編譯C或者OC的
      2. 請看上面SWIFT_INCLUDE_PATHS的配置
         1. 注意將Modules文件夾里的文件配置到跟上一級Headers相同的目錄下,并刪除Modules

Swift庫文件合并總結(jié)

1. 合并庫文件 -> libLGSwiftC.a
2. 處理頭文件
   1. module文件已經(jīng)處理了, 讓編譯器找到module文件就可以了
   2. OC配置 -> OTHER_CFLAGS
   3. Swift配置 -> SWIFT_INCLUDE_PATHS

Swift配置.apinotes

當(dāng)我們Swift調(diào)用OC方法的時(shí)候, 調(diào)用的命名有可能有變化.

1. 那么不想Swift進(jìn)行優(yōu)化怎么處理

   1. 宏 -> NS_SWIFT_NAME -> 規(guī)定名稱

   typedef NS_ENUM(NSUInteger, LGTeacherName) {
   LGTeacherNameHank,
   LGTeacherNameCat,
   };
   
   //屬性指示編譯器使用struct（swift_wrapper(struct)屬性），而與NS_TYPED_ENUM娘汞，編譯器被指示使用enum（swift_wrapper(enum)屬性）
   typedef NSString * LGTeacherNameString NS_TYPED_EXTENSIBLE_ENUM;
   
   extern NSString *getTeacherName(void);
   extern NSString * const LGTeacherCat;
   extern LGTeacherNameString const LGTeacherHank;
   
   // 宏來配置 -》SDK -〉 OC -》 修改原有的代碼 -〉發(fā)布新版本
   // 弊端 -> 工作量大
   @interface LGToSwift : NSObject
   
   - (instancetype)initWithName:(NSString *)name;
   
   - (id)objectForKeyedSubscript:(id)key; // subscript getter
   - (void)setObject:(id)obj forKeyedSubscript:(id)key;
   // 通過指定NS_SWIFT_NAME宏，我們可以添加一些詳細(xì)信息以使函數(shù)清晰可見夕玩，從而使其變得如下所示：
   // 規(guī)范
   - (nullable NSString *)teacherNameForIndex:(NSUInteger)index NS_SWIFT_NAME(teacherName(forIndex:));
   
   // NS_REFINED_FOR_SWIFT從現(xiàn)在開始你弦，Swift的Clang Importer將做一些額外的工作并將該方法導(dǎo)入為私有方法，并以雙下劃線字符開頭__燎孟，例如：
   //- (BOOL)changeTeacherName:(nullable NSDictionary<NSString *, id> *)options;
   - (BOOL)changeTeacherName:(nullable NSDictionary<NSString *, id> *)options NS_REFINED_FOR_SWIFT;
   

2. 通過宏的方法不可取, 工作量大 -> 那么怎么辦 -> .apinotes

3. 命名為SDK名稱.apinotes -> 已經(jīng)要將該文件放在SDK的根目錄里面

4. image.png

5. 該文件格式為yaml格式 -> 方法映射 OC到Swift或者反之

#yaml
---
# Name: -> SDK的名稱
Name: OCFramework
# Classes -> 你要修改的類名
Classes:
- Name: LGToSwift
  SwiftName: ToSwift
  # 方法名的修改
  Methods:
  - Selector: "changeTeacherName:"
    Parameters:
    - Position: 0
      Nullability: O
    MethodKind: Instance
    SwiftPrivate: true
    #Availability: nonswift -> 意思是Swift中不能用,可以不寫,寫了就是加限制的意思
    Availability: nonswift
    AvailabilityMsg: "這個(gè)不能用"
  - Selector: "initWithName:"
    MethodKind: Instance
    DesignatedInit: true
    
# 更準(zhǔn)確的參考官方文檔
# https://clang.llvm.org/docs/APINotes.html

總結(jié)

1. module -> 頭文件->目標(biāo)文件的關(guān)系
2. modulemap ->頭文件 -> 目標(biāo)文件的映射
3. module:定義一個(gè)module
   export：導(dǎo)出當(dāng)前代表的頭文件使用的頭文件
   export * ：匹配目錄下所有的頭文件
   module * ：目錄下所有的頭文件都當(dāng)作一個(gè)子module
   explicit : 顯式聲明一個(gè)module的名稱
4. Swift庫使用OC代碼：不能使用橋接文件
   1. oc的頭文件放到modulemap下
   2. oc的頭文件放到私有的modulemap下
   3. 協(xié)議的方式 投機(jī)取巧
5. Swift靜態(tài)庫的合并
   難點(diǎn)：.swiftmodule 文件（Swift的頭文件）
   1. libtool 合并靜態(tài)庫本身
   2. 用到的頭文件和Swift頭文件和modulemap文件通過目錄的形式放到一起
   3. OC要用合并的靜態(tài)庫：clang: other c flags ：-fmodule-map-file <modulemap path>
   4. Swift要用合并的靜態(tài)庫 : SwiftC :other swift flags 顯式告訴SwiftC <modulemap dir>
      1. 為什么OC根Swift要分開傳遞, 因?yàn)閮蓚€(gè)語音的編譯器不一樣
      2. OC -> Clang
      3. Swift -> Swift
6. OC映射到Swift方式
   1. 宏
   2. <工程名稱>.apinotes

**官方文檔: **
APINotes.html
Modules.html