通用直播间弹幕客户端LiveChatClient

苗锦洲

创建于：2024-01-16 13:23:15

更新于：2024-03-12 00:32:07

河南省

592

一个基于 Netty 的通用直播间弹幕客户端，支持弹幕发送（已支持 B 站、斗鱼、虎牙、抖音、快手）；BarrageFly——让弹幕飞，基于该项目的一个弹幕转发、过滤、处理平台

开源框架

Netty 弹幕 WebSocket 直播间快手 B站斗鱼虎牙抖音

友情提示：此篇文章大约需要阅读 27分37秒

#ordinaryroad-live-chat-client

license release Maven Central

This project is in progress... 👨‍💻，有问题欢迎提交 issuse，
觉得有用的话可以点个小星星 ⭐️ 鼓励一下，感谢

如果对项目感兴趣也欢迎加入 QQ 频道交流讨论，
提交 PR

ToDo List: https://github.com/orgs/OrdinaryRoad-Project/projects/1

Live room WebSocket chat client

Feature 0: Netty
Feature 1: 消息中的未知属性统一放到单独的 MAP 中（JSON 格式消息）
Feature 2: 支持自动重连
Feature 3: 支持同时监听多个直播间
Feature 4: 支持短直播间 id
Feature 5*: 支持弹幕发送、为主播点赞
Feature 6*: 内置收到弹幕、收到礼物、收到醒目留言、用户入房、收到点赞、状态变化回调
Feature 7: 支持消息转发

*存在平台差异

✅: 平台支持且已完成

☑️️: 平台支持但未实现

❌: 平台暂不支持

平台适配情况表

平台	LiveChatClient	Cookie	短直播间 id	发送弹幕	为主播点赞
Bilibili B 站	✅	✅	✅	✅	✅
Douyu 斗鱼	✅	✅	✅	✅	❌
Huya 虎牙	✅	✅	✅	✅	❌
Douyin 抖音	✅	☑️️	✅	☑️	☑️️
Kuaishou 快手	✅	✅	✅	✅	✅

平台直播间消息适配情况表

平台	弹幕	礼物	醒目留言	进入房间	点赞	状态变化
Bilibili B 站	✅	✅	✅	✅	✅	✅
Douyu 斗鱼	✅	✅	☑️	✅	❌	☑️
Huya 虎牙	✅	✅	❌	✅（高级用户）	❌	☑️
Douyin 抖音	✅	✅	❌	✅	✅（点赞个数）	✅
Kuaishou 快手	✅	✅（礼物信息不全）	❌	❌	✅

消息接口内置的方法见 https://github.com/OrdinaryRoad-Project/ordinaryroad-live-chat-client/tree/main/live-chat-client-commons/live-chat-client-commons-base/src/main/java/tech/ordinaryroad/live/chat/client/commons/base/msg

运行效果图

⭐BarrageFly——让弹幕飞，基于该项目的一个弹幕转发、过滤、处理平台

0 原理

直接人工抓取浏览器的 WebSocket 二进制流，然后分析模拟浏览器的行为；这样做的好处是不需要进行开发者认证，代价就是没有官方文档，分析过程比较费时费力，并且需要适配不同平台的流程变化（一般不会有大变化）

以后可能会考虑支持平台的开放协议

1 安装

JDK ≥ 8

B 站


<dependency>
    <groupId>tech.ordinaryroad</groupId>
    <artifactId>live-chat-client-bilibili</artifactId>
    <!-- 参考github release版本，不需要前缀`v` -->
    <version>${ordinaryroad-live-chat-client.version}</version>
</dependency>

斗鱼


<dependency>
    <groupId>tech.ordinaryroad</groupId>
    <artifactId>live-chat-client-douyu</artifactId>
    <!-- 参考github release版本，不需要前缀`v` -->
    <version>${ordinaryroad-live-chat-client.version}</version>
</dependency>

虎牙


<dependency>
    <groupId>tech.ordinaryroad</groupId>
    <artifactId>live-chat-client-huya</artifactId>
    <!-- 参考github release版本，不需要前缀`v` -->
    <version>${ordinaryroad-live-chat-client.version}</version>
</dependency>

抖音


<dependency>
    <groupId>tech.ordinaryroad</groupId>
    <artifactId>live-chat-client-douyin</artifactId>
    <!-- 参考github release版本，不需要前缀`v` -->
    <version>${ordinaryroad-live-chat-client.version}</version>
