目录结构
简介
默认的 Laravel 应用程序结构旨在为大型和小型应用程序提供一个良好的起点。但是您可以自由地以您喜欢的任何方式组织您的应用程序。只要 Composer 可以自动加载该类,Laravel 几乎不限制任何给定类的位置。
根目录
app 目录
app 目录包含应用程序的核心代码。我们稍后会更详细地探索这个目录;然而,您应用程序中几乎所有的类都将位于此目录中。
bootstrap 目录
bootstrap 目录包含 app.php 文件,该文件用于引导框架。此目录还包含一个 cache 目录,其中包含为性能优化而生成的框架文件,例如 路由和服务的缓存文件。
config 目录
顾名思义,config 目录包含您应用程序的所有配置文件。通读所有这些文件并熟悉所有可用的选项是一个好主意。
database 目录
database 目录包含您的数据库迁移、模型工厂和填充器。如果您愿意,您也可以使用此目录来保存 SQLite 数据库。
public 目录
public 目录包含 index.php 文件,该文件是进入您应用程序的所有请求的入口点并配置自动加载。此目录还包含您的资产(assets),例如图像、JavaScript 和 CSS。
resources 目录
resources 目录包含您的 视图 以及您的原始、未编译的资产,例如 CSS 或 JavaScript。
routes 目录
routes 目录包含您应用程序的所有路由定义。默认情况下,Laravel 包含两个路由文件:web.php 和 console.php。
web.php 文件包含 Laravel 放置在 web 中间件组中的路由,该组提供会话状态、CSRF 保护和 Cookie 加密。如果您的应用程序不提供无状态的 RESTful API,那么您的所有路由很可能都在 web.php 文件中定义。
console.php 文件是您可以定义所有基于闭包的控制台命令的地方。每个闭包都绑定到一个命令实例,这提供了一种与每个命令的 IO 方法交互的简单方法。尽管此文件没有定义 HTTP 路由,但它定义了进入您应用程序的基于控制台的入口点(路由)。您也可以在 console.php 文件中 调度 任务。
可选地,您可以通过 install:api 和 install:broadcasting Artisan 命令安装用于 API 路由(api.php)和广播频道(channels.php)的额外路由文件。
api.php 文件包含旨在无状态的路由,因此通过这些路由进入应用程序的请求旨在 通过令牌进行身份验证,并且无法访问会话状态。
channels.php 文件是您可以注册您的应用程序支持的所有 事件广播 频道的地方。
storage 目录
storage 目录包含您的日志、已编译的 Blade 模板、基于文件的会话、文件缓存以及框架生成的其他文件。此目录分为 app、framework 和 logs 目录。app 目录可用于存储应用程序生成的任何文件。framework 目录用于存储框架生成的文件和缓存。最后,logs 目录包含您应用程序的日志文件。
storage/app/public 目录可用于存储应公开访问的用户生成文件,例如个人资料头像。您应该在 public/storage 创建一个指向此目录的符号链接。您可以使用 php artisan storage:link Artisan 命令创建该链接。
tests 目录
tests 目录包含您的自动化测试。开箱即用提供了示例 Pest 或 PHPUnit 单元测试和功能测试。每个测试类都应该以 Test 单词作为后缀。您可以使用 /vendor/bin/pest 或 /vendor/bin/phpunit 命令运行您的测试。或者,如果您想要更详细和美观的测试结果表示,您可以使用 php artisan test Artisan 命令运行您的测试。
vendor 目录
vendor 目录包含您的 Composer 依赖项。
app 目录
您的应用程序的大部分代码都位于 app 目录中。默认情况下,此目录在 App 命名空间下,并由 Composer 使用 PSR-4 自动加载标准 进行自动加载。
默认情况下,app 目录包含 Http、Models 和 Providers 目录。然而,随着时间的推移,当您使用 make Artisan 命令生成类时,app 目录内部将生成各种其他目录。例如,app/Console 目录直到您执行 make:command Artisan 命令生成一个命令类时才会存在。
Console 和 Http 目录在下面各自的部分中会进一步解释,但您可以将 Console 和 Http 目录视为提供进入应用程序核心的 API。HTTP 协议和 CLI 都是与应用程序交互的机制,但实际上不包含应用程序逻辑。换句话说,它们是向应用程序发出命令的两种方式。Console 目录包含您的所有 Artisan 命令,而 Http 目录包含您的控制器、中间件和请求。
app 目录中的许多类都可以通过 Artisan 命令生成。要查看可用命令,请在终端中运行 php artisan list make 命令。Broadcasting 目录
Broadcasting 目录包含您应用程序的所有广播频道类。这些类是使用 make:channel 命令生成的。此目录默认不存在,但当您创建第一个频道时会为您创建。要了解有关频道的更多信息,请查看 事件广播 文档。
Console 目录
Console 目录包含您应用程序的所有自定义 Artisan 命令。这些命令可以使用 make:command 命令生成。
Events 目录
此目录默认不存在,但当您执行 event:generate 和 make:event Artisan 命令时会为您创建。Events 目录包含 事件类。事件可用于提醒应用程序的其他部分已发生给定操作,从而提供很大的灵活性和解耦。
Exceptions 目录
Exceptions 目录包含您应用程序的所有自定义异常。这些异常可以使用 make:exception 命令生成。
Http 目录
Http 目录包含您的控制器、中间件和表单请求。几乎所有用于处理进入您应用程序的请求的逻辑都将放在此目录中。
Jobs 目录
此目录默认不存在,但当您执行 make:job Artisan 命令时会为您创建。Jobs 目录包含您应用程序的 可排队作业。作业可以由您的应用程序排队,也可以在当前请求生命周期内同步运行。在当前请求期间同步运行的作业有时被称为 “命令”,因为它们是 命令模式 的一种实现。
Listeners 目录
此目录默认不存在,但当您执行 event:generate 或 make:listener Artisan 命令时会为您创建。Listeners 目录包含处理您的 事件 的类。事件监听器接收一个事件实例并响应事件被触发而执行逻辑。例如,UserRegistered 事件可能由 SendWelcomeEmail 监听器处理。
Mail 目录
此目录默认不存在,但当您执行 make:mail Artisan 命令时会为您创建。Mail 目录包含您的应用程序发送的所有 代表电子邮件的类。邮件对象允许您将构建电子邮件的所有逻辑封装在一个单一、简单的类中,该类可以使用 Mail::send 方法发送。
Models 目录
Models 目录包含您的所有 Eloquent 模型类。Laravel 附带的 Eloquent ORM 提供了一个漂亮、简单的 ActiveRecord 实现,用于处理您的数据库。每个数据库表都有一个相应的 “模型”,用于与该表交互。模型允许您查询表中的数据,以及向表中插入新记录。
Notifications 目录
此目录默认不存在,但当您执行 make:notification Artisan 命令时会为您创建。Notifications 目录包含您的应用程序发送的所有 “事务性” 通知,例如关于应用程序中发生的简单事件的通知。Laravel 的通知功能将通过各种驱动程序(例如电子邮件、Slack、短信或存储在数据库中)发送通知进行抽象。
Policies 目录
此目录默认不存在,但当您执行 make:policy Artisan 命令时会为您创建。Policies 目录包含您应用程序的 授权策略类。策略用于确定用户是否可以对资源执行给定操作。
Providers 目录
Providers 目录包含您的应用程序的所有 服务提供者。服务提供者通过在服务容器中绑定服务、注册事件或执行任何其他任务来引导您的应用程序,从而为传入的请求做好准备。
在全新的 Laravel 应用程序中,此目录将已包含 AppServiceProvider。您可以根据需要在该目录中添加自己的提供者。
Rules 目录
此目录默认不存在,但当您执行 make:rule Artisan 命令时会为您创建。Rules 目录包含您应用程序的自定义验证规则对象。规则用于将复杂的验证逻辑封装在一个简单的对象中。有关更多信息,请查看 验证文档。