
授權轉載,作者:王隆帥
最近在項目里頻繁遇到富文本相關的需求,於是我把幾個最常用到的 API 做成了封裝,順手分享給大家。不過授之以魚不如授之以漁,接下來我還會順帶聊聊 NSAttributedString,希望讀完這篇文章,你不僅會用,更能自己動手封裝出各類富文本 API。文末附上示例 Demo,拿去用吧!
一、常用需求的封裝
需求一:日常開發中,經常需要在一段文字里改動某些字的顏色。改色通常為了強調重點,而且往往用同一種顏色,所以下面這段代碼實現的是——把一句話中指定的某些字改成同一種顏色。
/** * 單純改變一句話中的某些字的顏色 * * @param color 需要改變成的顏色 * @param totalStr 總的字符串 * @param subArray 需要改變顏色的文字數組 * * @return 生成的富文本 */ + (NSMutableAttributedString *)ls_changeCorlorWithColor:(UIColor *)color TotalString:(NSString *)totalStr SubStringArray:(NSArray *)subArray { NSMutableAttributedString *attributedStr = [[NSMutableAttributedString alloc] initWithString:totalStr]; for (NSString *rangeStr in subArray) { NSRange range = [totalStr rangeOfString:rangeStr options:NSBackwardsSearch]; [attributedStr addAttribute:NSForegroundColorAttributeName value:color range:range]; } return attributedStr; }需求二:調整字間距,以適配整體 UI 觀感。
/** * 單純改變句子的字間距(需要 <CoreText/CoreText.h>) * * @param totalString 需要更改的字符串 * @param space 字間距 * * @return 生成的富文本 */ + (NSMutableAttributedString *)ls_changeSpaceWithTotalString:(NSString *)totalString Space:(CGFloat)space { NSMutableAttributedString *attributedStr = [[NSMutableAttributedString alloc] initWithString:totalString]; long number = space; CFNumberRef num = CFNumberCreate(kCFAllocatorDefault,kCFNumberSInt8Type,&number); [attributedStr addAttribute:(id)kCTKernAttributeName value:(__bridge id)num range:NSMakeRange(0,[attributedStr length])]; CFRelease(num); return attributedStr; }需求三:調整行間距,同樣是為了適配整體 UI。
/** * 單純改變段落的行間距 * * @param totalString 需要更改的字符串 * @param lineSpace 行間距 * * @return 生成的富文本 */ + (NSMutableAttributedString *)ls_changeLineSpaceWithTotalString:(NSString *)totalString LineSpace:(CGFloat)lineSpace { NSMutableAttributedString *attributedStr = [[NSMutableAttributedString alloc] initWithString:totalString]; NSMutableParagraphStyle * paragraphStyle = [[NSMutableParagraphStyle alloc] init]; [paragraphStyle setLineSpacing:lineSpace]; [attributedStr addAttribute:NSParagraphStyleAttributeName value:paragraphStyle range:NSMakeRange(0, [totalString length])]; return attributedStr; }需求四:同時調整行間距與字間距。
/** * 同時更改行間距和字間距 * * @param totalString 需要改變的字符串 * @param lineSpace 行間距 * @param textSpace 字間距 * * @return 生成的富文本 */ + (NSMutableAttributedString *)ls_changeLineAndTextSpaceWithTotalString:(NSString *)totalString LineSpace:(CGFloat)lineSpace textSpace:(CGFloat)textSpace { NSMutableAttributedString *attributedStr = [[NSMutableAttributedString alloc] initWithString:totalString]; NSMutableParagraphStyle * paragraphStyle = [[NSMutableParagraphStyle alloc] init]; [paragraphStyle setLineSpacing:lineSpace]; [attributedStr addAttribute:NSParagraphStyleAttributeName value:paragraphStyle range:NSMakeRange(0, [totalString length])]; long number = textSpace; CFNumberRef num = CFNumberCreate(kCFAllocatorDefault,kCFNumberSInt8Type,&number); [attributedStr addAttribute:(id)kCTKernAttributeName value:(__bridge id)num range:NSMakeRange(0,[attributedStr length])]; CFRelease(num); return attributedStr; }需求五:改動某些文字的顏色,並單獨設置其字體,用來突出重點。
/** * 改變某些文字的顏色 並單獨設置其字體 * * @param font 設置的字體 * @param color 顏色 * @param totalString 總的字符串 * @param subArray 想要變色的字符數組 * * @return 生成的富文本 */ + (NSMutableAttributedString *)ls_changeFontAndColor:(UIFont *)font Color:(UIColor *)color TotalString:(NSString *)totalString SubStringArray:(NSArray *)subArray { NSMutableAttributedString *attributedStr = [[NSMutableAttributedString alloc] initWithString:totalString]; for (NSString *rangeStr in subArray) { NSRange range = [totalString rangeOfString:rangeStr options:NSBackwardsSearch]; [attributedStr addAttribute:NSForegroundColorAttributeName value:color range:range]; [attributedStr addAttribute:NSFontAttributeName value:font range:range]; } return attributedStr; }以上幾種 API 綜合起來的效果如下圖所示。

