suchen

Heim >Backend-Entwicklung >PHP-Tutorial >Erfahren Sie, wie Sie PHP-Code besser umgestalten

Erfahren Sie, wie Sie PHP-Code besser umgestalten

藏色散人
藏色散人nach vorne
2023-03-13 15:44:273001Durchsuche

Dieser Artikel vermittelt Ihnen relevantes Wissen über PHP. Er spricht hauptsächlich darüber, was Refactoring ist. Wie kann man PHP-Code besser umgestalten? Freunde, die interessiert sind, können einen Blick darauf werfen. Ich hoffe, es wird für alle hilfreich sein.

Erfahren Sie, wie Sie PHP-Code besser umgestalten

Refactoring bezieht sich auf das Ändern oder Umschreiben des Codes, ohne die ursprüngliche Funktionalität zu ändern.

Im folgenden Beispiel zeige ich Ihnen, wie Sie Code besser schreiben können.

#1 – Ausdrucksstark

Dies ist vielleicht nur ein einfacher Tipp, aber das Schreiben von ausdrucksstarkem Code kann unseren Code erheblich verbessern. Sorgen Sie dafür, dass der Code immer selbsterklärend ist, damit Sie oder andere Entwickler in Zukunft wissen, was im Code vor sich geht.

Einige Entwickler sagten jedoch, dass die Benennung eines der schwierigsten Dinge beim Programmieren sei. Das ist einer der Gründe, warum es nicht so einfach ist, wie es sich anhört.

Beispiel #1 – Benennung

vor 

// ❌ 这个方法是用来做什么的，方法名表达并不清晰
// ❌ 是设置状态还是检查状态呢？
$status = $user->status('pending');

nach

// ✅ 通过添加 is，使方法名表达的意图更清晰
// ✅ 检测用户状态是否与给定状态相等
// ✅ 同时新变量名让我们可以推断它是布尔值
$isUserPending = $user->isStatus('pending');

Beispiel #2 – Benennung

vor 

// ❌ 这个类返回的是什么？类名？类全名？还是类路径？
return $factory->getTargetClass();

nach

// ✅ 我们获取的是类路径
// ✅ 如果用户想要类名？则找错了方法
return $factory->getTargetClassPath();

Beispiel #3 – Extrahieren

Vorher

// ❌ 重复的代码 ( "file_get_contents", "base_path" 方法以及文件扩展)
// ❌ 此刻，我们不去关心如何获得code examples
public function setCodeExamples(string $exampleBefore, string $exampleAfter)
{
    $this->exampleBefore = file_get_contents(base_path("$exampleBefore.md"));
    $this->exampleAfter = file_get_contents(base_path("$exampleAfter.md"));
}

Nachher 

public function setCodeExamples(string $exampleBefore, string $exampleAfter)
{ 
    // ✅ 代码直接说明了我们的意图：获取code example(不关注如何获取)
    $this->exampleBefore = $this->getCodeExample($exampleBefore);
    $this->exampleAfter = $this->getCodeExample($exampleAfter);
}
// ✅ 这个新方法可多次调用
private function getCodeExample(string $exampleName): string
{
    return file_get_contents(base_path("$exampleName.md"));
}

Beispiel Nr. 4 – Extrahieren

Vorher 

// ❌ 多重 where 语句，使阅读变得困难
// ❌ 意图究竟是什么呢？
User::whereNotNull('subscribed')->where('status', 'active');

Nachher

// ✅ 这个新的scope方法说明了发生了什么事
// ✅ 如果我们需要了解更多细节，可以进入这个scope方法内部去了解
// ✅ "subscribed" scope 方法可在其他地方使用
User::subscribed();

Beispiel Nr. 5 – Extrahieren

Dies ist ein Beispiel aus meinem vorherigen Projekt. Wir verwenden die Befehlszeile, um Benutzer zu importieren. Die ImportUsersCommand-Klasse enthält eine Handle-Methode zum Behandeln von Aufgaben.

Vorher

protected function handle()
{
    // ❌ 这个方法包含太多代码
    $url = $this->option('url') ?: $this->ask('Please provide the URL for the import:');
    $importResponse =  $this->http->get($url);
    // ❌ 进度条对用户很有用，不过却让代码显得杂乱
    $bar = $this->output->createProgressBar($importResponse->count());
    $bar->start();
    $this->userRepository->truncate();
    collect($importResponse->results)->each(function (array $attributes) use ($bar) {
        $this->userRepository->create($attributes);
        $bar->advance();
    });
    // ❌ 很难说清此处发生了哪些行为
    $bar->finish();
    $this->output->newLine();
    $this->info('Thanks. Users have been imported.');
    if($this->option('with-backup')) {
        $this->storage
            ->disk('backups')
            ->put(date('Y-m-d').'-import.json', $response->body());
        $this->info('Backup was stored successfully.');
    }
}

Nachher

