跳到内容

目录结构

介绍

默认的 Laravel 应用程序结构旨在为大小应用程序提供一个很好的起点。但是,您可以自由地组织您的应用程序,只要 Composer 可以自动加载该类,Laravel 几乎不对任何给定类的位置施加任何限制。

lightbulb

刚接触 Laravel?查看 Laravel Bootcamp,通过动手实践的方式了解框架,同时我们将引导您构建您的第一个 Laravel 应用程序。

根目录

App 目录

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 目录包含您的自动化测试。开箱即用地提供了示例 PestPHPUnit 单元测试和功能测试。每个测试类都应以单词 Test 为后缀。您可以使用 /vendor/bin/pest/vendor/bin/phpunit 命令运行测试。或者,如果您想要更详细和精美的测试结果表示,您可以使用 php artisan test Artisan 命令运行测试。

供应商目录

vendor 目录包含您的 Composer 依赖项。

App 目录

您的大部分应用程序都位于 app 目录中。默认情况下,此目录在 App 下命名,并且 Composer 使用 PSR-4 自动加载标准 自动加载。

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

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

lightbulb

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

广播目录

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

控制台目录

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

事件目录

此目录默认不存在,但会由 event:generatemake:event Artisan 命令为你创建。Events 目录存放 事件类。事件可以用来通知应用程序的其他部分,某个特定操作已经发生,从而提供很大的灵活性和解耦性。

异常目录

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

Http 目录

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

作业目录

此目录默认不存在,但如果你执行 make:job Artisan 命令,它会自动创建。Jobs 目录存放你应用程序的 可排队的作业。作业可以由你的应用程序排队,也可以在当前请求生命周期内同步运行。在当前请求期间同步运行的作业有时被称为“命令”,因为它们是 命令模式 的一种实现。

监听器目录

此目录默认不存在,但如果你执行 event:generatemake:listener Artisan 命令,它会自动创建。Listeners 目录包含处理你的 事件 的类。事件监听器接收一个事件实例,并响应事件的触发执行逻辑。例如,UserRegistered 事件可能会由 SendWelcomeEmail 监听器处理。

邮件目录

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

模型目录

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

通知目录

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

策略目录

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

提供者目录

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

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

规则目录

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