当前位置:  首页  >  PHP教程  >  PHP 基础  >  基础教程

论PHP接口版本控制【兼容多端接口】

在对接第三方接口的时候,总是会看到接口后缀会带着v1,v2这样的标识,我们知道这些都是接口版本的概念,那么如果我方需要提供对外的接口,或者对接web端和APP端的时候,希望公用同一个接口,但是接口所渲染的数据表现形式不太一致...

首先在控制器入口层写一个基类控制器,后续所有的控制器都将会继承该类,在构造函数中调取行为类中的解析服务层代码,将服务层类初始化给基类变量!

 public $service = null; /** * 构造函数处理头部请求 * * @return void */ public function __construct($type = 0, Request $request) { // 登录跳过 if (!$type) { // 注册行为监听 Hook::add('app_init', [ // 校验请求接口的身份(身份验证) 'app\\saas\\behavior\\AuthToken' ]); Hook::listen('app_init', []); } // 立即执行初始化控制器服务应用 $this->service = Hook::exec('app\\saas\\behavior\\InitializtionService', ['tag' => $type, 'request' => $request]); }

服务InitializtionService解析路由,判断,将服务层实例化

 public function run($params) { // 兼容控制器分层,优化控制器目录结构 $cOntroller= request()->controller(); $cOntrollerArray= explode(&#39;.&#39;, $controller); $cOntrollerLength= count($controllerArray); $appendCOntrollerName= &#39;&#39;; if ($cOntrollerLength== 1) { $appendCOntrollerName= $controllerArray[0]; } else { for ($i = 0; $i <$controllerLength - 1; $i++) { $appendControllerName .= strtolower($controllerArray[$i]) . &#39;\\&#39;; } $appendControllerName .= ucfirst($controllerArray[($controllerLength - 1)]); } // $cOntroller= &#39;\\app\\saas\\controller\\&#39; . request()->controller(); $cOntroller= &#39;\\app\\saas\\controller\\&#39; . $appendControllerName; $verion = request()->param(&#39;version&#39;); $init_service = function () use ($controller, $verion, $params) { // dump($controller); // $cOntroller= &#39;\app\saas\controller\test\Test&#39;; $reflection = new \ReflectionClass($controller); if (property_exists($controller, &#39;versions&#39;) && isset($reflection->getStaticProperties()[&#39;versions&#39;][$verion]) ) { // 默认规则返回,在前在后不允许返回其他信息 $service = $reflection->getStaticProperties()[&#39;versions&#39;][$verion]; // 判断控制器服务文件是否存在 return class_exists($service) ? new $service($params[&#39;tag&#39;], $params[&#39;request&#39;]) : Merror::getInstance()->jsonApi(40006); } else { Merror::getInstance()->jsonApi(40001); } }; return is_null($verion) ? Merror::getInstance()->jsonApi(40002) : $init_service(); }

这样在控制器中文件定义如下调用服务层逻辑代码,而不用关心是属于哪个服务层类,服务层代码只和版本有关

 class Sysorder extends Saas { /** * 版本服务调度属性--必须默认一个且是v1 * * @var array */ protected static $versiOns= [ &#39;v1&#39; => \app\saas\services\syscenter\Sysorder::class, ]; /** * 获取信息集权限目录 * * @method POST|GET * @name getSubMenuListCate */ public function getSubMenuListCate() { return json($this->service->getSubMenuListCate()); } /** * 获取列表 * * @method POST|GET * @name getSysOrderList */ public function getSysOrderList() { return json($this->service->getSysOrderList()); }

结语:此设计抛砖引玉,具体实现看各位phper大显神通了!
api多版本接口设计模式,可以参考(基于ThinkPhp5.1实现,框架不同,设计理念一致):www.kancloud.cn/lijianlin/ethantp5...
最后推广一下笔者自研的一套基于laravel设计的工作流流程引擎(https://learnku.com/laravel/t/48967),欢迎研究自研!

注:我这个设计主要是为了多版本接口开发的一种设计而已,每个人都有自己的开发习惯,不予强制,只是以便代码的维护和阅读!仅此建议而已

以上就是论PHP接口版本控制【兼容多端接口】的详细内容,更多请关注 第一PHP社区 其它相关文章!

内容推荐:免费高清PNG素材下载
吐了个 "CAO" !
扫码关注 PHP1 官方微信号
PHP1.CN | 中国最专业的PHP中文社区 | PNG素材下载 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved PHP1.CN 第一PHP社区 版权所有 京ICP备19059560号-4