laravel 5.4 + dingo api + jwt 代替 Passport

weixin_34138377發表於2018-03-20
LaravelGoAPIJWTPassport

前言

由於在度娘找了半天根本一大堆Copy版本，弄得我死去活來的，每個都試了一堆問題，到底你們做完有沒有總結過一次？然後有幾個使用lunmen+dingo api+jwt，完全不行啊，太監版不是我想要的。
後來Google，終於找到例子並實測成功。直接來了

新裝一個LV

composer create-project --prefer-dist laravel/laravel myApiProject

安裝dingo api

在composer.json中新增

composer require dingo/api:1.0.x@dev

在config/app.php

 'providers' => [
     //前面很多
    Dingo\Api\Provider\LaravelServiceProvider::class,
]

釋出配置檔案
終端執行

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

開啟.env檔案，把dingo的配置放到最後面

API_STANDARDS_TREE=vnd // 環境
API_SUBTYPE=myapp // 子型別
API_PREFIX=api // 字首
API_DOMAIN=api.myapp.com //子域名  （字首和子域名只能存在一個）可選
API_VERSION=v1 // 版本
API_NAME=My API // 名字（使用API Blueprint命令才會用到）
API_CONDITIONAL_REQUEST=false // 帶條件的請求
API_STRICT=false // Strict模式
API_DEFAULT_FORMAT=json // 響應格式
API_DEBUG=true // 除錯模式

下面是我的配置：

API_STANDARDS_TREE=vnd
API_SUBTYPE=emall
API_PREFIX=api
API_VERSION=v1

沒必要每個都配上去，主要的配一下就可以了

安裝jwt

還是composer.json

"require-dev": {
    "tymon/jwt-auth": "1.0.*"
},
"minimum-stability": "dev",
"prefer-stable": true

其實只需要加上，下面是我的寫法，上面是國外的寫法

   "tymon/jwt-auth": "1.0.*@dev"

執行composer update將dingo和jwt裝上去

新增jwt的認證
在config/api.php新增內容

'auth' => [
    'jwt' => Dingo\Api\Auth\Provider\JWT::class
]

在config/app.php

'providers' => [
    // 前面很多
    Tymon\JWTAuth\Providers\LaravelServiceProvider::class
],

'aliases' => [
    // 前面很多
    'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class
]

在終端執行：

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

會生成config/jwt.php 這是jwt的配置檔案

生成jwt的key到.env檔案執行：

php artisan jwt:secret

路由

在routers/api.php
中新建內容，兩個路徑分別是註冊和登入：

//這句接管路由
$api = app('Dingo\Api\Routing\Router');

$api->version('v1', function ($api) {

 $api->post('login', 'App\Http\Controllers\Api\Auth\LoginController@login');
 $api->post('register', 'App\Http\Controllers\Api\Auth\RegisterController@register');

});

生成兩個controller
終端輸入：

php artisan make:controller App\\Http\\Api\\Auth\\LoginController
php artisan make:controller App\\Http\\Api\\Auth\\RegisterController

資料庫

備置.env檔案

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=databasename
DB_USERNAME=root
DB_PASSWORD=

新增遷移檔案，當然你也可以使用php artisan make:auth 安裝LV自帶的使用者
下面我們用新建的吧
終端執行：

php artisan make:model User -m

此命令可以新增遷移檔案同時新增Model
遷移檔案一般在database/migrations/時間格式_create_users_table.php
開啟遷移檔案修改以下內容:

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->increments('id');
        $table->string('name')->unique();
        $table->string('email')->unique();
        $table->string('password');
        $table->rememberToken();
        $table->timestamps();
    });
}

終端執行：php artisan migrate建立users表

開啟我們新建的Model在App/下User.php
新增如下內容：

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

class User extends Authenticatable implements JWTSubject
{
    use Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'email', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];

    /**
     * Get the identifier that will be stored in the subject claim of the JWT.
     *
     * @return mixed
     */
    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/Http/Controller/Api/Auth/RegisterController.php
