dy原则的一个简单实践是什么(dy的dy)
在生活中,很多人可能想了解和弄清楚DRY原则的一个简单实践的相关问题?那么关于dry原则的一个简单实践是什么的答案我来给大家详细解答下。
DRY 是软件开发的原则之一,其目的主要是为了避免代码重复,指导开发者尽量以抽象的思维去解决重复,基本上是,当您发现自己一遍又一遍地编写相同的代码时,可能会有更好的方法。
实际案例
让我们先看一个例子,看看这个例子是否可以改进,以及如何通过重构来避免代码重复。
这里有一个简单的Report类,该类接收一些数据并通过控制台以格式化的方式直接输出。
我们这里使用php的一个代码片段来举例,相信大家对代码的结构和想要完成的工作都不难理解,所以为了大家更容易理解,我只对一些下面用到的php函数定义做一个解释:
1. echo() 函数输出一个或多个字符串
2. ucwords()函数把字符串中每个单词的首字符转换为大写。
3. strtolower() 函数把字符串转换为小写。
4. file_put_contents() 函数把一个字符串写入文件中。
5. floor() 函数向下舍入为最接近的整数。
class Report
{
public function show(array $data)
{
echo &34; . ucwords(strtolower($data[&34;])) . &34;;
echo &34; . ucwords(strtolower($data[&34;])) . &34;;
echo &34; . date(&34;, $data[&34;]) . &34;;
echo &34; . date(&34;, $data[&34;]) . &34;;
echo &34; . $data[&34;] . &34;;
echo &34; . floor($data[&34;] / 365) . &34;;
echo &34; . floor($data[&34;] / 52) . &34;;
}
}
可以看到,上面的代码完成目标是没有任何问题的。
这时我们对Report类提出一个新的需求:把所有字符串也可以保存到文件中。
我们经过一通复制和粘贴上面的代码,新建一个名为saveToFile的函数,就可以很快的完成这个需求,代码如下:
class Report
{
public function show(array $data)
{
echo &34; . ucwords(strtolower($data[&34;])) . &34;;
echo &34; . ucwords(strtolower($data[&34;])) . &34;;
echo &34; . date(&34;, $data[&34;]) . &34;;
echo &34; . date(&34;, $data[&34;]) . &34;;
echo &34; . $data[&34;] . &34;;
echo &34; . floor($data[&34;] / 365) . &34;;
echo &34; . floor($data[&34;] / 52) . &34;;
echo &34; . floor($data[&34;] / 12) . &34;;
}
public function saveToFile(array $data)
{
$report = &39;;
$report .= &34; . ucwords(strtolower($data[&34;])) . &34;;
$report .= &34; . ucwords(strtolower($data[&34;])) . &34;;
$report .= &34; . date(&34;, $data[&34;]) . &34;;
$report .= &34; . date(&34;, $data[&34;]) . &34;;
$report .= &34; . $data[&34;] . &34;;
$report .= &34; . floor($data[&34;] / 365) . &34;;
$report .= &34; . floor($data[&34;] / 52) . &34;;
$report .= &34; . floor($data[&34;] / 12) . &34;;
file_put_contents(&34;, $report);
}
}
那么,上面的代码能够满足我们提出的需求吗?答案当然&34;。但是从技术角度来看,这段代码似乎是有些问题的,它的重复代码到处都是。无论是对代码阅读及后期维护来讲,这都是一场噩梦。
所以我们需要进行一些重构,抽象能抽象的方法,让冗繁的代码变得更简洁。
首先,我们对Report类进行功能上的抽象,生成报告并输出一共可以分为两个功能,一个只负责创建Report,一个只负责如何处理Report,那么让我们开始重构吧。
class Report
{
public function show(array $data)
{
echo $this->createReport($data);
}
public function saveToFile(array $data)
{
file_put_contents(&34;, $this->createReport($data));
}
private function createReport(array $data): string
{
$report = &39;;
$report .= &34; . ucwords(strtolower($data[&34;])) . &34;;
$report .= &34; . ucwords(strtolower($data[&34;])) . &34;;
$report .= &34; . date(&34;, $data[&34;]) . &34;;
$report .= &34; . date(&34;, $data[&34;]) . &34;;
$report .= &34; . $data[&34;] . &34;;
$report .= &34; . floor($data[&34;] / 365) . &34;;
$report .= &34; . floor($data[&34;] / 52) . &34;;
$report .= &34; . floor($data[&34;] / 12) . &34;;
return $report;
}
}
现在看起来更清楚一些,对吗?
下面我们还有函数使用重复的问题要解决,例如,Report和Products的名称函数使用重复:
$report .= &34; . ucwords(strtolower($data[&34;])) . &34;;
$report .= &34; . ucwords(strtolower($data[&34;])) . &34;;
我们可以将这些转换抽象为一个新的函数:
private function normalizeName($name): string
{
return ucwords(strtolower($name));
}
另一个重复:日期格式。
$report .= &34; . date(&34;, $data[&34;]) . &34;;
$report .= &34; . date(&34;, $data[&34;]) . &34;;
让我们将其抽象为:
private function formatDate($date): string
{
return date(&34;, $date);
}
最后一个:平均值计算。
$report .= &34; . floor($data[&34;] / 365) . &34;;
$report .= &34; . floor($data[&34;] / 52) . &34;;
$report .= &34; . floor($data[&34;] / 12) . &34;;
尽管计算结果并不完全相同,但执行的操作大家是一致的,所以可以抽象为如下:
private function calculateAverage(array $data, $period): string
{
return floor($data[&34;] / $period);
}
所以,经过了一番重构,最终的Report类变为了如下:
class Report
{
public function show(array $data)
{
echo $this->createReport($data);
}
public function saveToFile(array $data)
{
file_put_contents(&34;, $this->createReport($data));
}
private function createReport(array $data)
{
$report = &39;;
$report .= &34; . $this->normalizeName($data[&34;]) . &34;;
$report .= &34; . $this->normalizeName($data[&34;]) . &34;;
$report .= &34; . $this->formatDate($data[&34;]) . &34;;
$report .= &34; . $this->formatDate($data[&34;]) . &34;;
$report .= &34; . $data[&34;] . &34;;
$report .= &34; . $this->calculateAverage($data, 365) . &34;;
$report .= &34; . $this->calculateAverage($data, 52) . &34;;
$report .= &34; . $this->calculateAverage($data, 12) . &34;;
return $report;
}
private function formatDate($date): string
{
return date(&34;, $date);
}
private function calculateAverage(array $data, $period): string
{
return floor($data[&34;] / $period);
}
private function normalizeName($name): string
{
return ucwords(strtolower($name));
}
}
这是一个简单的例子,实际情况可能比这要更加复杂的多,但我仅想通过这个实例向大家说明一个问题,那就是避免重复代码的重要性及我们如何通过重构去处理重复代码。
有时候重复一次相同的代码可能没问题,但是当第三次我们写出相同的代码时,那就说明是时候重构你的代码了。
结论:
请记住DRY原则,并随时抱着不要重复自己代码的想法去完成开发工作。
温馨提示:通过以上关于DRY原则的一个简单实践内容介绍后,相信大家有新的了解,更希望可以对你有所帮助。