最小惊讶原则(POLA)

wufei123 2025-01-26 阅读:52 评论:0
关键概念 1. 一致的方法命名 // bad - inconsistent naming class usermanager { public function getuser($i...

最小惊讶原则(pola)

关键概念 1. 一致的方法命名
PHP
// bad - inconsistent naming
class usermanager {
    public function getuser($id) { /* ... */ }
    public function fetchrole($id) { /* ... */ }
    public function retrievepermissions($id) { /* ... */ }
}

// good - consistent naming pattern
class usermanager {
    public function getuser($id) { /* ... */ }
    public function getrole($id) { /* ... */ }
    public function getpermissions($id) { /* ... */ }
}

命名方法时,一致性至关重要。在这个糟糕的例子中,我们使用三个不同的动词(get、fetch、retrieve)来执行类似的操作。这迫使开发人员记住同一类型操作的不同术语。好的示例在所有方法中一致地使用“get”,使 api 更可预测且更容易记住。当开发人员需要访问数据时,他们会直观地知道寻找以“get”开头的方法。

2. 预期回报类型
PHP
// bad - unexpected return types
class filehandler {
    public function readfile($path) {
        if (!file_exists($path)) {
            return false; // unexpected boolean
        }
        return file_get_contents($path);
    }
}

// good - consistent return types with exceptions
class filehandler {
    public function readfile($path): string {
        if (!file_exists($path)) {
            throw new filenotfoundexception("file not found: {$path}");
        }
        return file_get_contents($path);
    }
}

这个糟糕的例子混合了返回类型 - 有时返回字符串(文件内容),有时返回布尔值(false)。这给如何处理返回值带来了不确定性。这个很好的例子通过声明字符串返回类型并使用错误情况的异常来确保类型安全。这与 php 的内置行为相匹配,并使错误处理更加明确和可预测。

3. 可预测的参数顺序
PHP
// bad - inconsistent parameter order
class orderprocessor {
    public function createorder($items, $userid, $date) { /* ... */ }
    public function updateorder($date, $orderid, $items) { /* ... */ }
}

// good - consistent parameter order
class orderprocessor {
    public function createorder($userid, $items, $date) { /* ... */ }
    public function updateorder($orderid, $items, $date) { /* ... */ }
}

相似方法中的参数顺序应该保持一致。糟糕的示例将相似的参数放在不同的位置,使 api 变得混乱。好的示例保持了逻辑顺序:首先是标识符(userid/orderid),然后是主要数据(项目),最后是可选/元数据参数(日期)。这种模式符合 php 框架中的常见约定,并使 api 更加直观。

4. 清晰的方法行为
PHP
// bad - ambiguous behavior
class cart {
    public function add($product) {
        // sometimes creates new item, sometimes updates quantity
        // unpredictable!
    }
}

// good - clear, single responsibility
class cart {
    public function addnewitem($product) { /* ... */ }
    public function updatequantity($productid, $quantity) { /* ... */ }
}

方法应该有明确、单一的职责。坏例子的“add”方法不明确 - 它可能会添加一个新项目或更新一个现有项目。这个很好的例子将其分为两个不同的方法,具有明确的名称和目的。这使得代码的行为可预测,并遵循单一职责原则 (srp)。

5. 一致的错误处理
PHP
class PaymentProcessor {
    public function processPayment(float $amount): PaymentResult {
        try {
            // Process payment
            return new PaymentResult(true, 'Payment successful');
        } catch (PaymentException $e) {
            // Always handle errors the same way
            throw new PaymentFailedException($e->getMessage());
        }
    }
}

此示例演示了通过异常进行一致的错误处理。当出现问题时,它总是抛出特定的异常类型(paymentfailedexception),而不是返回不同的类型或使用错误代码。这为整个应用程序的错误处理创建了一个可预测的模式。该方法还为成功案例使用专用的 paymentresult 对象,保持类型一致性。

这些实践中的每一种都有助于使代码更易于维护、更易于理解且不易出现错误,因为它的行为方式是开发人员基于 php 开发中的常见模式和约定所期望的方式。

以上就是最小惊讶原则(POLA)的详细内容,更多请关注知识资源分享宝库其它相关文章!

版权声明

本站内容来源于互联网搬运,
仅限用于小范围内传播学习,请在下载后24小时内删除,
如果有侵权内容、不妥之处,请第一时间联系我们删除。敬请谅解!
E-mail:dpw1001@163.com

