LiveChatClient弹幕客户端

license release Maven Central

This project is in progress... 👨‍💻，有问题欢迎提交issuseopen in new window，
觉得有用的话可以点个小星星⭐️鼓励一下，感谢
如果对项目感兴趣也欢迎加入QQ频道open in new window交流讨论，
提交PR
ToDo List: https://github.com/orgs/OrdinaryRoad-Project/projects/1open in new window

Live room WebSocket chat client

Feature 0: Netty
Feature 1: 消息中的未知属性统一放到单独的MAP中
Feature 2: 支持自动重连
Feature 3: 支持同时监听多个直播间
Feature 4: 支持直播间短id
Feature 5: 支持弹幕发送
Feature 6: 内置收到弹幕、收到礼物、收到醒目留言、用户入房回调

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

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站：BilibiliCmdEnumopen in new window
斗鱼：DouyuCmdEnumopen in new window
虎牙：HuyaCmdEnumopen in new window
抖音：DouyinCmdEnumopen in new window
快手：PayloadTypeOuterClassopen in new window

可以重写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;
                ...
            }
            case SUPER_CHAT_MESSAGE_DELETE -> {
                // 删除醒目留言
                SendSmsReplyMsg sendSmsReplyMsg = (SendSmsReplyMsg) cmdMsg;
                ...
            }
        }
}

2.1 Client模式

Spring Boot 示例 client-exampleopen in new window

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

public class ClientModeExample {
    public static void main(String[] args) {
        String cookie = System.getenv("cookie");
        // 1. 创建配置
        BilibiliLiveChatClientConfig config = BilibiliLiveChatClientConfig.builder()
                // 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());
            }
        });
        // 3. 开始监听直播间
        client.connect();

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

2.2 高级模式

参考 BilibiliHandlerModeExampleopen in new window

3 项目说明

commons（主要是抽象接口、抽象类的定义）
- commons-base
  - 定义了一些基础的接口、抽象类：消息、消息监听器、连接连监听器
  - 消息接口
    - IMsg：所有msg都应该继承该类
      - ICmdMsg：有些平台的一些消息正文中没有消息类型cmd字段，例如B站的心跳包，因此再细分为cmdMsg
      - IDanmuMsg: 内置获取用户ID、用户名、用户头像、粉丝牌名称、粉丝牌等级、弹幕内容等方法
        ISuperChatMsg：醒目留言，内置获取持续时间方法
      - IGiftMsg：内置获取发送方ID、发送方用户名、发送方头像、接收方ID、接收方用户名、礼物名称、礼物图片、礼物ID、礼物个数、礼物单价等方法
  - 消息抽象类
    - BaseMsg：实现IMsg接口，提供存放未知属性的字段
      - BaseCmdMsg：继承自BaseMsg，实现ICmdMsg接口
  - 消息监听器
    - IBaseMsgListener（所有平台都支持，其他消息监听器存在平台差异）
      - onMsg：所有消息（不管消息内容）都会调用，不包括由该消息的某个字段派生出的消息，例如快手的弹幕礼物等消息是SC_FEED_PUSH中的字段，因此onMsg中不会出现处理后的弹幕、礼物消息，而是包含弹幕、礼物等的SCWebFeedPushCMD消息
      - onCmdMsg：cmd消息（消息体中有表示消息类型的字段时），并且该类型需要处理（例如心跳回复包不需要处理）时调用
      - onOtherCmdMsg：该消息类型不需要处理（例如PK、点赞数更新等类型）时调用
      - onUnknownCmd：该消息类型未知（没有对应的枚举类）时调用
    - IDanmuMsgListener（所有平台）
      - onDanmuMsg：收到弹幕消息
    - IGiftMsgListener（所有平台，快手礼物消息不全，缺少礼物单价、礼物个数、接收方信息、发送方粉丝牌信息）
      - onGiftMsg：收到礼物消息
    - ISuperChatMsgListener（B站）
      - onSuperChatMsg：收到醒目留言
    - IEnterRoomMsgListener（B站、斗鱼、抖音，虎牙只能接收到高级用户的入房回调）
      - onEnterRoomMsg：进入房间消息回调
- commons-client
  - 定义了Client的配置：连接地址、房间id、Cookie、心跳、自动重连等相关参数
  - 定义了Client的一些方法：初始化、销毁、连接、断开、添加消息回调、移除消息回调、发送弹幕等
  - 定义了Client的生命周期
- commons-util
  - 一些工具类：时间、反射、Cookie
servers（对使用的连接工具的抽象）
- servers-netty
  - 定义了连接处理Handler
  - 定义了数据处理Handler
- servers-netty-client（基于netty实现的Client）
  - 扩展了Client、ClientConfig
  - 扩展Handler增加了Client成员变量
clients（对servers-netty-client的具体实现）
- client-bilibili
- client-douyu
- client-huya
- client-douyin
- client-kuaishou

交流讨论

扫描二维码
或点击链接加入QQ频道【OrdinaryRoad】：https://pd.qq.com/s/3id0n7fvsopen in new window

感谢

douyu-crawler-demoopen in new window（斗鱼登录状态的请求包构建）
Kain-90/huya-danmuopen in new window
（虎牙流程参考，最新lib库vplayerUI.jsopen in new window、taf-signal.global.0.0.4.prod.jsopen in new window）
saermart/DouyinLiveWebFetcheropen in new window（抖音流程参考）

免责声明

免责声明：仅供学术研究使用。对于违反相关法律、造成危害的滥用行为，开发者不负任何责任。

LiveChatClient弹幕客户端

# LiveChatClient弹幕客户端

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

# 0 原理

# 1 安装

# B站

# 斗鱼

# 虎牙

# 抖音

# 快手

# 2 使用

# 2.0 不同平台的CMD定义

# 2.1 Client模式

# 2.2 高级模式

# 3 项目说明

# 交流讨论

# 感谢

# 免责声明

LiveChatClient弹幕客户端

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

0 原理

1 安装

B站

斗鱼

虎牙

抖音

快手

2 使用

2.0 不同平台的CMD定义

2.1 Client模式

2.2 高级模式

3 项目说明

交流讨论

感谢

免责声明