您好,欢迎访问一九零五行业门户网

如何写出优雅耐看的PHP代码?浅谈书写规范

如何写出优雅耐看的php代码?本篇文章带大家了解一下php代码的基本书写规范和框架规范,了解它们让你的php代码优雅一个档次!
引言今天老王同学跟我说,他的代码好糟糕,像一坨xiang。问我要怎么
提高自己的代码质量,让自己代码看得顺眼一点,舒服一点, 就像
看到大长腿mm,两眼放光那种。
于是我: 你先这样,然后这样,然后再那样。。。。。。
老王同学: 别闹, 到底是哪样?
好的, 我要开始装13了。。。
基本规范先说一下最基本的东西:
变量名使用驼峰命名。不懂的单词不要用拼音,而是要查词典找到对应的单词。
常量命名使用大写下划线方式命名。如:system_eroor = 50000。
缩进使用tab键,不要打一堆空格做缩进。
类名首字母大写驼峰命名,需要见名知其意,注释说明这个类的功能。例如:
方法名驼峰命名,方法行数尽量控制在80行左右,注释说明函数干嘛用的。
花括号独占一行,例如:
foreach慎用引用,例如以下代码会有问题:
预期结果是输出: 2 4 6,实际结果是2 4 4, 至于为什么可以看我之前的文章: php中&符号你真的了解吗?。 可以使用array_walk`方法避免这个问题, 示例:
避免if, elese嵌套过深,很多嵌套可以通过提前终止来消除, 举个简单的例子:
建议使用第二种方式,不符合条件的直接返回,剩下的就是符号条件的,那么避免了在if里面写很多代码。
多个if/else使用switch来替代,php8.0版本可以使用match更为简洁。
phpstorm中安装sonarlint插件。如果你写的代码出现虚线,说明不太理想,那么可以根据提示修改,相信有强迫症的同学一定会改,久而久之代码就很规范了。例如:
方法未使用,方法名不规范已经告诉你了,可以快捷修改,也可以自己修改。
框架规范前面说得都是比较基础的东西,接下来才是主要的内容。
相信很多同学都用过常用的thinkphp丶laravel丶yii等流行框架之一。
这些框架都是mvc架构的,看过很多人的代码,要么把业务逻辑写在控制器里面,要么写在model里面, 写在model里面相比写控制器里面的还相对好一点。其实对于大型项目都不太友好。
下文以laravel框架为例。
参数验证api需要进行参数验证,但是参数验证写在哪里比较优雅呢?可能很多人在controller定义规则,然后在调用验证方法,那么验证那段代码将在每个api里面出现,例如我同事写的。
这段代码在每个api里面均会出现一次,岂不是很啰嗦,那么如何解决呢?
在laravel的http目录下建立一个requsts目录,用于存放请求的参数验证类。建立一个baserequest类:
比如登录需要参数验证再建立一个loginrequest类继承这个baserequest。
使用的时候只要在controller的方法中注入这个请求类即可。
这里获取请求参数的时候会对表单进行验证,否则参数验证失败会调用刚刚request积累定义的方法抛json异常,返回信息给客户端。
控制器控制器的主要工作负载获取请求数据和返回内容,不应做更多的事情,那么可以定义一个service层来处理业务逻辑。所以我的控制器的代码只有一行。
在laravel的app目录下建立一个services文件夹用于存放service类,建立一个baseservice类:
然后建立一个userservice来处理用户相关的业务逻辑。
在usercontroller中注入这个userservice使用:
modelmodel不建议写业务逻辑。model主要是用来定义一些内容,不应该操纵数据。
model的数据操纵应该放在repository中,在laravel的app目录下建立一个文件夹repositories。
定义baserepository:
定义userrepository,用于用户数据相关的操作, 在构造方法中注入usermodel:
常量项目中很多常量该怎么定义?
在app目录创建一个constant目录, 再建立一个contstant类来保存这些自定义常量。
这样的好处是:
自定义常量可以集中的管理。修改常量值的时候,只需要在这个类中找修改一次即可,代码更新维护性好。
原文地址:https://juejin.cn/post/6957290009682509854
作者:classmatelin
推荐学习:《php视频教程》
以上就是如何写出优雅耐看的php代码?浅谈书写规范的详细内容。
其它类似信息

推荐信息