laravel
2. 入门
目录结构

介绍

默认的 Laravel 应用结构旨在为大型和小型应用程序提供一个良好的起点。但是,您可以按照自己喜欢的方式组织您的应用程序。Laravel 几乎不对任何给定类的位置施加限制 - 只要 Composer 可以自动加载该类。

[!注意]
对 Laravel 不熟悉?查看 Laravel 新手训练营 (opens in a new tab),在我们引导您构建第一个 Laravel 应用程序的同时,对该框架进行实践之旅。

根目录

应用目录

app 目录包含您的应用程序的核心代码。我们很快将更详细地探讨这个目录;然而,您的应用程序中的几乎所有类都将在此目录中。

引导目录

bootstrap 目录包含用于引导框架的 app.php 文件。此目录还包含一个 cache 目录,其中包含为性能优化而生成的框架文件,例如路由和服务缓存文件。

配置目录

顾名思义,config 目录包含您的应用程序的所有配置文件。阅读所有这些文件并熟悉为您提供的所有选项是一个好主意。

数据库目录

database 目录包含您的数据库迁移、模型工厂和种子。如果您愿意,您也可以使用此目录来保存 SQLite 数据库。

公共目录

public 目录包含 index.php 文件,这是进入您的应用程序的所有请求的入口点,并配置自动加载。此目录还包含您的资产,如图像、JavaScript 和 CSS。

资源目录

resources 目录包含您的 视图 以及您的原始、未编译的资产,如 CSS 或 JavaScript。

路由目录

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目录包含您的日志、编译后的 Blade 模板、基于文件的会话、文件缓存以及框架生成的其他文件。此目录被分隔为appframeworklogs目录。app目录可用于存储您的应用程序生成的任何文件。framework目录用于存储框架生成的文件和缓存。最后,logs目录包含您的应用程序的日志文件。

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

测试目录

tests目录包含您的自动化测试。默认情况下提供了例如Pest (opens in a new tab)PHPUnit (opens in a new tab)的单元测试和功能测试。每个测试类的后缀都应该是Test。您可以使用/vendor/bin/pest/vendor/bin/phpunit命令运行您的测试。或者,如果您想要更详细和美观的测试结果表示,您可以使用php artisan test Artisan 命令运行您的测试。

供应商目录

vendor目录包含您的Composer (opens in a new tab)依赖项。

应用程序目录

您的应用程序的大部分内容都位于app目录中。默认情况下,此目录在App命名空间下,并且由 Composer 使用PSR - 4 自动加载标准 (opens in a new tab)进行自动加载。

默认情况下,app目录包含HttpModelsProviders目录。但是,随着时间的推移,当您使用 make Artisan 命令生成类时,应用程序目录内会生成各种其他目录。例如,在您执行make:command Artisan 命令以生成命令类之前,app/Console目录将不存在。

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

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

广播目录

Broadcasting目录包含您的应用程序的所有广播频道类。这些类是使用make:channel命令生成的。默认情况下此目录不存在,但当您创建第一个频道时会为您创建。要了解有关频道的更多信息,请查看事件广播的文档。

控制台目录

Console目录包含您的应用程序的所有自定义 Artisan 命令。这些命令可以使用make:command命令生成。

事件目录

默认情况下此目录不存在,但event:generatemake:event Artisan 命令会为您创建。Events目录包含事件类。事件可用于提醒您的应用程序的其他部分某个给定操作已发生,提供了很大的灵活性和解耦性。

异常目录(The Exceptions Directory)

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

HTTP 目录(The Http Directory)

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

任务目录(The Jobs Directory)

默认情况下此目录不存在,但如果执行 make:job Artisan 命令,将为您创建该目录。Jobs 目录存放应用程序的可排队任务。应用程序可以将任务排队,或者在当前请求生命周期内同步运行。在当前请求期间同步运行的任务有时被称为“命令”,因为它们是命令模式 (opens in a new tab)的一种实现。

监听器目录(The Listeners Directory)

默认情况下此目录不存在,但如果执行 event:generatemake:listener Artisan 命令,将为您创建该目录。Listeners 目录包含处理事件的类。事件监听器接收事件实例并根据事件触发执行逻辑。例如,UserRegistered 事件可能由 SendWelcomeEmail 监听器处理。

邮件目录(The Mail Directory)

默认情况下此目录不存在,但如果执行 make:mail Artisan 命令,将为您创建该目录。Mail 目录包含应用程序发送的所有表示电子邮件的类。邮件对象允许您在一个简单的类中封装构建电子邮件的所有逻辑,该类可以使用 Mail::send 方法发送。

模型目录(The Models Directory)

Models 目录包含所有的Eloquent 模型类。Laravel 附带的 Eloquent ORM 为处理数据库提供了一个美观、简单的 ActiveRecord 实现。每个数据库表都有一个对应的“模型”,用于与该表进行交互。模型允许您查询表中的数据,以及向表中插入新记录。

通知目录(The Notifications Directory)

默认情况下此目录不存在,但如果执行 make:notification Artisan 命令,将为您创建该目录。Notifications 目录包含应用程序发送的所有“事务性”通知,例如关于应用程序中发生的事件的简单通知。Laravel 的通知功能将通过多种驱动程序(如电子邮件、Slack、SMS 或存储在数据库中)发送通知进行抽象。

策略目录(The Policies Directory)

默认情况下此目录不存在,但如果执行 make:policy Artisan 命令,将为您创建该目录。Policies 目录包含应用程序的授权策略类。策略用于确定用户是否可以对资源执行给定操作。

提供器目录(The Providers Directory)

Providers 目录包含应用程序的所有服务提供器。服务提供器通过在服务容器中绑定服务、注册事件或执行任何其他任务来引导应用程序,为传入的请求做好准备。

在一个新的 Laravel 应用程序中,此目录已经包含 AppServiceProvider。您可以根据需要在此目录中添加自己的提供器。

规则目录(The Rules Directory)

默认情况下此目录不存在,但如果执行 make:rule Artisan 命令,将为您创建该目录。Rules 目录包含应用程序的自定义验证规则对象。规则用于在一个简单的对象中封装复杂的验证逻辑。有关更多信息,请查看验证文档