目录结构

简介

默认的 Laravel 应用结构旨在为大型和小型应用提供一个良好的起点。但你可以自由地按照自己喜欢的方式组织应用。Laravel 几乎不对任何给定类的位置施加限制——只要 Composer 能够自动加载该类即可。

根目录

app 目录

app 目录包含应用的核心代码。我们稍后将详细探讨此目录；不过，应用中几乎所有的类都位于此目录中。

bootstrap 目录

bootstrap 目录包含用于引导框架的 app.php 文件。此目录还包含一个 cache 目录，其中存放框架生成的用于性能优化的文件，如路由和服务缓存文件。

config 目录

config 目录，顾名思义，包含应用的所有配置文件。建议通读所有这些文件，熟悉所有可用的选项。

database 目录

database 目录包含数据库 migration、模型 factory 和 seeder。如果你愿意，也可以使用此目录来存放 SQLite 数据库。

public 目录

public 目录包含 index.php 文件，它是所有进入应用的请求的入口点，并配置自动加载。此目录还存放你的资源文件，如图片、JavaScript 和 CSS。

resources 目录

resources 目录包含你的视图以及原始的、未编译的资源文件，如 CSS 或 JavaScript。

routes 目录

routes 目录包含应用的所有路由定义。默认情况下，Laravel 包含两个路由文件：web.php 和 console.php。

web.php 文件包含 Laravel 放置在 web middleware 组中的路由，该组提供 session 状态、CSRF 保护和 cookie 加密。如果你的应用不提供无状态的 RESTful API，那么所有路由很可能都将在 web.php 文件中定义。

console.php 文件是你可以定义所有基于闭包的控制台命令的地方。每个闭包都绑定到一个命令实例，允许以简单的方式与每个命令的 IO 方法交互。尽管此文件不定义 HTTP 路由，但它定义了进入应用的基于控制台的入口点（路由）。你也可以在 console.php 文件中调度任务。

你还可以通过 install:api 和 install:broadcasting Artisan 命令安装额外的路由文件，用于 API 路由（api.php）和广播频道（channels.php）。

api.php 文件包含旨在无状态的路由，因此通过这些路由进入应用的请求应通过令牌进行认证，并且不会访问 session 状态。

channels.php 文件是你可以注册应用支持的所有事件广播频道的地方。

storage 目录

storage 目录包含日志、编译后的 Blade 模板、基于文件的 session、文件缓存以及框架生成的其他文件。此目录分为 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 目录包含 controller、middleware 和请求。

NOTE

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 目录包含 controller、middleware 和表单请求。几乎所有处理进入应用的请求的逻辑都将放在此目录中。

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、SMS 或存储在数据库中。

Policies 目录

此目录默认不存在，但会在你执行 make:policy Artisan 命令时为你创建。Policies 目录包含应用的授权策略类。策略用于确定用户是否可以对资源执行给定操作。

Providers 目录

Providers 目录包含应用的所有 service provider。Service provider 通过在 service container 中绑定服务、注册事件或执行任何其他任务来引导应用，为传入请求做准备。

在全新的 Laravel 应用中，此目录已经包含了 AppServiceProvider。你可以根据需要自由地向此目录添加自己的 provider。

Rules 目录

此目录默认不存在，但会在你执行 make:rule Artisan 命令时为你创建。Rules 目录包含应用的自定义验证规则对象。规则用于将复杂的验证逻辑封装在一个简单的对象中。更多信息请查看验证文档。