Laravel应用的默认结构旨在为各种规模的应用程序提供出色的起点。然而,可以按照自己的喜好自由地组织应用程序。Laravel几乎不对任何给定类的位置施加限制-只要Composer能够自动加载该类。本教程主要介绍Laravel的目录结构。
一、根目录
1、app目录
app目录包含应用程序的核心代码。我们将很快更详细地探索这个目录;然而,应用程序中几乎所有的类都将位于此目录。
2、bootstrap目录
bootstrap目录包含引导框架的app.php文件。此目录还包含一个cache目录,其中包含用于性能优化的框架生成文件,例如路由和服务缓存文件。
3、config目录
config目录包含应用程序的所有配置文件。
4、database目录
database目录包含数据库迁移、模型工厂和种子文件。如果愿意,还可以使用此目录来保存SQLite数据库。
5、public目录
public目录包含index.php文件,这是所有请求进入应用程序的入口点,并配置自动加载。此目录还包含资产,如图像、JavaScript和CSS。
6、resources目录
resources目录包含视图以及原始的、未编译的资产,如CSS或JavaScript。
7、routes目录
routes目录包含应用程序的所有路由定义。默认情况下,Laravel附带了两个路由文件:web.php和console.php。
web.php文件包含Laravel放置在web中间件组中的路由,该组提供会话状态、CSRF保护和cookie加密。如果应用程序不提供无状态的、RESTfulAPI,则所有路由很可能都将在web.php文件中定义;
console.php文件是可以定义所有基于闭包的控制台命令的地方。每个闭包都绑定到一个命令实例,允许简单地与每个命令的IO方法进行交互。尽管此文件不定义HTTP路由,它定义了基于控制台的应用程序入口点(路由)。还可以在console.php文件中安排任务;
如果需要,可以通过install:api和install:broadcastingArtisan命令安装额外的API路由(api.php)和广播频道(channels.php)文件;
api.php文件包含旨在无状态的路由,因此通过这些路由进入应用程序的请求旨在通过令牌进行认证,并且不会访问会话状态;
channels.php文件是可以注册应用程序支持的所有事件广播频道的地方。
8、storage目录
storage目录包含日志、编译的Blade模板、基于文件的会话、文件缓存以及框架生成的其他文件。此目录分为app、framework和logs目录。app目录可用于存储应用程序生成的任何文件。framework目录用于存储框架生成的文件和缓存。最后,logs目录包含应用程序的日志文件。
storage/app/public目录可用于存储用户生成的文件,如应该公开访问的个人资料头像。应该在public/storage创建指向此目录的符号链接。可以使用phpartisanstorage:linkArtisan命令创建链接。
9、tests目录
tests目录包含自动化测试。默认情况下提供了Pest或PHPUnit单元测试和功能测试示例。每个测试类应以Test单词为后缀。可以使用/vendor/bin/pest或/vendor/bin/phpunit命令运行测试。或者,如果希望对测试结果有更详细和美观的表示,可以使用phpartisantestArtisan命令运行测试。
10、vendor目录
vendor目录包含Composer依赖项。
二、App目录
应用程序的大部分内容都位于app目录中。默认情况下,此目录在App命名空间下,并通过Composer使用PSR-4自动加载标准自动加载。
默认情况下,app目录包含Http、Models和Providers目录。然而,随着时间的推移,当使用makeArtisan命令生成类时,app目录内将生成各种其他目录。例如,直到执行make:commandArtisan命令生成命令类时,app/Console目录才会存在。
Console和Http目录在下面的各自部分中进一步解释,但可以将Console和Http目录视为提供进入应用程序核心的API。HTTP协议和CLI都是与应用程序交互的机制,但实际上不包含应用程序逻辑。换句话说,它们是向应用程序发出命令的两种方式。Console目录包含所有的Artisan命令,而Http目录包含控制器、中间件和请求。
>`app`目录中的许多类都可以通过Artisan命令生成。要查看可用命令,请在终端中运行`phpartisanlistmake`命令。
1、Broadcasting目录
Broadcasting目录包含应用程序的所有广播频道类。这些类是使用make:channel命令生成的。默认情况下,这个目录不存在,但当你创建第一个频道时,它将为你创建。要了解更多关于频道的信息,请查看事件广播文档。
2、Console目录
Console目录包含应用程序的所有自定义Artisan命令。这些命令可以使用make:command命令生成。
3、Events目录
默认情况下,这个目录不存在,但当你使用event:generate和make:eventArtisan命令时,它将为你创建。Events目录包含事件类。事件可用于提醒应用程序的其他部分某个给定动作已经发生,提供了极大的灵活性和解耦。
4、Exceptions目录
Exceptions目录包含应用程序的所有自定义异常。这些异常可以使用make:exception命令生成。
5、Http目录
Http目录包含控制器、中间件和表单请求。几乎所有处理进入应用程序的请求的逻辑都将放在此目录中。
6、Jobs目录
默认情况下,这个目录不存在,但如果执行make:jobArtisan命令,它将为创建。Jobs目录包含应用程序的可队列化作业。作业可以由应用程序排队,或在当前请求生命周期内同步运行。在当前请求期间同步运行的作业有时被称为“命令”,因为它们是命令模式的实现。
7、Listeners目录
默认情况下,这个目录不存在,但如果执行event:generate或make:listenerArtisan命令,它将为创建。Listeners目录包含处理事件的类。事件监听器接收事件实例并对事件触发时执行逻辑。例如,UserRegistered事件可能由SendWelcomeEmail监听器处理。
8、Mail目录
默认情况下,这个目录不存在,但如果执行make:mailArtisan命令,它将为创建。Mail目录包含由应用程序发送的所有代表电子邮件的类。邮件对象允许将构建电子邮件的所有逻辑封装在一个简单的类中,该类可以使用Mail::send方法发送。
9、Models目录
Models目录包含所有的Eloquent模型类。Laravel提供的EloquentORM提供了一个美观、简单的ActiveRecord实现,用于处理数据库。每个数据库表都有一个对应的“模型”,用于与该表交互。模型允许查询表中的数据,以及向表中插入新记录。
10、Notifications目录
默认情况下,这个目录不存在,但如果执行make:notificationArtisan命令,它将为创建。Notifications目录包含应用程序发送的所有“事务性”通知,例如关于应用程序内发生的事件的简单通知。Laravel的通知功能抽象了通过多种驱动程序(如电子邮件、Slack、SMS或存储在数据库中)发送通知的功能。
11、Policies目录
默认情况下,这个目录不存在,但如果执行make:policyArtisan命令,它将为创建。Policies目录包含应用程序的授权策略类。策略用于确定用户是否可以对资源执行给定操作。
12、Providers目录
Providers目录包含应用程序的所有服务提供者。服务提供者通过在服务容器中绑定服务、注册事件或执行任何其他任务来为接收请求的应用程序做准备。
在新的Laravel应用程序中,此目录将已经包含AppServiceProvider。可以根据需要向此目录添加自己的提供者。
13、Rules目录
默认情况下,这个目录不存在,但如果执行make:ruleArtisan命令,它将为创建。Rules目录包含应用程序的自定义验证规则对象。