跳转至内容

目录结构

简介

Laravel 默认的应用结构旨在为大型和小型应用程序提供一个良好的起点。当然,你可以随心所欲地组织你的应用程序。只要 Composer 能自动加载类,Laravel 对任何类存放的位置几乎没有任何限制。

根目录

应用目录 (The App Directory)

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 文件包含旨在保持无状态的路由,因此通过这些路由进入应用程序的请求应 通过令牌 (via tokens) 进行身份验证,并且无法访问会话状态。

channels.php 文件用于注册应用程序支持的所有 事件广播 频道。

Storage 目录

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

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

Tests 目录

tests 目录包含了你的自动化测试。框架开箱即用地提供了 PestPHPUnit 的单元测试和功能测试示例。每个测试类都应以 Test 作为后缀。你可以使用 /vendor/bin/pest/vendor/bin/phpunit 命令来运行测试。或者,如果你想要更详细且美观的测试结果展示,可以使用 php artisan test Artisan 命令来运行测试。

Vendor 目录

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

应用目录 (The App Directory)

你的应用程序主体代码存放在 app 目录中。默认情况下,该目录的命名空间为 App,并由 Composer 使用 PSR-4 自动加载标准 进行自动加载。

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

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、短信或存储在数据库中)发送通知的能力。

Policies 目录

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

Providers 目录

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

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

Rules 目录

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