《掌握 php 中的干净代码：我的编码之旅中的重要教训》重点介绍实用的实践规则和示例，以帮助 php 开发人员编写干净、可维护且高效的代码。在这里，我们将把这些基本规则分解为易于理解的部分，每个部分都附有一个示例。
1. 有意义的名字
- 规则：为变量、函数和类使用清晰且描述性的名称。
- 为什么：这使您的代码更易于理解和维护。
示例：
// bad:
$x = 25;
function d($a, $b) {
return $a + $b;
}
// good:
$age = 25;
function calculatesum($firstnumber, $secondnumber) {
return $firstnumber + $secondnumber;
}
描述：
立即学习“PHP免费学习笔记（深入）”；
- 避免使用单字母变量，例如 $x 或 $d。相反，请使用描述性名称，例如 $age 或calculatesum。
- 清晰的名称使您的意图明确，帮助当前和未来的开发人员理解代码的用途。
2. 单一责任原则（srp）
- 规则：一个函数或类应该只有一个改变的理由，这意味着它应该只做一件事。
- 为什么：这使您的代码更加模块化并且更容易重构。
示例：
// bad:
class order {
public function calculatetotal() {
// logic to calculate total
}
public function sendinvoiceemail() {
// logic to send email
}
}
// good:
class order {
public function calculatetotal() {
// logic to calculate total
}
}
class invoicemailer {
public function sendinvoiceemail() {
// logic to send email
}
}
描述：
立即学习“PHP免费学习笔记（深入）”；
- 在 bad 示例中，order 类负责计算总数并发送电子邮件。这违反了 srp，因为它有两个责任。
- 在good示例中，我们通过创建负责电子邮件任务的 invoicemailer 类来分离关注点，使每个类更易于管理和更新。
3. 保持函数较小
- 规则：函数应该做一件事并且做好它。将大函数分解为更小的函数。
- 为什么：小函数更容易理解、测试和维护。
示例：
// bad:
function processorder($order) {
// validate order
if (!$this->validateorder($order)) {
return false;
}
// calculate total
$total = $this->calculatetotal($order);
// send invoice
$this->sendinvoiceemail($order);
return true;
}
// good:
function processorder($order) {
if (!$this->isordervalid($order)) {
return false;
}
$this->finalizeorder($order);
return true;
}
private function isordervalid($order) {
return $this->validateorder($order);
}
private function finalizeorder($order) {
$total = $this->calculatetotal($order);
$this->sendinvoiceemail($order);
}
描述：
立即学习“PHP免费学习笔记（深入）”；
- 在 bad 示例中，processorder 函数尝试执行所有操作：验证、计算和发送发票。
- 在 good 示例中，我们将任务分解为更小、更集中的方法（isordervalid、finalizeorder），从而提高了可读性和可重用性。
4. 避免使用幻数和字符串
- 规则：用命名常量替换“神奇”数字和字符串。
- 为什么：这提高了可读性并使代码更容易修改。
示例：
// bad:
if ($user->age > 18) {
echo "eligible";
}
// good:
define('minimum_age', 18);
if ($user->age > minimum_age) {
echo "eligible";
}
描述：
立即学习“PHP免费学习笔记（深入）”；
- 在 bad 示例中，数字 18 是一个“神奇数字”。在分析上下文之前，你不知道它代表什么。
- 在 good 示例中，使用 minimum_age 使意图变得清晰，并允许您在一个位置更改值而无需搜索代码库。
5. dry（不要重复自己）
- 规则：避免重复代码。尽可能重用函数或类。
- 为什么：重复的代码更难维护并且更容易出现错误。
示例：
// bad:
$total = $itemprice * $quantity;
$finalprice = $total - ($total * $discountrate);
$carttotal = $cartitemprice * $cartquantity;
$finalcartprice = $carttotal - ($carttotal * $cartdiscountrate);
// good:
function calculatefinalprice($price, $quantity, $discountrate) {
$total = $price * $quantity;
return $total - ($total * $discountrate);
}
$finalprice = calculatefinalprice($itemprice, $quantity, $discountrate);
$finalcartprice = calculatefinalprice($cartitemprice, $cartquantity, $cartdiscountrate);
描述：
立即学习“PHP免费学习笔记（深入）”；
- 在bad示例中，价格计算逻辑是重复的。
- 在good示例中，我们创建了一个可重用的函数calculatefinalprice以避免重复并使代码更易于维护。
6. 使用保护子句来减少嵌套
- 规则：不使用深层嵌套的if语句，而是提前返回以简化结构。
- 为什么：保护子句消除了不必要的嵌套，使代码更干净、更易于遵循。
示例：
// bad:
function processpayment($amount) {
if ($amount > 0) {
if ($this->ispaymentmethodavailable()) {
if ($this->isuserloggedin()) {
// process payment
}
}
}
}
// good:
function processpayment($amount) {
if ($amount <= 0) {
return;
}
if (!$this->ispaymentmethodavailable()) {
return;
}
if (!$this->isuserloggedin()) {
return;
}
// process payment
}
描述：
立即学习“PHP免费学习笔记（深入）”；
- 在bad示例中，逻辑嵌套很深，导致阅读起来更加困难。
- 在good示例中，保护子句用于在不满足条件时提前返回，从而扁平化结构并使代码更清晰。
7. 评论“为什么”，而不是“什么”
- 规则：编写注释来解释为什么会发生某些事情，而不是解释正在发生的事情（这应该从代码中清楚地看出）。
- 为什么：注释应该提供超越显而易见的价值，有助于解释代码背后的意图和推理。
示例：
// bad: // increment age by 1 $age++; // good: // user's birthday has passed, increase age by 1 $age++;
描述：
立即学习“PHP免费学习笔记（深入）”；
- bad 注释只是重申了代码的作用，这从代码本身就很明显。
- good评论解释了为什么我们要增加年龄，添加有意义的背景。
8. 为了清晰而重构
- 规则：不断重构以提高代码清晰度和简单性。
- 为什么：干净的代码是通过不断重构来实现的，以确保它始终可读、高效和可维护。
示例：
// Before Refactoring:
function getDiscountedPrice($price, $isHoliday) {
if ($isHoliday) {
return $price * 0.9;
} else {
return $price;
}
}
// After Refactoring:
function getDiscountedPrice($price, $isHoliday) {
return $isHoliday ? $price * 0.9 : $price;
}
描述：
立即学习“PHP免费学习笔记（深入）”；
- 重构将冗长的代码转换为更简洁、优雅的版本，同时又不失清晰度。在此示例中，我们使用三元运算符简化了 if-else 结构。
这些基本规则源自在 php 中干净编码的旅程，使您的代码更具可读性、可维护性和可扩展性。通过一致地应用这些原则，您可以确保您的代码随着时间的推移易于理解和修改，无论您的项目有多复杂。
