> 请理解并尽量遵循以下命名规范,可以减少在开发过程中出现不必要的错误。
`DMP1`遵循`PSR-2`命名规范和`PSR-4`自动加载规范,并且注意如下规范:
### 目录和文件
* 目录使用小写+下划线;
* 类库、函数文件统一以`.php`为后缀;
* 类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;
* 类(包含接口和Trait)文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名;
* 类名(包括接口和Trait)和文件名保持一致,统一采用驼峰法命名(首字母大写);
### 函数和类、属性命名
* 类的命名采用驼峰法(首字母大写),例如`User`、`UserType`;
* 函数的命名使用小写字母和下划线(小写字母开头)的方式,例如`get_client_ip`;
* 方法的命名使用驼峰法(首字母小写),例如`getUserName`;
* 属性的命名使用驼峰法(首字母小写),例如`tableName`、`instance`;
* 特例:以双下划线`__`打头的函数或方法作为魔术方法,例如`__call`和`__autoload`;
### 常量和配置
* 常量以大写字母和下划线命名,例如`APP_PATH`;
* 配置参数以小写字母和下划线命名,例如`url_route_on`和`url_convert`;
* 环境变量定义使用大写字母和下划线命名,例如`APP_DEBUG`;
### 数据表和字段
* 数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如`think_user`表和`user_name`字段,不建议使用驼峰和中文作为数据表及字段命名。
* 记录时间与记录创建信息使用`create_info`字段text类型。最后修改信息使用`update_info`字段text类型。
* 敏感记录交互,特别是设置有权限分隔的数据,增加`openid`字段varchar(20)类型用来做记录使用的标识(id自增列保留)。
- 序言
- 基础
- 开发规范
- 架构说明
- 总览
- 中间件
- 事件
- 功能控制台
- 场景事件驱动
- 异常提醒
- 应用功能接口(Api)
- 内置服务
- 框架服务
- 场景驱动控制器
- 事件驱动逻辑
- 逻辑申明
- 消息队列
- 事件系统
- 钩子挂件
- 账户管理服务
- 权限管理服务
- 日志服务
- 数据字典服务
- 功能控制服务
- 中后台服务
- workdesktop
- 导航菜单
- 登录态接入
- 欢迎页
- 站内信
- 附件服务
- 托管
- 自定义上传
- 设置标签
- 文件检索
- 资源公开
- 报表服务
- 报表易生成
- 报表导出
- 数据导入
- 信息回收服务
- 查询手册
- 路由
- 控制器
- 逻辑层
- 模型
- 模板
- 标签库
- 资源引用
- 配置
- 权限
- 菜单
- 功能包
- 前端框架
- api服务
- AccountService
- Authorization
- DataCrypt
- EventLog
- LoginState
- 工具类
- 更新日志