duan617/laravel-hprose

Hprose for Laravel

v1.0.1 2022-09-13 05:22 UTC

Requires

• php: >=7.0.0
• hprose/hprose: v2.0.*
• hprose/hprose-swoole: dev-master

MIT

• duan617

• laravel
• Hprose

README

基于 hprose/hprose-php 开发的Laravel扩展：laravel-hprose

版本要求

Laravel>=5.2

安装

composer require "zhuqipeng/laravel-hprose:v1.0.*"

或者编辑composer.json

"require": {
    "zhuqipeng/laravel-hprose": "v1.0.*"
}

配置

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

   'providers' => [
       // ...
   
       duan617\LaravelHprose\ServiceProvider::class,
   ]

   'aliases' => [
       // ...
   
       'LaravelHproseMethodManage' => duan617\LaravelHprose\Facades\HproseMethodManage::class,
   ]

2. 配置.env文件

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

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

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

   HPROSE_DEMO=true // true or false
   

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

   php artisan vendor:publish --provider="duan617\LaravelHprose\ServiceProvider"

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

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

4. 配置说明，config/hprose.php

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

   'uris' => json_decode(env('HPROSE_URIS', '["tcp://0.0.0.0:1314"]')),

   是否启用demo方法，true开启 false关闭，开启后将自动对外发布一个远程调用方法 demo

   'demo' => env('HPROSE_DEMO'),

   参数验证器命名空间

   'parameter' => 'App\\Controllers\\Parameters'

   控制器命名空间

   'controller' => 'App\\Controllers',

使用

路由

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

路由文件

routes/rpc.php

添加路由方法

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

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

发布远程调用方法 getUserByName 和 update

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

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

控制器

<?php

namespace App\Controllers;

class User
{
    public function update($name)
    {
        return 'update name: ' . $name;
    }
}

使用参数验证器

在 add 方法后面追加链式调用 parameter 方法

\LaravelHproseRouter::add('userStore', 'User@store')->parameter('UserStore');

参数验证器

和 laravel 的表单验证规则一致，但必须继承 duan617\LaravelHprose\Parameters\Base

<?php

namespace App\Controllers\Parameters;

use duan617\LaravelHprose\Parameters\Base;

class UserStore extends Base
{
    public function rules()
    {
        return [
            'name'  => 'required',
        ];
    }

    public function messages()
    {
        return [
            'required' => ':attribute 参数是必传的'
        ];
    }
}

自定义参数验证错误响应格式

默认会抛出异常 \duan617\LaravelHprose\Exceptions\BadRequestParameterException

如果需要自定义异常，或者响应json格式，在验证器里重写 formatErrors 方法即可

<?php

namespace App\Controllers\Parameters;

use duan617\LaravelHprose\Parameters\Base;

class UserStore extends Base
{
    public function rules()
    {
        return [
            'name'  => 'required',
        ];
    }

    public function messages()
    {
        return [
            'required' => ':attribute 参数是必传的'
        ];
    }

    public function formatErrors(\Illuminate\Support\MessageBag $errorMessage)
    {
        return [
            'status_code'   => 400,
            'message'       => $errorMessage->first(),
        ];
    }
}

客户端调用

$client->getUserByName('zhuqipeng');
$client->userStore('zhuqipeng');
$client->userUpdate('zhuqipeng');

路由组

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

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

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

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

客户端调用

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

前缀

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

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

客户端调用

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

启动服务

php artisan hprose:socket_server