目录结构
简介
默认的 Laravel 应用程序结构旨在为大型和小型应用程序提供一个很好的起点。 但是您可以随意组织您的应用程序。 Laravel 对任何给定类的位置几乎没有任何限制——只要 Composer 可以自动加载该类。
根目录
App 目录
app
目录包含你应用程序的核心代码。之后我们会更详细地介绍这个目录;然而,你的应用程序中几乎所有的类都在这个目录中。
Bootstrap 目录
bootstrap
目录包含app.php
文件,用于引导框架。这个目录下还有一个cache
目录,包含框架生成的性能优化文件,如路由和服务缓存文件。你一般不需要修改这个目录下的任何文件。
Config 目录
config
目录,顾名思义,包含了你的应用程序的所有配置文件。我们建议你阅读所有这些文件并熟悉所有可用的选项。
Database 目录
database
目录包含你的数据库迁移、模型工厂和数据库填充文件。如果你愿意,你也可以用这个目录来存放一个SQLite数据库。
Public 目录
public
目录包含 index.php
文件,它是所有请求进入应用程序并配置自动加载的入口点。 js 和 CSS。
Resources 目录
resources
目录包含您的 views 以及原始的、未编译的资源,例如 CSS 或 js。 此目录还包含您的所有语言文件。
Routes 目录
routes
目录包含应用程序的所有路由定义。默认情况下,Laravel 包含几个路由文件:web.php
、api.php
、console.php
和 channels.php
。
web.php
文件包含 RouteServiceProvider
放置在 web
中间件组中的路由,它提供会话状态、CSRF 保护和 cookie 加密。如果您的应用程序不提供无状态的 RESTful API,那么您的所有路由很可能都在 web.php
文件中定义。
api.php
文件包含RouteServiceProvider
放在api
中间件组中的路由。这些路由的目的是无状态的,所以通过这些路由进入应用程序的请求将被认证通过tokens,并且不会访问会话状态。
console.php
文件是您可以定义所有基于闭包的控制台命令的地方。每个闭包都绑定到一个命令实例,允许一种简单的方法与每个命令的 IO 方法进行交互。即使此文件没有定义 HTTP 路由,它也会定义应用程序中基于控制台的入口点(路由)。
channels.php
文件是您可以注册应用程序支持的所有 事件广播 频道的地方。
Storage 目录
storage
目录包含你的日志、编译的 Blade 模板、基于文件的会话、文件缓存和框架生成的其他文件。 该目录分为app
、framework
和logs
目录。 app
目录可用于存储应用程序生成的任何文件。 framework
目录用于存储框架生成的文件和缓存。 最后,logs
目录包含应用程序的日志文件。
storage/app/public
目录可用于存储用户生成的文件,例如个人资料头像,这些文件应该可以公开访问。 你应该在 public/storage
创建一个指向这个目录的软链接。 您可以使用 php artisan storage:link
Artisan 命令创建链接。
Tests 目录
tests
目录包含您的自动化测试。 开箱即用的示例 PHPUnit 单元测试和功能测试。 每个测试类都应以单词Test
作为后缀。 您可以使用 phpunit
或 php vendor/bin/phpunit
命令运行测试。 或者,如果您想要更详细和更漂亮的测试结果表示,您可以使用 php artisan test
Artisan 命令运行测试。
Vendor 目录
vendor
目录包含您的 Composer 依赖项。
App 目录
您的大部分应用程序都位于 app
目录中。默认情况下,此目录的名称空间在 App
下,并由 Composer 使用 [PSR-4 自动加载标准] (https://www.php-fig.org/psr/psr-4/) 自动加载。
app
目录包含各种附加目录,例如 Console
、Http
和 Providers
。将 Console
和 Http
目录视为为应用程序核心提供 API。 HTTP 协议和 CLI 都是与应用程序交互的机制,但实际上并不包含应用程序逻辑。换句话说,它们是向您的应用程序发出命令的两种方式。 Console
目录包含您的所有 Artisan 命令,而 Http
目录包含您的控制器、中间件和请求。
当您使用 make
Artisan 命令生成类时,会在 app
目录中生成各种其他目录。因此,例如,在您执行 make:job
Artisan 命令生成队列任务之前,app/Jobs
目录将不存在。
{tip}
app
目录中的许多类可以由 Artisan 通过命令生成。 要查看可用命令,请在终端中运行php artisan list make
命令。
Broadcasting 目录
Broadcasting
目录包含应用程序的所有广播频道类。 这些类是使用 make:channel
命令生成的。 此目录默认不存在,但会在您创建第一个频道时为您创建。 要了解有关频道的更多信息,请查看有关 事件广播 的文档。
Console 目录
Console
目录包含应用程序的所有自定义 Artisan 命令。 这些命令可以使用 make:command
命令生成。 此目录还包含您的控制台内核,这是您注册自定义 Artisan 命令和定义 计划任务 的地方。
Events 目录
此目录默认不存在,但会由 event:generate
和 make:event
Artisan 命令为您创建。 Events
目录包含 事件类。 事件可用于提醒应用程序的其他部分发生了给定的操作,从而提供了极大的灵活性和解耦性。
Exceptions 目录
Exceptions
目录包含应用程序的异常处理程序,也是放置应用程序抛出的任何异常的好地方。 如果您想自定义记录或呈现异常的方式,您应该修改此目录中的 Handler
类。
Http 目录
Http
目录包含您的控制器、中间件和表单请求。 几乎所有处理进入应用程序的请求的逻辑都将放在这个目录中。
Jobs 目录
该目录默认不存在,但如果您执行 make:job
Artisan 命令,则会为您创建。 Jobs
目录包含应用程序的 queueable jobs。 队列可能由您的应用程序排队或在当前请求生命周期内同步运行。 在当前请求期间同步运行的队列有时称为“命令”,因为它们是 命令模式 的实现。
Listeners 目录
此目录默认不存在,但如果您执行 event:generate
或 make:listener
Artisan 命令,则会为您创建。 Listeners
目录包含处理您的 events 的类。 事件侦听器接收事件实例并执行逻辑以响应被触发的事件。 例如,UserRegistered
事件可能由SendWelcomeEmail
监听器处理。
Mail 目录
该目录默认不存在,但如果您执行 make:mail
Artisan 命令,则会为您创建。 Mail
目录包含您的应用程序发送的所有代表电子邮件的类。 Mail 对象允许您将构建电子邮件的所有逻辑封装在一个简单的类中,该类可以使用Mail::send
方法发送。
Models 目录
Models
目录包含所有 Eloquent 模型类。 Laravel 中包含的 Eloquent ORM 提供了一个漂亮、简单的 ActiveRecord 实现来处理你的数据库。 每个数据库表都有一个相应的“Model”,用于与该表进行交互。 模型允许您查询表中的数据,以及将新记录插入表中。
Notifications 目录
此目录默认不存在,但如果您执行 make:notification
Artisan 命令,则会为您创建。 Notifications
目录包含应用程序发送的所有“事务性”通知,例如有关应用程序内发生的事件的简单通知。 Laravel 的通知功能抽象了通过各种驱动程序发送通知,例如电子邮件、Slack、SMS 或存储在数据库中。
Policies 目录
该目录默认不存在,但如果您执行 make:policy
Artisan 命令,则会为您创建。 Policies
目录包含应用程序的 授权策略类。 策略用于确定用户是否可以对资源执行给定的操作。
Providers 目录
Providers
目录包含应用程序的所有 服务提供者。 服务提供者通过在服务容器中绑定服务、注册事件或执行任何其他任务来引导您的应用程序,以使您的应用程序为传入的请求做好准备。
在一个新的 Laravel 应用程序中,这个目录已经包含了几个提供者。 您可以根据需要自由地将自己的服务提供者添加到此目录中。
Rules 目录
此目录默认不存在,但如果您执行 make:rule
Artisan 命令,则会为您创建。 Rules
目录包含应用程序的自定义验证规则对象。 规则用于将复杂的验证逻辑封装在一个简单的对象中。 有关更多信息,请查看 验证文档。