Clean Code PHP:PHP代码简洁之道

最近在 GitHub 上看到了一篇很不错的文章,是关于代码编写风格和规范的,看了之后感觉收获颇丰,在这里根据我自己的理解和习惯增删改一下,以后方便拿来复习。文末有原文链接。

1、变量、方法等,名字要取得一眼就能够看出大概意思,代码可读性高一点。

//什么神仙能看得出这是当前时间的意思
$dqsj = date('Y-m-d h:i:s',time());

$currentTime = date('Y-m-d h:i:s',time());

2、尽量不要用无意义的变量名,增加代码可读性。

// l是什么,i又是什么?
$l = ['Austin', 'New York', 'San Francisco'];
for ($i = 0; $i < count($l); $i++) {
    var_dump($l[$i]);
}

$locations = ['Austin', 'New York', 'San Francisco']; 
foreach ($locations as $location) {
     var_dump($location);
}

3、用变量、常量、类的属性等,代替数字等,代码可读性高、便于维护。

//乍一看根本不知道86400是个什么鬼
if($time > 86400) {...}

$oneDay = 24 * 60 * 60;
if($time > $oneDay) {...}

//虽然写起来方便,但是可读性差,后期维护起来也会特别累
if($data['level'] == 0 or $data['level'] == 1) {...}

$levelSuper = 0;
$levelNormal = 1;
$levelAdmin = [$levelSuper,$levelNormal];
if(in_array($data['level'],$levelAdmin)) {...}

4、避免深层嵌套,尽早返回。

 function fibonacci(int $n)
 {
     if ($n < 50) {
         if ($n !== 0) {
             if ($n !== 1) {
                 return fibonacci($n - 1) + fibonacci($n - 2);
             } else {
                 return 1;
             }
         } else {
             return 0;
         }
     } else {
         return 'Not supported';
     }
 }

 function fibonacci(int $n): int
 {
     if ($n === 0 || $n === 1) {
         return $n;
     }
     if ($n >= 50) {     
         throw new \Exception('Not supported'); 
     } 
     return fibonacci($n - 1) + fibonacci($n - 2);
 }

5、参数默认值最好不要在方法中规定。

//当不传入name参数时,$name的值为'木木',但是当$name为null、''的时候,就并不会使用默认值了
function getUserByName($name= '木木'){...}

function getUserByName($name= null)
{     
    $name = $name ?: '木木';
}

6、区分 等式 和 恒等式,最好使用恒等式。两者的区别是,等式只判断左右的值是否相等,而恒等式还需要判断类型是否相等。

$a = '42';
$b = 42;
var_dump($a == $b);  //true
var_dump($a === $b);  //false
$a = 0;
$b = '';
var_dump($a == $b);  //true
var_dump($a === $b);  //false

7、简单的 if 语句能用三元运算符、NULL合并运算符代替。NULL合并运算符是PHP7新加的,非常好用,能够代替传统的三元运算符。

if (isset($_GET['name'])) {
    $name = $_GET['name'];
} else {
    $name = '木木';
}

$name = $_GET['name'] ? $_GET['name'] : '木木';
$name = $_GET['name'] ?? '木木';

if (isset($_GET['name'])) {
    $name = $_GET['name'];
} elseif (isset($_POST['name'])) {
    $name = $_POST['name'];
} else {
    $name = '木木';
}

$name = $_GET['name'] ?? $_POST['name'] ?? '木木';

8、一个函数应该就干一件事情,如果某个函数的功能十分复杂,可以考虑能否将其拆分成几个更细的函数,这样不仅能提高可读性和可维护性,而且也利于代码重用。

9、不要用flag作为函数的参数。flag就是在告诉大家,这个方法里处理很多事。一个函数应当只做一件事。 把不同flag的代码拆分到多个函数里。

function createFile(name, $temp = false)
{
    if ($temp) {
        touch($tempDir.$name);
    } else {
        touch($name);
    }
}

function createFile($name)
{
    touch($name);
}
function createTempFile($name)
{
    touch($tempDir.$name);
}

10、不要写全局变量和函数,容易造成全局污染,可以定义一个类来专门使用。

11、封装条件语句,增强可读性。

if ($user->level === 0) {
    echo 'is admin';
}

public function isAdmin($user){
    return $user->level === 0 ? true : false;
}
if (isAdmin($user)) {
    echo 'is admin';
}

12、给对象使用私有或受保护的成员变量,当需要被外部类访问的时候才使用 public。

13、DRY原则:Don’t Repeat Yourself。别写重复的代码,尽量不要复制粘贴你写的代码,虽然复制一时爽,但是当你需要修改这段代码的时候,修改的量也就不止一处了。为了使后期的维护工作变得简单,我们应该尽量减少代码重复的部分。

public function example($age)
{
    if ($age > 60) {
        return ['success' => TRUE, 'message' => '成功', 'code' => 0, 'data' => '老人'];
    } elseif($age > 18) {
        return ['success' => TRUE, 'message' => '成功', 'code' => 0, 'data' => '成年人'];
    } else {
        return ['success' => TRUE, 'message' => '成功', 'code' => 0, 'data' => '未成年人'];
    }
}

public function example($age)
{
    if ($age > 60) {
        $data = '老人';
    } elseif($age > 18) {
        $data = '成年人';
    } else {
        $data = '未成年人';
    }
    return ['success' => TRUE, 'message' => '成功', 'code' => 0, 'data' => $data ];
}

14、五个最重要的面对对象编码设计原则:SOLID

  • S: 单一职责原则 (SRP:Single Responsibility Principle):修改一个类应该只为一个理由,不要将一堆方法塞到一个类里面去,其功能应该约精简越好,修改次数越少越好。
  • O: 开闭原则 (OCP:Open/Closed Principle):对扩展开放,对修改关闭。即应该做到,在增加新的功能时,尽量不改变已有的代码。
  • L: 里氏替换原则 (LSP:Liskov Substitution Principle):在不改变原有结果正确性的前提下父类和子类可以互换。
  • I: 接口隔离原则 (ISP:Interface Segregation Principle):调用方不应该被强制依赖于他不需要的接口。
  • D: 依赖倒置原则 (DIP:Dependency Inversion Principle):1、高阶的模块不应该依赖低阶的模块,它们都应该依赖于抽象。2、抽象不应该依赖于实现,实现应该依赖于抽象。

好了,以上就是我对原文的整理,再加上我自己平时编程的一些习惯。如果你也有好的编程习惯,欢迎交流!

原文链接:https://github.com/php-cpm/clean-code-php

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注