laravel7使用JWT+Dingo構建API

她來聽我的演唱會發表於2020-08-04
LaravelJWTGoAPI

前言

類似安裝的教程很多，有很多大神已經寫了很詳盡的教程，可是在安裝使用過程中難免會有一些差別和遇到一些問題，權當做個記錄。

參考文章

JWT 完整使用詳解
dingo api 中文文件
Laravel5.5+dingo+JWT 開發後臺 API
Laravel 7 中文文件——Facades
執行 composer update,提示 Allowed memory size of bytes exhausted

安裝JWT

按照官網步驟執行：

composer require tymon/jwt-auth

在這裡可能會報錯：

Fatal error: Allowed memory size of 1610612736 bytes exhausted (tried to allocate 4096 bytes) in phar://C:/ProgramData/ComposerSetup/bin/composer.phar/src/Composer/DependencyResolver/Solver.php on line 223

Check https://getcomposer.org/doc/articles/troubleshooting.md#memory-limit-errors for more info on how to handle out of memory errors.

原因分析：

這個意味著PHP指令碼使用了過多的記憶體，並超出了系統對其設定的允許最大記憶體。解決這個問題，首先需要檢視你的程式是否分配了過多的記憶體，在程式沒有問題的情況下，你可以通過一下方法來增加PHP的記憶體限制（memory_limit）。

嘗試解決：

首先本地的PHP環境用的是wamp，本地的php版本與homestead的不一致，因此按照這篇文章的處理方式，分別執行：
php -r "echo ini_get('memory_limit').PHP_EOL;"
分別得到homestaed和本地的memory_limit為：-1和128M，為了排除這個干擾，把不是-1的改為-1（-1的意思為不限制，本地開發環境可以進行更改，線上執行環境請慎重）：

memory_limit = -1

注意：如果你使用了整合開發環境，例如本地的wamp，會有兩個php.ini，一個是版本內的php.ini（例如：D:\wamp64\bin\php\php7.3.12\php.ini）。一個是整合軟體的php.ini（例如：D:\wamp64\bin\apache\apache2.4.41\bin\php.ini，快捷方式）指向的是phpForApache.ini這個檔案。因此需要兩個地方都把128M改為-1。然後重啟wamp服務，重新執行：

composer require tymon/jwt-auth

jwt安裝成功：

Package manifest generated successfully.
49 packages you are using are looking for funding.
Use the `composer fund` command to find out more!

釋出配置

執行：

php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"

執行此命令會在app/config下生成jwt.php的配置檔案。
在此請注意一個地方,在jwt.php中有個配置項：

'ttl' => env('JWT_TTL', 60),

這裡代表的意思是token過期的時間，預設為一小時。一般情況下不建議進行更改，因為token的時間越長，危險係數就越高。如果是測試的話，可以根據實際情況進行更改。一個小時的時間明顯是無法滿足實際使用需求，尤其是給微信端做api介面。因此，不更改過期時間，需要做token重新整理。

生成金鑰

執行：

php artisan jwt:secret

提示：

jwt-auth secret [CHZqhRMbuoUjkQ4iiZIhazbcRLmIsqL5QmYxeIGpWaMuJoaf7ip0v1uteuqiUAbW] set successfully.

並且可以在.env檔案中看到生成了一個配置項：

JWT_SECRET=CHZqhRMbuoUjkQ4iiZIhazbcRLmIsqL5QmYxeIGpWaMuJoaf7ip0v1uteuqiUAbW

更新模型

<?php

namespace App\Models;

use Tymon\JWTAuth\Contracts\JWTSubject;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable implements JWTSubject
{
    use Notifiable;

    // Rest omitted for brevity

    /**
     * Get the identifier that will be stored in the subject claim of the JWT.
     *
     * @return mixed
     */
     protected $fillable = [
        'name', 'email', 'password'
    ];
    public function getJWTIdentifier()
    {
        return $this->getKey();
    }

    /**
     * Return a key value array, containing any custom claims to be added to the JWT.
     *
     * @return array
     */
    public function getJWTCustomClaims()
    {
        return [];
    }
}

注意：預設的模型為app/User.php，如果User模型位於其他地方，需要在app/config/auth.php中進行修改：

修改/配置auth.php

'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
        'api' => [
            'driver' => 'jwt', //把token改為jwt
            'provider' => 'users',//對應使用者認證表
        ],
    ],
