ホームページ  >  記事  >  バックエンド開発  >  PHP コードをより適切にリファクタリングする方法を教えます

PHP コードをより適切にリファクタリングする方法を教えます

藏色散人
藏色散人転載
2023-03-13 15:44:272959ブラウズ

この記事では、PHP に関する関連知識を提供し、主にリファクタリングとは何かについて説明します。 PHP コードをより適切にリファクタリングするにはどうすればよいでしょうか?興味のある方は以下をご覧ください。皆様のお役に立てれば幸いです。

PHP コードをより適切にリファクタリングする方法を教えます

リファクタリングとは、元の機能を変更せずにコードを変更または書き直すことを指します。

次の例では、より良いコードを記述する方法を示します。

#1 - 表現力

これは単なるヒントかもしれませんが、表現力豊かなコードを書くことでコードを大幅に改善できます。将来あなたや他の開発者がコード内で何が起こっているかを知ることができるように、コードは常に一目瞭然になるようにしてください。

しかし、開発者の中には、名前付けはプログラミングで最も難しいことの 1 つだと言う人もいます。それが、思っているほど簡単ではない理由の 1 つです。

例 1 - 名前付け

Before

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

After

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

例 2 - 名前付け

before

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

after

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

例 #3 -

before

// ❌ 重复的代码 ( "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"));
}

after## の抽出#

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"));
}

例 4 - 抽出

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

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

例 5 - # の抽出##これは私の以前のプロジェクトの例です。ユーザーをインポートするにはコマンドラインを使用します。 ImportUsersCommand クラスには、タスクを処理するための handle メソッドが含まれています。

Before

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.');
    }
}

After

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 - 早期リターン

早期リターンとは、構造体 Decompose を渡そうとすることを意味します。ネストを避けるために特定のケースに分割します。こうすることで、読みやすく理解しやすい、より直線的なコードが得られます。複数の return ステートメントを使用することを恐れないでください。

例#1

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;
}

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

例#2

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

After

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

注: 「防御ステートメント」という用語を耳にすることがありますが、これは早期に復帰することで実装されます。

#3 - コレクションへの再構築 Collection

PHP では、さまざまなデータで配列を使用します。これらの配列の処理と変換に使用できる機能は非常に限られており、良好なエクスペリエンスを提供しません。 (array_walk、usort など)

この問題に対処するために、配列の処理に役立つ Collection クラスの概念があります。最もよく知られている実装は Laravel です。この実装では、コレクション クラスが配列を操作するための多くの便利な機能を提供します。

注: 次の例では、Laravel のcollect () ヘルパー関数を使用しますが、他のフレームワークやライブラリでも同様の方法で使用できます。

#例#1

#前

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

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

#例#2

Before

$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;
After
$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 - 一貫性

コードの各行により、少量の視覚的なノイズが追加されます。コードが多ければ多いほど、読むのが難しくなります。だからこそルールを設けることが重要なのです。このような一貫性を保つと、コードやパターンを認識しやすくなります。これにより、ノイズが減り、コードがより読みやすくなります。

例#1

class UserController 
{
    // ❌ 确定如何命名变量(驼峰或是蛇形等),不要混用!
    public function find($userId)
    {
    }
}
// ❌ 选择使用单数或者复数形式命名控制器,并保持一致
class InvoicesController 
{
    // ❌ 修改了样式,如花扣号的位置,影响可读性
    public function find($user_id) {
    }
}
class UserController 
{
    // ✅ 所有变量驼峰式命名
    public function find($userId)
    {
    }
}
// ✅ 控制器命名规则一致(此处都使用单数)
class InvoiceController 
{
    // ✅ 花括号的位置(格式)一致,使代码更为可读
    public function find($userId)
    {
    }
}

例#2

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();

After

// ✅ 可通过接口提供通用规则保持一致性
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();

リファクタリング❤️ テスト

リファクタリングによってコードの機能が変更されるわけではないことはすでに述べました。これは、リファクタリング後も機能するため、テストを実行するときに便利です。そのため、私はテストがあるときにのみコードのリファクタリングを開始します。コードの動作を誤って変更しないようにしてくれるでしょう。したがって、テストを作成することを忘れずに、TDD を採用することも忘れないでください。

推奨学習: 「PHP ビデオ チュートリアル

以上がPHP コードをより適切にリファクタリングする方法を教えますの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

声明:
この記事はlearnku.comで複製されています。侵害がある場合は、admin@php.cn までご連絡ください。