maxsihong/wd-service

微店服务商扩展

v1.0.1 2023-05-22 03:37 UTC

This package is auto-updated.

Last update: 2024-11-04 09:04:14 UTC


README

📦 微店服务商扩展是一个基于PHP的扩展,用于在微店平台上开发服务商应用。

GitHub code size in bytes Latest Stable Version Latest Unstable Version Total Downloads License

Security Status

📑 目录

🚧 进度

目前只打算把订单、商品模块整体封装,剩余模块后续看情况添加吧。如果需要其他模块使用可以自行 Fork 并提交合并,或者联系我协助添加。

  • 项目搭建、容器封装、基础接口封装
  • 【订单管理】接口封装
  • 【商品管理】接口封装 (57%)

⚠ 注意事项

项目如需接收微店的消息推送,则需要添加个每天执行的定时任务,主动刷新用户的 access_token。 因为微店要求如果 access_token无效的话,则不会主动推送消息通知。 定时任务:Maxsihong\WdService\Commands\WdRefreshAccessToken

🏃 环境需求

  • PHP >= 7.3.0

🚀 安装

composer require maxsihong/wd-service

🙂 使用示例

实例化:

// 配置
$config = [
    'app_id' => '1xxxxxx', // 服务商appid
    'app_secret' => 'axxxxxx', // 服务商secret
    'domain' => 'https://api.vdian.com/api', // 微店api地址
    'redirect_uri' => 'https://xxx.com/callback', // 注意 xxx.com 为你服务商授权的推送域名,微店有白名单限制;后面的 callback 可自定义,改地址是回调接收微店返回的code和state,后续进行调用获取token操作
    // redis
    'cache' => [
        "host" => "127.0.0.1",
        "port" => 6379,
        "database" => 0, // 选择redis库,0~15 共16个库
        "password" => "", // 密码
        'prefix' => 'wdcache_', // 前缀
    ],
];
// 相关用户和店铺(可不传),但后面记得需要初始化这两个值
$init_param = ['uid' => 1, 'openid' => '1xxxx'];

$app = new \Maxsihong\WdService\Entrance($config, $init_param);

/**
 * 注意 后面的参数可不传是不影响创建容器的,默认是uid-0;但后面记得需要初始化这两个值(`reSetUidAndOpenidAndCacheKey`),因为缓存都是基于这两个值存储的
 * 可以理解为uid是用户,而openid则是店铺,一个用户有多个店铺,这样的关系;
 * 所以后续存储缓存,包括access_token都是基于uid和openid为base_key做缓存的
 */

使用

// 加密数据
$str = $app::wdCommon()->encrypt('123456789');

🙂 Laravel 使用示例

注册服务

// 在 `App\Providers\AppServiceProvider` 类
public function register()
{
    // 注册 微店 服务容器
    $this->app->bind("onlineretailers.wd", function ($app, $init_param) {
        /**
        * 初始化用户uid,这个判断可根据自己业务来判断是否需要
        * 不加的话则直接初始化即可:$init_param['uid'] = $init_param['uid'] ?? 0;
         */
        if (empty($init_param) || !isset($init_param['uid'])) {
            throw new \Maxsihong\WdService\Kernel\Exception\ApiException('必须要初始化用户uid');
        }

        $init_param['openid'] = $init_param['openid'] ?? '';

        // $config 可放如config内,使用config('xx')获取
        return new \Maxsihong\WdService\Entrance($config, $init_param);
    });
}

使用

// 获取容器
// 想要idea更好的提示,可增加下面 @var 的注释
/** @var \Maxsihong\WdService\Entrance $app */
$app = app('onlineretailers.wd', ['uid' => 1, 'openid' => '1xxxx']);
// 加密数据
$str = $app::wdCommon()->encrypt('123456789');

📝 相关文档

🤝 License

MIT