目录结构
介绍
默认的 Laravel 应用程序结构旨在为大型和小型应用程序提供一个良好的起点。但是你可以自由地组织你的应用程序。只要 Composer 可以自动加载类,Laravel 几乎不限制任何给点类的位置。
根目录
App 目录
app
目录包含应用程序的核心代码,我们将在稍后详细探讨该目录;不管怎样,应用程序中几乎所有的类都位于此目录中。
Bootstrap 目录
bootstrap
目录包含了框架的启动文件 app.php
。该目录还包含一个 cache
目录,其中包含框架生成的文件,这些文件用于性能优化,例如路由和服务缓存文件。你通常不需要修改此目录中的任何文件。
Config 目录
顾名思义,config
目录包含应用程序的所有配置文件。最好把这些文件都浏览一遍,并熟悉所有可用的选项。
Database 目录
database
目录包含数据库迁移,模型工厂和种子生成器文件。如果你愿意,你还可以把它作为 SQLite 数据库存放目录。
Public 目录
public
目录包含 index.php
文件,该文件是进入你应用程序的所有请求的入口,并配置自动加载。该目录还包含你的资源,如图像、JavaScript 脚本和 CSS 样式。
Resources 目录
resources
目录包含了 views 以及未编译的资源文件(如 CSS 或 JavaScript)。此目录还包含所有的语言文件。
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
中间件组中的路由。这些路由是无状态的,因此通过这些路由进入应用程序的请求将 通过令牌 进行身份验证,并且将无法访问会话状态。
console.php
文件中定义所有基于闭包的控制台命令。每个闭包都被绑定到一个命令实例,从而允许一种简单的方法与每个命令的 IO 方法进行交互。即使此文件未定义 HTTP 路由,它仍定义了应用程序中基于控制台的入口点 (路由) 。
channels.php
文件是你可以注册应用程序支持的所有 事件广播 频道的位置。
Storage 目录
storage
目录包含了你的日志文件,已编译的 Blade 模版,基于文件的会话,文件缓存以及框架生成的其他文件。该目录分为 app
,framework
和 logs
目录。app
目录可用于存储应用程序生成的任何文件。framework
目录用于存储框架生成的文件和缓存。最后,logs
目录包含应用程序的日志文件。
storage/app/public
目录用来存储用户生成的文件,例如个人资料,这些文件应该是可以公开访问的。你应该在 public/storage
处创建一个指向到该目录的链接。你可以使用 php artisan storage:link
命令来创建链接。
Tests 目录
tests
目录包含自动化测试类。开箱即用的示例 PHPUnit 单元测试和功能测试。每个测试类都应该以单词 Test
作为后缀。你可以使用 phpunit
或 php vendor/bin/phpunit
命令运行测试。或者,如果你想更详细,更漂亮地表示测试结果,则可以使用 php artisan test
命令运行测试。
Vendor 目录
vendor
目录包含你的 Composer 依赖。
App 目录
应用程序的大部分都位于 app
目录中。默认情况下,此目录的名称空间在 App
下,并由 Composer 使用 PSR-4 自动加载 自动加载。
app
目录包含各种目录,如 Console
、Http
和 Providers
。可以将 Console
和 Http
目录看作是为应用程序的核心提供了一个API。HTTP 协议和 CLI 都是与应用程序交互的机制,但实际上并不包含应用程序逻辑。换句话说,它们是向应用程序发出命令的两种方式。Console
目录包含所有 Artisan 命令,而 Http
目录包含控制器、中间件和请求。
当你使用 Artisan 命令 make
生成类时,将在 app
目录内生成各种目录。因此,例如当你执行 make:job
命令生成队列任务时,将会生成 app/Jobs
目录。
技巧:
app
目录中的许多类可以由 Artisan 通过命令生成。要查看可用的命令,请在终端中运行php artisan list make
命令。
Broadcasting 目录
Broadcasting
目录包含应用程序的所有广播频道类,这些类都是通过 make:channel
命令生成的。这个目录默认是不存在的,但是当你创建第一个广播频道类时候时它会自动生成。要了解有关频道的更多信息,请查看 广播系统。
Console 目录
Console
目录包含应用所有自定义的 Artisan 命令, 这些类通过 make:command
命令生成。 此目录也安置了控制台内核,在其中你可以注册自定义的 Artisan 命令,并定义 计划任务。
Events 目录
该目录默认不存在,但可以通过 event:generate
和 make:event
命令创建。Events
目录用于存放 事件类。事件类用于告知应用其他部分某个事件发生情况并提供灵活的、解耦的处理机制。
Exceptions 目录
Exceptions
目录包含应用的异常处理器,同时还是处理应用抛出的所有异常的好地方。如果你想要自定义异常的记录或呈现方式,需要编辑该目录下的 Handler
类。
Http 目录
Http
目录包含了控制器、中间件以及表单请求等,几乎所有通过 Web 进入应用的请求的逻辑都在这里进行。
Jobs 目录
该目录默认不存在,但可以通过执行 make:job
命令生成,Jobs
目录用于存放 队列任务,应用中的任务可以被推送至队列,也可以在当前请求生命周期内同步执行。同步执行的任务有时也被看作是命令,因为它们实现了 命令模式。
Listeners 目录
默认情况下,此目录不存在,但如果你执行 event:generate
或 make:listener
Artisan命令时,会自动生成。Listeners
目录包含所有处理 事件 的类。在事件触发后,事件侦听器接收事件实例并执行处理逻辑。例如,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
目录包含应用程序用户自定义的验证规则。这些验证规则用于将复杂的验证逻辑封装在一个简单的对象中。有关更多信息,请查看 表单验证。