1 Star 0 Fork 0

imi 开发组 / imi-hprose

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

imi-hprose

Latest Version Php Version Swoole Version IMI License

介绍

在 imi 框架中集成 Hprose 服务开发,目前支持TCPUnix Socket协议。

未来将实现:中间件、过滤器、Http 协议、WebSocket 协议……

Composer

本项目可以使用composer安装,遵循psr-4自动加载规则,在你的 composer.json 中加入下面的内容:

{
    "require": {
        "imiphp/imi-hprose": "^1.2"
    }
}

然后执行 composer update 安装。

服务端

在项目 config/config.php 中配置:

[
    'components'    =>  [
        // 引入RPC组件以及本组件
        'Rpc'    	=>  'Imi\Rpc',
        'Hprose'    =>  'Imi\Hprose',
    ],
]

如果你用主服务器:

[
    // 主服务器配置
	'mainServer'	=>	[
		'namespace'	=>	'XXX\MainServer', // 你的命名空间
		'type'		=>	'Hprose', // 必须设为 Hprose
		'port'		=>	8080,
	],
]

如果你用子服务器:

[
    // 子服务器(端口监听)配置
	'subServers'		=>	[
		// 子服务器名
		'XXX'	=>	[
			'namespace'	=>	'XXX\Hprose', // 你的命名空间
			'type'		=>	'Hprose', // 必须设为 Hprose
			'port'		=>	50001,
		]
	],
]

控制器基类

Imi\Rpc\Controller\RpcController

控制器注解

\Imi\Rpc\Route\Annotation\RpcController

用法:

@RpcController

别名前缀:@RpcController('a_b_')

动作注解

\Imi\Rpc\Route\Annotation\RpcAction

无参

路由注解

\Imi\Hprose\Route\Annotation\HproseRoute

参数:

  • name 路由名称规则。一般也是方法名,如果设置了别名,则最终为别名+方法名
  • mode 该设置表示该服务函数返回的结果类型,具体值请参考 Hprose 文档
  • simple 该设置表示本服务函数所返回的结果是否为简单数据。默认值为 false。
  • oneway 该设置表示本服务函数是否不需要等待返回值。当该设置为 true 时,调用会异步开始,并且不等待结果,立即返回 null 给客户端。默认值为 false。
  • async 该设置表示本服务函数是否为异步函数,异步函数的最后一个参数是一个回调函数,用户需要在异步函数中调用该回调方法来传回返回值
  • passContext 该属性为 boolean 类型,默认值为 false。具体请参考 Hprose 文档

Hprose 文档参考:https://github.com/hprose/hprose-php/wiki/06-Hprose-服务器#addfunction-%E6%96%B9%E6%B3%95

客户端

连接池配置

[
	'pools'	=>	[
		'连接池名'	=>	[
			'sync'	=>	[
				'pool'	=>	[
					'class'		=>	\Imi\Rpc\Client\Pool\RpcClientSyncPool::class,
					'config'	=>	[
						// 连接池通用,查阅文档
					],
				],
				'resource'	=>	[
					'clientClass'	=>	\Imi\Hprose\Client\HproseSocketClient::class,
					'uris'	=>	'tcp://127.0.0.1:50001', // 连接地址
					// 其它配置
				]
			],
			'async'	=>	[
				'pool'	=>	[
					'class'		=>	\Imi\Rpc\Client\Pool\RpcClientCoroutinePool::class,
					'config'	=>	[
						// 连接池通用,查阅文档
					],
				],
				'resource'	=>	[
					'clientClass'	=>	\Imi\Hprose\Client\HproseSocketClient::class,
					'uris'	=>	'tcp://127.0.0.1:50001', // 连接地址
					// 其它配置
				]
			],
		],
	],
	'rpc'	=>	[
		'defaultPool'	=>	'连接池名', // 默认连接池名
	],
]

客户端调用

代码调用:

\Imi\Rpc\Client\Pool\RpcClientPool::getService('服务名')->方法名(参数);

注解调用:

class Test
{
	/**
	 * @RpcClient()
	 *
	 * @var \Imi\Rpc\Client\IRpcClient
	 */
	protected $rpcClient;

	/**
	 * @RpcService(serviceName="服务名")
	 *
	 * @var \Imi\Rpc\Client\IService
	 */
	protected $xxxRpc;

	public function aaa()
	{
		// 方法一
		$this->rpcClient->getService('服务名')->方法名(参数);

		// 方法二
		$this->xxxRpc->方法名(参数);
	}
}

免费技术支持

QQ群:17916227 点击加群,如有问题会有人解答和修复。

运行环境

版权信息

imi-hprose 遵循 MIT 开源协议发布,并提供免费使用。

捐赠

开源不求盈利,多少都是心意,生活不易,随缘随缘……

MIT License Copyright (c) 2018 imiphp Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

在 imi 框架中集成 Hprose 服务开发,目前支持TCP、Unix Socket协议 展开 收起
PHP
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
PHP
1
https://gitee.com/imiphp/imi-hprose.git
git@gitee.com:imiphp/imi-hprose.git
imiphp
imi-hprose
imi-hprose
master

搜索帮助