README

基于 hprose/hprose-php 开发的Lumen扩展：hprose-lumen

开发背景：最近需要在lumen框架中实现rpc的功能，于是在网上找了相关的资料，进行了一些拓展

版本要求

Lumen>=5.2
【注】本项目是在Lumen8下进行的测试

安装

直接使用

composer require trangfoo/hprose-lumen

使用lumen配置

在 bootstrap/app.php 中引入hprose配置、注册 ServiceProvider 和 Facade

     $app->configure('hprose');

   $app->register(Trangfoo\HproseLumen\ServiceProvider::class);

    $app->withFacades(true, [
        // ...
        'Trangfoo\HproseLumen\Facades\Router' => 'HproseLumenRouter',
    ]);

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

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

配置.env文件

完整配置

#[RPC]
#RPC服务（监听端口、主机）
HPROSE_PORT=8888
HPROSE_URIS=["tcp://0.0.0.0:${HPROSE_PORT}"]

#开启范例路由
HPROSE_DEMO=true

#请求不通过返回码及信息
HPROSE_REJECT_CODE=0
HPROSE_REJECT_MSG=Server拒绝本次请求

#RPC连接密钥
HPROSE_SECRET=123456789

#RPC超时限制（秒）
HPROSE_TIMEOUT=60

监听地址列表，字符串json格式数组

#RPC服务（监听端口、主机）
HPROSE_PORT=8888
HPROSE_URIS=["tcp://0.0.0.0:${HPROSE_PORT}"]

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

#开启范例路由
HPROSE_DEMO=true

客户端与服务端通信时，如果发生鉴权失败、超时等返回失败信息； RPC通信的鉴权密钥、超时时间限制

#请求不通过返回码及信息
HPROSE_REJECT_CODE=0
HPROSE_REJECT_MSG=Server拒绝本次请求

#RPC连接密钥
HPROSE_SECRET=123456789

#RPC超时限制（秒）
HPROSE_TIMEOUT=60

创建配置和路由文件：
```
php artisan vendor:publish --provider="Trangfoo\HproseLumen\ServiceProvider"
```
应用根目录下的config目录下会自动生成新文件hprose.php

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

使用

路由

路由文件

routes/rpc.php

添加路由方法

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

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

发布远程调用方法 getUserByName 和 update

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

\HproseLumenRouter::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',
        ];
    }
}

客户端调用、加入鉴权Handler

$client = new \Hprose\Socket\Client('tcp://127.0.0.1:8888', false);
$client->addInvokeHandler(array(new \Trangfoo\HproseLumen\Handler\AuthHandler(), 'inputInvokeHandler'));  //添加鉴权InvokeHandler
$client->getUserByName('lumen');
$client->userUpdate('lumen');

路由组

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

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

\HproseLumenRouter::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');

前缀

\HproseLumenRouter::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'];
}

启动服务

php artisan hprose:socket_server

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

trangfoo / hprose-lumen

Maintainers

Details

README

版本要求

安装

使用lumen配置

使用

路由

启动服务