PHP开发规范总结

php中世界最好的语言
发布: 2023-03-26 19:36:02
原创
1254 人浏览过

这次给大家带来PHP开发规范总结,PHP开发规范的注意事项有哪些,下面就是实战案例,一起来看一下。

基本约定

源文件

代码使用

文件格式必须是无BOM UTF-8格式

一个文件只声明一种类型,如class和interface不能混写在一个源文件中

缩进

使用4个空格来缩进,IDE可以设置

行长度

每行120个字符

关键字

所有关键字均为小写,如true、false

命名

类名为大驼峰法,如UserModel

类方法名为小驼峰法,如getUserId()

函数使用小写字母加_组合,如get_cookie()

变量名使用小驼峰法,如$userId

常量定义为大写字母加_组合,如IS_DEBUG

代码注释标签

类文件中对类、方法、属性进行注释,使用@param @return @throwns

@param注释写出详解,如@param string $username 用户名

业务模块

路由为小写字母加_组成,如/api/get_user_info

View层负责数据展示

Controller层负责输入参数校验,最外层捕捉异常,调用Logic和View视图层

Logic层负责具体业务逻辑,调用Model层,返回处理数据

Model层负责数据表查询和关联关系

异常类需分清功能,如ParamException表示参数错误,UserException表示自定义异常

异常需分类定义code,使用PHP类常量代替,如


        
登录后复制

数据表文件如有Enum类型,使用PHP类常量代替,如


        
登录后复制

其中STATUS和AUTH为数据表映射字段名

Api接口输出,示例

{ "code" : 0, "msg" : "success", "data" : { "userId" : 100 } }
登录后复制

其中code与msg为必填字段,data为空的情况下不填,示例

{ "code" : 100001, "msg" : "不具有权限" }
登录后复制

其它

数组,键为字符串时候使用单引号,只有一个键时候使用单行,示例

$arr = [ 'userId' => 100 ];
登录后复制

多个键时候使用多行,示例

$arr = [ 'id' => 100, 'username' => 'admin', ];
登录后复制

字符串使用单引号'

相信看了本文案例你已经掌握了方法,更多精彩请关注php中文网其它相关文章!

推荐阅读:

PHP对源代码加密方法总结

如何实现php删除固定路径下文件夹与文件

以上是PHP开发规范总结的详细内容。更多信息请关注PHP中文网其他相关文章!

相关标签:
来源:php.cn
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责声明 Sitemap
PHP中文网:公益在线PHP培训,帮助PHP学习者快速成长!