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