简介
Laravel 应用程序的默认结构旨在为大型和小型应用程序提供一个出色的起点。但是,你可以自由地按照自己的喜好组织应用程序。Laravel 几乎不对任何给定类的位置施加限制 - 只要 Composer 能够自动加载该类。
注意
初次使用 Laravel?请查看 Laravel Bootcamp 以获得该框架的实战指南,同时我们将帮助你构建你的第一个 Laravel 应用。
根目录
App 目录php app
目录包含应用程序的核心代码。我们很快将详细探讨这个目录;但是,你的应用程序中几乎所有的类都将在此目录中。
Bootstrap 目录php bootstrap
目录包含 php app.php
文件,该文件负责启动框架。此目录还包含一个 php cache
目录,其中包含用于性能优化的框架生成的文件,例如路由和服务缓存文件。
Config 目录
顾名思义,php config
目录包含了应用程序的所有配置文件。阅读所有这些文件并熟悉可用的选项是个好主意。
Database 目录php database
目录包含您的数据库迁移、模型工厂和种子。如果您愿意,您还可以使用此目录来存放 SQLite 数据库。
Public 目录php public
目录包含 php index.php
文件,这是所有进入应用程序请求的入口点,并配置自动加载。此目录还存放您的资源,如图片、JavaScript 和 CSS。
Resources 目录php resources
目录包含您的 视图 以及未编译的原始资源,如 CSS 或 JavaScript。
Routes 目录php routes
目录包含了应用程序的所有路由定义。默认情况下,Laravel 包含两个路由文件:php web.php
和 php console.php
。php web.php
文件包含 Laravel 放在 php web
中间件组中的路由,提供会话状态、CSRF保护和 cookie 加密。如果您的应用程序不提供无状态的 RESTful API,那么您的所有路由很可能都会定义在 php web.php
文件中。
php console.php
文件是您可以定义所有基于闭包的控制台命令的地方。每个闭包都绑定到一个命令实例,允许以简单的方式与每个命令的IO方法交互。尽管这个文件没有定义HTTP路由,但它定义了基于控制台的进入应用程序的入口点(路由)。您还可以在 php console.php
文件中 计划 任务。
可选地,您可以通过 php install:api
和 php install:broadcasting
Artisan命令安装额外的路由文件,用于API路由(php api.php
)和广播频道(php channels.php
)。php api.php
文件包含意图无状态的路线,因此通过这些路由进入应用程序的请求意图通过 token 进行身份验证,并且无法访问会话状态。php channels.php
文件是您可以注册应用程序支持的所有 事件广播 频道的地方。
Storage 目录php storage
目录包含您的日志、编译的Blade模板、基于文件的会话、文件缓存以及框架生成的其他文件。这个目录被分为 php app
、php framework
和 php logs
目录。php app
目录可用于存储应用程序生成的任何文件。php framework
目录用于存储框架生成的文件和缓存。最后,php logs
目录包含您的应用程序日志文件。php storage/app/public
目录可用于存储应公开访问的用户生成文件,例如个人资料头像。您应该在 php public/storage
创建一个指向此目录的符号链接。您可以使用 php php artisan storage:link
Artisan 命令创建链接。
Tests 目录php tests
目录包含你的自动化测试。默认情况下提供了 Pest 或 PHPUnit 单元测试和功能测试示例。每个测试类应以 php Test
单词为后缀。你可以使用 php /vendor/bin/pest
或 php /vendor/bin/phpunit
命令运行测试。或者,如果你希望对测试结果有更详细和美观的表示,你可以使用 php php artisan test
Artisan 命令运行测试。
Vendor 目录php vendor
目录包含您的 Composer 依赖项。
App 目录
你应用程序的大部分内容都位于 php app
目录中。默认情况下,此目录在 php App
命名空间下,并通过 Composer 使用 PSR-4 自动加载标准 自动加载。
默认情况下,php app
目录包含 php Http
、php Models
和 php Providers
目录。然而,随着时间的推移,当你使用 make Artisan 命令生成类时,php app
目录内将生成各种其他目录。例如,直到你执行 php make:command
Artisan 命令生成命令类时,php app/Console
目录才会存在。
php Console
和 php Http
目录将在下面的各自部分中进一步解释,但可以将 php Console
和 php Http
目录视为提供进入应用程序核心的 API。HTTP 协议和 CLI 都是与应用程序交互的机制,但实际上不包含应用程序逻辑。换句话说,它们是向应用程序发出命令的两种方式。php Console
目录包含所有的 Artisan 命令,而 php Http
目录包含你的控制器、中间件和请求。
技巧php app
目录中的许多类可以由 Artisan 通过命令生成。 要查看可用命令,请在终端中运行php php artisan list make
命令。
Broadcasting 目录php Broadcasting
目录包含应用程序的所有广播频道类。这些类是使用 php make:channel
命令生成的。默认情况下,该目录不存在,但在创建第一个频道时会为你生成。要了解更多关于频道的信息,请查看 事件广播 的文档。
Console 目录php Console
目录包含应用程序的所有自定义 Artisan 命令。这些命令可以使用 php make:command
命令生成。
Events 目录
默认情况下,该目录不存在,但可以通过 php event:generate
和 php make:event
Artisan 命令为你生成。php Events
目录存储 事件类。事件可用于通知应用程序的其他部分某个特定操作已发生,从而提供了很大的灵活性和解耦性。
Exceptions 目录php Exceptions
目录包含应用程序的所有自定义异常。这些异常可以使用 php make:exception
命令生成。
Http 目录php Http
目录包含你的控制器、中间件和表单请求。几乎所有处理进入应用程序请求的逻辑都将放在这个目录中。
Jobs 目录
默认情况下,该目录不存在,但如果你执行 php make:job
Artisan 命令,它将为你生成。php Jobs
目录存储应用程序的 队列任务。这些任务可以由应用程序排队或在当前请求的生命周期内同步运行。在当前请求期间同步运行的任务有时被称为「命令」,因为它们是 命令模式 的实现。
Listeners 目录
默认情况下,该目录不存在,但可以通过执行 php event:generate
或 php make:listener
Artisan 命令为你生成。php Listeners
目录包含处理你的 事件 的类。事件监听器接收事件实例,并在事件触发时执行逻辑。例如,php UserRegistered
事件可能由 php SendWelcomeEmail
监听器处理。
Mail 目录
默认情况下,该目录不存在,但可以通过执行 php make:mail
Artisan 命令为你生成。php Mail
目录包含应用程序发送的所有 表示电子邮件的类。邮件对象允许你在一个简单的类中封装构建电子邮件的所有逻辑,并可以使用 php Mail::send
方法发送。
Models 目录php Models
目录包含所有的 Eloquent 模型类。Laravel 的 Eloquent ORM 提供了一个优雅、简单的 ActiveRecord 实现,用于与数据库交互。每个数据库表都有一个对应的 「Model」,用于与该表交互。模型允许你查询表中的数据,也可以向表中插入新记录。
Notifications 目录
默认情况下,该目录不存在,但可以通过执行 php make:notification
Artisan 命令为你生成。php Notifications
目录包含应用程序发送的所有「事务性」 通知,例如应用程序内事件的简单通知。Laravel 的通知功能支持通过多种驱动程序发送通知,如电子邮件、Slack、SMS 或存储在数据库中。
Policies 目录
默认情况下,该目录不存在,但可以通过执行 php make:policy
Artisan 命令为你生成。php Policies
目录包含应用程序的 授权策略类。策略用于确定用户是否可以对某个资源执行给定的操作。
Providers 目录php Providers
目录包含应用程序的所有 服务提供者。服务提供者通过绑定服务到服务容器、注册事件或执行其他任务来引导你的应用程序,以准备处理传入的请求。
在一个新的 Laravel 应用程序中,这个目录已经包含 php AppServiceProvider
。你可以根据需要添加自己的服务提供者到这个目录。
Rules 目录
默认情况下,该目录不存在,但可以通过执行 php make:rule
Artisan 命令为你生成。php Rules
目录包含应用程序的自定义验证规则对象。这些验证规则用于将复杂的验证逻辑封装在一个简单的对象中。更多信息请查看 表单验证。