2019-01-14

前言:


为方便自己或者后人阅读之前写的代码,写php的要求遵循以下代码规范,大家看一看,不强求全部做到,尽量做到即可。
参考自ThinkPHP项目及代码规范指北PSR-1 基础编码规范PSR-2 编码风格规范

编写规范


  • 新项目至少使用tp5.0以上的框架,尽量遵循MVC架构

  • 代码 必须 使用 4 个空格来进行缩进。

  • 类的开始花括号({)写在函数声明后自成一行,结束花括号(})也写在函数主体后自成一行。

class Lottery extends Controller
{
}
  • 方法的开始花括号({)写在函数声明后自成一行,结束花括号(})也写在函数主体后自成一行。
public function index()
{
}
  • 控制结构的开始花括号({)写在声明的同一行,而结束花括号(})写在主体后自成一行。
for ($i = 0; $i < 10; $i++) {
    // for 循环主体
}

类和文件命名


  • 类(包括接口、Trait)文件名和类名保持一致,并且使用首字母大写的驼峰命名;

  • 函数文件、配置文件、路由定义文件等文件名使用小写规范;

  • 无论类还是普通文件都使用.php后缀;

  • 目录名统一使用小写规范,并且使用单数规范;

  • 模板文件使用小写规范;

配置和变量命名


  • 配置参数名统一使用小写规范;

  • 常量定义统一使用大写规范;

  • 环境变量定义统一使用大写规范;

函数和类、属性命名


  • 函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_client_ip

  • 方法的命名使用驼峰法(首字母小写),例如getUserName

  • 属性的命名使用驼峰法(首字母小写),例如 tableNameinstance

  • 特例:以双下划线__打头的函数或方法作为魔术方法,例如__call__callStatic

数据表命名


数据表和字段采用小写加下划线方式命名,例如 think_user表和 user_name字段,禁止使用驼峰、中文或者拼音作为数据表及字段命名。

控制器规范


  • 控制器建议继承一个公共的控制器类,便于统一调整和增加通用逻辑。并建议继承系统的控制器类,以便于使用控制器中间件功能。

  • 对于控制器操作方法的拦截以及统一处理应当使用中间件独立操作。

  • 控制器的代码应当尽量少,以确保逻辑清晰和可读性。始终保持controller层作为访问控制器层的名称。

  • 请求数据的验证操作统一使用验证器进行验证。

  • 不要在操作方法中输出除了调试信息之外的任何内容,而是通过return返回需要输出的内容。

  • 操作方法中始终明确响应输出的类型,而不要依赖全局配置。

数据库和模型规范


  • 主键统一使用id

  • 外键统一使用resource_id形式(例如user_id);

  • 模型数据字段统一使用小写+下划线命名,和数据表字段规范一致;

  • 数据表统一添加系统时间字段(create_timeupdate_time);

  • 当使用软删除,添加时间字段delete_time,类型和系统时间字段保持一致;

  • 模型类应该继承一个统一的公共类,便于调整和统一设置;

模板规范


  • 模板文件应当引入一个公共模板,用于引入公共的css、js文件

  • 模板文件应当使用操作方法转换为小写+下划线方式命名;

  • 当你需要跨模块调用的时候,尽量在控制器操作方法中明确要渲染的模板;

  • 避免在模板文件中添加逻辑代码,应当只是数据的输出;

  • 使用static目录统一存放静态资源文件;

Api规范


  • 待更新···
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,100评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,308评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,718评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,275评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,376评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,454评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,464评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,248评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,686评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,974评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,150评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,817评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,484评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,140评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,374评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,012评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,041评论 2 351

推荐阅读更多精彩内容