Laravel Sanctum认证接口方案（laravel api 认证）

本方案适用前后端分离项目场景，认证方式采用laravel Sanctum，仅简单测试登录，可关注后续完整版，测试使用的技术，后端使用php laravel8.5框架，前端使用vue开源模板gitee：jishupu/vue-admin-jishupu。

一、后端配置

1.1、安装 Laravel

① 当前使用的phpstudy的php集成环境来运行项目

② 当然使用的laravel版本8.5，执行命令：

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

③ .env配置文件中配置数据库

④ 使用的phpstudy创建网站，自定义域名api.laravel8.com绑定项目根目录，通过http://api.laravel8.com/api访问项目接口

1.2、安装 Laravel Sanctum

执行命令：composer require laravel/sanctum

1.3、发布 Sanctum 的配置

执行命令：php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"

Sanctum 的配置文件将会保存在 config 文件夹中。

1.4、添加Sanctum 的中间件

在 app/Http/Kernel.php 文件中将 Sanctum 的中间件。

use Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful;
'api' => [
EnsureFrontendRequestsAreStateful::class,
'throttle:60,1',
\Illuminate\Routing\Middleware\SubstituteBindings::class,
],

1.5、执行数据库迁移文件，Sanctum 将创建一个数据库表personal_access_tokens用于存储 API 令牌

执行命令：php artisan migrate

说明：执行命令将创建官方表users、personal_access_tokens，首次迁移还会创建migrations、failed_jobs数据表

1.6、发行 API 令牌前模型配置

给用户发行令牌的时候，Users 模型里应该使用 HasApiTokens :

use Laravel\Sanctum\HasApiTokens;
class Users extends Authenticatable
{
use HasApiTokens, Notifiable;
}

1.7、登录接口

创建用户控制器：php artisan make:controller UserController

/**
* Display a listing of the resource.
*
* @return \Illuminate\Http\Response
*/
public function index()
{
return $this->success("请求成功，我是用户列表接口");
}

/**
* 登录
* @param Request $request
* @return \Illuminate\Http\JsonResponse
*/
public function login(Request $request)
{
$validator = Validator::make($request->all(), [
'username' => 'required',
'password' => 'required'
], [
'username.required' => '请输入用户名',
'password.required' => '请输入密码',
]);
if ($validator->fails()) {
return $this->error($validator->errors()->first());
}
$user = Users::where(['username' => $request->username, 'status' => 1])->select(['id', 'password', 'name', 'last_login_time'])->first();
if (!$user || !Hash::check($request->password, $user->password)) {
return $this->error("帐号或密码错误，请重新输入");
}
// 发行令牌
$token = $user->createToken('console-token')->plainTextToken;
$data = [
'user' => $user,
'token' => $token
];
return $this->success("登录成功", $data);
}

1.8、路由保护

修改routes/api.php：

// 登录
Route::post('user/login', [UserController::class, 'login'])->name("login");
// 登录后允许访问
Route::middleware('auth:sanctum')->group(function () {
Route::apiResource('user', 'UserController');
});

1.9、跨域配置

① .env文件：SANCTUM_STATEFUL_DOMAINS = 127.0.0.1

② config/cors.php配置

return [
'paths' => ['api/*', 'sanctum/csrf-cookie'],
'allowed_methods' => ['*'],
'allowed_origins' => ['*'],
'allowed_origins_patterns' => [],
'allowed_headers' => ['*'],
'exposed_headers' => [],
'max_age' => 0,
'supports_credentials' => true,
];

1.10、创建一个user管理员账号

① 为 User 模型创建一个 Seeder：

php artisan make:seeder UsersTableSeeder

② database/seeds/UsersTableSeeder.php 的 run()方法中代码：

DB::table('users')->insert([
'name' => '系统管理员',
'username' => 'admin',
'password' => Hash::make('admin@2021'),
]);

③ 生成账号：用户名admin，密码：admin@2021

php artisan db:seed --class=UsersTableSeeder

1.11、登录接口测试

使用postman测试登录接口是否通畅。

说明：从登录接口中获取token，在访问用户列表接口接口时，将令牌作为 Bearer 令牌传递到 Authorization 请求头中。

二、前端vue应用

当前用的使用vue开源模板gitee：jishupu/vue-admin-jishupu做登录接口测试，部署后访问地址：http://localhost:9527

2.1、配置接口地址

配置开发环境接口地址，配置后，重启服务。

修改.env.development配置文件中接口地址：

VUE_APP_BASE_API = 'http://api.laravel8.com/api'

2.2、登录接口测试

登录地址：http://localhost:9527/#/login?redirect=%2F

输入账号、密码，验证码默认，提示“登录成功”并在控制台上看到接口返回结果，则达到应用目的。

说明：前端报错是因登录接口字段与前端对象属性不统一以及权限还未应用导致的问题，这里仅简单测试登录接口。

官方参考资料：HTTP://learnku.com/docs/laravel/8.x/sanctum/9421

本文结束，感谢阅读。