高级 PHP 工程师必备的编码技巧及思维(life)

男娘i 2023-03-02 14:50 4阅读 0赞

好的开发者通常以代码质量来定义。在软件行业，写好的代码意味着在在测试，更新，扩展或者修复漏洞中省钱。本文，我将向你展示一些现实生活中技巧和想法的例子，来帮助你清理你的逻辑代码，重构它，让它变得更健壮和模块化。这些技巧将不仅仅帮助你重构你的旧代码，而且给你一些如何从现在开始写出简洁代码的好建议。

我的官方群[点击此处][Link 1]。

## 什么是重构，为什么我们需要它？ ##

重构是指帮组我们写简洁代码的方法和步骤。这对其他可能阅读，扩展和不需要怎么编辑来复用我们代码的其他开发者来说是很重要的。

下面的内容将向你展示一些重构逻辑代码，让它变得更好的例子。

## 不要在没有单元测试的情况下重构生产环境的代码 ##

我的第一条建议是从不在没有完全进行单元测试的情况下开始重构逻辑代码。我的理由是：你将会以很难有修复的损坏的功能收尾，因为你也很难指出是哪里损坏了。因此，如果你要重构它，从测试开始。保证你准备重构的部分被测试覆盖到。[PHPUnit 代码覆盖分析][PHPUnit].

## 从你代码最底层开始重构 ##

看一下下面的图片。这是一个我从 Github 找到的真实的酒店管理系统项目。这是一个开源的项目，可想闭源项目将是糟糕的。

![format_png][]

示例：从底层开始重构

你看这个代码，这里用红色标出了三个层级。最底层应该是在第一个 if 条件下被 if/else 包围的申明。通常，最底层是集中在单一逻辑处理，比较容易重构。

## 让你的方法更短，分解它们到更小的方法或者配置文件 / DB 表 ##

也许在这里，我们可以向下面一样提炼它到一个私有方法：

![format_png 1][]

使你的方法更短

下一个深入点将是上传参数和加载视图。现在，再来看看在重构其他部分之后的 `add()` 方法。它变得更加简洁，易读，易于测试。

![format_png 2][]

示例：首先重构最底层

## if 申明坚持使用大括号 ##

大多数编程语言都支持单行 if 申明，因为这样比较简单，所以一些开发就这么使用，但是这样不便于阅读，而且容易造成问题，因为一个空行就可以中断条件造成崩溃。看下下面两个示例的不同：

![format_png 3][]

示例：使用大括号

## 别使用魔术数字或者魔术字符串： ##

下个示例中，你注意到如果房间超过 250 ，会返回一个错误信息。这里，250 就被认为是一个魔术数字。如果你不是写这个的开发者，很难指出这个数字表示什么。

![format_png 4][]

示例：魔术数字

为了重构这个方法，我们可以指出 250 表示最大的房间数。为了替换硬编码，我们可以提取它到一个变量 `$maxAvailableRooms` 。现在对其他开发者来说，它变得更易被理解。

![format_png 5][]

示例：修复魔术数字

## 不要使用 else 申明，如果你不是真的需要： ##

在相同的 availablerooms () 函数中，你注意到那个 if 申明， 其中我们可以很容易摆脱 else 部分，而且逻辑保持一致。

![format_png 6][]

示例：忽略 else 申明

## 使用能够表示你的方法，变量和测试的命名 ##

在后面的示例中，你会发现酒店管理系统有两个方法分别是 “index () ” 和 “ room\_m () ”。 对我来说，我搞不清它们的目的是什么。我认为它应该很容易被理解，如果它们的命名都能够描述自己。

![format_png 7][]

示例：不好的方法命名

## 充分利用你的编程语言的功能 ##

许多开发者不会利用到他们使用的编程语言的全部功能。很多功能能够节约你们的的时间，而且能够让你们的代码更健壮。看下下面的示例，注意如何在更少代码情况下更容易达到相同的结果的，通过使用类型提示。

![format_png 8][]

![format_png 9][]

**最后，我想提供一些关于更好编码的快速提示：**

*  使用新的数组形式 \[\] 替代旧的 array ()。
 *  除非不检查数据类型很重要，否则使用 === 操作符替代 ==。
 *  给公共方法提供简短的描述性名称总是一个好主意。私有方法可以使用更长的名称，因为它们的适用范围比较有限。
 *  仅对实现接口的方法使用通用名称例如 add ()，并对单个类方法使用描述性名称例如 addUser () 或 addDocument ()。
 *  从类中删除未使用的方法。
 *  对返回值为 boolean 等的函数使用 is/has 前缀：isAdmin ($user)，hasPermission ($user)。
 *  始终在类方法和属性中使用访问修饰符。
 *  注意接口污染：仅使用用户可以公开使用的方法。
 *  在公共方法位于顶部的位置组织类方法。
 *  始终在类中应用单一职责的概念。
 *  **以上内容希望帮助到大家，**很多PHPer在进阶的时候总会遇到一些问题和瓶颈，业务代码写多了没有方向感，不知道该从那里入手去提升，对此我整理了一些资料，包括但不限于：分布式架构、高可扩展、高性能、高并发、服务器性能调优、TP6，laravel，YII2，Redis，Swoole、Swoft、Kafka、Mysql优化、shell脚本、Docker、微服务、Nginx等多个知识点高级进阶干货需要的可以免费分享给大家**，需要的可以加入**我的官方群[点击此处][Link 1]。

[Link 1]: https://link.zhihu.com/?target=https%3A//jq.qq.com/%3F_wv%3D1027%26k%3DJNZRtm7R
[PHPUnit]: https://link.zhihu.com/?target=https%3A//phpunit.readthedocs.io/en/7.1/code-coverage-analysis.html
[format_png]: /images/20230208/d5d800430a7b47109de7c8107d46800f.png
[format_png 1]: /images/20230208/ac20dec0255142c4bf3b756648700845.png
[format_png 2]: /images/20230208/435971b388404708b952b545c66f81f4.png
[format_png 3]: /images/20230208/1138d2a7fed4416fb745fb2686e2c763.png
[format_png 4]: /images/20230208/6c75f703ef524d648752921b6fd0658b.png
[format_png 5]: /images/20230208/8950bb847d9e477fa14c3328add25553.png
[format_png 6]: /images/20230208/efbb0f01c00b4f968923cc4a9e100d04.png
[format_png 7]: /images/20230208/60664539664e4933aed688f510057088.png
[format_png 8]: /images/20230208/33083000a0fe44f98272dc3bb58c8d21.png
[format_png 9]: /images/20230208/9ba43020eff142c88dc9a511791d0e84.png