简介
默认的 Laravel 应用结构旨在为大型和小型应用提供一个极佳的起点。但你可以按照自己的喜好自由组织应用。Laravel 对任何类的存放位置几乎没有任何限制——只要 Composer 能够自动加载该类即可。
根目录
应用目录
app 目录包含应用的核心代码。我们将很快详细探讨该目录;不过,应用中的几乎所有类都会位于此目录中。
引导目录
bootstrap 目录包含用于引导框架的 app.php 文件。该目录下还包含一个 cache 目录,用于存放框架生成的、用于性能优化的文件,例如路由缓存文件和服务缓存文件。
配置目录
config 目录,顾名思义,包含应用的所有配置文件。仔细阅读所有这些文件并熟悉可用的所有选项是一个很好的做法。
数据库目录
database 目录包含数据库迁移、模型工厂和数据填充。如有必要,你也可以在该目录中存放 SQLite 数据库。
公共目录
public 目录包含 index.php 文件,它是进入应用的所有请求的入口,并且用于配置自动加载。该目录还存放着静态资源,如图像、JavaScript 和 CSS。
资源目录
resources 目录包含视图,以及未编译的原始资源,例如 CSS 或 JavaScript。
路由目录
routes 目录包含应用的所有路由定义。默认情况下,Laravel 包含两个路由文件:web.php 和 console.php。
web.php 文件包含 Laravel 置于 web 中间件组中的路由,该中间件组提供会话状态、CSRF 防护和 Cookie 加密。如果你的应用不提供无状态的 RESTful API,那么所有路由很可能都将定义在 web.php 文件中。
console.php 文件是定义所有基于闭包的 Console 命令的位置。每个闭包绑定到一个命令实例,让你能以简单的方式与每个命令的 IO 方法进行交互。尽管此文件不定义 HTTP 路由,但它定义了基于 Console 的应用入口(路由)。你也可以在 console.php 文件中调度任务。
可选地,你可以通过 install:api 和 install:broadcasting Artisan 命令安装额外的 API 路由文件(api.php)和广播频道文件(channels.php)。
api.php 文件包含旨在无状态的路由,因此通过这些路由进入应用的请求会通过令牌进行身份验证,并且不会访问会话状态。
channels.php 文件是注册应用所支持的所有事件广播频道的位置。
存储目录
storage 目录包含日志、编译后的 Blade 模板、基于文件的会话、文件缓存以及由框架生成的其他文件。该目录划分为 app、framework 和 logs 子目录。app 目录可用于存储由应用生成的任何文件。framework 目录用于存储框架生成的文件和缓存。最后,logs 目录包含应用的日志文件。
storage/app/public 目录可用于存储应公开访问的用户生成文件,例如个人资料头像。你应该在 public/storage 创建一个指向此目录的符号链接。你可以使用 php artisan storage:link Artisan 命令创建该链接。
测试目录
tests 目录包含自动化测试。开箱即用地提供了Pest 或 PHPUnit 单元测试和功能测试示例。每个测试类都应以 Test 作为后缀。你可以使用 /vendor/bin/pest 或 /vendor/bin/phpunit 命令运行测试。或者,如果你希望得到更详细、更美观的测试结果展示,可以使用 php artisan test Artisan 命令运行测试。
第三方依赖目录
vendor 目录包含你的Composer依赖。
应用目录
应用的大部分内容都存放在 app 目录中。默认情况下,该目录的命名空间为 App,并通过PSR-4 自动加载标准由 Composer 自动加载。
默认情况下,app 目录包含 Http、Models 和 Providers 目录。不过随着时间推移,当你使用 make Artisan 命令生成类时,app 目录内会生成各种其他目录。例如,在你执行 make:command Artisan 命令生成命令类之前,app/Console 目录是不会存在的。
下面的相应章节将分别对 Console 和 Http 目录进行详细说明,不过可以将其理解为提供了进入应用核心的 API。HTTP 协议和 CLI 都是与应用进行交互的机制,但实际上并不包含应用逻辑。换句话说,它们是向应用发出命令的两种方式。Console 目录包含所有的 Artisan 命令,而 Http 目录则包含控制器、中间件和请求。
app 目录中的许多类都能通过 Artisan 命令生成。若要查看可用命令,可以在终端中运行 php artisan list make 命令。
广播目录
Broadcasting 目录包含应用的所有广播频道类。这些类通过 make:channel 命令生成。该目录默认不存在,在你创建第一个频道时会自动创建。要了解有关频道的更多信息,请参阅事件广播文档。
Console 目录
Console 目录包含应用的所有自定义 Artisan 命令。这些命令可以使用 make:command 命令生成。
事件目录
此目录默认不存在,但会由 event:generate 和 make:event Artisan 命令自动创建。Events 目录存放事件类。事件可用于告知应用的其他部分已发生某个操作,从而提供极大的灵活性和解耦。
异常目录
Exceptions 目录包含应用的所有自定义异常。这些异常可以使用 make:exception 命令生成。
Http 目录
Http 目录包含控制器、中间件和表单请求。几乎所有处理进入应用请求的逻辑都会放在此目录中。
任务目录
此目录默认不存在,但当你执行 make:job Artisan 命令时会为你创建。Jobs 目录存放应用的可排队任务。任务可以由应用排队处理,或者在当前请求生命周期内同步执行。在当前请求中同步运行的任务有时被称为“命令”,因为它们是命令模式的一种实现。
监听器目录
此目录默认不存在,但当你执行 event:generate 或 make:listener Artisan 命令时会为你创建。Listeners 目录包含处理事件的类。事件监听器接收一个事件实例,并针对事件触发执行相应逻辑。例如,UserRegistered 事件可能由 SendWelcomeEmail 监听器处理。
邮件目录
该目录默认不存在,但如果执行 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 目录包含应用程序的自定义验证规则对象。规则用于将复杂的验证逻辑封装为简洁的对象。如需了解更多信息,请查阅验证文档。