# automan-bot/android-bot architecture

> Architecture diagram of the GitHub repository automan-bot/android-bot, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/automan-bot/android-bot
- Repository: https://github.com/automan-bot/android-bot

## Overview

下面给出如何根据项目的文件结构和 README 文档，绘制一份准确且详尽的系统设计图的说明，目标是帮助你（作为负责人软件工程师）全面了解项目架构，从而建立一个从整体上洞察各模块组件和交互关系的图示。

一、项目类型与目的
1. 根据文件树和 README 内容可知，项目为一个针对 Android 设备（通过 AutoBot APP 提供 HTTP 和 WebSocket API）的控制 SDK，支持浏览器和 Node 环境下调用。
##### 项目核心用途在于实现无线投屏、屏幕录制、触控输入、文件管理、应用管理、剪切板监听、通知监听等功能，适用于远程控制、自动化测试、批量管理和机器人自动回复等场景。

二、文件结构分析
##### 主要目录：
- src：存放核心源代码，如 Device 类、AdbDevice（局域网设备扫描）、ScreenControl，以及其他辅助工具如 utils 和 model；
- demo：提供了浏览器和 Node 环境下的使用示例；
- .build：包含构建配置和打包脚本；
- customTypes：定义自定义的 TypeScript 类型；
- 其他如配置文件（tsconfig.json、package.json）和 GitHub 工作流相关文件等。
##### 从目录命名上可以看出项目分为 API 实现、核心逻辑、模型定义、工具函数等几个部分，体现了一种分层架构和模块化设计。

三、根据 README 分析的更多信息
##### README 详细介绍了各核心功能和用法，说明项目中封装了对 AutoBot 官方 HTTP / WebSocket API 的调用；
2. 列出了核心类（例如 Device 及其联动的 ScreenControl），分别面向不同环境（Node、浏览器）的用例展示，使得架构需要区分 Node 与浏览器两种 WebSocket 客户端实现；
##### 通过 demo 和用例代码可以看出，对于设备的操作，既有命令式 API（例如获取屏幕、执行手势等），也有事件监听模式（例如屏幕、通知、剪切板的实时变化监听）。

四、系统设计图绘制建议
##### 主要组件
a. 客户端接口层：
- Device 类：封装与设备交互的核心接口，包含系统信息、屏幕截图、通知、剪切板、按键/触控等控制功能。
- AdbDevice：在 Node 环境下负责局域网设备扫描的模块。
- ScreenControl：提供实时屏幕图像、通知和剪切板监听等交互功能，通过主动和被动模式获取屏幕数据。

b. 网络与通信层：
- HTTP API：对接 AutoBot APP 提供的 HTTP 接口，执行命令（如获取系统信息、操作文件、应用操作）
- WebSocket 客户端：额外分为 BrowserWebSocket（浏览器环境）和 NodeWebSocket（Node 环境），用于实时控制与消息推送。

c. 辅助模块：
- Model 目录内的各数据模型类（如 GlobalModel、KeyCode、PackageInfo），用于定义数据结构。
- Utils 目录下的工具函数库（如 netUtils、request、getport 等），负责网络、请求、端口查询等逻辑。

##### 组件之间的关系与交互
- 用户调用 Device 类的 API发起控制，从而触发 HTTP 请求或者通过 WebSocket 发出实时控制命令。
- 在 Node 环境下，AdbDevice 模块首先扫描局域网中的设备，然后使用 Device 创建相应连接；在浏览器环境下，则需要用户手动传入设备 IP 与端口。
- ScreenControl 作为 Device 的属性，负责专门处理屏幕图像及相关事件通知。
- 数据模型（Model）和工具函数（Utils）作为内部支撑，提供必要的格式化、封装和辅助功能。

##### 关键的设计原则和技术栈
- 模块化设计：各个功能模块清晰分层（设备通信、数据模型、工具函数），便于扩展维护。
- 环境适配：考虑 Node 和浏览器环境中 WebSocket 客户端的不同实现。
- 事件驱动和异步处理：大量接口通过 Promise、异步调用和事件监听来实现实时数据交互。
- TypeScript 类型定义：通过 customTypes 目录提供类型支持，保证代码健壮性。

五、绘制系统设计图的具体指南
##### 图形构成元素：
- 每个组件使用清晰标签，如“Device”、“AdbDevice”、“ScreenControl”、“HTTP API”、“WebSocket Client (Browser/Node)”、“Utils”、“Model”等；
- 用不同颜色或形状区分模块类别，如核心 API 模块、通信模块、辅助模块；
- 使用带箭头的连线显示数据流、依赖关系和调用链条；
- 标注出调用模式：例如 RESTful HTTP 请求与 WebSocket 实时连接之间的箭头标注数据交互方向。

