本文主要讲解thinkphp8的命名规范,主要包括:遵循PHP自身的PSR-2命名规范和PSR-4自动加载规范、目录和文件命名规范、函数和类、属性命名规范、常量和配置命名规范、数据表和字段命名规范、不能使用PHP保留字。
在使用thinkphp8开发项目之前,应理解并尽量遵循以下命名规范,可以减少在开发过程中出现不必要的错误。
一、遵循PHP自身的PSR-2命名规范和PSR-4自动加载规范
二、目录和文件命名规范
目录使用小写+下划线;
类库、函数文件统一以.php为后缀;
类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;
类(包含接口和Trait)文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名;
类名(包括接口和Trait)和文件名保持一致,统一采用驼峰法命名(首字母大写);
三、函数和类、属性命名规范
类的命名采用驼峰法(首字母大写),例如 User、UserType;
函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_client_ip;
方法的命名使用驼峰法(首字母小写),例如 getUserName;
属性的命名使用驼峰法(首字母小写),例如 tableName、instance;
特例:以双下划线__打头的函数或方法作为魔术方法,例如 __call 和 __autoload;
四、常量和配置命名规范
常量以大写字母和下划线命名,例如 APP_PATH;
配置参数以小写字母和下划线命名,例如 url_route_on 和url_convert;
环境变量定义使用大写字母和下划线命名,例如APP_DEBUG;
五、数据表和字段命名规范
数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 think_user 表和 user_name字段,不建议使用驼峰和中文作为数据表及字段命名。
六、不能使用PHP保留字
不能使用PHP保留字作为常量、类名和方法名,以及命名空间的命名,否则会造成系统错误。
1、关键词在 PHP 中有着特定的语法和功能,通过它们可以实现不同的编程逻辑和控制流程,从而构建出功能丰富的 PHP 应用程序。
2、这些词语在 PHP 中有着特殊的意义。
3、它们中有些像是函数,有些像是常量,但是它们不是真的,它们只是语言结构的一部分。
4、不能使用它们的任何一个作为常量、类名或函数名。
5、它们可以被用作类的属性、常量以及类的方法名,或者接口名和 traits 名,除了 class 不能被用作常量名。
关键词列表(一行五个)
function、global、goto、if、implements
include、include_once、instanceof、insteadof、interface
isset()、list()、match、namespace、new
or、print、private、protected、public
readonly、require、require_once、return、static
switch、throw、trait、try、unset()
use、var、while、xor、yield
yield from
编译时常量
__CLASS__、__DIR__、__FILE__、__FUNCTION__、__LINE__、__METHOD__、__NAMESPACE__、__TRAIT__
PSR-2命名规范、PSR-4自动加载规范及以上关键字的意思,到时候我们重新发文,进行详细解释。