BarrageKit弹幕插件

前言

现在直播这么火，好多直播框架，诸如IJKMediaFramework等更是方便了直播类APP的开发，那我们也一起给它添砖加瓦吧。

插件介绍

插件是基于Objective-C编写的，整体思路较为简单，功能包括：

1. 弹幕的滚动方向、滚动速度
2. 弹幕的暂停与恢复、显示与隐藏
3. 弹幕的类型：纯文字弹幕、投票类弹幕、其他等(可自定义)
4. 弹幕的推送方式：主动获取弹幕源、被动接收
5. 弹幕的缓存，避免大量弹幕出现时内存Boom

还有一些不完善的地方（比如弹幕的轨道现为随机生成，可能会重叠）及一些新的功能欢迎issue

插件展示

• 四个方向的弹幕滚动

• 弹幕的暂停与恢复

  
  弹幕的暂停与恢复

核心代码介绍

①BarrageManager弹幕管理者

数组介绍：

• _cachePool为弹幕单元的缓冲数组，从屏幕上移除的BarrageScene会加入到该数组中
• _barrageScene为当前屏幕上正在显示的弹幕显示单元的数组，弹幕显示的时候会加入到该数组中

BarrageManager 作为弹幕的管理者，流程为：

• 初始化弹幕manager，启动timer,主动拉取弹幕数据，调用-delegate barrageManagerDataSource返回数据。
• 调用- (void)showWithData:(id)data方法显示弹幕，data可以为BarrageModel或NSArray格式
  • 判断缓冲池是否为空，为空则新建弹幕显示单元BarrageScene,并加入到_barrageScene数组中。若不为空，则取出_cachePool的firstObject进行重用并从_cachePool中移除，添加到_barrageScene中来

核心代码如下：

if (_cachePool.count < 1) {
                    // nil
                    BarrageScene *scene = [[BarrageScene alloc] initWithFrame:CGRectZero Model:model];
                    [_barrageScene addObject:scene];
                    [_bindingView addSubview:scene];
                    Weakself;
                    scene.animationDidStopBlock = ^(BarrageScene *scene_){
                        [weakSelf.cachePool addObject:scene_];
                        [weakSelf.barrageScene removeObject:scene_];
                        [scene_ removeFromSuperview];
                    };
                    [scene scroll];
                    
                }else {
                    //从缓冲池获取到Scene后，将其从缓冲池中移除
//                    NSLog(@"get from cache");
                    BarrageScene *scene =  _cachePool.firstObject;
                    [_barrageScene addObject:scene];
                    [_cachePool removeObjectAtIndex:0];
                    scene.model = model;
                    
                    [_bindingView addSubview:scene];
                    [scene scroll];
                }

②BarrageModel弹幕模型

message弹幕信息为NSMutableAttributedString类型，图片、表情等都可以使用了

模型属性：

//弹幕ID barrage's id
@property (assign, nonatomic) NSInteger numberID;

//弹幕时间 barrage;s time
@property (strong, nonatomic) NSString *time;

//弹幕类型 barrage's type
@property (assign, nonatomic) BarrageDisplayType barrageType;

//弹幕速度 barrage's speed
@property (assign, nonatomic) BarrageDisplaySpeedType speed;

//弹幕滚动方向 barrage's direction
@property (assign, nonatomic) BarrageScrollDirection direction;

//弹幕位置 barage's location
@property (assign, nonatomic) BarrageDisplayLocationType displayLocation;

//弹幕所属的父View  barrage's superView
@property (weak, nonatomic) UIView *bindView;

//弹幕内容 barrage's content
@property (strong, nonatomic, nonnull) NSMutableAttributedString *message;

//弹幕作者 barrage's author
@property (strong, nonatomic, nullable) id author;

//弹幕对象 goal object
@property (strong, nonatomic, nullable) id object;

//弹幕字体 barrage's textfont
@property (copy, nonatomic) UIFont *font;

//弹幕字体颜色 barrage's textColor
@property (copy, nonatomic) UIColor *textColor;

③BarrageScene弹幕显示单元

• 滚动Scroll

• ①根据弹幕的滚动速度和滚动方向计算弹幕的滚动距离和所需要的时间

• ②使用CABasicAnimation完成动画，后期弹幕的暂停和回复比较方便

• ③弹幕滚动完毕后，执行_animationDidStopBlock，将该scene加入到manager的cachePool中等待被重用

• 重用

• 弹幕从BarrageManager的cachePool中取出来，根据BarrageModel弹幕信息重新初始化frame且重新开始动画

• 暂停 pause

  • 暂停layer动画即可

CFTimeInterval pausedTime = [self.layer convertTime:CACurrentMediaTime() fromLayer:nil];
self.layer.speed = 0.0;
self.layer.timeOffset = pausedTime;

• 恢复 resume
  • 恢复layer动画即可

CFTimeInterval pausedTime = [self.layer timeOffset];
self.layer.timeOffset = 0.0;
self.layer.beginTime = 0.0;
self.layer.speed = 1.0;
CFTimeInterval timeSincePause = [self.layer convertTime:CACurrentMediaTime() fromLayer:nil] - pausedTime;
self.layer.beginTime = timeSincePause;

• 关闭 close

[self.layer removeAllAnimations];
[self removeFromSuperview];

插件使用

下载项目导入到项目中，使用时import 'BarrageKit.h'即可

_manager = [BarrageManager manager];
    
    //出现的View
    _manager.bindingView = self.view;
    
    //delegate
    _manager.delegate = self;
    
    //弹幕显示位置
    _manager.displayLocation = BarrageDisplayLocationTypeDefault;
    
    //滚动方向
    _manager.scrollDirection = BarrageScrollDirectRightToLeft;
    
    //滚动速度
    _manager.scrollSpeed = 30;
    
    //收到内存警告的处理方式
    _manager.memoryMode = BarrageMemoryWarningModeHalf;
    
    //刷新时间
    _manager.refreshInterval = 1.0;
    
    //开始滚动 manager主动获取弹幕，另外一种方式，`[_manager showBarrageWithDataSource:m]` 退出弹幕即可
    [_manager startScroll];

Tips:

• ①如果弹幕为投票类型的弹幕时，请重写ViewController的touchesBegan 方法

- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event {
    UITouch *touch = [touches anyObject];
    CGPoint touchPoint = [touch locationInView:self.view];
    [[_manager barrageScenes] enumerateObjectsUsingBlock:^(BarrageScene * _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
        if ([obj.layer.presentationLayer hitTest:touchPoint]) {
            //弹幕类型为投票类型时，为弹幕添加点击事件，请在此处添加
            /* if barrage's type is ` BarrageDisplayTypeVote `, add your code here*/
            NSLog(@"message = %@",obj.model.message.string);
        }
    }];
}

• ②重写ViewController的dealloc方法，执行BarrageManager的toDealloc
• ③ViewController收到内存警告时，[_manager didReceiveMemoryWarning];将会按照memoryMode指定的方法清楚缓冲池

- (void)didReceiveMemoryWarning {
    [super didReceiveMemoryWarning];
    // Dispose of any resources that can be recreated.
    
    // 收到内存警告时，清楚弹幕缓冲池 When you receive a memory warning，clean the barrage's cache
    [_manager didReceiveMemoryWarning];
}

• ④如果要高度自定义弹幕显示，可以修改BarrageScene中的初始化代码

最后

大家查看项目后，欢迎issue，同时有其他的功能或建议欢迎提出来，简书、github均可。

• 项目及Demo下载地址