##### 调整图示以适应项目特点
- 对于全栈应用来说（虽然目前主要为 SDK 库，但支持两种运行环境），特别强调“环境适配层”：左侧展示浏览器客户端调用 “BrowserWebSocket”，右侧展示 Node 环境下的 “NodeWebSocket”及局域网设备扫描（AdbDevice）；中间部分共用 Device 及 ScreenControl 模块。
- 将外部依赖（AutoBot APP 和对应的 HTTP/WebSocket 服务端）作为独立的外部系统展现在图的右侧，并用箭头标明调用的方向。
- 展示 demo 示例代码如何依赖这些模块来达到自动化操作和实时控制的效果。

##### 最终系统设计图必须包含：
- 各主要模块的名称，并且使用不同颜色或者图标区分类型（例如 API 类、事件监听模块、外部系统等）；
- 动态数据流向，例如从设备发出的事件（屏幕变更、通知更新、剪切板事件）通过 WebSocket 返回给调用方，同时也展示用户发起的 HTTP 请求；
- 特别标注区分浏览器与 Node 环境下的不同实现细节和适配方式。

六、小结
在绘制系统设计图时，务必做到全面而清晰，将项目按功能模块分解，展现出各模块之间的依赖、数据流和调用逻辑。这样不仅利于日后扩展和维护，也能让新加入团队的工程师快速理解项目整体架构。
希望以上说明为你在设计架构图时提供了明确的思路和操作指导。

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Demo 节点
    Demo("Demo 示例代码"):::demo

    %% 客户端接口层
    subgraph "客户端接口层"
        Device("Device 类"):::apiCore
        Adb("AdbDevice"):::apiCore
        Screen("ScreenControl"):::apiCore
    end

    %% 网络与通信层
    subgraph "网络与通信层"
        HTTP_API("HTTP API"):::network
        BrowserWS("Browser WebSocket客户端"):::network
        NodeWS("Node WebSocket客户端"):::network
    end

    %% 辅助模块
    subgraph "辅助模块"
        Model("数据模型"):::assistance
        Utils("工具函数库"):::assistance
    end

    %% 外部系统
    AutoBot("AutoBot APP 服务"):::external

    %% 连接 Demo 与客户端接口层
    Demo -->|"调用Device"| Device

    %% 设备扫描（仅 Node 环境）
    Adb -->|"设备扫描"| Device

    %% Device 内部属性
    Device -->|"屏幕控制"| Screen

    %% Device 与网络接口
    Device -->|"HTTP请求"| HTTP_API
    Device -->|"WebSocket(浏览器)"| BrowserWS
    Device -->|"WebSocket(Node)"| NodeWS

    %% 网络层与外部系统
    HTTP_API -->|"调用"| AutoBot
    BrowserWS -->|"实时通信"| AutoBot
    NodeWS -->|"实时通信"| AutoBot

    %% 辅助模块支持
    Device -->|"数据处理"| Model
    HTTP_API -->|"辅助函数"| Utils

    %% 样式定义
    classDef apiCore fill:#FAD7A0,stroke:#D35400,stroke-width:2px;
    classDef network fill:#AED6F1,stroke:#2471A3,stroke-width:2px;
    classDef assistance fill:#ABEBC6,stroke:#239B56,stroke-width:2px;
    classDef external fill:#F9E79F,stroke:#B7950B,stroke-width:2px;
    classDef demo fill:#D2B4DE,stroke:#8E44AD,stroke-width:2px;

    %% Click 事件
    click Device "https://github.com/automan-bot/android-bot/blob/master/src/Device.ts"
    click Adb "https://github.com/automan-bot/android-bot/blob/master/src/AdbDevice.ts"
    click Screen "https://github.com/automan-bot/android-bot/blob/master/src/ScreenControl.ts"
    click HTTP_API "https://github.com/automan-bot/android-bot/blob/master/src/api/server.ts"
    click BrowserWS "https://github.com/automan-bot/android-bot/blob/master/src/interface/BrowserWebSocket.ts"
    click NodeWS "https://github.com/automan-bot/android-bot/blob/master/src/interface/NodeWebSocket.ts"
    click Model "https://github.com/automan-bot/android-bot/tree/master/src/Model"
    click Utils "https://github.com/automan-bot/android-bot/tree/master/src/utils"
```
