Laravel Passport 安装与使用指南

Laravel Passport 安装与使用指南

passportLaravel Passport provides OAuth2 server support to Laravel.项目地址:https://gitcode.com/gh_mirrors/pas/passport

Laravel Passport 是 Laravel 框架提供的一个 OAuth2 全面解决方案，它使你可以轻松地为你的应用程序添加 API 身份验证。本文将深入介绍其核心结构、启动机制以及关键配置文件，帮助开发者快速上手。

1. 项目目录结构及介绍

Laravel Passport 的结构紧密集成于 Laravel 应用内部，以下是一些关键目录及其功能简介：

- config/
    ├── passport.php           # Passport 配置文件，定制 Passport 行为。
- database/
    └── migrations/            # 包含用于创建 Passport 相关数据库表的迁移文件。
- routes/
    └── api.php                # 通常在此定义受 Passport 保护的 API 路由（可选）。
- vendor/
    └── laravel/
        └── passport/          # Passport 的核心代码库，包括服务提供者、契约接口、控制器等。
        │   ├──src/              
        │       ├── Auth         # 认证相关类，如令牌认证。
        │       ├── Contracts     # 契约接口定义。
        │       ├──闸道          # Gateways 类，处理客户端令牌逻辑。
        │       └──...           # 其他各种组件和服务。
    └── ...

2. 项目的启动文件介绍

在 Laravel 中，不需要直接操作特定的“启动文件”来激活 Passport。安装和配置是通过 Composer 加载依赖并执行命令行完成的。重要步骤包括：

• 安装：通过 Composer 添加 Passport 依赖。

  composer require laravel/passport
  

• 发布配置与迁移：接下来，运行以下命令来发布 Passport 的配置文件和执行必要的数据库迁移。

  php artisan passport:install
  

  这个命令会创建加密密钥，同时在数据库中添加所需的表。

Laravel 的自动加载机制保证了 Passport 组件在需要时被正确初始化。配置文件 config/passport.php 是启动过程中最关键的手动配置点。

3. 项目的配置文件介绍

config/passport.php

此配置文件控制 Passport 的核心行为，包含了多个配置项，例如客户端的生成方式、个人访问令牌的命名空间、令牌的有效期等。关键部分包括：

• client_secret 和 personal_access_client：安装时自动生成的客户端ID和秘密，用于API的身份验证。
• tokens 部分定义了访问令牌和刷新令牌的有效时间，默认值分别为1小时和永久有效。
• scopes: 如果启用范围管理，这里可以定义不同的访问权限范围。
• guarded_by：指定哪些门面应该由Passport保护，虽然这通常是通过中间件在路由级别设置的。

// 示例配置片段
return [
    'stateless' => env('PASSPORT_STATELESS', false),
    'client_id' => env('PASSPORT_CLIENT_ID'),
    'client_secret' => env('PASSPORT_CLIENT_SECRET'),
    // ...
];

通过上述指南，您可以快速理解并配置 Laravel Passport，进而搭建安全的API身份验证系统。记得根据实际需求调整 config/passport.php 文件中的配置以满足特定应用场景。

passportLaravel Passport provides OAuth2 server support to Laravel.项目地址:https://gitcode.com/gh_mirrors/pas/passport