开发规范

命名规范

请理解并尽量遵循以下命名规范,可以减少在开发过程中出现不必要的错误。

目录和文件

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

函数和类、属性命名

  • 类的命名采用驼峰法(首字母大写),例如 User、UserType;
  • 函数的命名采用驼峰法(首字母小写),例如 getClientIp;
  • 方法的命名使用驼峰法(首字母小写),例如 getUserName;
  • 属性的命名使用驼峰法(首字母小写),例如 tableName、instance;
  • 特例:以双下划线__打头的函数或方法作为魔术方法,例如 __call 和 __autoload;

常量和配置

  • 常量以大写字母和下划线命名,例如 APP_PATH;
  • 配置参数以小写字母和下划线命名,例如 url_route_on 和url_convert;
  • 环境变量定义使用大写字母和下划线命名,例如APP_DEBUG;

数据表和字段

  • 数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 think_user 表和 user_name字段,不建议使用驼峰和中文作为数据表及字段命名。

代码规范

  • 严格遵循PSR-2 编码规范
  • 避免在视图中编写复杂的逻辑,保持视图简洁
  • 使用服务层来处理业务逻辑,控制器只负责接收请求和返回响应
  • 避免直接在控制器中操作数据库,应该使用模型来处理数据库操作

安全规范

  • 避免直接拼接SQL 语句,应该使用参数绑定或者查询构造器
  • 对用户输入的数据进行有效验证和过滤,以防止SQL注入等安全问题
  • 对敏感数据进行加密存储

注释规范

  • 代码中应包含清晰的注释,解释代码的作用和逻辑
  • 注释应该是清晰、简洁并且易于理解
  • 注释应该随代码一起更新,保持与代码的一致性
大纲
命名规范
目录和文件
函数和类、属性命名
常量和配置
数据表和字段
代码规范
安全规范
注释规范