Laravel5.6經過路由進行API版本控制的簡單方法

Laravel版本:5.6

API隨着迭代,新版本每每須要繼承老版本的功能,並對原有的功能修改和擴展,這時爲了兼容各個版本的接口,就須要進行版本控制。php

請求版本區分:

在請求的header中附帶版本信息,如app-version:1.0.1
laravel這邊的獲取方法:laravel

Request::header('app-version');

文件路徑:app

1.0.1版本的UserController,文件路徑就是
app/Http/Controllers/Api/v1d0d1/UserController.phppost

1.0.2版本,就是
app/Http/Controllers/Api/v1d0d2/UserController.php版本控制

注意1.0.2版本若是須要使用1.0.1原有的功能,須要繼承原有的類code

use App\Http\Controllers\Api\UserController as UserCtrl;
class UserController extends UserCtrl
{
    ...
}

版本控制

版本解析方法:
function getRouteContoller($controllerName)
{
    $base_path = 'App\Http\Controllers\Api\\';
    //無版本
    $app_version = Request::header('app-version');
    if (!$app_version) return $controllerName;
    //當前版本
    $version_path = 'v' . str_replace('.', 'd', $app_version) . '\\';
    $controllerPath = $base_path . $version_path . $controllerName;
    if (class_exists($controllerPath)) {
        return $version_path . $controllerName;
    }
    //往期版本
    $versionNumbers = intval(str_replace('.', '', $app_version));
    for ($i = $versionNumbers - 1; $i > 0; $i--) {
        $version_path = 'v' . implode('d', str_split($i)) . '\\';
        $controllerPath = $base_path . $version_path . $controllerName;
        if (class_exists($controllerPath)) {
            return $version_path . $controllerName;
        }
    }
    return $controllerName;
}

注:該方法會將1.0.2版本解析爲v1d0d2,並判斷對應類是否存在,若是存在則直接返回類的路徑;不存在則向下尋找1.0.1版本類是否存在,直到找到存在的類返回。繼承

路由文件
Route::post('login', getRouteContoller('UserController').'login');
相關文章
相關標籤/搜索