讀別人的原始碼是進步最快的方式之一,但很多人打開專案就迷路了。這裡以 TQRichTextViewDemo 為例,示範一套「從入口往下追」的分析方法。
1. 先找 AppDelegate
無論一個工程多麼複雜、有多少類別,入口只有一個,就是 AppDelegate 的 didFinishLaunchingWithOptions 方法,讀別人原始碼可以從這裡下手。在 TQRichTextViewDemo 中,這個方法僅建立了一個 TQViewController 並設為 window 的 rootViewController。
2. 接著看 TQViewController
同樣從初始化方法開始:沒有 initWithNib,那就看 viewDidLoad。在這個方法中,只建立了一個 TQRichTextView,設定了 frame、text、backgroundColor、delegate 等屬性,然後加到 self.view 上。看完 viewDidLoad 發現這是系統呼叫的最後一個方法,結合模擬器的運行效果,我們可以猜測:文字的解析與繪製過程被封裝進了 TQRichTextView。
3. 深入 TQRichTextView
- 先瀏覽標頭檔,了解有哪幾個屬性與可呼叫的方法。
- 閱讀 initWithFrame,發現這裡只是對幾個屬性做初始化。
- 尋找是否有覆寫的 set/get 方法。找到 setText、setFont、setTextColor、setLineSpacing,閱讀後發現每次更新完值都會呼叫 setNeedsDisplay——說明每次對這四個屬性賦值後都會觸發 drawRect。
- 繼續往下讀,找到 drawRect(同樣由系統呼叫),繪製工作應該就在這裡完成。
drawRect 的內部流程
- 呼叫 analyzeText: 傳入 _text,回傳值賦給 _textAnalyzed。
- 進到 analyzeText 中:先清空陣列與字典,定義 NSString 的 result 與 NSMutableArray 的 array(賦值為 richTextRunsArray)。
- 執行 TQRichTextEmojiRun 的類方法,傳入 string 與 array 的指標。因為是類方法,直接看實作即可。從命名連蒙帶猜,這應該是解析字串中表情的方法。看重點:若解析到表情,就建立一個 TQRichTextEmojiRun 實例,range 為表情字串在 string 中的範圍、originalText 為表情字串,把這個物件放進傳入的陣列,最後把字串中的表情替換成空格並回傳。
- 看 TQRichTextEmojiRun 的 init,發現設定了兩個來自父類 TQRichTextBaseRun 的變數:TQRichTextRunType 與是否回應觸摸。同時發現 TQRichTextURLRun 也繼承自 TQRichTextBaseRun。
- 回到 analyzeText 繼續往下看。
- 執行 TQRichTextURLRun 的類方法,傳入 result 與 array 的指標。命名格式與呼叫方式都和上一個類似,可以猜測是解析 URL 的:找到匹配字串後建立 TQRichTextURLRun 物件,設定 range 與 originText,加入陣列並回傳 string。
- 看 TQRichTextURLRun 的 init,同樣設定了來自父類的兩個變數。此處類別繼承為:TQRichTextEmojiRun → TQRichTextImageRun → TQRichTextBaseRun。
- 回到 analyzeText,遍歷 richTextRunsArray,對每個物件呼叫 setOriginalFont 並傳入 self.font。由於陣列裡裝的是 TQRichTextEmojiRun 與 TQRichTextURLRun,這個屬性其實來自父類 TQRichTextBaseRun。
- 回傳 result,離開 analyzeText,回到 drawRect。
- 建立 NSAttributedString 並賦值一些屬性。
- 文本處理:遍歷 richTextRunsArray,對每個物件呼叫 replaceTextWithAttributedString:。
- TQRichTextEmojiRun 中找不到這個方法,改到 TQRichTextImageRun 中閱讀:
- 傳入的 attrString 先刪除佔位的空格字元。
- 建立 CTRunDelegateCallbacks,發現設定的寬高為 OriginalFont 高度的 1.1 倍。
- 建立空格 NSAttributedString,加上 CTRunDelegateRef 屬性。
- 把這個空格物件插入傳入的 attrString。
- 看 super 方法,發現這段 range 上還設定了 key 為 TQRichTextAttribute、value 為自己的一組鍵值對。
- 同樣閱讀 TQRichTextURLRun 的版本:為該段 range 加上藍色字體,再呼叫 super 加上同一組鍵值對。
- 繪製準備工作(不研究繪製細節可粗讀):清空 richTextRunRectDic。
- 繪製:找重點——繪製替換過的特殊文本單元。
- 遍歷取出每個 run,取出 attributes 中 key 為 TQRichTextAttribute 的值。
- 若值存在,說明這個 run 是特殊 run。
- 求 run 的 frame(粗讀略過)。
- 呼叫 drawRunWithRect:,回傳值賦給 didDraw:
- TQRichTextEmojiRun 的版本繪製了表情圖片並回傳 YES。
- TQRichTextURLRun 與 TQRichTextBaseRun 的版本回傳 NO。
- 判斷 run 的 isResponseTouch 屬性(來自 TQRichTextBaseRun,註解說是「是否回應觸摸」)。若回應觸摸,就在 richTextRunRectDic 中加入 rect→run 的鍵值對,並釋放 CF 型別變數(CF 型別不支援 ARC)。
- 繼續找 TQRichTextView 中覆寫的系統方法,找到 touchesBegan 與 touchesEnded:取得觸摸點並轉成以左下角為原點的座標,判斷能否指向 delegate,遍歷 richTextRunRectDic 判斷點是否落在某個 rect 內,若在則呼叫 delegate 方法。
結論
類別結構關係:
- TQRichTextEmojiRun → TQRichTextImageRun → TQRichTextBaseRun
- TQRichTextURLRun → TQRichTextBaseRun
- 兩者各自實作 analyzeText:runsArray:,從字串中取出需要的文字並建立 TQRichTextBaseRun 物件加入陣列保存。
- 兩者各自覆寫 replaceTextWithAttributedString:,在字串的特定 range 處加上 attributed 屬性。
- 兩者各自覆寫 drawRunWithRect:,實作自訂位置繪製並回傳是否繪製了內容。
流程:
- 更改 TQRichTextView 的屬性 → 2. 觸發 drawRect → 3. 呼叫 analyzeText:runsArray: 解析字串 → 4. 建立 NSAttributedString → 5. 為它加上屬性(透過 replaceTextWithAttributedString:)→ 6. 用 CoreText 繪製 NSAttributedString → 7. 呼叫 drawRunWithRect: 做自訂繪製 → 8. 把 run 與 rect 存進字典,之後從字典取值判斷能否點擊。
由此可得:若要更換表情與文字的解析規則,只需去 TQRichTextEmojiRun 或 TQRichTextURLRun 修改三個方法——analyzeText:runsArray:(改解析規則)、replaceTextWithAttributedString:(改屬性)、drawRunWithRect:(改自訂繪製);若要實現點擊,把 isResponseTouch 設為 YES 並實作 TQRichTextViewDelegate 即可。
閱讀程式碼發現的缺陷
- TQRichTextView 沒有實作 awakeFromNib,若用 xib 拖拽,就無法為它設定預設屬性。
解法:加上 awakeFromNib 並在其中為預設屬性賦值。
- sizeWithFont 與 boundingRectWithSize:options:attributes:context: 計算時不含行間距,若 TQRichTextView 的 lineSpacing 不為 0,這兩個方法算出的高度會比實際顯示所需的高度小。
解法:把 TQRichTextView 的 lineSpacing 設為 0。