Ios教程網 >> IOS編程開發 >> IOS開發基礎 >> 富文本常用封裝(NSAttributedString淺析)

富文本常用封裝(NSAttributedString淺析)

編輯：IOS開發基礎

QQ截圖20160714123141.jpg

授權轉載，作者：王隆帥

最近經常遇到關於富文本的一些需求，特此封裝了幾個最常用的API分享給大家，但授之以魚不如授之以漁，接下來會順便談談NSAttributedString，確保你讀了本篇文章能夠自己封裝關於富文本的API，本文封裝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

/**
 *  單純改變句子的字間距（需要 ）
 *
 *  @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 *)attrs;
- (instancetype)initWithAttributedString:(NSAttributedString *)attrStr;

第一種使用字符串初始化初始化富文本

第二種使用字符串及屬性字典（就是配置富文本的相關屬性）初始化富文本

第三種就是用其他富文本初始化富文本

2、常用操作API

為某一范圍內文字添加某個屬性

- (void)addAttribute:(NSString *)name value:(id)value range:(NSRange)range;

示例：

為某一范圍內文字添加多個屬性（兩個API效果與格式一樣）

- (void)addAttributes:(NSDictionary *)attrs range:(NSRange)range;
- (void)setAttributes:(nullable NSDictionary *)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。