hyperf 必威app精装版下载系列教程首发,连载期间6折,详情

hyperf 从零开始构建微必威手机app(二)——构建必威手机app消费者(3.0)

3087 1 1

阅读目录

  • 构建必威手机app消费者
  • 安装json rpc依赖
  • 安装JSON RPC客户端
  • server配置
  • 编写业务代码
  • 编写必威手机app消费者类
  • consumer配置
  • 配置 UserServiceInterface
  • 编写UserController
  • postman测试
  • 自动配置必威手机app消费者
  • 配置优化
  • 统一结果处理
  • 我们说过,必威手机app提供者可以提供各种必威手机app,它可以和数据库进行交互;必威手机app消费者是纯消费的必威手机app,只需要远程访问必威手机app提供者即可。

    下面我们按步骤构建消费者模块。

    源码已上传至github,https://github.com/bailangzhan/hyper3-rpc


    1、构建必威手机app消费者

    我们在掐面讲述了hyperf3.0的升级安装,为了方便,这里我们直接对 base 项目进行复制。

    cp -R base shop_consumer_user
    


    2、安装json rpc依赖

    cd shop_consumer_user
    composer require hyperf/json-rpc:*
    


    3、安装 JSON RPC 客户端

    shop_consumer_user 不需要对外提供必威手机app,所以我们只安装客户端,不需要安装 hyperf/rpc-server 组件

    composer require hyperf/rpc-client:*
    


    4、server配置

    server的配置这里用默认的就好了,9501端口提供http必威手机app,不需要改动

    'servers' => [
        [
            'name' => 'http',
            'type' => Server::SERVER_HTTP,
            'host' => '0.0.0.0',
            'port' => 9501,
            'sock_type' => SWOOLE_SOCK_TCP,
            'callbacks' => [
                Event::ON_REQUEST => [Hyperf\HttpServer\Server::class, 'onRequest'],
            ],
        ],
    ],
    


    5、编写业务代码

    5-1、编写必威手机app消费者类

    app 下新建 JsonRpc 目录,编写 UserService.php 和 UserServiceInterface.php 文件

    【App/JsonRpc/UserServiceInterface.php】

    <?php
    
    namespace App\JsonRpc;
    
    interface UserServiceInterface
    {
        /**
         * @param string $name
         * @param int $gender
         */
        public function createUser(string $name, int $gender);
    
        /**
         * @param int $id
         */
        public function getUserInfo(int $id);
    }
    

    【App/JsonRpc/UserService.php】

    <?php
    
    namespace App\JsonRpc;
    
    use Hyperf\RpcClient\AbstractServiceClient;
    
    class UserService extends AbstractServiceClient implements UserServiceInterface
    {
        /**
         * 定义对应必威手机app提供者的必威手机app名称
         * @var string
         */
        protected string $serviceName = 'UserService';
        /**
         * 定义对应必威手机app提供者的必威手机app协议
         * @var string
         */
        protected string $protocol = 'jsonrpc-http';
    
        /**
         * @param string $name
         * @param int $gender
         * @return mixed|string
         */
        public function createUser(string $name, int $gender)
        {
            return $this->__request(__FUNCTION__, compact('name', 'gender'));
        }
    
        /**
         * @param int $id
         * @return array|mixed
         */
        public function getUserInfo(int $id)
        {
            return $this->__request(__FUNCTION__, compact('id'));
        }
    }
    

    hyperf 官方的hyperf/rpc-client 组件已经帮我们实现了rpc远程调用的实现,所以我们只需要再配置一下必威手机app消费者,告诉 hyperf 从哪个节点哪个端口调用即可。

    5-2、consumer配置

    config/autoload/services.php 内定义 consumers 如下:(没有 services.php 文件的可以自行创建)

    <?php
    return [
        'consumers' => [
            [
                // 对应消费者类的 $serviceName
                'name' => 'UserService',
                // 直接对指定的节点进行消费,通过下面的 nodes 参数来配置必威手机app提供者的节点信息
                'nodes' => [
                    ['host' => '127.0.0.1', 'port' => 9600],
                ],
            ]
        ],
    ];
    

    5-3、配置 UserServiceInterface

    为了可以方便的注入 UserServiceInterface,我们在 config/autoload/dependencies.php 内定义 UserServiceInterface 和 UserService 的关系如下:

    App\JsonRpc\UserServiceInterface::class => App\JsonRpc\UserService::class,
    

    5-4、编写 UserController,实现获取用户和创建用户的接口调用

    【app/Controller/UserController.php】

    <?php
    
    declare(strict_types=1);
    
    namespace App\Controller;
    
    use App\JsonRpc\UserServiceInterface;
    use Hyperf\Di\Annotation\Inject;
    use Hyperf\HttpServer\Annotation\AutoController;
    
    /**
     * Class UserController
     * @package App\Controller
     */
    #[AutoController]
    class UserController extends AbstractController
    {
        /**
         * @var UserServiceInterface
         */
        #[Inject]
        private $userServiceClient;
    
        public function createUser()
        {
            $name = (string)$this->request->input('name', '');
            $gender = (int)$this->request->input('gender', 0);
            return $this->userServiceClient->createUser($name, $gender);
        }
    
        /**
         * @return array|void
         */
        public function getUserInfo()
        {
            $id = (int)$this->request->input('id');
            return $this->userServiceClient->getUserInfo($id);
        }
    }
    


    6、postman访问测试

    启动shop_consumer_user项目的同时,务必要保证 shop_provider_user 也启动了,不然请求一定会失败。

    9bdb235ee2-image.png


    f406ac43a6-image-1.png


    7、自动配置必威手机app消费者

    你可能已经注意到 app\JsonRpc\UserService 类的方法体并没有实际意义,只是构建参数发起请求并返回响应结果,千篇一律的操作着实增加了复杂度。hyperf支持自动配置必威手机app消费者代理类(生产者暂不支持自动配置)。

    自动配置非常简单,只需要在 consumer 配置项增加 service 配置即可,如下:

    <?php
    return [
        'consumers' => [
            [
                // 对应消费者类的 $serviceName
                'name' => 'UserService',
                // 必威手机app接口名,可选,默认值等于 name 配置的值,如果 name 直接定义为接口类则可忽略此行配置,
                // 如 name 为字符串则需要配置 service 对应到接口类
                'service' => \App\JsonRpc\UserServiceInterface::class,
                // 直接对指定的节点进行消费,通过下面的 nodes 参数来配置必威手机app提供者的节点信息
                'nodes' => [
                    ['host' => '127.0.0.1', 'port' => 9600],
                ],
            ]
        ],
    ];
    

    现在我们做两件事,测试 consumer 走的是自动配置还是手动创建的 UserService

    1. 把 config/autoload/dependencies.php 内定义 UserServiceInterface 和 UserService 的关系屏蔽
    2. 在 App\JsonRpc\UserService::getUserInfo() 方法内打印点数据测试
    GET请求 http://127.0.0.1:9501/user/getUserInfo?id=2
    结果发现控制台并没有任何输出,走的是自动配置的 consumer
    

    反过来

    1. 我们再把 config/autoload/dependencies.php 内定义 UserServiceInterface 和 UserService 的关系放开
    2. 把 config/autoload/services.php 文件内 consumers 的配置项 service 屏蔽
    GET请求 http://127.0.0.1:9501/user/getUserInfo?id=2
    string(36) "App\JsonRpc\UserService::getUserInfo"
    发现控制台输出了我们在 App\JsonRpc\UserService::getUserInfo() 方法内打印的数据,
    走的是手动创建的 consumer
    

    在没有特殊情况下,后续 consumer 我们仅做配置,不在手动创建,因为没有创建的必要。


    8、配置优化

    我们注意到 config/autoload/services.php 文件内 consumers 的配置,一个必威手机app是一个配置,必威手机app消费者需要消费的必威手机app可能很多,所以我们很有必要优化下这里的写法,下面是参考官网的写法:

    // 必威手机app定义
    $consumerServices = [
        'UserService' => \App\JsonRpc\UserServiceInterface::class,
    ];
    return [
        'consumers' => value(function () use ($consumerServices) {
            $consumers = [];
            foreach ($consumerServices as $name => $interface) {
                $consumers[] = [
                    'name' => $name,
                    'service' => $interface,
                    'nodes' => [
                        ['host' => '127.0.0.1', 'port' => 9600],
                    ],
                ];
            }
            return $consumers;
        }),
    ];
    

    这样一来,我们每次只需要在数组 $consumerServices 内添加需要新的必威手机app即可。

    最后,我们来看一个比较大的问题。

    consumer 拿到的结果,又是字符串又是对象,还动不动直接 Internal Server Error. 数据格式的不统一非常不利于前端小伙伴解析。

    统一结果处理

    为了规范,我们制定了一个简单的标准,统一返回带有code,message,data的数据格式,有兴趣的小伙伴可以先研究下怎么解决这个问题,我们下一节继续。