目录结构

简介

默认的 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.phpconsole.php

web.php 文件包含了 Laravel 放置在 web 中间件组中的路由,该组提供会话状态、CSRF 保护和 cookie 加密。如果你的应用程序不提供无状态的 RESTful API,则所有路由很可能会在 web.php 文件中定义。

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

可选地,你可以通过 install:apiinstall:broadcasting Artisan 命令安装额外的路由文件,用于 API 路由(api.php)和广播频道(channels.php)。

api.php 文件包含的是旨在无状态的路由,因此通过这些路由进入应用程序的请求将通过令牌进行身份验证,并且无法访问会话状态。

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

storage 目录

storage 目录包含了日志、编译过的 Blade 模板、基于文件的会话、文件缓存以及框架生成的其它文件。该目录分为 appframeworklogs 目录。app 目录可以用于存储应用程序生成的任何文件。framework 目录用于存储框架生成的文件和缓存。最后,logs 目录包含应用程序的日志文件。

storage/app/public 目录可以用于存储用户生成的文件,例如个人资料头像,这些文件应该是公开可访问的。你应当在 public/storage 目录创建一个符号链接,指向这个目录。你可以使用 php artisan storage:link Artisan 命令创建该链接。

tests 目录

tests 目录包含了自动化测试。Laravel 默认提供了 PestPHPUnit 单元测试和功能测试示例。每个测试类的后缀应为 Test。你可以使用 /vendor/bin/pest/vendor/bin/phpunit 命令运行测试。如果你希望获得更详细和美观的测试结果展示,可以使用 php artisan test Artisan 命令运行测试。

vendor 目录

vendor 目录包含了你的 Composer 依赖项。

App 目录

应用程序的大部分内容都存放在 app 目录中。默认情况下,该目录被命名为 App,并且通过 Composer 使用 PSR-4 自动加载标准 进行加载。

默认情况下,app 目录包含 HttpModelsProviders 目录。然而,随着你使用 Artisan 的 make 命令生成类,app 目录中会逐渐生成各种其它目录。例如,app/Console 目录在你执行 make:command Artisan 命令生成命令类之前是不存在的。

ConsoleHttp 目录将在下面的相关章节中进一步解释,但可以将 ConsoleHttp 目录视为应用程序核心的 API。HTTP 协议和 CLI 都是与应用程序交互的机制,但不包含实际的应用程序逻辑。换句话说,它们是向应用程序发出命令的两种方式。Console 目录包含所有的 Artisan 命令,而 Http 目录包含控制器、中间件和请求。

app 目录中的许多类可以通过 Artisan 命令生成。要查看可用命令,请在终端中运行 php artisan list make 命令。

Broadcasting 目录

broadcasting 目录包含了应用程序所有的广播频道类。这些类是使用 make:channel 命令生成的。该目录默认不存在,但在你创建第一个频道时会为你创建。要了解更多关于频道的内容,请查看 【事件广播】 的文档。

Console 目录

console 目录包含了应用程序所有自定义的 Artisan 命令。这些命令可以通过 make:command 命令生成。

Events 目录

该目录默认不存在,但会在你执行 event:generatemake:event Artisan 命令时为你创建。Events 目录包含 【事件类】。事件可用于通知应用程序的其它部分某个特定操作已经发生,从而提供了灵活性和解耦。

Exceptions 目录

Exceptions 目录包含了应用程序的所有自定义异常。这些异常可以通过 make:exception 命令生成。

HTTP 目录

Http 目录包含了控制器、中间件和表单请求。几乎所有用于处理进入应用程序的请求的逻辑都将放置在该目录中。

Jobs 目录

该目录默认不存在,但如果你执行 make:job Artisan 命令,它会为你创建。Jobs 目录包含了应用程序的 【可队列任务】。任务可以由应用程序排队执行,也可以在当前请求生命周期内同步执行。同步执行的任务有时被称为 “命令”,因为它们是 【命令模式】 的一种实现。

Listeners 目录

该目录默认不存在,但如果你执行 event:generatemake: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 目录包含应用程序的自定义验证规则对象。规则用于将复杂的验证逻辑封装在一个简单的对象中。欲了解更多信息,请查阅 【验证文档】。