極簡，高效能分散式 PHP 框架

探索者發表於2019-05-07
分散式PHP框架

One - 極簡 . 高效能 . 鬆耦合 . 分散式 . 可執行於多種環境(cli,apache/php-fpm,swoole)

github：https://github.com/lizhichao/one

適用場景

  1. 常規web/app後端伺服器
  2. 遊戲/im即時通訊伺服器
  3. tcp/udp物聯網伺服器
  4. 綜合性專案，各種混合協議通訊

背景

在用過laravel框架，發現它的路由和資料庫ORM確實非常好用，但是整體確實有點慢，執行到控制器大約需要耗時30ms左右。於是打算做一個擁有非常好用的路由和orm又非常簡單的框架。所以你會發現one框的路由和ORM有laravel的影子。但也有一些自己的特色，例如ORM支援自動化快取(自動化讀、寫、重新整理)保持與資料庫同步，對外使用無感知。one框架也支援在fpm下執行，在fpm下框架自身整體耗時在1ms左右。

hello world

安裝

composer create-project lizhichao/one-app app
cd app
php App/swoole.php

測試

curl http://127.0.0.1:8081/

主要功能

  • RESTful路由
  • 中介軟體
  • websocket/tcp/http……任意協議路由
  • ORM模型
  • 統一的session處理
  • mysql連線池
  • redis連線池
  • 協程 tcp-client 連線池
  • HTTP/TCP/WEBOSCKET/UDP伺服器
  • 快取
  • 程式間記憶體共享
  • RPC(http,tcp,udp)
  • 日誌
  • RequestId跟蹤
  • 分散式（長連線,事務……）
  • Actor

路由


Router::get('/', \App\Controllers\IndexController::class . '@index');

// 帶引數路由
Router::get('/user/{id}', \App\Controllers\IndexController::class . '@user');

// 路由分組 
Router::group(['namespace'=>'App\\Test\\WebSocket'],function (){
    // websocket 路由
    Router::set('ws','/a','TestController@abc'); 
    Router::set('ws','/b','TestController@bbb'); 
});

// 中介軟體
Router::group([
    'middle' => [
        \App\Test\MixPro\TestMiddle::class . '@checkSession'
    ]
], function () {
    Router::get('/mix/ws', HttpController::class . '@ws');
    Router::get('/mix/http', HttpController::class . '@http');
    Router::post('/mix/http/loop', HttpController::class . '@httpLoop');
    Router::post('/mix/http/send', HttpController::class . '@httpSend');
});

orm 模型

定義模型

namespace App\Model;

use One\Database\Mysql\Model;

// 模型裡面不需要指定主鍵，框架會快取資料庫結構
// 自動匹配主鍵，自動過濾非表結構裡的欄位
class User extends Model
{
    // 定義模型對應的表名
    CONST TABLE = 'users';

    // 定義關係
    public function articles()
    {
        return $this->hasMany('id',Article::class,'user_id');
    }

    // 定義事件 
    // 是否開啟自動化快取 
    // ……
}

使用模型

  • 在fpm下資料庫連線為單列,
  • 在swoole模式下所有資料庫操作自動切換為連線池
// 查詢一條記錄
$user = User::find(1);

// 關聯查詢
$user_list = User::whereIn('id',[1,2,3])->with('articles')->findAll()->toArray();

// 更新
$r = $user->update(['name' => 'aaa']);
// 或者
$r = user::where('id',1)->update(['name' => 'aaa']);
// $r 為影響記錄數量

快取

// 設定快取 無過期時間
Cache::set('ccc',1);

// 設定快取 1分鐘過期
Cache::set('ccc',1,60);

// 獲取
Cache::get('ccc');

// 或者 快取ccc 過期10s 在tag1下面
Cache::get('ccc',function (){
    return '快取的資訊';
},10,['tag1']);

// 重新整理tag1下的所有快取
Cache::flush('tag1');

HTTP/TCP/WEBSOCKET/UDP伺服器

啟動一個websocket伺服器，
新增http服務監聽，
新增tcp服務監聽


