本文共 1036 字，大约阅读时间需要 3 分钟。

Laravel开发规范

一、概述

Laravel 5.5 是当前框架中最稳定的版本，公司将持续支持至 2019 年 6 月。为确保代码一致性和可维护性，我们制定本开发规范。

本规范适用于公司所有项目和开发人员，要求新旧员工均严格遵守。

二、开发环境

1. PHP开发环境

• 操作系统：Windows/Linux
• 数据库：MySQL 5.7
• PHP版本：PHP 7.0+
• 服务器：Nginx 1.0+

文件编码要求：utf-8 无 BOM 头

2. 服务器环境

• 操作系统：Linux（CentOS 7.2+）
• 数据库：MySQL 5.7+
• PHP版本：PHP 7.0+
• 服务器：Nginx 1.0+

三、命名规范

1. 文件和目录命名

• 目录使用小写字母，多字母时用中划线连接，如 easywechat-composer
• 类库文件以 .php 为后缀
• 类文件名以命名空间定义，命名空间与文件路径一致
• 类文件采用驼峰命名，其他文件用小写驼峰命名

2. 命名使用规范

• 类名用驼峰命名，例如 UserController
• 函数和属性用小写驼峰命名，例如 getUserName
• 常量用大写加划线命名，如 APP_PATH
• 配置参数用小写加划线命名，如 url_path
• 数据表字段命名用小写加划线，避免特殊字符

四、目录结构

严格遵循官方框架架构设计，确保业务逻辑与代码结构对称。

五、注释标准

方法注释需清晰说明用途、输入、输出，例如：

function example($param) {    // 获得用户信息    // $param: 用户ID    // 返回用户详细信息数组    return $user-> 詳細資料;}

六、输出标准

非报错或跳转页面输出，统一采用以下格式：

[    'status' => true|false,    'msg' => '错误信息',    'data' => []]

七、代码格式

1. 簡洁跨行

• 方法注释与方法之间不跨行
• 方法内 if 与循环前跨行
• 逻辑块按功能划分

2. 空格使用

• if 与括号间隔空格
• foreach 与括号间隔空格
• 逗号隔开变量后留空格

八、研发思想

1. 代码优雅性

• 使用合理的缩进和命名
• 优先复用逻辑模块
• پروptime化处理和缓存

2. 逻辑模块化

• 划分原子逻辑
• 高复用性设计

九、其他规定

十、参考文档

去除此处内容

转载地址：http://yfgyk.baihongyu.com/