在做过大量的代码审查后,我经常看到一些重复的错误,以下是纠正这些错误的方法。
在循环之前测试数组是否为空
- $items = [];
- // ...
- if (count($items) > 0) {
- foreach ($items as $item) {
- // process on $item ...
- }
- }
foreach
以及数组函数 (array_*
) 可以处理空数组。
- $items = [];
- // ...
- foreach ($items as $item) {
- // process on $item ...
- }
将代码内容封装到一个 if 语句汇总
- function foo(User $user) {
- if (!$user->isDisabled()) {
- // ...
- // long process
- // ...
- }
- }
这不是 PHP 特有的情况,不过我经常碰到此类情况。你可以通过提前返回来减少缩进。
所有主要方法处于第一个缩进级别
- function foo(User $user) {
- if ($user->isDisabled()) {
- return;
- }
-
- // ...
- // 其他代码
- // ...
- }
多次调用 isset 方法
你可能遇到以下情况:
- $a = null;
- $b = null;
- $c = null;
- // ...
-
- if (!isset($a) || !isset($b) || !isset($c)) {
- throw new Exception("undefined variable");
- }
-
- // 或者
-
- if (isset($a) && isset($b) && isset($c) {
- // process with $a, $b et $c
- }
-
- // 或者
-
- $items = [];
- //...
- if (isset($items['user']) && isset($items['user']['id']) {
- // process with $items['user']['id']
- }
我们经常需要检查变量是否已定义,php 提供了 isset 函数可以用于检测该变量,而且该函数可以一次接受多个参数,所以一下代码可能更好
- $a = null;
- $b = null;
- $c = null;
- // ...
-
- if (!isset($a, $b, $c)) {
- throw new Exception("undefined variable");
- }
- // 或者
-
- if (isset($a, $b, $c)) {
- // process with $a, $b et $c
- }
- // 或者
- $items = [];
- //...
- if (isset($items['user'], $items['user']['id'])) {
- // process with $items['user']['id']
- }
- echo 和 sprintf 方法一起使用
- $name = "John Doe";
- echo sprintf('Bonjour %s', $name);
看到这段代码你可能会想笑,不过我的确这样写了一段时间,而且我仍然会看到很多这样写的!其实echo
和sprintf
并不需同时使用,printf
就可以完全实现打印功能。
- $name = "John Doe";
- printf('Bonjour %s', $name);
通过组合两种方法检查数组中是否存在键
- $items = [
- 'one_key' => 'John',
- 'search_key' => 'Jane',
- ];
-
- if (in_array('search_key', array_keys($items))) {
- // process
- }
我经常看到的最后一个错误是in_array
和array_keys
的联合使用。所有这些都可以使用array_key_exists
替换。
- $items = [
- 'one_key' => 'John',
- 'search_key' => 'Jane',
- ];
-
- if (array_key_exists('search_key', $items)) {
- // process
- }
我们还可以使用isset
来检查值是否不是null
。
- if (isset($items['search_key'])) {
- // process
- }