# thinkWorkerman

**Repository Path**: rotoos/think-workerman

## Basic Information

- **Project Name**: thinkWorkerman
- **Description**: workerman for ........
- **Primary Language**: PHP
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-03-20
- **Last Updated**: 2023-05-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ThinkWorkerman 

基于 **Workerman** 的 **HttpServer** 插件 ，基于内存方案快速运行 Web 及其他通信协议服务！


### 安装插件

```shell
### 安装前建议尝试更新所有组件
composer update --optimize-autoloader

composer require rotoos/think-workerman --optimize-autoloader
```

### 卸载插件

```shell
composer remove rotoos/think-workerman
```

### 配置参数

配置文件 `config/worker.php`

```php
[
    // 服务监听地址
    'host'     => '127.0.0.1',
    // 服务监听端口
    'port'     => 2346,
    // 套接字上下文选项
    'context'  => [],
    // 高级自定义服务类
    'classes'  => '',
    // 消息请求回调处理
    'callable' => null,
    // 服务进程参数配置
    'worker'   => [
        'name'  => 'DeAdmin',
        'count' => 4,
    ],
    // 监控文件变更重载
    'files'    => [
        // 监控检测间隔（单位秒，零不监控）
        'time' => 3,
        // 文件监控目录（默认监控 app 目录）
        'path' => [],
    ],
    // 监控内存超限重载
    'memory'   => [
        // 监控检测间隔（单位秒，零不监控）
        'time'  => 60,
        // 限制内存大小（可选单位有 G M K ）
        'limit' => '1G'
    ],
    // 自定义服务配置（可选）
    'customs'  => [
        // 自定义 text 服务
        'text' => [
            // 进程类型(Workerman|Gateway|Business)
            'type'    => 'workerman',
            // 监听地址(<协议>://<地址>:<端口>)
            'listen'  => 'text://0.0.0.0:8686',
            // 高级自定义服务类
            'classes' => '',
            // 套接字上下文选项
            'context' => [],
            // 服务进程参数配置
            'worker'  => [
                //'name' => 'TextTest',
                // onWorkerStart => [class,method]
                // onWorkerReload => [class,method]
                // onConnect => [class,method]
                // onBufferFull => [class,method]
                // onBufferDrain => [class,method]
                // onError => [class,method]
                // 设置连接的 onMessage 回调
                'onMessage' => function ($connection, $data) {
                    dump($data);
                    $connection->send("hello world");
                }
            ]
        ],
        // 自定义 WebSocket 服务
        'websocket' => [
            // 进程类型(Workerman|Gateway|Business) 
            'type'    => 'Gateway',
            // 监听地址(<协议>://<地址>:<端口>)
            'listen'  => 'websocket://0.0.0.0:8688',
            // 高级自定义服务类
            'classes' => '',
            // 套接字上下文选项
            'context' => [],
            // 服务进程参数配置
            'worker'  => [
                //'name' => 'WebsocketTest',
                // onWorkerStart => [class,method]
                // onWorkerReload => [class,method]
                // onConnect => [class,method]
                // onBufferFull => [class,method]
                // onBufferDrain => [class,method]
                // onError => [class,method]
                // 设置连接的 onMessage 回调
                'onMessage' => function ($connection, $data) {
                    //// $connection->worker->connections 为全部连接
                    // foreach($connection->worker->connections as $con)
                    // {
                    //    $con->send($data);
                    // }
                    $connection->send("hello world");
                }
            ]
        ],
    ],
];
```

### 使用方法

在命令行启动服务端

```shell
#========= 启动参数配置 =========#
### 守护方式运行  -d
### 指定监听域名  --host 127.0.0.1
### 指定监听端口  --port 2346 
### 启动指定服务  --custom text

# 启动默认 Http 服务
php think xadmin:worker

# 启动自定义 text 服务，注意 text 为 customs 配置项
php think xadmin:worker --custom text

# 启动自定义 WebSocket 服务，注意 websocket 为 customs 配置项
php think xadmin:worker --custom websocket

```

然后就可以通过浏览器直接访问当前应用

```
http://localhost:2346
```

默认使用 `Workerman` 工作方式，如果需要使用 `Gateway`、`Business` 方式，需要安装 `GatewayWorker` 组件。

安装 `GatewayWorker` 的指令如下：

```shell
# 安装 GatewayWorker 组件
composer require workerman/gateway-worker
```

Linux 支持操作指令如下：

```shell
php think xadmin:worker [start|stop|reload|restart|status|-d]

# 以上所有操作效果与 Workerman 官方操作一致，详情请阅读对应文档。
```

Windows 支持操作指令如下：

```shell
php think xadmin:worker [start|stop|status|-d]

# 以上 stop|status|-d 操作是基于 wimc 实现，Workerman 官方不支持此种方式操作。  
```

其他 **workerman** 的参数可以在应用配置目录下的 **worker.php** 里面 **worker** 项配置。

更多其他特性请阅读 **workerman** 文档 https://www.workerman.net/doc/workerman

### 版权说明

本项目包含的第三方源码和二进制文件之版权信息另行标注。