'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\User::class,//指定模型
            'table' => 'users',//資料表
        ],
    ],

安裝Dingo

執行：

composer require dingo/api

安裝成功後執行：

php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"

執行成功後生成一個位於app/config下的配置檔案api.php。
配置.env檔案：

#dingo api設定
API_STANDARDS_TREE=prs
API_PREFIX=api
API_VERSION=v1
API_DEBUG=true
API_SUBTYPE=myapp

具體配置引數可以參考中文文件

實戰階段

在HTTP下分別新建兩個資料夾V1和Wap，分別對應路由app/routes/api.php和app/routes/web.php，這樣做的好處是能區分介面和前端的一些路由，如果後續有新版本介面更新，可以不受之前的介面影響。
執行：

php artisan make:controller V1/AuthController

生成控制器AuthController：

<?php

namespace App\Http\Controllers\V1;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Validator;
use App\Model\User;

class AuthController extends Controller
{

    protected $guard = 'api';//如果不設定成員變數熟悉，使用的時候請使用助手函式，例如：$token = auth('api')->tokenById($uid);

    /**
     * Create a new AuthController instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('refresh', ['except' => ['login','register']]);
    }

    public function register(Request $request)
    {

        $rules = [
            'name' => ['required'],
            'email' => ['required'],
            'password' => ['required', 'min:6', 'max:16'],
        ];

        $payload = $request->only('name', 'email', 'password');
        $validator = Validator::make($payload, $rules);

        // 驗證格式
        if ($validator->fails()) {
            return $this->response->array(['error' => $validator->errors()]);
        }

        // 建立使用者
        $result = User::create([
            'name' => $payload['name'],
            'email' => $payload['email'],
            'password' => bcrypt($payload['password']),
        ]);

        if ($result) {
            return $this->response->array(['success' => '建立使用者成功']);
        } else {
            return $this->response->array(['error' => '建立使用者失敗']);
        }

    }

    /**
     * Get a JWT token via given credentials.
     *
     * @param  \Illuminate\Http\Request  $request
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function login(Request $request)
    {
        $credentials = $request->only('email', 'password');

        if ($token = $this->guard()->attempt($credentials)) {
            return $this->respondWithToken($token);
        }

        return $this->response->errorUnauthorized('登入失敗');
    }

    /**
     * Get the authenticated User
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function me()
    {
        //return response()->json($this->guard()->user());
        return $this->response->array($this->guard()->user());
    }

    /**
     * Log the user out (Invalidate the token)
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function logout()
    {
        $this->guard()->logout();

        //return response()->json(['message' => 'Successfully logged out']);
        return $this->response->array(['message' => '退出成功']);
    }

    /**
     * Refresh a token.
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function refresh()
    {
        return $this->respondWithToken($this->guard()->refresh());
    }

    /**
     * Get the token array structure.
     *
     * @param  string $token
     *
     * @return \Illuminate\Http\JsonResponse
     */
    protected function respondWithToken($token)
    {
        return response()->json([
            'access_token' => $token,
            'token_type' => 'bearer',
            'expires_in' => $this->guard()->factory()->getTTL() * 60
        ]);
    }

    /**
     * Get the guard to be used during authentication.
     *
     * @return \Illuminate\Contracts\Auth\Guard
     */
    public function guard()
    {
        return Auth::guard($this->guard);
    }
}

上述是用賬號密碼註冊並且生成token的例子，適合做管理系統或者其他進行登入，如果是API的token的話，可以嘗試另一種，使用使用者的id生成token。當用token請求介面時，可以通過token獲取使用者資訊，方便圍繞使用者資訊進行操作：

//例如微信端登入，獲取了openid後存入資料庫有了使用者資訊，可以用使用者id生成token
$token = auth('api')->tokenById($id);
//校驗token，通過token獲取使用者資訊
$userInfo = auth('api')->user();

設定路由

$api = app('Dingo\Api\Routing\Router');
$api->version('v1', ['namespace' => 'App\Http\Controllers\V1'], function ($api) {
    $api->post('register', 'AuthController@register');
    $api->post('login', 'AuthController@login');
    $api->post('logout', 'AuthController@logout');
    $api->post('refresh', 'AuthController@refresh');
    $api->post('me', 'AuthController@me');
    $api->get('test', 'AuthController@test');
});

至於後續測試以及擴充套件，可以參考開篇的幾篇參考文章。後續有新的擴充套件，再更新！

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章