Categories: 其他重构

基于 重构 简化条件逻辑 重构条件代码实现

1、现有的实现如下

<?php

namespace Modules\ThemeStoreDB\ThemeSetting;

use Illuminate\Support\Str;

class ThemeVersion
{
    const SPECIAL_IDENTIFIER = '-h.'; // 特殊版本标识
    const HYPHEN = '-'; // 连字符

    public string $semantic;

    function __construct(string $semantic)
    {
        $this->semantic = $semantic;
    }

    /**
     * 对比两个「PHP 规范化」的版本数字字符串，添加例外：-h.
     * @param self $version
     * @return int 在第一个参数小于，等于或大于第二个参数时，该比较函数必须相应地返回一个小于，等于或大于 0 的整数
     */    public function compare(self $version): int
    {
        if (Str::contains($this->semantic, self::SPECIAL_IDENTIFIER) && !Str::contains($version->semantic, self::SPECIAL_IDENTIFIER) && Str::before($this->semantic, self::HYPHEN) == Str::before($version->semantic, self::HYPHEN)) {
            return 1;
        } elseif (!Str::contains($this->semantic, self::SPECIAL_IDENTIFIER) && Str::contains($version->semantic, self::SPECIAL_IDENTIFIER) && Str::before($this->semantic, self::HYPHEN) == Str::before($version->semantic, self::HYPHEN)) {
            return -1;
        } else {
            return version_compare($this->semantic, $version->semantic);
        }
    }

2、参考 10.1　分解条件表达式（Decompose Conditional），调整为如下

<?php

namespace Modules\ThemeStoreDB\ThemeSetting;

use Illuminate\Support\Str;

class ThemeVersion
{
    const SPECIAL_IDENTIFIER = '-h.'; // 特殊版本标识
    const HYPHEN = '-'; // 连字符

    public string $semantic;

    function __construct(string $semantic)
    {
        $this->semantic = $semantic;
    }

    /**
     * 对比两个「PHP 规范化」的版本数字字符串，添加例外：-h.
     * @param self $version
     * @return int 在第一个参数小于，等于或大于第二个参数时，该比较函数必须相应地返回一个小于，等于或大于 0 的整数
     */    public function compare(self $version): int
    {
        if (self::isSpecial($this->semantic) && !self::isSpecial($version->semantic) && self::isMainEqual($this->semantic, $version->semantic)) {
            return 1;
        } elseif (!self::isSpecial($this->semantic) && self::isSpecial($version->semantic) && self::isMainEqual($this->semantic, $version->semantic)) {
            return -1;
        } else {
            return version_compare($this->semantic, $version->semantic);
        }
    }

    /**
     * 返回版本是否是特殊版本
     * @param string $semantic
     * @return bool
     */    private static function isSpecial(string $semantic): bool
    {
        return Str::contains($semantic, self::SPECIAL_IDENTIFIER);
    }

    /**
     * 返回两个版本的主版本号是否相等
     * @param string $semantic1
     * @param string $semantic2
     * @return bool
     */    private static function isMainEqual(string $semantic1, string $semantic2): bool
    {
        return self::getMain($semantic1) == self::getMain($semantic2);
    }

    /**
     * 获取版本的主版本号
     * @param string $semantic
     * @return string
     */    private static function getMain(string $semantic): string
    {
        return Str::before($semantic, self::HYPHEN);
    }
}

3、10.2　合并条件表达式（Consolidate Conditional Expression）。将检查条件提炼成一个独立的函数对于厘清代码意义非常有用，因为它把描述“做什么”的语句换成了“为什么这样做”。



    /**
     * 对比两个「PHP 规范化」的版本数字字符串，添加例外：-h.
     * @param self $version
     * @return int 在第一个参数小于，等于或大于第二个参数时，该比较函数必须相应地返回一个小于，等于或大于 0 的整数
     */    public function compare(self $version): int
    {
        if (self::isSpecialGt($this->semantic, $version->semantic)) {
            return 1;
        } elseif (self::isSpecialLt($this->semantic, $version->semantic)) {
            return -1;
        } else {
            return version_compare($this->semantic, $version->semantic);
        }
    }

    /**
     * 当两个版本中仅存在一个特殊版本时，第一个版本大于第二个版本
     * @param string $semantic1
     * @param string $semantic2
     * @return bool
     */    private static function isSpecialGt(string $semantic1, string $semantic2): bool
    {
        return self::isSpecial($semantic1) && !self::isSpecial($semantic2) && self::isMainEqual($semantic1, $semantic2);
    }

