介绍
做这个开源系统,一直没有做开发文档,有点对不住大家,今天我把技术规范写一下。
目录结构
访问方式
http://localhost/index.php?r=模块名称_控制器名称_方法
或
http://localhost/index.php?module=模块名称&controller=控制器名称&action=方法名称
默认值是:模块名称:Default,控制器名称:Page,方法名称:index
命名规范
1) 类文件都是以.class.php为后缀,使用驼峰法命名,并且首字母大写。
2) 类名要体现文件路径
3) 核心文件要放置在lib/Core/目录下面,这时候你不需要require里面的文件,直接使用就可以。
4) 函数的命名使用小写字母和下划线的方式
5) 方法的命名使用驼峰法如validClientIp,私有方法使用下划线'_',如_insertIP()。
6) 常量以大写字母加下划线命名,如DB_HOST。
7) 对内部变量的命名没有强制规范,可以根据个人喜好来命名。但个人建议方法参数变量我们使用驼峰法,内部参数使用小写字母和下划线命名。
如:public function validAcount($userName){
$user_name = $userName;
}
8) 模板文件以.tpl为后缀。
9) 数据表和字段采用小写加下划线方式命名。如hh_ip的字段create_date
开发要求
1)MySQL最好使用PDO进行操作,因为安全性、性能比较高。
2)每次的数据库读取操作希望都使用explain进行校验,以便确认命中索引。
打开日志
查看日志
查看是否命中索引
3)对于inner join,建议最多使用2个表。超过2个,建议使用多个短select语句。
4)尽量用英文写注释,一是培养大家的英文能力;二是提高大家的命名能力。
5)大家统一使用utf-8的编码方式。——这玩意好像现在很多新系统都这么干。(淘宝怪怪的,竟然用gbk,每次使用他们的接口我都iconv一下,麻烦不麻烦!)
6)禁止使用全局函数。
总结
欢迎大家一起过来开发,开发这个项目除了创作好的产品外,主要是为了技术交流,看看大家的好的技术。如果大家有更好的规范或者方法,不妨告知一、二。
QQ群:152448006
地址:
大家进入之后,给我一个gmail帐号,然后我给大家分配一个新帐号给你。
如
推荐