iOS-UIAccessibility旁白适配

近期在处理App适配VoiceOver(旁白)功能，简单的系统控件苹果都能很好的识别，但在复杂界面处理遇到了一些问题，VoiceOver问题可参考的资料不多，把自己踩过的坑记录如下。

首先介绍下 旁白常用的手势：

轻点：选择并朗读项目。
左右轻扫：选择下一项或上一项。
双指轻点三下：打开“项目选取器”。
三指上下轻扫：一次滚动一页。
三指左右轻扫：前往下一页或上一页（例如，在主屏幕上中）。
四指滑动：切换App 。
这是本人在开发旁白模式中常用的手势，更多手势可以查看 iPhone使用手册 来了解。

旁白最常用 UIAccessibility API

accessibilityLabel： 描述内容“是什么”，例如 “产品名称”
accessibilityValue： 描述“值是多少”，例如“年化利率5%”
accessibilityTraits： 描述"特性、状态、行为、用法"。控件的特性可以是按钮(Button)，控件的状态可以是已选中(Selected)
accessibilityHint： 描述行动“做什么”，例如“点击两下可跳转购买页面”

1、Label、Value、Hint 配置的字符串，会以语音的形式念出来，配置什么，念什么。
2、配置的Traits各个类型，也会以语音的形式念出。例如：UIAccessibilityTraitSelected、UIAccessibilityTraitImage、UIAccessibilityTraitButton分别播报"已选定”、”图片”、”按钮”。

遇到的问题记录：

1.是否启用VoiceOver

UIAccessibilityIsVoiceOverRunning()

2.主动播报

在toast 弹出或者刷新成功等场景需要主动播报

UIAccessibilityPostNotification(UIAccessibilityAnnouncementNotification, @"播报文案xxxx");

3.焦点穿透

accessibilityViewIsModal 属性设为YES

self.noNetworkV.accessibilityViewIsModal = YES;

4.兼容开发者自定义的控件和视图,支持VoiceOver

所有的标准UIKit控件和视图默认支持VoiceOver，UILabel，UIButton这些控件的isAccessibilityElement属性默认是true, UIView属性默认是false，所以自定义视图如果想要支持VoiceOver，需要设置 isAccessibilityElement = YES, 使得VoiceOver可以访问这个view。

 view.isAccessibilityElement = YES;
 view.accessibilityLabel = @"文案内容";
 view.accessibilityTraits = UIAccessibilityTraitNone;

5.访问Cell与Cell中的按钮，且分别读出不同的内容

假设现在有-个UITableview与一个自定义Cell,，Cell中有一个按钮，现在需求是可以访问Cell与Cell中的按钮，且分别读出不同的内容，如下图所示意：

image.png

那么此时单纯设置Cell为访问元素然后再访问子元素这个思路是行不通的，我们可以设置CelI不激活为isAccessibilityElement, 但是苹果内部是可以将Cell作为整个访问元素且设置它的accessibilityL abel，完成button基本设置后，再设置button的accessibilityHint就可以实现我们想要的效果。

核心代码如下：


- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
    TestCell *cell = [tableView dequeueReusableCellWithIdentifier:[TestCell description] forIndexPath:indexPath];
    [cell setDataWithVersionM:self.dataArray[indexPath.row]];
    cell.isAccessibilityElement = NO;
    return cell;
}

.....

- (void)setDataWithVersionM:(YBUserVersionM *)versionM {
  if ([versionM.versionCode isEqualToString:@"default"]) {
        self.accessibilityLabel = @"标准版";
    } else if ([versionM.versionCode isEqualToString:@"young"]) {
        self.accessibilityLabel = @"乡村版";
    } else if ([versionM.versionCode isEqualToString:@"big"]) {
        self.accessibilityLabel = @"大字版";
    }
    NSString *chooseOrNotStr;
    if ([versionM.versionCode isEqualToString:[[YBVersionManager instance] getCurentVersion]]) {
        [self.chooseBtn setSelected:YES];
        chooseOrNotStr = @"已选中";
    } else {
        [self.chooseBtn setSelected:NO];
        chooseOrNotStr = @"未选中";
    }
    self.accessibilityHint = chooseOrNotStr;

}

6. 只有背景图片无文字的控件.

