未加星标

浅析PHP开发规范

字体大小 | |
[开发(php) 所属分类 开发(php) | 发布者 店小二05 | 时间 | 作者 红领巾 ] 0人收藏点击收藏

基本约定

源文件
代码使用<?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类常量代替,如

<?php
namespace app\exceptions\codes;
class UserExceptionCode extends BaseExceptionCode {
const NO_AUTH = 1000001;
const NO_AUTH_MSG = '不具有权限';
const STATUS_EXCEPTION = 1000002;
const STATUS_EXCEPTION_MSG = '状态异常';
}

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

<?php
namespace app\enums;
class UserEnum extends BaseEnum {
const STATUS_DELETED = -1;// 已删除
const STATUS_DISABLE = 0;// 禁用
const STATUS_ENABLE = 1;// 正常
const AUTH_GUEST = 1;// 匿名用户
const AUTH_GENERAL_ADMIN = 2;// 普通管理员
const AUTH_SUPER_ADMIN = 3;// 超级管理员
}
其中STATUS和AUTH为数据表映射字段名

Api接口输出,示例

{
"code" : 0,
"msg" : "success",
"data" : {
"userId" : 100
}
}

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

{
"code" : 100001,
"msg" : "不具有权限"
}
其它

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

$arr = [ 'userId' => 100 ];

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

$arr = [
'id' => 100,
'username' => 'admin',
];

字符串使用单引号'


您可能感兴趣的文章:thinkPHP5.0框架开发规范简介浅析php与数据库代码开发规范PHP开发规范手册之PHP代码规范详解

本文开发(php)相关术语:php代码审计工具 php开发工程师 移动开发者大会 移动互联网开发 web开发工程师 软件开发流程 软件开发工程师

主题: PHPUT数据AUAUTTIADMSGSU关联关系
tags: const,AUTH,STATUS,PHP,gt,code,#63,示例,msg,param,class,lt,userId
分页:12
转载请注明
本文标题:浅析PHP开发规范
本站链接:https://www.codesec.net/view/572356.html


1.凡CodeSecTeam转载的文章,均出自其它媒体或其他官网介绍,目的在于传递更多的信息,并不代表本站赞同其观点和其真实性负责;
2.转载的文章仅代表原创作者观点,与本站无关。其原创性以及文中陈述文字和内容未经本站证实,本站对该文以及其中全部或者部分内容、文字的真实性、完整性、及时性,不作出任何保证或承若;
3.如本站转载稿涉及版权等问题,请作者及时联系本站,我们会及时处理。
登录后可拥有收藏文章、关注作者等权限...
技术大类 技术大类 | 开发(php) | 评论(0) | 阅读(92)