</dependency>

快手


<dependency>
    <groupId>tech.ordinaryroad</groupId>
    <artifactId>live-chat-client-kuaishou</artifactId>
    <!-- 参考github release版本，不需要前缀`v` -->
    <version>${ordinaryroad-live-chat-client.version}</version>
</dependency>

2 使用

测试类包含了多种样例，可供参考

2.0 不同平台的 CMD 定义

B 站：BilibiliCmdEnum
斗鱼：DouyuCmdEnum
虎牙：HuyaCmdEnum
抖音：DouyinCmdEnum
快手：PayloadTypeOuterClass

可以重写 onCmdMsg(收到的所有CMD消息) 或 onOtherCmdMsg(框架未处理的CMD消息) 回调方法，判断 CMD 来监听框架已经定义的 CMD 类型

如果要监听的消息枚举类中未定义，可以考虑重写 onUnknownCmdMsg(未知CMD消息) 方法


@Override
public void onOtherCmdMsg(BilibiliCmdEnum cmd, ICmdMsg<BilibiliCmdEnum> cmdMsg) {
        switch (cmd) {
            case GUARD_BUY: {
                // 有人上舰
                SendSmsReplyMsg sendSmsReplyMsg = (SendSmsReplyMsg) cmdMsg;
                ...
                break;
            }
            case SUPER_CHAT_MESSAGE_DELETE: {
                // 删除醒目留言
                SendSmsReplyMsg sendSmsReplyMsg = (SendSmsReplyMsg) cmdMsg;
                ...
                break;
            }
            default: {
                // ignore
            }
        }
}

2.1 Client 模式

Spring Boot 示例 client-example

创建配置
创建 Client 并传入配置、添加消息回调
开始监听直播间

如果需要查看其他平台的效果，请将 Bilibili 改为其他平台对应的英文，并修改消息回调接口的函数签名


public class ClientModeExample {
    public static void main(String[] args) {
        String cookie = System.getenv("cookie");
        // 1. 创建配置
        BilibiliLiveChatClientConfig config = BilibiliLiveChatClientConfig.builder()
                // TODO 消息转发地址
                .forwardWebsocketUri("")
                // TODO 浏览器Cookie
                .cookie(cookie)
                // TODO 直播间id（支持短id）
                .roomId(7777)
                .build();

        // 2. 创建Client并传入配置、添加消息回调
        BilibiliLiveChatClient client = new BilibiliLiveChatClient(config, new IBilibiliMsgListener() {
            @Override
            public void onDanmuMsg(BilibiliBinaryFrameHandler binaryFrameHandler, DanmuMsgMsg msg) {
                IBilibiliMsgListener.super.onDanmuMsg(binaryFrameHandler, msg);
                System.out.printf("%s 收到弹幕 %s %s(%s)：%s\n", binaryFrameHandler.getRoomId(), msg.getBadgeLevel() != 0 ? msg.getBadgeLevel() + msg.getBadgeName() : "", msg.getUsername(), msg.getUid(), msg.getContent());
            }

            @Override
            public void onGiftMsg(BilibiliBinaryFrameHandler binaryFrameHandler, SendGiftMsg msg) {
                IBilibiliMsgListener.super.onGiftMsg(binaryFrameHandler, msg);
                System.out.printf("%s 收到礼物 %s %s(%s) %s %s(%s)x%s(%s)\n", binaryFrameHandler.getRoomId(), msg.getBadgeLevel() != 0 ? msg.getBadgeLevel() + msg.getBadgeName() : "", msg.getUsername(), msg.getUid(), msg.getData().getAction(), msg.getGiftName(), msg.getGiftId(), msg.getGiftCount(), msg.getGiftPrice());
            }

            @Override
            public void onSuperChatMsg(BilibiliBinaryFrameHandler binaryFrameHandler, SuperChatMessageMsg msg) {
                IBilibiliMsgListener.super.onSuperChatMsg(binaryFrameHandler, msg);
                System.out.printf("%s 收到醒目留言 %s(%s)：%s\n", binaryFrameHandler.getRoomId(), msg.getUsername(), msg.getUid(), msg.getContent());
            }

            @Override
            public void onEnterRoomMsg(InteractWordMsg msg) {
                System.out.printf("%s %s(%s) 进入直播间\n", msg.getBadgeLevel() != 0 ? msg.getBadgeLevel() + msg.getBadgeName() : "", msg.getUsername(), msg.getUid());
            }

            @Override
            public void onLikeMsg(BilibiliBinaryFrameHandler binaryFrameHandler, LikeInfoV3ClickMsg msg) {
                IBilibiliMsgListener.super.onLikeMsg(binaryFrameHandler, msg);
                System.out.printf("%s 收到点赞 %s %s(%s)\n", binaryFrameHandler.getRoomId(), msg.getBadgeLevel() != 0 ? msg.getBadgeLevel() + msg.getBadgeName() : "", msg.getUsername(), msg.getUid());
            }

            @Override
            public void onLiveStatusMsg(BilibiliBinaryFrameHandler binaryFrameHandler, BilibiliLiveStatusChangeMsg msg) {
                IBilibiliMsgListener.super.onLiveStatusMsg(binaryFrameHandler, msg);
                System.out.printf("%s 状态变化 %s\n", binaryFrameHandler.getRoomId(), msg.getLiveStatusAction(binaryFrameHandler.getRoomId()));
            }
        });
        // 3. 开始监听直播间
        client.connect();

        // 客户端连接状态回调
        client.addStatusChangeListener((evt, oldStatus, newStatus) -> {
            if (newStatus == ClientStatusEnums.CONNECTED) {
                // TODO 要发送的弹幕内容，请注意控制发送频率；框架内置支持设置发送弹幕的最少时间间隔，小于时将忽略该次发送
                client.sendDanmu("666666" + RandomUtil.randomNumbers(1));
            }
        });
    }
}

