Lumen-hprose

基于 hprose/hprose-php 开发的Lumen/Laravel扩展：Lumen-hprose 参考：Laravel-hprose

开发背景：最近打算使用lumen框架做rpc的功能，于是在网上找是否有相关的拓展，于是找到了Laravel-hprose，本打算直接用于 lumen 但尝试后发现laravel的不能完全与lumen兼容，于是根据Laravel-hprose 修改 得到 Lumen-hprose，同时兼容lumen 和 laravel。

版本要求

Laravel>=5.2

安装

直接使用

composer require lumening/lumen-hprose

如果上面不行，那么 编辑composer.json

"repositories": [
        {
            "type": "git",
            "url": "https://github.com/lumening/lumen-hprose.git"
        }
    ]

然后执行

composer require "lumening/lumen-hprose"

使用laravel配置

1. 在 config/app.php 注册 ServiceProvider 和 Facade (Laravel 5.5 无需手动注册)

   'providers' => [
       // ...
   
      Lumening\LumenHprose\ServiceProvider::class,
   ]
   

   'aliases' => [
       // ...
   
        'LumenHproseRouter'=>Lumening\LumenHprose\Facades\Router::class,
   ]
   

2. 配置.env文件 监听地址列表，字符串json格式数组

   HPROSE_URIS=["tcp://0.0.0.0:8888"]
   

   是否启用demo方法，true开启 false关闭，开启后将自动对外发布一个远程调用方法 demo 客户端可调用：$client->demo()

   HPROSE_DEMO=true // true or false
   

3. 创建配置和路由文件：

   php artisan vendor:publish --provider="Lumening\LumenHprose\ServiceProvider"
   

   应用根目录下的config目录下会自动生成新文件hprose.php

   应用根目录下的routes目录下会自动生成新文件rpc.php

使用lumen配置

1. 在 bootstrap/app.php 注册 ServiceProvider 和 Facade

      $app->register(Lumening\LumenHprose\ServiceProvider::class);
   

       $app->withFacades(true, [
           // ...
           'Lumening\LumenHprose\Facades\Router' => 'LumenHproseRouter',
       ]);
   

2. 在 app/Console/Kernel.php 添加 vendor publish

       protected $commands = [
       //...
       \Laravelista\LumenVendorPublish\VendorPublishCommand::class,
       ];
   

3. 配置.env文件 监听地址列表，字符串json格式数组

   HPROSE_URIS=["tcp://0.0.0.0:8888"]
   

   是否启用demo方法，true开启 false关闭，开启后将自动对外发布一个远程调用方法 demo 客户端可调用：$client->demo()

   HPROSE_DEMO=true // true or false
   

4. 创建配置和路由文件：

   php artisan vendor:publish --provider="Lumening\LumenHprose\ServiceProvider"
   

   应用根目录下的config目录下会自动生成新文件hprose.php

   应用根目录下的routes目录下会自动生成新文件rpc.php

使用

路由

和 laravel 路由的用法相似，基于 dingo/api 的路由代码上做了简单修改

路由文件

routes/rpc.php

添加路由方法

\LumenHproseRouter::add(string $name, string|callable $action, array $options = []);

• string $name 可供客户端远程调用的方法名
• string|callable $action 类方法，格式：App\Controllers\User@update
• array $options 是一个关联数组，它里面包含了一些对该服务函数的特殊设置，详情请参考hprose-php官方文档介绍 链接

发布远程调用方法 getUserByName 和 update

\LumenHproseRouter::add('getUserByName', function ($name) {
    return 'name: ' . $name;
});

\LumenHproseRouter::add('userUpdate', 'App\Controllers\User@update', ['model' => \Hprose\ResultMode::Normal]);

控制器

<?php

namespace App\Controllers;

class User
{
    public function update($name)
    {
        return 'update name: ' . $name;
    }
    
    public function getUserById($id)
    {
        return [
            'id'=>$id,
            'name'=>'lumen',
            'email'=>'',
            'url'=>'http://www.lumen.fun',
        ];
    }
}

客户端调用 客户端可以只安装 Hprose

$client = new \Hprose\Socket\Client('tcp://127.0.0.1:8888', false);
$client->getUserByName('lumen');
$client->userUpdate('lumen');

路由组

\LumenHproseRouter::group(array $attributes, callable $callback);

• array $attributes 属性 ['namespace' => '', 'prefix' => '']
• callable $callback 回调函数

\LumenHproseRouter::group(['namespace' => 'App\Controllers'], function ($route) {
    $route->add('getUserByName', function ($name) {
        return 'name: ' . $name;
    });
    
    $route->add('getUserById', 'User@getUserById');
    $route->add('userUpdate', 'User@update');
});

客户端调用

$client->getUserByName('lumen');
$client->userUpdate('lumen');

前缀

\LumenHproseRouter::group(['namespace' => 'App\Controllers', 'prefix' => 'user'], function ($route) {
    $route->add('getByName', function ($name) {
        return 'name: ' . $name;
    });

    $route->add('update', 'User@update');
});

客户端调用

$client->user->getByName('lumen');
$client->user->update('lumen');
// 或者
$client->user_getByName('lumen');
$client->user_update('lumen');

如果服务端出现 exception ，因为hprose 没有返回code(已经和开发者确认)，需要将code 合并到message用json方式包裹返回

try{
    $client->user->getByName('lumen');
}catch(\Exception $e){
    $info = json_decode($e->getMessage(),true);
    $message = $info['message'];
    $code = $info['code'];
}
//更新tag

启动服务

php artisan hprose:socket_server

更新了路由后需要重新启动服务