protected function handle(): void
{
    // ✅ handle方法是你访问该类首先会查看的方法
    // ✅ 现在可以很容易就对这个方法做了些什么有个粗略的了解
    $url = $this->option('url') ?: $this->ask('Please provide the URL for the import:');
    $importResponse =  $this->http->get($url);
    $this->importUsers($importResponse->results);
    $this->saveBackupIfAsked($importResponse);
}
// ✅ 如果需要了解更多细节，可以查看这些专用的方法
protected function importUsers($userData): void
{
    $bar = $this->output->createProgressBar(count($userData));
    $bar->start();
    $this->userRepository->truncate();
    collect($userData)->each(function (array $attributes) use ($bar) {
        $this->userRepository->create($attributes);
        $bar->advance();
    });
    $bar->finish();
    $this->output->newLine();
    $this->info('Thanks. Users have been imported.');
}
// ✅ 不要害怕使用多行代码
// ✅ 这个例子中它让我们核心的 handle 方法更为简洁
protected function saveBackupIfAsked(Response $response): void
{
    if($this->option('with-backup')) {
        $this->storage
            ->disk('backups')
            ->put(date('Y-m-d').'-import.json', $response->body());
        $this->info('Backup was stored successfully.');
    }
}

#2 – Frühe Rückkehr

Frühe Rückkehr bezieht sich auf die Praxis, bei der wir versuchen, Verschachtelungen zu vermeiden, indem wir die Struktur in bestimmte Fälle aufteilen. Auf diese Weise erhalten wir einen lineareren Code, der leichter zu lesen und zu verstehen ist. Scheuen Sie sich nicht, mehrere Return-Anweisungen zu verwenden.

Beispiel #1

Vor 

public function calculateScore(User $user): int
{
    if ($user->inactive) {
        $score = 0;
    } else {
        // ❌ 怎么又有一个 "if"?
        if ($user->hasBonus) {
            $score = $user->score + $this->bonus;
        } else {
            // ❌ 由于存在多个层级，大费眼神 ? 
            $score = $user->score;
        }
    }
    return $score;
}

Nach 

public function calculateScore(User $user): int
{
    // ✅ 边缘用例提前检测
    if ($user->inactive) {
        return 0;
    }
    // ✅ 每个用例都有自己的代码块，使得更容易跟进
    if ($user->hasBonus) {
        return $user->score + $this->bonus;
    }
    return $user->score;
}

Beispiel #2

Vor 

public function sendInvoice(Invoice $invoice): void
{
    if($user->notificationChannel === 'Slack')
    {
        $this->notifier->slack($invoice);
    } else {
        // ❌ 即使是简单的ELSE都影响代码的可读性
        $this->notifier->email($invoice);
    }
}

Nach 

public function sendInvoice(Invoice $invoice): bool
{
    // ✅ 每个条件都易读
    if($user->notificationChannel === 'Slack')
    {
        return $this->notifier->slack($invoice);
    }
    // ✅ 不用再考虑ELSE 指向哪里
    return $this->notifier->email($invoice);
}

Hinweis: Manchmal hört man den Begriff „defensiv“. -Anweisung", die bei vorzeitiger Rückgabe zurückgegeben wird.

#3 – Umstrukturierung in eine Sammlung

In PHP verwenden wir Arrays in vielen verschiedenen Daten. Die für die Handhabung und Konvertierung dieser Arrays verfügbaren Funktionen sind sehr begrenzt und bieten kein gutes Erlebnis. (array_walk, usort usw.)

Um dieses Problem zu lösen, gibt es ein Konzept der Collection-Klasse, mit dem Sie Arrays für Sie verwalten können. Die bekannteste Implementierung findet sich in Laravel, wo die Collection-Klasse viele nützliche Funktionen für die Arbeit mit Arrays bereitstellt.

Hinweis: In den folgenden Beispielen verwende ich die Hilfsfunktion „collect()“ von Laravel, sie kann jedoch auf ähnliche Weise in anderen Frameworks oder Bibliotheken verwendet werden.

Beispiel #1

Vorher

// ❌ 这里我们有一个临时变量 
$score = 0;
// ❌ 用循环没有问题，不过可读性还是有改善空间
foreach($this->playedGames as $game) {
    $score += $game->score;
}
return $score;

Nachher

// ✅ 集合是带有方法的对象
// ✅ sum 方法使之更具表现力
return collect($this->playedGames)
    ->sum('score');

Beispiel #2

Vorher

