CRMEB开源商城系统 & 标准版系统(PHP)开发规范

一个项目在着手开发之前,一定要确定好相关的开发规范。比如文件目录结构、方法名称、变量名称、代码风格以及注释等。本期内容,我们就以CRMEB开源商城系统 & 标准版系统(PHP)为示例,系统的介绍一下本项目中的开发规范。

一、文件目录

CRMEB标准版系统(PHP)的框架使用的是ThinkPHP6,主要目录和框架目录相似,在这里说明一下项目中使用到的主要目录:

1、程序根目录下的crmeb目录是系统的核心目录,程序的核心功能都在这个文件夹下,基类、支付、短信、授权、导出、云存储等基本功能都在次文件夹下。

注意❗️❗️ 这个文件日常开发中尽量不要修改,如果必须要增加一个基础功能时,再去修改此文件夹。

2、app是ThinkPHP默认的目录,但是项目在app文件夹下进行了功能性的细化,包括model、dao、services等。

model:对应数据库的文件,保证每一张表都有一个model对应,这是一个最简单的model文件,命名空间,引用基类,pk是表主键,name是表名称。

dao层文件:只做数据查询、添加、修改等数据库操作,不做任何数据处理。

services层:处理程序的主要逻辑,如果构造方法注入dao层文件,services层的文件和dao层文件不是一一对应的。

controller层:这个里面的文件用于接收数据和发送数据,接收到数据之后调用对应处理数据的service层代码进行处理,再将返回值发送给请求方。

二、代码的开发

namespace和use规范:

(1)namespace声明后必须插入一个空白行

(2)所有use必须在namespace后声明

(3)每条use声明语句必须只有一个use关键词

(4)use声明语句块后必须要有一个空白行

类的定义:使用英文名词,以大写字母作为词的分隔,其他的字母均使用小写,名词的首个字母使用大写,不使用下划线,extends必须和类名在同一行。

定义的每个属性都必须添加访问修饰符:public、protected或private。

方法的命名规则:使用小驼峰命名

(1)使用英文名词、动词,以大写字母作为词的分隔,其他的字母均使用小写,单词的首个字母使用小写;

(2)不使用下划线参数,严格情况下需要声明变量类型,有默认值的参数需要在最后面;

(3)每一个方法都要有注释,表明方法用途、传入参数和类型、返回的参数类型等。

所有的运算符左右都要留下空格,类似下面的方法:

(1)PHP所有关键字必须全部小写

(2)非空行后一定不能有多余的空格符

(3)每行一定不能存在多于一条语句

(4)适当空行可以使得阅读代码更加方便以及有助于代码的分块(但注意不能滥用空行)。

温馨提示:在功能逻辑实现过程中,避免在循环中进行数据库的操作!

相关推荐
叶帆16 小时前
【YFIOs】用C#开发硬件之WiFi网络
开发语言·网络·c#
meilindehuzi_a16 小时前
深入理解 JavaScript 的同步与异步机制:从单线程设计到 Promise 核心应用
开发语言·javascript·ecmascript
如烟花的信页16 小时前
加速乐cookie逆向分析
javascript·爬虫·python·js逆向
永远的WEB小白16 小时前
css改变svg图标的颜色
前端·javascript·css
ikoala17 小时前
Codex 不得不装的 12 个插件,都在这了
前端·javascript·后端
skywalk816317 小时前
记录段言的开发过程
开发语言·学习·编程
未若君雅裁17 小时前
JVM 垃圾回收器全景与G1深度解析
java·开发语言·jvm
霸道流氓气质17 小时前
Java 大数据量异步处理方案:线程池 vs 消息队列
java·开发语言
devilnumber17 小时前
想真正吃透 + 灵活运用 Java 代理模式
java·开发语言·代理模式
AC赳赳老秦17 小时前
OpenClaw 助力技术面试:自动生成面试题、模拟面试、整理面试知识点
开发语言·python·面试·职场和发展·自动化·deepseek·openclaw