Laravel Jetstream安装与使用指南
Laravel Jetstream 是一个专为 Laravel 框架设计的优雅应用搭建套件,提供了一个完美的起点来创建你的下一个 Laravel 应用。它集成了登录、注册、邮件验证、两步验证、会话管理、通过 Laravel Sanctum 支持的 API 功能以及可选的团队管理功能,并采用 Tailwind CSS 进行样式设计。本指南将引导您了解其基本架构并介绍关键文件。
1. 项目目录结构及介绍
Laravel Jetstream 的目录结构紧密遵循 Laravel 的常规布局,同时融入了其特定的组件。以下是核心部分的简介:
根目录重要文件夹和文件
- src - 包含 Jetstream 的主要源代码。
- config - 存放与 Jetstream 配置相关的文件,如
jetstream.php
定义了各种设置。 - routes - 应用程序的路由定义,包括 web 和 api 路由。
- database - 数据迁移文件和种子数据脚本。
- resources - 视图模板、语言文件、Vue 组件等前端资源。
- tests - 单元测试和功能测试文件。
关键文件
- composer.json - 依赖管理文件,列出 Jetstream 及其依赖。
- LICENSE - 许可证文件,说明软件遵循 MIT 许可。
- README.md - 项目概述和快速入门指南。
- config/jetstream.php - Jetstream 的配置文件,允许自定义诸如认证方式(Livewire 或 Inertia)、UI 布局和功能选项。
2. 项目的启动文件介绍
在 Laravel 中,项目的主要启动逻辑并不直接体现在单一文件上,而是分散在多个位置以实现松耦合设计。然而,对于开发者而言,以下两个是初始化流程的关键点:
- bootstrap/app.php - 在这个文件中,你可以手动配置应用程序实例,但在 Jetstream 的上下文中,更多关注的是服务提供者自动注册。
- public/index.php - 应用程序的入口点,负责启动 Laravel 应用程序实例并处理 HTTP 请求。当服务器接收请求时,它首先加载此文件。
安装 Jetstream 后,您通常不需要直接编辑这些启动文件,除非进行高度定制化的开发工作。
3. 项目的配置文件介绍
jetstream.php
位于 config
目录下的 jetstream.php
文件是 Jetstream 最核心的配置文件。该文件允许您配置:
- Authentication scaffolding(认证架构):选择 Livewire 或 Inertia 作为前端技术栈。
- User Model:指定用于用户身份验证的模型。
- Features:启用或禁用特性,例如团队支持、API 端点、密码更新等。
- Themes:如果适用,可以配置界面主题。
- Components:控制 UI 组件的行为,如表单验证行为。
其他相关配置
- auth.php - Laravel 的认证配置,尽管 Jetstream 提供了默认配置,但您可以在此调整认证相关的细项,如守卫和提供者。
- filesystems.php - 如果 Jetstream 的一些特性涉及文件存储,比如上传的用户头像,那么这里会有相关配置。
- services.php 或其他服务配置文件 - 定义如 API 密钥这样的服务配置,间接影响 Jetstream 的 API 功能。
安装和配置 Jetstream 通常通过 Laravel 的命令行工具 Artisan 来完成,具体步骤包括通过 Composer 添加依赖、发布配置及运行安装命令。确保查阅官方文档以获取最新的安装指令和详细配置说明。