介绍

 

技术规范写一下。

 

目录结构

 

开源软件管理安全监控平台 开源软件管理规范_php

 

访问方式

 

  http://localhost/index.php?r=模块名称_控制器名称_方法

  http://localhost/index.php?module=模块名称&controller=控制器名称&action=方法名称

 

默认值是:模块名称:Default,控制器名称:Page,方法名称:index

 

命名规范

 

  1)  类文件都是以.class.php为后缀,使用驼峰法命名,并且首字母大写。

开源软件管理安全监控平台 开源软件管理规范_开源软件管理安全监控平台_02

  2)  类名要体现文件路径

开源软件管理安全监控平台 开源软件管理规范_php_03

  3)  核心文件要放置在lib/Core/目录下面,这时候你不需要require里面的文件,直接使用就可以。

开源软件管理安全监控平台 开源软件管理规范_开源软件管理安全监控平台_04

  4)  函数的命名使用小写字母和下划线的方式

开源软件管理安全监控平台 开源软件管理规范_下划线_05

  5)  方法的命名使用驼峰法如validClientIp,私有方法使用下划线'_',如_insertIP()。

开源软件管理安全监控平台 开源软件管理规范_后缀_06

  6)  常量以大写字母加下划线命名,如DB_HOST。

开源软件管理安全监控平台 开源软件管理规范_php_07

  7)  对内部变量的命名没有强制规范,可以根据个人喜好来命名。但个人建议方法参数变量我们使用驼峰法,内部参数使用小写字母和下划线命名。

如:public function validAcount($userName){
        $user_name = $userName;
      }

  8)  模板文件以.tpl为后缀。

开源软件管理安全监控平台 开源软件管理规范_php_08

  9)  数据表和字段采用小写加下划线方式命名。如hh_ip的字段create_date

开源软件管理安全监控平台 开源软件管理规范_后缀_09

 

开发要求

 

因为安全性、性能比较高。

开源软件管理安全监控平台 开源软件管理规范_下划线_10

  2)每次的数据库读取操作希望都使用explain进行校验,以便确认命中索引。

打开日志

开源软件管理安全监控平台 开源软件管理规范_下划线_11

                                  

开源软件管理安全监控平台 开源软件管理规范_下划线_12

查看日志

开源软件管理安全监控平台 开源软件管理规范_php_13

                                  

开源软件管理安全监控平台 开源软件管理规范_下划线_12

查看是否命中索引

开源软件管理安全监控平台 开源软件管理规范_php_15

  3)对于inner join,建议最多使用2个表。超过2个,建议使用多个短select语句。

  4)尽量用英文写注释,一是培养大家的英文能力;二是提高大家的命名能力。

  5)大家统一使用utf-8的编码方式。——这玩意好像现在很多新系统都这么干。(淘宝怪怪的,竟然用gbk,每次使用他们的接口我都iconv一下,麻烦不麻烦!)

  6)禁止使用全局函数。