laravel7使用JWT+Dingo构建API

前言

类似安装的教程很多，有很多大神已经写了很详尽的教程，可是在安装使用过程中难免会有一些差别和遇到一些问题，权当做个记录。

参考文章

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',//对应的provider
        ],
    ],

'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 协议》，转载必须注明作者和本文链接