开发规范和目录结构

179 阅读2分钟

一.开发规范

1. ThinkPHP6.x 遵循的是 PSR-2 的命名规范和 PSR-4 的自动加载;

2. 目录和文件的规范如下:

  1. 目录名(小写+下划线);
  2. 类库和函数文件统一以.php 为后缀;
  3. 类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径 一致;
  4. 类(包含接口和 Trait)文件采用驼峰式命名(首字母大写),其它采用 小写+下划线命名;
  5. 类名(包括接口和 Trait)和文件名保持一致,统一采用驼峰式命名 (首字母大写);

3. 函数和类、属性命名规范如下:

  1. 类的命名采用驼峰法(首字母大写),如:User、UserType;
  2. 函数的命名使用小写字母和下划线(小写字母开头)的方式, 如:get_client_ip;
  3. 方法的命名使用驼峰法(首字母小写),如:getUserName;
  4. 属性的命名使用驼峰法(首字母小写),如:tableName;
  5. 特例:以双下划线**打头的函数或方法作为魔术方法,如: **call 和 __autoload;

4. 常量与配置的规范如下:

  1. 常量以大写字母和下划线命名,如:APP_PATH;
  2. 配置参数以小写字母和下划线命名,如:url_convert;
  3. 环境变量定义使用大写字母和下划线命名,如:APP_DEBUG;
  4. 数据表和字段的规范如下:
  5. 数据表和字段采用小写加下划线方式命名;
  6. 并注意字段名不要以下划线开头,如: think_user 表和 user_name
  7. 字段不建议使用驼峰和中文作为数据表及字段命名;

二.目录结构

1. ThinkPHP6.x 支持多应用模式部署,app 是应用目录;

2. 默认情况下,是采用的单模式,如下图结构:

单应用模式.png

3. 多应用模式下,结构如下图:

多应用模式.png

4. 上图中,app_name 可以有多个,即多应用模式;

5. 在目录结构上,只确保对外可访问的仅 public 目录;

在 linux 环境下,需要设置 runtime 目录权限为 777

6. 在 app 目录中,还有如下文件

app应用目录.png