    /**
     * 当两个版本中仅存在一个特殊版本时，第一个版本小于第二个版本
     * @param string $semantic1
     * @param string $semantic2
     * @return bool
     */    private static function isSpecialLt(string $semantic1, string $semantic2): bool
    {
        return !self::isSpecial($semantic1) && self::isSpecial($semantic2) && self::isMainEqual($semantic1, $semantic2);
    }
}

4、10.3　以卫语句取代嵌套条件表达式（Replace Nested Conditional with Guard Clauses）。如果某个条件极其罕见，就应该单独检查该条件，并在该条件为真时立刻从函数中返回。这样的单独检查常常被称为“卫语句”（guard clauses）。

<?php

namespace Modules\ThemeStoreDB\ThemeSetting;

use Illuminate\Support\Str;

class ThemeVersion
{
    const SPECIAL_IDENTIFIER = '-h.'; // 特殊版本标识
    const HYPHEN = '-'; // 连字符

    public string $semantic;

    function __construct(string $semantic)
    {
        $this->semantic = $semantic;
    }

    /**
     * 对比两个「PHP 规范化」的版本数字字符串，添加例外：-h.
     * @param self $version
     * @return int 在第一个参数小于，等于或大于第二个参数时，该比较函数必须相应地返回一个小于，等于或大于 0 的整数
     */    public function compare(self $version): int
    {
        if (self::isSpecialGt($this->semantic, $version->semantic)) {
            return 1;
        }
        if (self::isSpecialLt($this->semantic, $version->semantic)) {
            return -1;
        }

        return version_compare($this->semantic, $version->semantic);
    }

    /**
     * 返回版本是否是特殊版本
     * @param string $semantic
     * @return bool
     */    private static function isSpecial(string $semantic): bool
    {
        return Str::contains($semantic, self::SPECIAL_IDENTIFIER);
    }

    /**
     * 返回两个版本的主版本号是否相等
     * @param string $semantic1
     * @param string $semantic2
     * @return bool
     */    private static function isMainEqual(string $semantic1, string $semantic2): bool
    {
        return self::getMain($semantic1) == self::getMain($semantic2);
    }

    /**
     * 获取版本的主版本号
     * @param string $semantic
     * @return string
     */    private static function getMain(string $semantic): string
    {
        return Str::before($semantic, self::HYPHEN);
    }

    /**
     * 当两个版本中仅存在一个特殊版本时，第一个版本大于第二个版本
     * @param string $semantic1
     * @param string $semantic2
     * @return bool
     */    private static function isSpecialGt(string $semantic1, string $semantic2): bool
    {
        return self::isSpecial($semantic1) && !self::isSpecial($semantic2) && self::isMainEqual($semantic1, $semantic2);
    }

    /**
     * 当两个版本中仅存在一个特殊版本时，第一个版本小于第二个版本
     * @param string $semantic1
     * @param string $semantic2
     * @return bool
     */    private static function isSpecialLt(string $semantic1, string $semantic2): bool
    {
        return !self::isSpecial($semantic1) && self::isSpecial($semantic2) && self::isMainEqual($semantic1, $semantic2);
    }
}
永夜

Leave a Comment
Share
Published by
永夜
Tags: Consolidate Conditional ExpressionDecompose Conditionalguard clausesReplace Nested Conditional with Guard Clauses以卫语句取代嵌套条件表达式函数分解条件表达式卫语句合并条件表达式简化条件逻辑重构重构条件代码
1 年 ago

Recent Posts

Laravel 9 中的 Redis 门面 hset 不允许传递多个字段/值

1、尝试基于 Redis 门面…

7 小时 ago

在 Google Chrome 中由于网站升级，打开空白，仅在无痕模式中可正常打开的解决

1、在 Google Chro…

4 天 ago

在 https://tinys.pl/cn/swap 上用 SOL 购买得到 NUTS，在 欧易 Web3 钱包 中显示数量为 0 的排查分析

1、在 https://tin…

6 天 ago

在 Laravel 9 中，基于 Spatie\QueryBuilder\QueryBuilder 来生成查询 SQL，同一字段可支持：partial、exact

1、参考：在 Laravel …

1 周 ago

基于 PHP-Xlswriter 导出 Excel 文件时，设置日期列的格式

1、现在导出的 Excel 文…

1 周 ago

在 OneKey 钱包中，发送 Optimism 网络中的 USDT 的流程

1、在 OneKey 钱包中，…

2 周 ago