目录结构
介绍
默认的 Laravel 应用结构旨在为大型和小型应用提供一个良好的起点。但您可以自由地组织您的应用,Laravel 几乎没有对任何给定类的位置施加限制——只要 Composer 能够自动加载该类。
对 Laravel 不熟悉?查看 Laravel Bootcamp,在我们带您构建第一个 Laravel 应用的过程中,进行一次动手实践的框架之旅。
Root 目录
App 目录
app
目录包含您应用的核心代码。我们将很快更详细地探讨此目录;然而,您应用中的几乎所有类都将在此目录中。
Bootstrap 目录
bootstrap
目录包含引导框架的 app.php
文件。此目录还包含一个 cache
目录,其中包含用于性能优化的框架生成的文件,例如路由和服务缓存文件。您通常不需要修改此目录中的任何文件。
Config 目录
config
目录,顾名思义,包含您应用的所有配置文件。阅读所有这些文件并熟悉所有可用选项是个好主意。
Database 目录
database
目录包含您的数据库迁移、模型工厂和种子。如果您愿意,您也可以使用此目录来保存 SQLite 数据库。
Lang 目录
lang
目录包含您应用的所有语言文件。
Public 目录
public
目录包含 index.php
文件,这是所有进入您应用的请求的入口点,并配置自动加载。此目录还包含您的资产,例如图像、JavaScript 和 CSS。
Resources 目录
resources
目录包含您的 视图 以及您的原始、未编译的资产,例如 CSS 或 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
Artisan 命令创建链接。
Tests 目录
tests
目录包含您的自动化测试。示例 PHPUnit 单元测试和功能测试是开箱即用的。每个测试类应以 Test
结尾。您可以使用 phpunit
或 php vendor/bin/phpunit
命令运行测试。或者,如果您希望以更详细和美观的方式展示测试结果,您可以使用 php artisan test
Artisan 命令运行测试。
Vendor 目录
vendor
目录包含您的 Composer 依赖项。
App 目录
您应用的大部分内容都位于 app
目录中。默认情况下,此目录的命名空间为 App
,并由 Composer 使用 PSR-4 自动加载标准 自动加载。
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
方法发送。
Models 目录
Models
目录包含您所有的 Eloquent 模型类。Laravel 附带的 Eloquent ORM 提供了一种美观、简单的 ActiveRecord 实现,用于与您的数据库进行交互。每个数据库表都有一个对应的“模型”,用于与该表进行交互。模型允许您查询表中的数据,以及向表中插入新记录。
Notifications 目录
此目录默认不存在,但如果您执行 make:notification
Artisan 命令,它将为您创建。Notifications
目录包含您应用发送的所有“事务性” 通知,例如有关您应用中发生的事件的简单通知。Laravel 的通知功能抽象了通过多种驱动程序(例如电子邮件、Slack、SMS 或存储在数据库中)发送通知的过程。
Policies 目录
此目录默认不存在,但如果您执行 make:policy
Artisan 命令,它将为您创建。Policies
目录包含您应用的 授权策略类。策略用于确定用户是否可以对资源执行给定操作。
Providers 目录
Providers
目录包含您应用的所有 服务提供者。服务提供者通过在服务容器中绑定服务、注册事件或执行其他任务来引导您的应用,为传入请求做好准备。
在一个新的 Laravel 应用中,此目录将已经包含几个提供者。您可以根据需要向此目录添加自己的提供者。
Rules 目录
此目录默认不存在,但如果您执行 make:rule
Artisan 命令,它将为您创建。Rules
目录包含您应用的自定义验证规则对象。规则用于将复杂的验证逻辑封装在一个简单的对象中。有关更多信息,请查看 验证文档。