PHP框架:Laravel – 项目目录结构介绍, Laravel目录结构, Laravel 各文件夹功能说明, Laravel 文件夹结构
当一个 Laravel 项目创建完毕后,默认的目录结构如下:
1,app 目录
(2)app 目录下包含多个子目录,分别如下:
- Console 目录:该包含应用所有自定义的 Artisan 命令,这些命令类可以使用 make:command 命令生成。该目录下还有 Console/Kernel 类,在这里可以注册自定义的 Artisan 命令以及定义调度任务。
- Exceptions 目录:该目录包含应用的异常处理器,同时还是处理应用抛出的任何异常的好地方。如果你想要自定义异常如何记录或渲染,需要编辑该目录下的 Handler 类。
- Http 目录:该目录包含了控制器、中间件以及表单请求等,几乎所有通过 Web 进入应用的请求处理都在这里进行。
- Providers 目录:该目录包含应用的所有服务提供者。服务提供者在应用启动过程中绑定服务到容器、注册事件以及执行其他任务为即将到来的请求处理做好准备工作。在新安装的 Laravel 应用中,该目录已经包含了一些服务提供者,我们可以按需添加自己的服务提供者到该目录。
2,bootstrap 目录
- app.php:用于框架的启动和自动载入配置
- cache 文件夹:里面包含了框架为提升性能所生成的文件,如路由和服务缓存文件
3,config 目录
4,database 目录
5,public 目录
6,resources 目录
7,routes 目录
- web.php:该文件包含的路由通过 RouteServiceProvider 引入,都被约束在 web 中间件组中,因而支持 Session、CSRF 保护以及 Cookie 加密功能,如果应用无需提供无状态的、RESTful 风格的 API,那么路由基本上都要定义在 web.php 文件中。
- api.php:该文件包含的路由通过 RouteServiceProvider 引入,都被约束在 api 中间件组中,因而支持频率限制功能,这些路由是无状态的,所以请求通过这些路由进入应用需要通过 token 进行认证并且不能访问 Session 状态。
- console.php:该文件用于定义所有基于闭包的控制台命令,每个闭包都被绑定到一个控制台命令并且允许与命令行 IO 方法进行交互,尽管这个文件并不定义 HTTP 路由,但是它定义了基于控制台的应用入口(路由)。
- channels.php:该文件用于注册应用支持的所有事件广播频道。
8,storage 目录
- app 目录用于存放应用生成的文件
- framework 目录用于存放框架生成的文件和缓存
- logs 目录存放的是应用的日志文件。
9,tests 目录
10,vendor 目录
顶级目录 |
作用 |
app |
主要包含应用程序的核心代码,用户构建应用的大部分工作都在这个目录下进行,包括路由文件、控制器文件、模型文件等 |
bootstrap |
主要包含几个框架启动和自动加载配置的文件 |
config |
主要包含应用程序常用的配置文件信息 |
database |
主要包含数据库迁移和数据填充文件 |
public |
为应用程序的入口目录,包含应用程序入口文件index.php,同时包含静态资源文件:如CSS、Javascript、images等 |
resources |
主要包含视图文件 |
store |
包含编译后的Blade模板,基于文件 session、文件缓存和日志等文件 |
tests |
主要包含自动化测试文件 |
vendor |
主要包含依赖库文件,其中包含Laravel框架的源代码 |
.env文件 |
一个重要的文件,为Laravel框架主配置文件 |
composer.json |
composer项目依赖管理文件 |
应用程序 大部分内容都存在于app目录下,该目录通过composer使用自动加载标注(PSR-4)来自动加载其中的文件。
该目录下的组织结构
目录 |
作用 |
Console |
主要包含所有的artisan命令 |
Events |
用来放置于事件相关的类 |
Exceptions |
包含应用程序的异常处理类,用于处理应用程序抛出的任何异常 |
Http |
主要包含路由文件、控制器文件、请求文件、中间件文件等,是应用程序与Laravel框架源代码等外部库交互 主要地方 |
Jobs |
主要包含消息队列的各种消息类文件 |
Listeners |
主要包含监听事件类文件 |
Providers |
主要包含服务提供者的相关文件 |
vendor目录主要包含Laravel应用程序的外部依赖库,包括Laravel框架的源代码部分。该目录种文件的组织结构是根据依赖关系决定 ,每一个文件夹都是一个功能模块,可以单独通过composer下载该组件进行使用,相当于整个Vendor目录就是一个个相互依赖的功能组件模块组织起来的,它们可以独立工作,也可以被组织起来协调工作,下面介绍几个主要的目录结构:
目录 |
作用 |
composer |
主要包括composer按照PSR规范生成的自动加载类,应用程序 的自动加载都是由这部分实现 |
laravel |
包含Laravel框架源代码,代码部分都包含爱vendor\laravel\framework\src\Illuminate文件夹下,在该文件夹下又包含很多文件夹,每一个文件夹又是一个组件,如用于管理session的session组件、用于实现路由功能的routing组件,这些组件都是可以独立工作的 |
symfony |
Laravel的底层(如请求类、响应类、文件管理类等)使用了symfony框架的部分 |
monolog |
包含日志记录模块文件 |
phpunit |
包含程序单元测试模块文件 |
这是之前的整理,留下来做参考吧:
以下为5.2的目录结构,还未修改成5.4版本,引用自:Laravel5.2目录结构及composer.json文件解析
|– app 包含Controller、Model、路由等在内的应用目录,大部分业务将在该目录下进行
| |– Console 命令行程序目录
| | |– Commands 包含了用于命令行执行的类,可在该目录下自定义类
| | |– Kernel.php 命令调用内核文件,包含commands变量(命令清单,自定义的命令需加入到这里)和schedule方法(用于任务调度,即定时任务)
| |– Events 事件目录
| |– Exceptions 包含了自定义错误和异常处理类
| |– Http HTTP传输层相关的类目录
| | |– Controllers 控制器目录
| | |– Middleware 中间件目录
| | |– Requests 请求类目录
| | |– Kernel.php 包含http中间件和路由中间件的内核文件
| | |– routes.php 强大的路由
| |– Jobs 该目录下包含队列的任务类
| |– Listeners 监听器目录
| |– Providers 服务提供者目录
| |– User.php 自带的模型实例,我们新建的Model默认也存储在该目录
|– bootstrap 框架启动载入目录
| |– app.php 创建框架应用实例
| |– autoload.php 自动加载
| |– cache 存放框架启动缓存,web服务器需要有该目录的写入权限
|– config 各种配置文件的目录
| |– app.php 系统级配置文件
| |– auth.php 用户身份认证配置文件,指定好table和model就可以很方便地用身份认证功能了
| |– broadcasting.php 事件广播配置文件
| |– cache.php 缓存配置文件
| |– compile.php 编译额外文件和类需要的配置文件,一般用户很少用到
| |– database.php 数据库配置文件
| |– filesystems.php 文件系统配置文件,这里可以配置云存储参数
| |– mail.php 电子邮件配置文件
| |– queue.php 消息队列配置文件
| |– services.php 可存放第三方服务的配置信息
| |– session.php 配置session的存储方式、生命周期等信息
| |– view.php 模板文件配置文件,包含模板目录和编译目录等
|– database 数据库相关目录
| |– factories 5.1以上版本的新特性,工厂类目录,也是用于数据填充
| | |– ModelFactory.php 在该文件可定义不同Model所需填充的数据类型
| |– migrations 存储数据库迁移文件
| |– seeds 存放数据填充类的目录
| |– DatabaseSeeder.php 执行php artisan db:seed命令将会调用该类的run方法。该方法可调用执行该目录下其他Seeder类,也可调用factories方法生成ModelFactory里定义的数据模型
|– public 网站入口,应当将ip或域名指向该目录而不是根目录。可供外部访问的css、js和图片等资源皆放置于此
| |– index.php 入口文件
| |– .htaccess Apache服务器用该文件重写URL
| |– web.config IIS服务器用该文件重写URL
|– resources 资源文件目录
| |– assets 可存放包含LESS、SASS、CoffeeScript在内的原始资源文件
| |– lang 本地化文件目录
| |– views 视图文件就放在这啦
|– storage 存储目录。web服务器需要有该目录及所有子目录的写入权限
| |– app 可用于存储应用程序所需的一些文件
| |– framework 该目录下包括缓存、sessions和编译后的视图文件
| |– logs 日志目录
|– tests 测试目录
|– vendor 该目录下包含Laravel源代码和第三方依赖包
|– .env 环境配置文件。config目录下的配置文件会使用该文件里面的参数,不同生产环境使用不同的.env文件即可。
|– artisan 强大的命令行接口,你可以在app/Console/Commands下编写自定义命令
|– composer.json 存放依赖关系的文件
|– composer.lock 锁文件,存放安装时依赖包的真实版本
|– gulpfile.js gulp(一种前端构建工具)配置文件
|– package.json gulp配置文件
|– phpspec.yml phpspec(一种PHP测试框架)配置文件
|– phpunit.xml phpunit(一种PHP测试框架)配置文件
|– server.php PHP内置的Web服务器将把这个文件作为入口。以public/index.php为入口的可以忽略掉该文件
composer.json文件
{ "name": "laravel/laravel", //项目名称 "description": "The Laravel Framework.", //描述 "keywords": ["framework", "laravel"], //关键词 "license": "MIT", //许可协议 "type": "project", //类型 "require": { "php": ">=5.5.9", //PHP版本 "laravel/framework": "5.2.*" //框架版本 }, "require-dev": { //依赖包 "fzaninotto/faker": "~1.4", "mockery/mockery": "0.9.*", "phpunit/phpunit": "~4.0", "symfony/css-selector": "2.8.*|3.0.*", "symfony/dom-crawler": "2.8.*|3.0.*" }, "autoload": { //自动加载 "classmap": [ "database" ], "psr-4": { //一种自动加载的规范 "App\\": "app/" } }, "autoload-dev": { //加载测试 "classmap": [ "tests/TestCase.php" ] }, "scripts": { //执行脚本 "post-root-package-install": [ "php -r \"copy('.env.example', '.env');\"" ], "post-create-project-cmd": [ "php artisan key:generate" ], "post-install-cmd": [ "php artisan clear-compiled", "php artisan optimize" ], "post-update-cmd": [ "php artisan clear-compiled", "php artisan optimize" ] }, "config": { //配置项 "preferred-install": "dist" //优先安装压缩版 }, "repositories": { //配置composer镜像 "packagist": { "type": "composer", "url": "https://packagist.phpcomposer.com" } } }
本文:PHP框架:Laravel – 项目目录结构介绍, Laravel目录结构, Laravel 各文件夹功能说明, Laravel 文件夹结构