2.2 高级模式

参考 BilibiliHandlerModeExample

3 项目说明

3.1 commons 模块

主要是抽象接口、抽象类的定义

3.1.1 commons-base

定义了一些基础的接口、抽象类：消息、消息监听器、连接连监听器

消息接口
- IMsg：所有 msg 都应该继承该类
  - ICmdMsg：有些平台的一些消息正文中没有消息类型 cmd 字段，例如 B 站的心跳包，因此再细分为 cmdMsg
  - IDanmuMsg: 内置获取用户 ID、用户名、用户头像、粉丝牌名称、粉丝牌等级、弹幕内容等方法
    - ISuperChatMsg：醒目留言，内置获取持续时间方法
  - IGiftMsg: 内置获取发送方 ID、发送方用户名、发送方头像、接收方 ID、接收方用户名、礼物名称、礼物图片、礼物 ID、礼物个数、礼物单价等方法
  - IEnterRoomMsg: 内置获取用户 ID、用户名、用户头像、粉丝牌名称、粉丝牌等级方法
  - ILikeMsg: 内置获取用户 ID、用户名、用户头像、粉丝牌名称、粉丝牌等级、点赞数方法
消息抽象类
- BaseMsg：实现 IMsg 接口，提供存放未知属性的字段
  - BaseCmdMsg：继承自 BaseMsg，实现 ICmdMsg 接口
消息监听器
- IBaseMsgListener（所有平台都支持，其他消息监听器存在平台差异）
  - onMsg：所有消息（不管消息内容）都会调用，不包括由该消息的某个字段派生出的消息，例如快手的弹幕礼物等消息是 SC_FEED_PUSH 中的字段，因此 onMsg 中不会出现处理后的弹幕、礼物消息，而是包含弹幕、礼物等的 SCWebFeedPush CMD 消息
  - onCmdMsg：cmd 消息（消息体中有表示消息类型的字段时），并且该类型需要处理（例如心跳回复包不需要处理）时调用
  - onOtherCmdMsg：该消息类型不需要处理（例如 PK、点赞数更新等类型）时调用
  - onUnknownCmd：该消息类型未知（没有对应的枚举类）时调用
- IDanmuMsgListener（所有平台）
  - onDanmuMsg：收到弹幕消息
- IGiftMsgListener（所有平台，快手礼物消息不全，缺少礼物单价、接收方信息、发送方粉丝牌信息）
  - onGiftMsg：收到礼物消息（抖音、快手平台需要判断礼物个数是否大于 0）
- ISuperChatMsgListener（B 站）
  - onSuperChatMsg：收到醒目留言
- IEnterRoomMsgListener（B 站、斗鱼、抖音，虎牙只能接收到高级用户的入房回调）
  - onEnterRoomMsg：进入房间消息回调
- ILikeMsgListener（B 站、快手、抖音支持获取点赞的个数）
  - onLikeMsg：收到点赞消息