README

PHP >= 7.4

引入: composer require luguohuakai/srun:~1.0.0

SRUN SDK(北向接口/单点登录) 和常用工具类封装

部分接口未实现的,或者需要扩展的,可以继承相应模块自行实现,也可以GitHub提交PR(欢迎PR)
未实现接口或这里调用方式不能满足需求的也可自行根据北向接口文档进行调用
日志: srun4k环境下默认位于: /srun3/log/srun/; 非srun4k环境: /var/log/srun/
如果要使用SDK请到srun4k 8080中配置北向接口权限
支持的接口随北向接口更新

当前支持的北向接口有(V1)

new User(); // 用户相关
new Alipay(); // 支付相关
new Auth(); // 鉴权相关
new Financial(); // 财务相关
new Group(); // 用户组相关
new Message(); // 消息相关
new Package(); // 套餐相关
new Product(); // 产品相关
new Setting(); // 设置相关
new Srun(); // 北向接口基类
new Strategy(); // 策略相关

支持北向接口V2

new SrunV2(); // 基础服务
new UserV2(); // 用户相关
new VisitorV2(); // 访客相关
new GroupV2(); // 用户组相关
new BillingStrategyV2(); // 计费策略相关
new FinancialV2(); // 财务相关
new OnlineStrategyV2(); // 用户上网策略相关
new DeviceV2(); // 上网设备相关
new OnlineV2(); // 在线相关
new OnlineDetailV2(); // 上网明细相关
new MessageV2(); // 通知公告相关
new ManagerV2(); // 管理员相关
new LogV2(); // 日志相关
new StatisticsV2(); // 统计类接口

使用方法

use func\src\Func;
use srun\src\Srun;
use srun\src\User;

// 基本用法 (使用默认地址: https://127.0.0.1:8001/)
$user = new User;
$user->view('srun');

// 手动配置接口地址
$user = new User('https://127.0.0.1:8001/')
$user->view('srun');

// 使用配置文件 配置文件参考 `vendor/luguohuakai/srun/config/srun.ini`
$ini = parse_ini_file('./srun.ini', true);
$user = new User(...$ini['north'])
$user->view('srun');

// 也可以先在自己项目中先初始化再调用
function initUser(): User
{
    $ini = parse_ini_file('./srun.ini');
    return new User($ini['srun_north_api_url']);
}
initUser()->view('srun');

// 手动配置缓存redis 老版本 < 1.0.8
$user = new User;
$user->setRdsConfig(['port' => 6380, 'host' => '127.0.0.1', 'pass' => 'xxx']);
$user->view('srun');

// 根据文档自行调用北向接口方式
$srun = new Srun;
$srun->req('path/to/api/addr', ['param1' => 'xxx', 'param2' => 'xxx'], 'post');

缓存类使用方法

新版缓存逻辑: srun4k环境: 自动设置为redis缓存(16382); 非srun4k环境: 自动设置为文件缓存

/**
 * 目前支持 文件缓存 redis缓存
 * @param int $type 可选 0:自动设置 1:文件缓存Cache::CACHE_FILE, 2:redis缓存Cache::CACHE_REDIS
 * @param string $cache_file 可选 自定义文件缓存位置
 * @param array $rds_config 可选 自定义redis缓存配置 如: ['index' => 0,'port' => 6379,'host' => '127.0.0.1','pass' => null]
 */
use srun\src\Cache;

$cache = new Cache;
$cache->set($key, $value);
$cache->get($key);

luguohuakai / srun

Maintainers

Details

README

当前支持的北向接口有(V1)

支持北向接口V2

使用方法

缓存类使用方法