新增如下內容：

use App\Http\Controllers\Controller;
use App\User;
use Dingo\Api\Exception\StoreResourceFailedException;
use Dingo\Api\Routing\Helpers;
use Illuminate\Foundation\Auth\RegistersUsers;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;
use Tymon\JWTAuth\Facades\JWTAuth;

class RegisterController extends Controller
{
    use RegistersUsers;
    use Helpers;

    public function register(Request $request){

        $validator = $this->validator($request->all());
        if($validator->fails()){
            throw new StoreResourceFailedException("Validation Error", $validator->errors());
        }

        $user = $this->create($request->all());

        if($user->save()){

            $token = JWTAuth::fromUser($user);

            return $this->response->array([
                "token" => $token,
                "message" => "User created",
                "status_code" => 201
            ]);
        }else{
            return $this->response->error("User Not Found...", 404);
        }
    }

    protected function validator(array $data)
    {
        return Validator::make($data, [
            'name' => 'required|unique:users',
            'email' => 'required|email|max:255|unique:users',
            'password' => 'required|min:6',
        ]);
    }

    protected function create(array $data)
    {
        return User::create([
            'name' => $data['name'],
            'email' => $data['email'],
            'password' => bcrypt($data['password']),
        ]);
    }

}

開啟Postman進行測試地址：http://127.0.0.1/myApiProject...

[圖片上傳失敗...(image-e47af2-1521530944954)]

登入

在之前建的App/Http/Controller/Api/Auth/LoginController.php

use App\User;
use Dingo\Api\Routing\Helpers;
use Illuminate\Foundation\Auth\AuthenticatesUsers;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Hash;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
use Tymon\JWTAuth\Facades\JWTAuth;

class LoginController extends Controller
{
    use AuthenticatesUsers;
    use Helpers;

    public function login(Request $request){

        $user = User::where('email', $request->email)->orWhere('name', $request->email)->first();

        if($user && Hash::check($request->get('password'), $user->password)){
            $token = JWTAuth::fromUser($user);
            return $this->sendLoginResponse($request, $token);
        }

        return $this->sendFailedLoginResponse($request);
    }

    public function sendLoginResponse(Request $request, $token){
        $this->clearLoginAttempts($request);

        return $this->authenticated($token);
    }

    public function authenticated($token){
        return $this->response->array([
            'token' => $token,
            'status_code' => 200,
            'message' => 'User Authenticated'
        ]);
    }

    public function sendFailedLoginResponse(){
        throw new UnauthorizedHttpException("Bad Credentials");
    }

    public function logout(){
        $this->guard()->logout();
    }
 }

開啟Postman進行測試地址：http://127.0.0.1/myApiProject...

[圖片上傳失敗...(image-ad9ae9-1521530944954)]

可以看到我們得到了token

拉取使用者資訊

在routers/api.php新增

$api->group(['middleware' => 'api.auth'], function ($api) {
    $api->get('user', 'App\Http\Controllers\Api\UsersController@index');
});

終端執行：

php artisan make:controller App\\Http\\Controllers\\Api\\UsersController

在UsersController.php中新增

namespace App\Http\Controllers\Api;

use Dingo\Api\Routing\Helpers;
use Illuminate\Routing\Controller;

class UsersController extends Controller
{
    use Helpers;

    public function __construct()
    {
        $this->middleware('api.auth');
    }
    public function index(){
//        return User::all();
        $user = $this->auth->user();

        return $user;
    }
}

開啟Postman進行測試地址：http://127.0.0.1/myApiProject...
注意因為我們設定了需要token才能拉取資料，所以在請求頭Header中
我們新增了：Authorization ：Bearer + token
Bearer是一種token_type在原始碼中有提到，應該是一種標準
[圖片上傳失敗...(image-6775dd-1521530944954)]

總結

這裡只提到了註冊登入，但沒有管理Token。

原文連結

相關文章