目录结构
介绍
默认的 Laravel 应用程序结构旨在为大型和小型应用程序提供一个良好的起点。但您可以随意组织您的应用程序。Laravel 几乎不对任何类的位置施加限制——只要 Composer 能够自动加载该类即可。
Laravel 新手?查看 Laravel Bootcamp 以获得框架的动手体验,同时我们将带您构建第一个 Laravel 应用程序。
根目录
App 目录
app
目录包含应用程序的核心代码。我们将很快更详细地探讨此目录;然而,您应用程序中的几乎所有类都将在此目录中。
Bootstrap 目录
bootstrap
目录包含引导框架的 app.php
文件。此目录还包含一个 cache
目录,其中包含框架生成的文件以进行性能优化,例如路由和服务缓存文件。
Config 目录
顾名思义,config
目录包含应用程序的所有配置文件。通读这些文件并熟悉所有可用选项是个好主意。
Database 目录
database
目录包含您的数据库迁移、模型工厂和种子。如果您愿意,您还可以使用此目录来保存 SQLite 数据库。
Public 目录
public
目录包含 index.php
文件,这是进入应用程序的所有请求的入口点,并配置自动加载。此目录还包含您的资产,如图像、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
下命名空间,并使用 PSR-4 自动加载标准 由 Composer 自动加载。
默认情况下,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、SMS 或存储在数据库中)发送通知。
Policies 目录
此目录默认不存在,但如果您执行 make:policy
Artisan 命令将为您创建。Policies
目录包含应用程序的授权策略类。策略用于确定用户是否可以对资源执行给定操作。
Providers 目录
Providers
目录包含应用程序的所有服务提供者。服务提供者通过在服务容器中绑定服务、注册事件或执行任何其他任务来引导应用程序,为传入请求做好准备。
在一个新的 Laravel 应用程序中,此目录将已经包含 AppServiceProvider
。您可以根据需要向此目录添加自己的提供者。
Rules 目录
此目录默认不存在,但如果您执行 make:rule
Artisan 命令将为您创建。Rules
目录包含应用程序的自定义验证规则对象。规则用于在简单对象中封装复杂的验证逻辑。有关更多信息,请查看验证文档。