编码规范
PHP代码文件必须以不带BOM的UTF-8编码; 纯PHP文件必须省略最后 ?>结束标签。
缩进
使用tab键来缩进,每个tab键长度必须设置4个空格。
行
以屏幕换行为准,尽量不要横拉滚动条看代码;
非空行不能有多余的空格;
每行不能有多条语句;
适当空行有利于代码阅读,但不能滥用。
关键字
PHP所有关键字必须小写,bool值true,false,null 也必须小写;
关键字有:abstract、array、as、break、case、catch、class、const、try、use、public等等。
函数
每个函数或方法不能多于60行。
数组
当有两个以上键值对时,请换行,如:
$where = [
'id' => 789,
'user_name' => '52php'
];
命名
1、 类名 类名使用大驼峰式的写法,如下:
class ClassName
{
// constants, properties, methods
}
2、 类的方法名 类方法名使用小驼峰的写法,方法名紧跟括号,中间不能有空格,参数之间要有空格且大括号必须自成一行如下:
class ClassName
{
public function fooBarBaz($storeName, $storeId, array $info = [])
{
// method body
}
}
3、 类文件名 类文件名必须和对应的类名一致,也是大驼峰式写法
4、其他文件名 如视图、配置、脚本文件等全部用小写字母+下划线命名
5、 函数名 普通函数使用小写字母+下划线命名,且函数名紧跟括号,中间不能有空格,参数之间要有空格,大括号换行如:
function curl_request($a, $b)
{
// method body
}
6、 变量、常量名 变量名使用小驼峰的写法,常量名全部用大写+下划线,如下
//变量
$userName = 'xia';
//常量
const VERSION = '1.0';
const SITE_URL = 'http://www.baidu.com';
7、数据库命名
数据库全部用小写命名,数据表及字段采用小写+下划线方式命名,且表中主键id尽可能加上表名,如:title_id。
注释
类、方法、行数,要以/* */格式注释,第二行开始写注释内容,表明作者、时间、参数格式、返回格式等,常用标签有:>@autor、@since、@param 、@return等,如:
/**
* 我是类描述信息哦!
*
* @author Author
* @since 2015.01.02
* @version 1.0
*/
class ClassName
{
public function aVeryLongMethodName(
ClassTypeHint $arg1,
&$arg2,
array $arg3 = [])
{
// method body
}
}
/**
* 我是方法描述信息
*
* @author Author
* @since 2015.01.02
* @param ClassName $arg1 参数1描述 我是具体的对象类型哦
* @param array $arg2 参数2描述 我是数据类型哦
* @param int $arg3 参数3描述 我是基本数据类型哦
* @return boolean
*/
public function methodName(ClassName $arg1, array $arg2, $arg3)
{
// method body
return true;
}
其他注释 尽量用 //,注释开始前必须一个空格
控制结构
控制结构关键词(if、elseif、else、foreach、switch、case、try、catch、for等)后必须有一个空格;
左括号 ( 后一定不能有空格,右括号 ) 前也一定不能有空格;
右括号 ) 与开始花括号 { 间一定有一个空格;
结束花括号 } 一定在结构体主体后单独成行。
if ($expr1) {
// if body
} elseif ($expr2) {
// elseif body
} else {
// else body;
}
在 if 条件判断中,如果用到常量,将常量放在等号或不等号的左边,如下:
if (6 == $a) {
//body
}
当大于两个 if 时,请使用 switch 代替 if,如:
<?php
switch ($expr) {
case 0:
echo 'First case, with a break';
break;
case 1:
echo 'Second case, which falls through';
break;
case 2:
case 3:
case 4:
echo 'Third case, return instead of break';
break;
default:
echo 'Default case';
}
借鉴链接 PHP-FIG
主地址:
子地址:
说明:字符串如果是纯字符(不带变量),那么就用单引号。($a = ‘a b c’)
mysql
表设计
1、库名、表名必须使用小写字母,“_”分割,字段名使用驼峰命名。
2、库名、表名、字段名必须不超过20个字符。
3、库名、表名、字段名见名知意,建议使用名词而不是动词。
4、建议插入操作多的使用InnoDB存储引擎、查询操作多的使用MYISAM存储引擎。
5、存储精确浮点数必须使用DECIMAL替代FLOAT和DOUBLE。
6、建议使用UNSIGNED存储非负数值。
7、建议使用INT UNSIGNED存储IPV4。
8、整形定义中不添加长度,比如使用INT,而不是INT(4)。
9、使用短数据类型,比如取值范围为0-80时,使用TINYINT UNSIGNED。
10、不建议使用ENUM类型,使用TINYINT来代替。
11、尽可能不使用TEXT、BLOB类型。
12、VARCHAR(N),N表示的是字符数不是字节数,比如VARCHAR(255),可以最大可存储255个汉字,需要根据实际的宽度来选择N。
13、VARCHAR(N),N尽可能小,因为MySQL一个表中所有的VARCHAR字段最大长度是65535个字节,进行排序和创建临时表一类的内存操作时,会使用N的长度申请内存。
14、表字符集选择UTF8。
15、使用VARBINARY存储变长字符串。
16、存储年使用YEAR类型。
17、存储日期使用DATE类型。
18、存储时间(精确到秒)建议使用TIMESTAMP类型,因为TIMESTAMP使用4字节,DATETIME使用8个字节。
19、建议字段定义为NOT NULL。
20、将过大字段拆分到其他表中。
21、禁止在数据库中使用VARBINARY、BLOB存储图片、文件等。
索引
1、非唯一索引必须按照“idx_字段名称_字段名称[_字段名]”进行命名。
2、唯一索引必须按照“uniq_字段名称_字段名称[_字段名]”进行命名。
3、索引名称必须使用小写。
4、索引中的字段数建议不超过5个。
5、单张表的索引数量控制在5个以内。
6、唯一键由3个以下字段组成,并且字段都是整形时,使用唯一键作为主键。
7、没有唯一键或者唯一键不符合5中的条件时,使用自增id作为主键。
8、唯一键不和主键重复。
9、索引字段的顺序需要考虑字段值去重之后的个数,个数多的放在前面。
10、ORDER BY,GROUP BY,DISTINCT的字段需要添加在索引的后面。
11、使用EXPLAIN判断SQL语句是否合理使用索引,尽量避免extra列出现:Using File Sort,Using Temporary
12、UPDATE、DELETE语句需要根据WHERE条件添加索引。
13、不建议使用%前缀模糊查询,例如LIKE “%weibo”。
14、对长度过长的VARCHAR字段建立索引时,添加crc32或者MD5 Hash字段,对Hash字段建立索引。
15、合理创建联合索引(避免冗余),(a,b,c) 相当于 (a) 、(a,b) 、(a,b,c)。
16、合理利用覆盖索引。
SQL语句
1、使用prepared statement,可以提供性能并且避免SQL注入。
2、SQL语句中IN包含的值不应过多。
3、UPDATE、DELETE语句不使用LIMIT。
4、WHERE条件中必须使用合适的类型,避免MySQL进行隐式类型转化。
5、SELECT语句只获取需要的字段。
6、SELECT、INSERT语句必须显式的指明字段名称,不使用SELECT ,不使用INSERT INTO table()。
7、使用SELECT column_name1, column_name2 FROM table WHERE [condition]而不是SELECT column_name1 FROM table WHERE [condition]和SELECT column_name2 FROM table WHERE [condition]。
8、WHERE条件中的非等值条件(IN、BETWEEN、<、<=、>、>=)会导致后面的条件使用不了索引。
9、避免在SQL语句进行数学运算或者函数运算,容易将业务逻辑和DB耦合在一起。
10、INSERT语句使用batch提交(INSERT INTO table VALUES(),(),()……),values的个数不应过多。
11、避免使用存储过程、触发器、函数等,容易将业务逻辑和DB耦合在一起,并且MySQL的存储过程、触发器、函数中存在一定的bug。
12、避免使用JOIN。
13、使用合理的SQL语句减少与数据库的交互次数。
14、不使用ORDER BY RAND(),使用其他方法替换。
15、建议使用合理的分页方式以提高分页的效率。
16、统计表中记录数时使用COUNT(),而不是COUNT(primary_key)和COUNT(1)。
17、禁止在从库上执行后台管理和统计类型功能的QUERY。
散表
1、每张表数据量建议控制在5000w以下。
2、可以结合使用hash、range、lookup table进行散表。
3、散表如果使用md5(或者类似的hash算法)进行散表,表名后缀使用16进制,比如user_ff。
4、推荐使用CRC32求余(或者类似的算术算法)进行散表,表名后缀使用数字,数字必须从0开始并等宽,比如散100张表,后缀从00-99。
5、使用时间散表,表名后缀必须使用特定格式,比如按日散表user_20110209、按月散表user_201102。
其他
1、批量导入、导出数据需要在执行过程中观察服务,重复审查是否有问题。
2、批量更新数据,如update,delete 操作,需在执行过程中观察服务。
3、产品出现非数据库平台运维导致的问题和故障时,如前端被抓站,请及时稳定程序,并处理。
4、业务部门程序出现bug等影响数据库服务的问题,请及时稳定程序,并处理。
5、业务部门推广活动,请提前进行服务和访问评估。
6、服务器权限、线上的DB权限、svn权限由技术经理控制。不得随意下分。
7、开发人员只可以访问测试DB权限。