需要给出描述和对应控件的属性, 例如返回按钮/关闭按钮

image.png

self.backButton.accessibilityLabel = @"返回";
self.closeButton.accessibilityLabel = @"关闭";
self.closeButton.accessibilityTraits = UIAccessibilityTraitButton;

7.数字/电话号连读处理，比如播报验证码1234的时候，系统会自动播报成“一千两百三十四”。

① 在中间加分隔符 1:2:3:4，这样就会一个数字一个数字的读了；
② 转换为对应的大写汉字即可；


self.cardNubLbl.accessibilityLabel = [YBVoiceOverTool acquireAccessableNumber:bankNum];


/// 将电话号码转换为旁白可读的中文
+ (NSString *)acquireAccessableNumber:(NSString *)number {
    NSArray *transFromArr = @[@"1",@"2",@"3",@"4",@"5",@"6",@"7",@"8",@"9",@"0"];
    NSArray *transToArr = @[@"一",@"二",@"三",@"四",@"五",@"六",@"七",@"八",@"九",@"零"];
    NSDictionary *dictionary = [NSDictionary dictionaryWithObjects:transToArr forKeys:transFromArr];
    NSMutableArray *resultArr = [NSMutableArray array];
    for (int i = 0; i < number.length; i++) {
        NSString *currentStr = [number substringWithRange:NSMakeRange(i, 1)];
        [resultArr addObject:dictionary[currentStr]?:currentStr];
    }
    NSString *resultStr = [resultArr componentsJoinedByString:@""];
    return resultStr;
}

8.调整页面焦点顺序

cell.shouldGroupAccessibilityChildren = YES;
cell.accessibilityElements = @[cell.leftBtn, cell.rightBtn];

注意：调整层级时不要漏掉控件，否则旁白模式下这个被遗漏的控件会无法选中也无法播报。

9. 多音字读错

解决方案：换位同音字替代。比如：“密码重（chóng）置”，苹果识别为“密码重(zhòng)置”，可以用“密码崇置” 来解决。accessibilityLabel 属性仅仅旁白模式下朗读，不影响展示。

self.tipsLbl.accessibilityLabel = @“密码崇置”;

10.进入语音界面，旁白音量超级小，几乎听不见

录音要AVAudioSessionCategoryRecord模式，结束录音设为AVAudioSessionCategoryPlayback

- (void)viewWillAppear:(BOOL)animated {
    [super viewWillAppear:animated];
    [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryPlayback
}


// 开始录音
- (void)vprStartRecord {
    // sdk开始录音
    [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryRecord error:nil];
    [[AVAudioSession sharedInstance] setActive:YES error:nil];
    [[VoiceRecordManager sharedInstance] start];
}

// 结束录音
- (void)vprStopRecordShowTips:(BOOL)isTips {
    [[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryPlayback error:nil];
    // sdk结束录音
    [[VoiceRecordManager sharedInstance] stop];
....
}

注意：因为项目中是进入这个页面旁白声音就变小了，所以我在viewWillAppear 生命周期中也设置了setCategory:AVAudioSessionCategoryPlayback 模式。

11. 一段文案中有两个跳转事件：点击隐私政策，只会跳转第一个，第二个一直跳转无效

解决方案：
a、改成两个控件，每个控件一个点击事件；
b、如果是富文本的话，直接用\n 换行，变为两行展示协议，可以分别跳转两个协议。

12. 支持卡片内容三指滑动

三指滑动.gif

核心代码：

- (BOOL)accessibilityScroll:(UIAccessibilityScrollDirection)direction {
    if (direction == UIAccessibilityScrollDirectionLeft) {
        if (self.selectIndex < 4 ) {
            self.selectIndex = self.selectIndex+1;            
            [self scrollToIndex:self.selectIndex];
            [self accessibilityScrollPage:self.selectIndex];
            return YES;
        }
    }else if (direction == UIAccessibilityScrollDirectionRight) {
        if (self.selectIndex != 0) {
            self.selectIndex = self.selectIndex-1;
            [self scrollToIndex:self.selectIndex];
            [self accessibilityScrollPage:self.selectIndex];
            return YES;
        }
    }
    return NO;
}

Demo示例下载