0

0

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

藏色散人

藏色散人

发布时间:2020-09-09 09:14:33

|

5982人浏览过

|

来源于learnku

转载

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

推荐:《PHP视频教程

在对接第三方接口的时候,总是会看到接口后缀会带着v1,v2这样的标识,我们知道这些都是接口版本的概念,那么如果我方需要提供对外的接口,或者对接web端和app端的时候,希望公用同一个接口,但是接口所渲染的数据表现形式不太一致,以及接口授权也不太一致的情况下,如何做到使用不同版本,且不同版本直接互不影响且同时共存呢?

首先笔者在考虑到接口设计时,有几大模块:

  • 控制器层(controller):笔者将其定义为入口层(相当于java的dao层)

  • 服务层(services):逻辑服务层,控制器入口层通过版本号标识转接到不同的服务层,具体的代码逻辑实现都在此处编写

  • 行为层(behavior):也可理解为事件层,服务中间件,行为钩子都将在此处控制,入口权限过滤校验,对接第三方服务扩展通过行为钩子抽出,不让其加大服务层的代码臃肿

    立即学习PHP免费学习笔记(深入)”;

  • 模型层(model):该层根据实际业务和开发习惯而定,可要可不要

  • 校验层(validate):笔者认为很有必要,所有独立拉出一个目录来做相关校验,不管是独立校验,校验引擎,还是框架自带校验都在该目录定义,方便维护和扩展

  • 公共层(common):系统公共代码,比如附件上传,下载等

  • 配置层(config):内部配置,根据需求自定义是否需要

    rpcms轻量开源内容管理系统3.3.3
    rpcms轻量开源内容管理系统3.3.3

    RPCMS是一款基于PHP+MYSQL的轻量型内容管理/博客系统,支持PHP5.6版本以上,支持win/Linux系统。它自主研发的RP框架(OPP方式),采用MVC架构搭建的高效、稳定的内容管理系统。灵活小巧,但有着强大的扩展性、丰富的插件接口和大量的模板。统一采用模板标签,轻松上手,让开发更方便!智能缓存机制让网站运行方面大幅度提高。系统特点:源码简洁、体积轻巧、功能丰富、安全、灵活等特点,完

    下载
  • 语言包(lang):根据需求而定

  • 复用层(tarits):根据实际需求而定

  • 任务层(job):根据实际需求而定

目录层级如图所示:

那么在入口层如何转接到服务层呢?因为在这过程我们会将接口中的版本号转接到不同的版本服务层。
首先在控制器入口层写一个基类控制器,后续所有的控制器都将会继承该类,在构造函数中调取行为类中的解析服务层代码,将服务层类初始化给基类变量!

    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('.', $controller);
        $controllerLength = count($controllerArray);
        $appendControllerName = '';
        if ($controllerLength == 1) {
            $appendControllerName = $controllerArray[0];
        } else {
            for ($i = 0; $i < $controllerLength - 1; $i++) {
                $appendControllerName .= strtolower($controllerArray[$i]) . '\\';
            }
            $appendControllerName .= ucfirst($controllerArray[($controllerLength - 1)]);
        }

        // $controller =  '\\app\\saas\\controller\\' . request()->controller();
        $controller =  '\\app\\saas\\controller\\' . $appendControllerName;
        $verion = request()->param('version');
        $init_service = function () use ($controller, $verion, $params) {
            // dump($controller);
            // $controller = '\app\saas\controller\test\Test';
            $reflection = new \ReflectionClass($controller);

            if (property_exists($controller, 'versions')
                && isset($reflection->getStaticProperties()['versions'][$verion])
            ) {
                // 默认规则返回,在前在后不允许返回其他信息
                $service = $reflection->getStaticProperties()['versions'][$verion];
                // 判断控制器服务文件是否存在
                return class_exists($service) ? new $service($params['tag'], $params['request']) : 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 = [
        'v1' => \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),欢迎研究自研!

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

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

832

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

737

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

733

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16925

2023.08.03

php与html混编教程大全
php与html混编教程大全

本专题整合了php和html混编相关教程,阅读专题下面的文章了解更多详细内容。

12

2026.01.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号