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

github:

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

github.com

適用場景

  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跟蹤
  • 分散式(長連接,事務……)

路由

Router::get(/, AppControllersIndexController::class . @index);

// 帶參數路由
Router::get(/user/{id}, AppControllersIndexController::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 => [
AppTestMixProTestMiddle::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 AppModel;

use OneDatabaseMysqlModel;

// 模型裡面不需要指定主鍵,框架會緩存資料庫結構
// 自動匹配主鍵,自動過濾非表結構里的欄位
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 => OneSwooleOneServer::SWOOLE_WEBSOCKET_SERVER,
port => 8082,
// 事件回調
action => OneSwooleServerWsServer::class,
mode => SWOOLE_PROCESS,
sock_type => SWOOLE_SOCK_TCP,
ip => 0.0.0.0,
// swoole 伺服器設置參數
set => [
worker_num => 5
]
],
// 添加監聽
add_listener => [
[
port => 8081,
// 事件回調
action => AppServerAppHttpPort::class,
type => SWOOLE_SOCK_TCP,
ip => 0.0.0.0,
// 給監聽設置參數
set => [
open_http_protocol => true,
open_websocket_protocol => false
]
],
[
port => 8083,
// 打包 解包協議
pack_protocol => OneProtocolText::class,
// 事件回調
action => AppTestMixProTcpPort::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 => AppServerRpcHttpPort::class,
type => SWOOLE_SOCK_TCP,
ip => 0.0.0.0,
set => [
open_http_protocol => true,
open_websocket_protocol => false
]
],
// tcp 協議 rpc服務
[
port => 8083,
action => AppServerRpcTcpPort::class,
type => SWOOLE_SOCK_TCP,
pack_protocol => OneProtocolFrame::class, // tcp 打包 解包協議
ip => 0.0.0.0,
set => [
open_http_protocol => false,
open_websocket_protocol => false,
open_length_check => 1,
package_length_func => OneProtocolFrame::length,
package_body_offset => OneProtocolFrame::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


推薦閱讀:
相关文章