anhao/hyperf-gotask

A replacement for Swoole TaskWorker in Go

v3.1.2 2024-10-21 07:08 UTC

Requires

• php: >=7.4
• ext-json: *
• ext-sockets: *
• ext-swoole: >=4.4
• hyperf/pool: ^3.0
• hyperf/process: ^3.0
• spiral/goridge: 3.2.1
• symfony/event-dispatcher: ^5.1|^6.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• hyperf/command: ^3.0
• hyperf/config: ^3.0
• hyperf/di: ^3.0
• hyperf/framework: ^3.0
• hyperf/testing: ^3.0
• mockery/mockery: ^1.3
• phpstan/phpstan: ^1.0
• swoole/ide-helper: ^4.5 || ^5.0

MIT

• php
• hyperf

README

English | 中文

GoTask spawns a go process as a Swoole sidecar and establishes a bi-directional IPC to offload heavy-duties to Go. Think of it as a Swoole Taskworker in Go.

composer require hyperf/gotask

Feature

• High performance with low footprint.
• Based on Swoole 4 coroutine socket API.
• Support Unix Socket, TCP and stdin/stdout pipes.
• Support both PHP-to-Go and Go-to-PHP calls.
• Automatic sidecar lifecycle management.
• Correctly handle remote error.
• Support both structural payload and binary payload.
• Sidecar API compatible with net/rpc.
• Baked-in connection pool.
• Optionally integrated with Hyperf framework.

Perfect For

• Blocking operations in Swoole, such as MongoDB queries.
• CPU Intensive operations, such as encoding and decoding.
• Leveraging Go eco-system, such as Kubernetes clients.

Requirement

• PHP 7.2+
• Go 1.13+
• Swoole 4.4LTS+
• Hyperf 1.1+ (optional)

Task Delivery Demo

package main

import (
    "github.com/anhao/gotask/v3/pkg/gotask"
)

type App struct{}

func (a *App) Hi(name string, r *interface{}) error {
    *r = map[string]string{
        "hello": name,
    }
    return nil
}

func main() {
    gotask.SetAddress("127.0.0.1:6001")
    gotask.Register(new(App))
    gotask.Run()
}

<?php

use Hyperf\GoTask\IPC\SocketIPCSender;
use function Swoole\Coroutine\run;

require_once "../vendor/autoload.php";

run(function(){
    $task = new SocketIPCSender('127.0.0.1:6001');
    var_dump($task->call("App.Hi", "Hyperf"));
    // [ "hello" => "Hyperf" ]
});

Resources

English documentation is not yet complete! Please see examples first.

• Installation
• Document
• FAQ
• Example
• Hyperf Example

Benchmark

https://github.com/reasno/gotask-benchmark

Credit

• https://github.com/spiral/goridge provides the IPC protocol.
• https://github.com/twose helps the creation of this project.