[
     // 主伺服器
    'server' => [
        'server_type' => \One\Swoole\OneServer::SWOOLE_WEBSOCKET_SERVER,
        'port' => 8082,
        // 事件回撥
        'action' => \One\Swoole\Server\WsServer::class,
        'mode' => SWOOLE_PROCESS,
        'sock_type' => SWOOLE_SOCK_TCP,
        'ip' => '0.0.0.0',
        // swoole 伺服器設定引數
        'set' => [
            'worker_num' => 5
        ]
    ],
    // 新增監聽
    'add_listener' => [
        [
            'port' => 8081,
            // 事件回撥
            'action' => \App\Server\AppHttpPort::class,
            'type' => SWOOLE_SOCK_TCP,
            'ip' => '0.0.0.0',
            // 給監聽設定引數
            'set' => [
                'open_http_protocol' => true,
                'open_websocket_protocol' => false
            ]
        ],
        [
            'port' => 8083,
            // 打包 解包協議
            'pack_protocol' => \One\Protocol\Text::class,
            // 事件回撥
            'action' => \App\Test\MixPro\TcpPort::class,
            'type' => SWOOLE_SOCK_TCP,
            'ip' => '0.0.0.0',
            // 給監聽設定引數
            'set' => [
                'open_http_protocol' => false,
                'open_websocket_protocol' => false
            ]
        ]
    ]
];

RPC

像呼叫本專案的方法一樣呼叫遠端伺服器的方法。跨語言，跨機器。

服務端

啟動rpc服務，框架已經內建了各個協議的rpc服務，新增到到上面配置檔案的action即可。列如: 支援http呼叫，又支援tcp呼叫。

// http 協議 rpc服務
[
    'port'   => 8082,
    'action' => \App\Server\RpcHttpPort::class,
    'type'   => SWOOLE_SOCK_TCP,
    'ip'     => '0.0.0.0',
    'set'    => [
        'open_http_protocol'      => true,
        'open_websocket_protocol' => false
    ]
],
// tcp 協議 rpc服務
[
    'port'          => 8083,
    'action'        => \App\Server\RpcTcpPort::class,
    'type'          => SWOOLE_SOCK_TCP,
    'pack_protocol' => \One\Protocol\Frame::class, // tcp 打包 解包協議
    'ip'            => '0.0.0.0',
    'set'           => [
        'open_http_protocol'      => false,
        'open_websocket_protocol' => false,
        'open_length_check'       => 1,
        'package_length_func'     => '\One\Protocol\Frame::length',
        'package_body_offset'     => \One\Protocol\Frame::HEAD_LEN,
    ]
]

新增具體服務到rpc，
例如有個類Abc


class Abc
{
    private $a;

    // 初始值
    public function __construct($a = 0)
    {
        $this->a = $a;
    }

    // 加法
    public function add($a, $b)
    {
        return $this->a + $a + $b;
    }

    public function time()
    {
        return date('Y-m-d H:i:s');
    }

    // 重新設初始值
    public function setA($a)
    {
        $this->a = $a;
        return $this;
    }
}

把Abc新增到rpc服務


// 新增Abc到rpc服務
RpcServer::add(Abc::class);

// 如果你不希望把Abc下的所有方法都新增到rpc服務，也可以指定新增。
// 未指定的方法客戶端無法呼叫.
//RpcServer::add(Abc::class,'add');

// 分組新增
//RpcServer::group([
//    // 中介軟體 在這裡可以做 許可權驗證 資料加解密 等等
//    'middle' => [
//        TestMiddle::class . '@aa'
//    ],
//    // 快取 如果設定了 當以同樣的引數呼叫時 會返回快取資訊 不會真正呼叫 單位:秒
//    'cache'  => 10
//], function () {
//    RpcServer::add(Abc::class);
//    RpcServer::add(User::class);
//});

客戶端呼叫

為了方便呼叫我們建立一個對映類（one框架可自動生成）

class ClientAbc extends RpcClientHttp {

    // rpc伺服器地址
    protected $_rpc_server = 'http://127.0.0.1:8082/';

    // 遠端的類 不設定 預設為當前類名
    protected $_remote_class_name = 'Abc';
}

呼叫rpc服務的遠端方法， 和呼叫本專案的方法一樣的。你可以想象這個方法就在你的專案裡面。

$abc = new ClientAbc(5);

// $res === 10
$res = $abc->add(2,3);

// 鏈式呼叫 $res === 105
$res = $abc->setA(100)->add(2,3);

// 如果把上面的模型的User新增到rpc
// RpcServer::add(User::class);
// 下面執行結果和上面一樣
// $user_list = User::whereIn('id',[1,2,3])->with('articles')->findAll()->toArray();

上面是通過http協議呼叫的。你也可以通過其他協議呼叫。例如Tcp協議

class ClientAbc extends RpcClientTcp {

    // rpc伺服器地址
    protected $_rpc_server = 'tcp://127.0.0.1:8083/';

    // 遠端的類 不設定 預設為當前類名
    protected $_remote_class_name = 'Abc';
}

其中類 RpcClientHttp,RpcClientTcp在框架裡。
你也可以複製到任何其他地方使用。

更多請看文件

詳細文件地址

使用列子-DEMO

QQ交流群: 731475644

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章