$users = [
    [ 'id' => 801, 'name' => 'Peter', 'score' => 505, 'active' => true],
    [ 'id' => 844, 'name' => 'Mary', 'score' => 704, 'active' => true],
    [ 'id' => 542, 'name' => 'Norman', 'score' => 104, 'active' => false],
];
// 请求结果: 只显示活跃用户，以 score 排序  ["Mary(704)","Peter(505)"]
$users = array_filter($users, fn ($user) => $user['active']);
// ❌ usort 进行排序处理的又是哪一个对象呢？它是如何实现？
usort($users, fn($a, $b) => $a[&#39;score&#39;] < $b[&#39;score&#39;]);
// ❌ 所有的转换都是分离的，不过都是users相关的
$userHighScoreTitles = array_map(fn($user) => $user[&#39;name&#39;] . &#39;(&#39; . $user[&#39;score&#39;] . &#39;)&#39;, $users);
return $userHighScoreTitles;

Nachher

$users = [
    [ &#39;id&#39; => 801, &#39;name&#39; => &#39;Peter&#39;, &#39;score&#39; => 505, &#39;active&#39; => true],
    [ &#39;id&#39; => 844, &#39;name&#39; => &#39;Mary&#39;, &#39;score&#39; => 704, &#39;active&#39; => true],
    [ &#39;id&#39; => 542, &#39;name&#39; => &#39;Norman&#39;, &#39;score&#39; => 104, &#39;active&#39; => false],
];
// 请求结果: 只显示活跃用户，以 score 排序  ["Mary(704)","Peter(505)"]
// ✅ 只传入一次users
return collect($users)
    // ✅ 我们通过管道将其传入所有方法
  ->filter(fn($user) => $user[&#39;active&#39;])
  ->sortBy(&#39;score&#39;)
  ->map(fn($user) => "{$user[&#39;name&#39;]} ({$user[&#39;score&#39;]})"
  ->values()
    // ✅ 最后返回数组
  ->toArray();

#4 – Konsistenz

Jede Codezeile fügt ein wenig visuelles Rauschen hinzu . Je mehr Code vorhanden ist, desto schwieriger ist er zu lesen. Deshalb ist es wichtig, Regeln zu haben. Wenn Sie solche Dinge konsistent halten, können Sie Codes und Muster besser erkennen. Dies führt zu weniger Rauschen und besser lesbarem Code.

Beispiel #1

Vorher

class UserController 
{
    // ❌ 确定如何命名变量(驼峰或是蛇形等)，不要混用！
    public function find($userId)
    {
    }
}
// ❌ 选择使用单数或者复数形式命名控制器，并保持一致
class InvoicesController 
{
    // ❌ 修改了样式，如花扣号的位置，影响可读性
    public function find($user_id) {
    }
}

Nachher

class UserController 
{
    // ✅ 所有变量驼峰式命名
    public function find($userId)
    {
    }
}
// ✅ 控制器命名规则一致(此处都使用单数)
class InvoiceController 
{
    // ✅ 花括号的位置(格式)一致，使代码更为可读
    public function find($userId)
    {
    }
}

Beispiel #2

Vorher

class PdfExporter
{
    // ❌ "handle" 和 "export" 是类似方法的不同名称
    public function handle(Collection $items): void
    {
        // export items...
    }
}
class CsvExporter
{
    public function export(Collection $items): void
    {
        // export items...
    }
}
// ❌ 使用时你会疑惑它们是否处理相似的任务
// ❌ 你可能需要再去查看类源码进行确定
$pdfExport->handle();
$csvExporter->export();

Nachher

// ✅ 可通过接口提供通用规则保持一致性
interface Exporter
{
    public function export(Collection $items): void;
}
class PdfExporter implements Exporter
{
    public function export(Collection $items): void
    {
        // export items...
    }
}
class CsvExporter implements Exporter
{
    public function export(Collection $items): void
    {
        // export items...
    }
}
// ✅ 对类似的任务使用相同的方法名，更具可读性
// ✅ 不用再去查看类源码，变可知它们都用在导出数据
$pdfExport->export();
$csvExporter->export();

Refactor❤️-Test

Ich habe bereits erwähnt, dass Refactoring die Codefunktion nicht verändert. Dies ist beim Ausführen von Tests praktisch, da diese auch nach dem Refactoring funktionieren sollten. Deshalb beginne ich mit dem Refactoring von Code erst, wenn ich Tests habe. Sie stellen sicher, dass ich das Verhalten des Codes nicht versehentlich ändere. Vergessen Sie also nicht, Tests zu schreiben und sich sogar für TDD zu entscheiden.

Empfohlenes Lernen: „PHP-Video-Tutorial“

Das obige ist der detaillierte Inhalt vonErfahren Sie, wie Sie PHP-Code besser umgestalten. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Stellungnahme：
Dieser Artikel ist reproduziert unter:learnku.com. Bei Verstößen wenden Sie sich bitte an admin@php.cn löschen
Vorheriger Artikel：Ein Artikel, der analysiert, wie die vorverarbeiteten Abfragen von PHP die SQL-Injection verhindernNächster Artikel：Ein Artikel, der analysiert, wie die vorverarbeiteten Abfragen von PHP die SQL-Injection verhindern

In Verbindung stehende Artikel

Mehr sehen