分享:

扫一扫在手机阅读、分享本文

发表评论
热门文章
  • BioWare埃德蒙顿工作室面临关闭危机,龙腾世纪制作总监辞职引关注(龙腾.总监.辞职.危机.面临.....)

    BioWare埃德蒙顿工作室面临关闭危机,龙腾世纪制作总监辞职引关注(龙腾.总监.辞职.危机.面临.....)
    知名变性人制作总监corrine busche离职bioware,引发业界震荡!外媒“smash jt”独家报道称,《龙腾世纪:影幢守护者》制作总监corrine busche已离开bioware,此举不仅引发了关于个人职业发展方向的讨论,更因其可能预示着bioware埃德蒙顿工作室即将关闭而备受关注。本文将深入分析busche离职的原因及其对bioware及游戏行业的影响。 Busche的告别信:挑战与感激并存 据“Smash JT”获得的内部邮件显示,Busche离职原...
  • 闪耀暖暖靡城永恒怎么样-闪耀暖暖靡城永恒套装介绍(闪耀.暖暖.套装.介绍.....)

    闪耀暖暖靡城永恒怎么样-闪耀暖暖靡城永恒套装介绍(闪耀.暖暖.套装.介绍.....)
    闪耀暖暖钻石竞技场第十七赛季“华梦泡影”即将开启!全新闪耀性感套装【靡城永恒】震撼来袭!想知道如何获得这套精美套装吗?快来看看吧! 【靡城永恒】套装设计理念抢先看: 设计灵感源于夜色中的孤星,象征着淡然、漠视一切的灰色瞳眸。设计师希望通过这套服装,展现出在虚幻与真实交织的夜幕下,一种独特的魅力。 服装细节考究,从面料的光泽、鞋跟声响到裙摆的弧度,都力求完美还原设计初衷。 【靡城永恒】套装设计亮点: 闪耀的绸缎与金丝交织,轻盈的羽毛增添华贵感。 这套服装仿佛是从无尽的黑...
  • 蛋仔派对2025最新皮肤兑换码汇总 最新皮肤兑换码一览(兑换.皮肤.最新.派对.汇总.....)

    蛋仔派对2025最新皮肤兑换码汇总 最新皮肤兑换码一览(兑换.皮肤.最新.派对.汇总.....)
    蛋仔派对2025最新皮肤兑换码大放送!游戏内新增多款皮肤兑换码,包含最新、福利和通用三种类型,助你轻松获取精美奖励! 赶紧来看看如何兑换吧! 兑换码列表: 最新兑换码: ccewndj4k4k、cdkqdfm4fh、peetnmp4ef、cdxymk8f67 福利兑换码: cca863ywtfa、eggy2310am、eggy2311gz、eggyeggy9wz 通用兑换码: pec74dkcty、jsrqkrrjmh、cd3wt7wrph、ccepn7d8cjf...
  • python怎么调用其他文件函数

    python怎么调用其他文件函数
    在 python 中调用其他文件中的函数,有两种方式:1. 使用 import 语句导入模块,然后调用 [模块名].[函数名]();2. 使用 from ... import 语句从模块导入特定函数,然后调用 [函数名]()。 如何在 Python 中调用其他文件中的函数 在 Python 中,您可以通过以下两种方式调用其他文件中的函数: 1. 使用 import 语句 优点:简单且易于使用。 缺点:会将整个模块导入到当前作用域中,可能会导致命名空间混乱。 步骤:...
  • 俄罗斯引擎yandex入口官网地址 yandex网址在线免费进入(俄罗斯.官网.在线免费.入口.地址......)

    俄罗斯引擎yandex入口官网地址 yandex网址在线免费进入(俄罗斯.官网.在线免费.入口.地址......)
    俄罗斯引擎yandex官网地址入口在哪里?这是不少网友都关注的问题,接下来由php小编为大家带来yandex网址在线免费进入,感兴趣的网友一起随小编来瞧瞧吧! 俄罗斯引擎yandex入口官网地址 1、俄罗斯引擎yandex入口官网地址☜☜☜☜☜点击进入 2、yandex网址在线免费进入☜☜☜☜☜点击进入 【俄罗斯引擎yandex】 1、Yandex的搜索引擎在俄罗斯拥有极高的市场份额,其算法针对俄语和斯拉夫语系进行了优化,能更好地理解用户意图,提供更精准的搜索结果。它不仅...