二、聊聊 NSAttributedString
1、初始化方法
- (instancetype)initWithString:(NSString *)str; - (instancetype)initWithString:(NSString *)str attributes:(nullable NSDictionary<NSString *, id> *)attrs; - (instancetype)initWithAttributedString:(NSAttributedString *)attrStr;
第一種是直接傳入字符串來初始化富文本;第二種是傳入字符串以及屬性字典(也就是配置富文本各項屬性的字典)來初始化;第三種則是用另一個已有的富文本對象來初始化。
2、常用操作 API
為指定範圍內的文字添加某一個屬性:
- (void)addAttribute:(NSString *)name value:(id)value range:(NSRange)range;
示例:

為指定範圍內的文字添加多個屬性(下面兩個 API 效果一致,只是格式不同):
- (void)addAttributes:(NSDictionary<NSString *, id> *)attrs range:(NSRange)range; - (void)setAttributes:(nullable NSDictionary<NSString *, id> *)attrs range:(NSRange)range;
示例:

移除指定範圍內的某個屬性(可與添加屬性的 API 對照理解,此處不再示例):
- (void)removeAttribute:(NSString *)name range:(NSRange)range;
其他部分 API(見名知意,可與 NSString 對照,不再贅述):
- (void)replaceCharactersInRange:(NSRange)range withAttributedString:(NSAttributedString *)attrString; - (void)insertAttributedString:(NSAttributedString *)attrString atIndex:(NSUInteger)loc; - (void)appendAttributedString:(NSAttributedString *)attrString; - (void)deleteCharactersInRange:(NSRange)range; - (void)setAttributedString:(NSAttributedString *)attrString;
3、相關可設置屬性對照
從上面的 API 不難看出,富文本的核心方法就是「為某一範圍添加單個屬性」和「添加屬性字典」,本質上就是一個 key 對應一個 value。只要能記住各個屬性對應的效果,就能自由組合,封裝出滿足各種需求的 API。
NSFontAttributeName:字體字號,value 值為 UIFont 類型
NSParagraphStyleAttributeName:段落樣式,value 值為 NSParagraphStyle 類型(其屬性如下)
lineSpacing 行間距(具體用法可查看上面的設置行間距 API)
paragraphSpacing 段落間距
alignment 對齊方式
firstLineHeadIndent 指定段落開始的縮進像素
headIndent 調整全部文字的縮進像素
NSForegroundColorAttributeName:字體顏色,value 值為 UIColor 類型
NSBackgroundColorAttributeName:背景顏色,value 值為 UIColor 類型
NSObliquenessAttributeName:字體粗傾斜,value 值為 NSNumber 類型
NSExpansionAttributeName:字體加粗,value 值為 NSNumber 類型(比例)0 就是不變,1 增加一倍
NSKernAttributeName:字間距,value 值為 CGFloat 類型
NSUnderlineStyleAttributeName:下劃線,value 值為 1 或 0
NSUnderlineColorAttributeName:下劃線顏色,value 值為 UIColor 類型
NSStrikethroughStyleAttributeName:刪除線,value 值為 1 或 0
NSStrikethroughColorAttributeName:刪除線顏色,value 值為 UIColor 類型
NSStrokeColorAttributeName:描邊顏色,value 值為 UIColor 類型
NSStrokeWidthAttributeName:字體描邊,value 值為 CGFloat
NSLigatureAttributeName:連筆字,value 值為 1 或 0
NSShadowAttributeName:陰影,value 值為 NSShadow 類型(其屬性如下)
shadowOffset 影子與字符串的偏移量
shadowBlurRadius 影子的模糊程度
shadowColor 影子的顏色
NSTextEffectAttributeName:設置文本特殊效果,目前只有圖版印刷效果可用,value 值為 NSString 類型
NSAttachmentAttributeName:設置文本附件,value 值為 NSTextAttachment 類型(可自行研究)
NSLinkAttributeName:鏈接,value 值為 NSURL(首選)或 NSString 類型
NSBaselineOffsetAttributeName:基準線偏移,value 值為 NSNumber 類型
NSWritingDirectionAttributeName:文字方向,分別代表不同的文字出現方向,value 值為 @[@(1),@(2)]
NSVerticalGlyphFormAttributeName:水平或豎直文本,在 iOS 上沒什麼用,不支持豎版,value 值為 1 豎直、0 水平
三、示例 Demo 講解
Demo 在此,點擊可跳轉。API 路徑地址如下:
/YiDing/Class/Helpers/LSCoreToolCenter
截圖如下:

使用示例的路徑如下:
/YiDing/Class/Sections/LSSection/NSMutableAttributedString
截圖如下:

四、更新
7.18 晚更新:有同學希望能夠對所有相同的子字符串都進行操作,於是我新增了一個獲取位置數組的方法並封裝了進去,效果圖也已更新,感興趣的可以到 Demo 里查看。