topphp/topphp-client

客户端管理组件

v1.0.6 2020-09-24 08:17 UTC

Requires

• php: ~7.2
• ext-json: *
• ext-mbstring: *
• ext-redis: *
• guzzlehttp/guzzle: ^6.3
• predis/predis: ^1.1

Requires (Dev)

• phpunit/phpunit: ^8.0.0
• squizlabs/php_codesniffer: ^3.5

MIT

• topphp

README

这是一个客户端管理工具，包含Http请求客户端Guzzle，Redis客户端，Socket客户端等

包含方法

• Http客户端请求 GET POST PUT PATCH DELETE
• Redis客户端 普通set get存取，list存取，哈希存取等

组件结构

config/     
src/     
tests/
vendor/

安装

    composer require topphp/topphp-client

用法

    全客户端命名空间引用：
        use Topphp\TopphpClient\Client;
    Redis客户端助手类命名空间引用：
        use Topphp\TopphpClient\redis\RedisHelper;
    Http客户端助手类命名空间引用：
        use Topphp\TopphpClient\guzzle\HttpHelper;
    调用方式有两种：
        1、通过原始客户端单例调用指定的客户端
            Client::getInstance()->cli("redis")->set("arr", ["这是一个数组"], 90);
        2、通过助手类直接调用【推荐】
            RedisHelper::set("arr", ["这是一个数组"], 90);
            HttpHelper::get("https://www.baidu.com");
            $data = [
                "field"=>"val"  
            ];
            // $type 类型：在header头为空的情况下，自动根据类型填充header头信息，包含（json，body，form_params，multipart，xml）
            HttpHelper::post(string $url, array $data, string $type = 'json', array $headers = [])
    注意事项：
        1、写好对应的配置后，在骨架即可直接调用，无需传入配置，需要动态切换配置时，只需要通过骨架的config()方法动态修改即可。
        2、还提供一种直接传入配置的方式
            Client::getInstance($config)->cli("http")->get("https://www.baidu.com");
        3、组价同时也提供直接暴露客户端对象句柄的方式直接调用原生客户端对象，完成更多高级操作
            Client::getInstance()->cli("redis")->handler()->publish( $channel, $message );
            RedisHelper::handler()->publish( $channel, $message );
        4、关于获取配置优先级顺序
            A.Client::getInstance($config)// 优先获取手动传入的配置（助手类不适用）
            B.非手动传入配置的（配置不传，传空或者使用助手类），优先根据指定客户端获取独立配置文件topphpClientHttp、topphpClientRedis、topphpClientSocket中的配置
            C.没有配置独立配置文件的Redis客户端会自动获取Cache配置中的redis配置
            D.都没有的，会提示配置错误
        5、独立配置文件示例：
            Http：暂无需配置，保持默认即可，swoole环境自动提供协程的http客户端
            Socket：敬请期待...
            Redis：swoole环境已内部集成协程化的Redis客户端
            
                return [
                    // 客户端连接方式配置
                    'Redis' => [
                        // 支持多库配置（默认选择default,可以通过修改默认的connect来动态切换redis配置）
                        'default_connect' => 'default',
                        'default'         => [
                            // 连接地址
                            'host'         => '127.0.0.1',
                            // 连接密码
                            'auth'         => '',
                            // 端口
                            'port'         => 6379,
                            // 选择库
                            'db'           => 0,
                        ]
                    ]
                ];
                
        6、默认的助手类已经提供了大部分常用场景所需的方法，更多用法可以参看单元测试文件和对应的官方文档

修改日志

有关最近更改的内容的详细信息，请参阅更改日志（CHANGELOG）。

测试

    ./vendor/bin/phpunit tests/ClientTest.php

贡献

详情请参阅贡献（CONTRIBUTING）和行为准则（CODE_OF_CONDUCT）。

安全

如果您发现任何与安全相关的问题，请发送电子邮件至[e-mail]，而不要使用问题跟踪器。

信用

• topphp
• All Contributors

许可证

The MIT License (MIT). Please see License File for more information.