| php代码规范 | ||||||||||||||||
|
1.命名规范 1.1.变量命名 1.1.1.普通变量 普通变量命名遵循以下规则： a． 所有字母都使用小写； b． 对于一个变量使用多个单词的，使用’_'作为每个词的间隔。 例如：$base_dir、$red_rose_price等 1.1.2.静态变量 静态变量命名遵循以下规则： a． 静态变量使用小写的s_开头； b． 静态变量所有字母都使用小写； c． 多个单词组成的变量名使用’_'作为每个词的间隔。 例子：$s_base_dir、$s_red_rose_prise等。 1.1.3.局部变量 局部变量命名遵循以下规则： a． 所有字母使用小写； b． 变量使用’_'开头； c． 多个单词组成的局部变量名使用’_'作为每个词间的间隔。 例子：$_base_dir、$_red_rose_price等。 1.1.4.全局变量 全局变量应该带前缀’g',知道一个变量的作用域是非常重要的。 例如 global $gLOG_LEVEL; global $gLOG_PATH; 1.1.5.全局常量 全局变量命名遵循以下规则： a． 所有字母使用大写 b． 全局变量多个单词间使用’_'作为间隔。 例子：$BASE_DIR、$RED_ROSE_PRICE等。 1.1.6.Session变量 session变量命名遵循以下规则： a． 所有字母使用大写； b． session变量名使用’S_’开头； c． 多个单词间使用’_'间隔。 例子：$S_BASE_DIR、$S_RED_ROSE_PRICE等。 1.2.类 php中类命名遵循以下规则： a． 以大写字母开头； b． 多个单词组成的变量名，单词之间不用间隔，各个单词首字母大写。 例子：class MyClass 或class DbOracle等。 1.2.1.方法和函数 方法或函数命名遵循以下规则： a． 首字母小写； b． 多个单词间不使用间隔，除第一个单词外，其他单词首字母大写。 例子：function myFunction ()或function myDbOracle ()等。 1.2.2.缩写词 当变量名或者其他命名中遇到缩写词时，参照具体的命名规则，而不采用缩写词原来的全部大写的方式。 例子：function myPear（不是myPEAR） functio getHtmlSource（不是getHTMLSource）。 1.2.3.数据库表名 数据库表名命名遵循以下规范： a． 表名均使用小写字母； b． 对于普通数据表，使用_t结尾； c． 对于视图，使用_v结尾； d． 对于多个单词组成的表名，使用_间隔； 例子：user_info_t和book_store_v等 新建数据表应该前面加功能前缀，例如嘉荣抢红包数据表建立 jr_redenvelope 活动主表，区分不同活动 jr_redenvelope_coupon_lib 卡券数据库 jr_redenvelope_coupon_lib_cancel 已经核销卡券数据库 jr_redenvelope_shake_record 用户摇红包记录 新建数据库、新建字段必须添加注释 1.2.4.数据库字段 数据库字段命名遵循以下规范： a． 全部使用小写； b． 多个单词间使用_间隔。 例子：user_name、rose_price等。 1.3.书写规则 书写规则是指在编写php程序时，代码书写的规则，包括缩进、结构控制等方面规范： 1.3.1.代码缩进 在书写代码的时候，必须注意代码的缩进规则，我们规定代码缩进规则如下： a． 使用4个空格作为缩进，而不使用tab缩进（对于ultraedit，可以进行预先设置） 例子： for ( $i=0;$i<$count;$i++ ) { echo "test"; } 1.3.2.大括号{ }书写规则 在程序中进行结构控制代码编写，如if、for、while、switch等结构，大括号传统的有两种书写习惯，分别如下： a．{直接跟在控制语句之后，不换行，如 for ($i=0;$i<$count;$i++) { echo "test"; } b．{在控制语句下一行，如 for($i=0;$i<$count;$i++) { echo "test"; } 其中，a是PEAR建议的方式，但是从实际书写中来讲，这并不影响程序的规范和影响用phpdoc实现文档，所以可以根据个人习惯来采用上面的两种方式，但是要求在同一个程序中，只使用其中一种，以免造成阅读的不方便。 1.3.3.小括号( )和函数、关键词等 小括号、关键词和函数遵循以下规则： a． 不要把小括号和关键词紧贴在一起，要用一个空格间隔；如if ( $a<$b )； b． 小括号和函数名间没有空格；如$test = date("ymdhis")； c． 除非必要，不要在Return返回语句中使用小括号。 如Return $a； 1.3.4.＝符号书写 在程序中=符号的书写遵循以下规则： a． 在=符号的两侧，均需留出一个空格；如$a = $b 、if ($a = = $b)等； b． 在一个申明块，或者实现同样功能的一个块中，要求=号尽量上下对其，左边可以为了保持对齐使用多个空格，而右边要求空一个空格；如下例： $testa = $aaa; $testaa = $bbb; $testaaa = $ccc; 1.3.5.if else swith for while等书写 对于控制结构的书写遵循以下规则： a． 在if条件判断中，如果用到常量判断条件，将常量放在等号或不等号的左边，例如： if ( 6 == $errorNum )，因为如果你在等式中漏了一个等号，语法检查器会为你报错，可以很快找到错误位置，这样的写法要多注意； b． switch结构中必须要有default块； c． 在for和wiile的循环使用中，要警惕continue、break的使用，避免产生类似goto的问题； 1.3.6.类的构造函数 如果要在类里面编写构造函数，必须遵循以下规则： a． 不能在构造函数中有太多实际操作，顶多用来初始化一些值和变量； b． 不能在构造函数中因为使用操作而返回false或者错误，因为在声明和实例化一个对象的时候，是不能返回错误的； 1.3.7.语句断行, 每行控制在80个字符以内 在代码书写中，遵循以下原则： a． 尽量保证程序语句一行就是一句，而不要让一行语句太长产生折行； b． 尽量不要使一行的代码太长，一般控制在80个字符以内； c． 如果一行代码太长，请使用类似 .= 的方式断行书写； d． 对于执行数据库的sql语句操作，尽量不要在函数内写sql语句，而先用变量定义sql语句，然后在执行操作的函数中调用定义的变量； 例子： $sql = "SELECT username,password,address,age,postcode FROM test_t "; $sql .= " WHERE username='aaa'"; $res = mysql_query($sql); 1.3.8.不要不可思议的数字 一个在源代码中使用了的赤裸裸的数字是不可思议的数字，因为包括作者，在三个月内，没人它的含义。例如： if (22 == $foo) { start_thermo_nuclear_war(); } else if (19 == $foo) { refund_lotso_money(); } else { cry_cause_im_lost(); } 你应该用define()来给你想表示某样东西的数值一个真正的名字，而不是采用赤裸裸的数字，例如： define("PRESIDENT_WENT_CRAZY", "22"); define("WE_GOOFED", "19"); define("THEY_DIDNT_PAY", "16");
if ( PRESIDENT_WENT_CRAZY == $foo) { start_thermo_nuclear_war(); } else if (WE_GOOFED == $foo) { refund_lotso_money(); } else if (THEY_DIDNT_PAY == $foo) { infinite_loop(); } else { happy_days_i_know_why_im_here(); } 1.3.9.true/false和0/1判断 遵循以下规则： a． 不能使用0/1代替true/false，在PHP中，这是不相等的； b． 不要使用非零的表达式、变量或者方法直接进行true/false判断，而必须使用严格的完整true/false判断； 如：不使用if ($a) 或者if (checka()) 而使用if (FALSE != $a)或者 if (FALSE != check()) 1.3.10.避免嵌入式赋值 在程序中避免下面例子中的嵌入式赋值： 不使用这样的方式： while ($a != ($c = getchar())) { process the character } 1.3.11.错误返回检测规则 检查所有的系统调用的错误信息，除非你要忽略错误。 为每条系统错误消息定义好系统错误文本，并记录错误LOG。 1.4.程序注释 每个程序均必须提供必要的注释，书写注释要求规范，参照PEAR提供的注释要求，为今后利用phpdoc生成php文档做准备。程序注释的原则如下： a． 注释中除了文件头的注释块外，其他地方都不使用//注释，而使用/* */的注释； b． 注释内容必须写在被注释对象的前面，不写在一行或者后面； 1.4.1.程序头注释块 每个程序头部必须有统一的注释块，规则如下： a． 必须包含本程序的描述； b． 必须包含作者； c． 必须包含书写日期； d． 必须包含版本信息； e． 必须包含项目名称； f． 必须包含文件的名称； g． 重要的使用说明，如类的调用方法、注意事项等； 参考例子如下： <?php // // +---------------------------------------------------------+ // | PHP version 4.0 | // +---------------------------------------------------------+ // | Copyright (c) 1997-2001 The PHP Group | // +---------------------------------------------------------+ // | This source file is subject to of the PHP license, | // | that is bundled with this packafile LICENSE, and is | // | available at through the world-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the and are unable to | // | obtain it through the world-wide-web,end a note to | // | license@php.net so we can mail you a immediately. | // +---------------------------------------------------------+ // | Authors: Stig Bakken <ssb@fast.no> | // | Tomas V.V.Cox | // | | // +---------------------------------------------------------+ // // $Id: Common.php,v 1.8.2.3 2001/11/13 01:26:48 ssb Exp $ 1.4.2.类的注释 类的注释采用里面的参考例子方式： /** * @ Purpose: * 访问数据库的类，以ODBC作为通用访问接口 * @Package Name: Database * @Author: Forrest Gump gump@crtvu.edu.cn * @Modifications: * No20020523-100: * odbc_fetch_into()参数位置第二和第三个位置调换 * John Johnson John@crtvu.edu.cn * @See: (参照) */ class Database { …… } 1.4.3.函数和方法的注释 函数和方法的注释写在函数和方法的前面，采用类似下面例子的规则： /** * @Purpose: * 执行一次查询 * @Method Name: Query() * * @Param: string $queryStr SQL查询字符串 * @Param: string $username 用户名 * * @Author: Michael Lee * * @Return: mixed 查询返回值（结果集对象） */ function（$queryStr,$username） {……} 1.4.4.变量或者语句注释 程序中变量或者语句的注释遵循以下原则： a． 写在变量或者语句的前面一行，而不写在同行或者后面； b． 注释采用/* */的方式； c． 每个函数前面要包含一个注释块。内容包括函数功能简述，输入/输出参数，预期的返回值，出错代码定义。 d． 注释完整规范。 e． 把已经注释掉的代码删除，或者注明这些已经注释掉的代码仍然保留在源码中的特殊原因。 f． 例子： /** * @Purpose: * 数据库连接用户名 * @Attribute/Variable Name: db_user_name * @Type: string */ var db_user_name; 每个新建的文件前必须加上注释，注释格式 /** * 实现功能描述： * 创建人: * 创建时间: * 修改人1: * 修改内容： * 修改时间: * 修改人2: * 修改内容： * 修改时间: **/ 每个新建控制器、方法必须添加注释 2. 代码规范特殊要求 2.1.商家后台 2.1.1.列表页面 1. 必须使用最新的后台样式； 2. 必须有分页，要有搜索，要有导出成excel 2.1.2.编辑页面 1. 如果涉及到图片，则必须链接到图片库，用户可以从图片库选择图片，也可以上传图片； 2. 如果涉及到音乐，则必须链接到系统音乐消息库，从音乐库中选择； 2.1.3.微信支付 1. 支付目录设置成同一个（weixinpl/common_shop/jiushop/) (因为微信只能设置3个支付目录） 2.1.4.过滤单引号 所有的get或者post传过来的参数，都要过滤$rule =$configutil->splash_new($_POST["rule"]); Or $rule =$configutil->splash_new($_GET["rule"]); 2.1.5.公共代码文件 能用公共文件尽量用公共代码文件 1. weixin目录的公共方法写在app/common/common.php,全局参数配置在app/Conf/config.php 2. weixinpl目录的公共方法写在app/common,全局参数配置在config.php 2.1.6.资源文件放到约定地方 1. Weixin目录资源文件放到plat/Public 目录，例如嘉荣抢红包 Js 放到 Public/JrRedEnvelope/js Css 放到 Public/JrRedEnvelope/css image 放到 Public/JrRedEnvelope/img 2、Weixin 目录 上传图片放到 plat/app/Public 目录，并且按customer_id 分开存放，例如 Customer_id为44的用户上传摇周边的图片放 plat/app/Public/upload_shakearound/44/ Customer_id为44的用户上传抢红包的图片放 plat/app/Public/upload_JrRedEnvelope/44/ 3、 weixinpl 目录 上传图片放到 up/oemID/customer_id/ 目录，并且按功能分开存放，例如 oemID为1，Customer_id为44的用户上传商城基本设置的图片放 up/1/44/Base 2.1.5在Weixin目录添加新功能应该独立控制器和视图，而不应放到IndexV2Action控制器里面 例如，新建嘉荣红包功能，应新建控制器JrRedEnvelopeAction.class.php 、视图文件夹Tpl/JrRedEnvelope、资源文件夹Public/JrRedEnvelope, 上传图片文件夹app/Public/upload_rRedEnvelope, 用来分别编写逻辑代码、html、存放资源文件以及客户上传的图片
2.2.前端 2.2.1.提示语言 1. 必须清晰和无理解歧义 2.2.2.列表页面 1. 必须添加‘加载更多’，不能一页显示全所有产品； 2.2.3.过滤单引号 所有的get或者post传过来的参数，都要过滤$rule =$configutil->splash_new($_POST["rule"]); Or $rule =$configutil->splash_new($_GET["rule"]); 2.2.4.公共文件或方法 weixinplcommonutility_shop.php文件中 SendMessage($content,$fromuser,$customer_id)调用微信接口发送文字类型客服消息，$content发送内容，$fromuser微信用户openid，$customer_id商家ID SendMessage_formedia($material_id,$fromuser,$customer_id,$type)调用微信接口发送图片，视频，语音，音乐消息，$material_id素材ID（可以通过素材群发功能上传素材获取id），$fromuser微信用户openid，$customer_id商家ID，$type素材类型（5图片，6视频，4音乐，3语音） weixinplcommonutility.php文件中 sendMessage($username,$pwd,$tel,$content,$connect=null)调用短信发送接口，$username,$pwd短信发送账号密码（旧版本需要，新版本统一调用数据库），$tel手机号，$content发送内容，$connect数据库对象（如果数据库使用对象连接就需要传该参数） add_material($access_token,$data,$type)新增永久素材，$access_token微信公众号的全局唯一票据，$data素材信息JSON格式，$type素材类型图片（image）、语音（voice）、视频（video） del_material($access_token, $data = null)删除永久素材，$access_token微信公众号的全局唯一票据，$data素材信息JSON格式 get_access_token($appid,$appsecret)获取access token，$appid第三方用户唯一凭证,$appsecret第三方用户唯一凭证密钥 add_news($customer_id,$data = null)上传图文消息素材，$customer_id商家ID，$data素材信息JSON格式 update_news($customer_id,$data = null)修改图文消息素材，$customer_id商家ID，$data素材信息JSON格式 weixinplcommonutility.php文件中 web_Authorization($customer_id) 调用微信网页授权接口，$customer_id商家id 2.2.5.微信图片、视频、语音 微信接口所用到的media_id统一在移动应用->微信应用->素材群发里面上传和调用 3.商城 3.1.个人数据公用文件 目录路径:weixinpl/common/own_data.php 3.2.公用常用方法 目录路径:weixinpl/common/utility_fun.php 3.3.分佣方法 目录路径:weixinpl/common/utility_shop.php
|