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