ThinkPHP5——2 命名规范与目录结构

一、命名方法

1、匈牙利命名法：
     标识符中的每个单词之间用下划线分隔：use_name;
2、驼峰命名法：
     标识符中的每个单词的首字母大写，用大写字母来分隔，根据 首字母是否大写又分为：
    1.大驼峰:首字母大写，常用作类名：ClassName,又称:帕斯卡命名法
    2. 小蛇峰:除第一个单词外，每个单词首字母大写,常用作类属性和方法:$useName

二、命名规范

1、目录与文件

类型	命名规范	实例
目录	小写字母/小写字母+下划线	user/user_type
类文件（驼峰法）	命名空间与文件真实路径完全一致	app\index\controller
	类名与文件名保持一致（首字母大写）	User.php中只有User类
其他文件	小写字母/小写字母+下划线	list.php / list_user.php

 

 

 

 

 

 

2、函数与类属性与方法

类型	命名规范	实例
函数	匈牙利命名法（小写字母+下划线）	get_user_type()
类的方法	驼峰法（首字母小写）	getName()
类的属性	驼峰法（首字母小写）	userType
魔术方法	双下划线开头+驼峰法	__set(), __callStatic()

 

 

 

 

 

3、常量与参数的配置

类型	命名规范	实例
常量	匈牙利命名法（大写字母+下划线）	APP_PATH
配置参数	匈牙利命名法（小写字母+下划线）	url_route_on

 

 

 

4、数据库与字段

类型	命名规范	实例
数据表	小写字母+下划线，前缀用数据库名	tp5_staff
字段	小写字母+下划线，前缀用表名	staff_name

 

 

 

三、目录结构

www  WEB部署目录（或者子目录）
├─application           应用目录
│  ├─common             公共模块目录（可以更改）
│  ├─module_name        模块目录
│  │  ├─common.php      模块函数文件
│  │  ├─controller      控制器目录
│  │  ├─model           模型目录
│  │  ├─view            视图目录
│  │  └─ ...            更多类库目录
│  │
│  ├─command.php        命令行定义文件
│  ├─common.php         公共函数文件
│  └─tags.php           应用行为扩展定义文件
│
├─config                应用配置目录
│  ├─module_name        模块配置目录
│  │  ├─database.php    数据库配置
│  │  ├─cache           缓存配置
│  │  └─ ...            
│  │
│  ├─app.php            应用配置
│  ├─cache.php          缓存配置
│  ├─cookie.php         Cookie配置
│  ├─database.php       数据库配置
│  ├─log.php            日志配置
│  ├─session.php        Session配置
│  ├─template.php       模板引擎配置
│  └─trace.php          Trace配置
│
├─route                 路由定义目录
│  ├─route.php          路由定义
│  └─...                更多
│
├─public                WEB目录（对外访问目录）
│  ├─index.php          入口文件
│  ├─router.php         快速测试文件
│  └─.htaccess          用于apache的重写
│
├─thinkphp              框架系统目录
│  ├─lang               语言文件目录
│  ├─library            框架类库目录
│  │  ├─think           Think类库包目录
│  │  └─traits          系统Trait目录
│  │
│  ├─tpl                系统模板目录
│  ├─base.php           基础定义文件
│  ├─console.php        控制台入口文件
│  ├─convention.php     框架惯例配置文件
│  ├─helper.php         助手函数文件
│  ├─phpunit.xml        phpunit配置文件
│  └─start.php          框架入口文件
│
├─extend                扩展类库目录
├─runtime               应用的运行时目录（可写，可定制）
├─vendor                第三方类库目录（Composer依赖库）
├─build.php             自动生成定义文件（参考）
├─composer.json         composer 定义文件
├─LICENSE.txt           授权说明文件
├─README.md             README 文件
├─think                 命令行入口文件