Ajar anda cara memfaktorkan semula kod PHP dengan lebih baik

Artikel ini membawakan anda pengetahuan yang berkaitan tentang PHP terutamanya bercakap kepada anda tentang apa itu pemfaktoran semula? Bagaimana untuk memfaktorkan semula kod PHP dengan lebih baik? Rakan-rakan yang berminat boleh lihat di bawah ini semoga bermanfaat untuk semua.

Pemfaktoran semula merujuk kepada mengubah suai atau menulis semula kod tanpa mengubah fungsi asal.

Dalam contoh berikut, saya akan menunjukkan kepada anda cara menulis kod yang lebih baik.

#1 - Ekspresif

Ini mungkin hanya petua mudah, tetapi menulis kod ekspresif boleh meningkatkan kod kami dengan sangat baik. Sentiasa jelaskan kod itu sendiri supaya anda atau pembangun lain pada masa hadapan boleh mengetahui perkara yang berlaku dalam kod tersebut.

Walau bagaimanapun, sesetengah pembangun mengatakan bahawa penamaan adalah salah satu perkara yang paling sukar dalam pengaturcaraan. Itulah salah satu sebab mengapa ia tidak semudah yang disangkakan.

Contoh #1 - Penamaan

sebelum

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

selepas

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

Contoh #2 - Menamakan

sebelum

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

selepas

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

Contoh #3 - Mengekstrak

sebelum

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

Selepas

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

Contoh #4 - Ekstrak

Sebelum

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

Selepas

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

Contoh #5 - Pengekstrakan

Ini adalah contoh daripada projek saya sebelum ini. Kami menggunakan baris arahan untuk mengimport pengguna. Kelas ImportUsersCommand mengandungi kaedah pengendalian untuk mengendalikan tugas.

Sebelum

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

Selepas

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 - Pulang terlebih dahulu

Pulangan terlebih dahulu bermakna kita Cuba elakkan bersarang dengan memecahkan struktur kepada kes tertentu. Dengan cara ini kita mendapat kod yang lebih linear yang lebih mudah dibaca dan difahami. Jangan takut untuk menggunakan berbilang penyata pulangan.

Contoh #1

Sebelum

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

Selepas

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

Contoh #2

Sebelum

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

Selepas

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

Nota: Kadangkala anda akan mendengar istilah "pernyataan pertahanan", yang dilaksanakan dengan pulang awal.

#3 - Bina semula menjadi Koleksi koleksi

Dalam PHP, kami menggunakan tatasusunan dalam banyak data yang berbeza. Fungsi yang tersedia untuk mengendalikan dan menukar tatasusunan ini sangat terhad dan tidak memberikan pengalaman yang baik. (array_walk, usort, dll)

Untuk menangani masalah ini, terdapat konsep kelas Koleksi yang boleh digunakan untuk mengendalikan tatasusunan untuk anda. Pelaksanaan yang paling terkenal adalah dalam Laravel, di mana kelas koleksi menyediakan banyak ciri berguna untuk bekerja dengan tatasusunan.

Nota: Dalam contoh berikut, saya akan menggunakan fungsi helper collect () Laravel, tetapi ia boleh digunakan dengan cara yang sama dalam rangka kerja atau perpustakaan lain.

Contoh #1

Sebelum

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

Selepas

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

Contoh #2

Sebelum

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

Selepas

$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
return collect($users)
    // ✅ 我们通过管道将其传入所有方法
  ->filter(fn($user) => $user['active'])
  ->sortBy('score')
  ->map(fn($user) => "{$user['name']} ({$user['score']})"
  ->values()
    // ✅ 最后返回数组
  ->toArray();

#4 - Ketekalan

Setiap baris kod menambah jumlah yang kecil kebisingan Visual. Semakin banyak kod yang ada, semakin sukar untuk dibaca. Itulah sebabnya penting untuk mempunyai peraturan. Memastikan perkara seperti ini konsisten akan membantu anda mengenali kod dan corak. Ini akan menghasilkan bunyi yang kurang dan kod yang lebih mudah dibaca.

Contoh #1

Sebelum

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

Selepas

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

Contoh #2

Sebelum

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

Selepas

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

Pemfaktoran Semula❤️ Pengujian

Saya telah pun menyebut bahawa pemfaktoran semula tidak mengubah kefungsian kod. Ini mudah semasa menjalankan ujian, kerana ia juga harus berfungsi selepas pemfaktoran semula. Itulah sebabnya saya hanya mula memfaktorkan semula kod apabila saya mempunyai ujian. Mereka akan memastikan bahawa saya tidak mengubah tingkah laku kod secara tidak sengaja. Jadi jangan lupa untuk menulis ujian dan juga pergi untuk TDD.

Pembelajaran yang disyorkan: "Tutorial Video PHP"

Atas ialah kandungan terperinci Ajar anda cara memfaktorkan semula kod PHP dengan lebih baik. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!