展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > 契约式编程与防御式编程

契约式编程与防御式编程

背景 这事儿得从几天前的一次技术讨论说起——关于接口返回数据的处理,以及几个月前关于课件本地数据结构的争论。核心问题其实很经典:当约定好的数据格式出现异常时,我们该在程序内部默默兼容处理,还是干脆利落地抛出错误? 举个具体的例子:我们需要解析一段JSON。按照约定,它的格式要么是标准结构,要么干脆是

本文目录

    背景

    这事儿得从几天前的一次技术讨论说起——关于接口返回数据的处理,以及几个月前关于课件本地数据结构的争论。核心问题其实很经典:当约定好的数据格式出现异常时,我们该在程序内部默默兼容处理,还是干脆利落地抛出错误?

    举个具体的例子:我们需要解析一段JSON。按照约定,它的格式要么是标准结构,要么干脆是空值。但如果负责返回JSON的方法,偏偏给了一个“既非标准、又非空”的怪东西,程序该怎么办?

    团队里立刻出现了两种声音:

    小花主张:“一旦碰到约定之外的异常,程序必须做兼容处理,绝对不能Crash!”

    小Fa则认为:“约定外的异常必须立刻抛出,明确告知约定被破坏,这样才能揪出根因。”

    相信每位开发者都遇到过类似困境。最常见的“栗子”莫过于NullPointerException。当试图从JSON中取出某个字段却遭遇空指针时,一部分开发者会认定这是数据问题,把数据修正即可;另一部分则认为是程序问题,代码理应做好非空判断再使用。两种思路各有道理:前者代码简洁明了,逻辑干净,但一旦出错,程序便会崩溃;后者程序“耐操”,任你数据怎么错,我自岿然不动,但代价是代码里遍布非空判断,显得臃肿而重复。

    生存还是毁灭?这真是个问题。

    防御式编程

    正当我们争论不休时,一位姓康的同事默默祭出了一块“砖头”——《代码大全2》(近900页,厚度堪比三本《Android群英传》)。起初还以为他要物理说服,结果他翻到了第八章,几个大字赫然映入眼帘:『防御式编程』。

    《代码大全2》第八章封面图

    果然是老司机,居然能从“防御性驾驶”悟出“防御性编程”。说好的编程不开车呢?

    这位作者编程水平如何暂且不论,但论开车,肯定没有何老师diao!

    言归正传,《代码大全》给的定义很直白:所谓“防御式编程”,核心思想就是“人类是不安全且容易犯错的,你写的代码应该预见到所有可能的错误输入,确保程序不会因为别人的错误而崩溃”。

    书中提到,程序需要对可能的错误输入做出兼容。例如,一个除法函数,必须判断分母是否为0,并给调用者返回明确的错误提示。此外,高级语言通常提供了『断言』和『异常』两种机制来处理错误。

    断言

    断言,是一种在开发阶段使用的、让程序在运行时进行自检的代码。断言为真,程序正常运行;断言为假,程序则异常退出。等等,防御式编程不是说要兼容异常吗?怎么反而退出了?实际上,作者的本意是“先断言,后处理错误”,而断言通常只在开发环境中启用,正式上线后会被移除。

    断言机制示意图

    但这里存在一个悖论:开发阶段的错误处理代码,可能被断言提前拦截掉了。然而,错误处理代码本身也是人写的,谁来检测“错误处理代码”可能发生的错误呢?

    异常

    当代码出现问题时,可以通过抛出异常来通知外界。如果你无法处理,就交给上层调用者。这一点大家都很熟悉,最简单的莫过于try-catch。甚至见过有人把整段代码都塞进try-catch里——这得是对人类有多不信任?

    所以,防御式编程用久了,会不会开始怀疑人生?果然,往后翻几页,作者自己也给出了忠告。

    《代码大全》中关于防御式编程副作用的提醒

    借用奇异博士的一句台词:“你TM居然把警告写在咒语的下一页!”

    简而言之,防御式编程就是以怀疑的态度审视所有输入。但这和我们最初讨论的主题略有不同:我们面对的是“已有明确约定,但返回了约定之外内容”的情况。

    契约式编程

    讨论正酣,天空突然飘来五个字——哦不对,是另一个概念:『契约式编程』。

    这个听起来有点意思!简单来说,契约作用于双方,每一方都需要完成某些任务来促成契约,同时也必须履行一些义务作为前提。任何一方无视了应尽的义务,契约便宣告失败。

    契约式编程要求对『前提条件』、『后继条件』和『不变量条件』进行严格检查。例如参数检查,一旦参数不符合约定,立即“撕毁契约”。如今许多新语言都支持这种特性,比如Swift的参数约束检查,就是一种类契约式编程的实践。

    契约所约束的,是“确保程序正常运行的必要条件”。一旦契约被破坏,原因只有一个:程序出了Bug。例如,某个数据字段在处理时必须非空,那么谁来保证这一点?必须是调用方(或其他模块)。因此,一旦出现问题,责任方应是调用方,它必须确保调用时传入的参数符合约定。

    这让人想起早期面向日本企业编程时的一些经历。日本人的做事风格以谨慎和细致闻名,在详细设计阶段,每个方法、函数的参数、返回值、类型乃至所有可能取值都已定义清楚。方法之间有明确的界限,如果你的方法因为传入参数不符合设计而报错,你完全可以理直气壮地找到调用方,要求其按设计调用。不得不说,这堪称契约式编程的最佳实践。日企普遍采用这种方式还有一个原因:严格区分责任,让每个人都不必为了迁就他人的错误而进行“艰难的编码”。每个人只需按契约处理好自己的事,让破坏契约的人承担责任。

    再引申一下,这和现在的『面向接口编程』也非常类似。两个模块之间定义好调用和处理的接口,具体实现对方无需关心,只要按照协议开发即可。但光有接口还不够,还需要契约来进一步约束参数和返回值。

    无独有偶,《代码大全》中也提到了『进攻式编程』,其精神与契约式编程有异曲同工之妙。

    《代码大全》中关于进攻式编程的描述

    乌托邦

    好了,梦该醒了,让阳光照进现实。以上两种编程方式都非常理想化,但在大多数公司里,无论是推行防御式还是契约式,都面临实际困难。例如前端与后端的接口对接、不同部门同事的协作,按契约式编程,可能没人理会你的契约;按防御式编程,代码又容易变得惨不忍睹,且防不胜防。

    那么到底该怎么办?一个可行的思路是:如果能在公司层面推广契约式编程,首先能提升开发效率,让每个人对自己写的代码负责,在开发者之间建立坚实的信任关系,同时减少不必要的沟通成本。但与此同时,必要的防御式编程也不能少,这是保证程序健壮与稳定的底线。

    怎么说呢,这或许体现了千百年来一脉相承的智慧——『中庸之道』。契约还是防御?视具体情况而定。这终究是一门平衡的艺术。

    警告

    最后,建议各位以防御式心态阅读本文。毕竟每个人都会犯错,欢迎留言交流。

    此文一出,很可能引发双方“混战”。红与黑,天灾还是近卫,联盟还是部落——Choose your side.

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Postman macOS版
    Postman macOS版

    Postman是一套面向API全生命周期的开发与测试平台,可在Mac上发送和调试多种协议请求,管理集合、环境及认证信息,并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用,提供个人免费方案。

    Docker Desktop macOS版
    Docker Desktop macOS版

    Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境,集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。

    Android Studio macOS版
    Android Studio macOS版

    Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境,基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。

    Xcode macOS版
    Xcode macOS版

    Xcode 是苹果面向 Mac 提供的官方集成开发环境,将代码编辑、项目构建、SwiftUI 实时预览、设备模拟、自动化测试、断点调试、性能分析和应用分发整合在同一套工作流中,适合开发与维护 iPhone、iPad、Mac、Apple Wa

    JetBrains WebStorm macOS版
    JetBrains WebStorm macOS版

    JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

    PhpStorm macOS版
    PhpStorm macOS版

    PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境,可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。

    JetBrains PyCharm macOS版
    JetBrains PyCharm macOS版

    JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

    JetBrains IntelliJ IDEA macOS版
    JetBrains IntelliJ IDEA macOS版

    IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

    Visual Studio Code macOS版
    Visual Studio Code macOS版

    Visual Studio Code 是微软提供的免费代码编辑器,支持 macOS,并为 Intel 与 Apple 芯片 Mac 提供适配版本。软件集代码编辑、调试、Git 源代码管理、集成终端和扩展市场于一体。

    REAPER macOS版
    REAPER macOS版

    REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

    Adobe Audition macOS版
    Adobe Audition macOS版

    Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

    Pro Tools macOS版
    Pro Tools macOS版

    Pro Tools 是 Avid 推出的专业数字音频工作站,覆盖多轨录音、无损剪辑、MIDI 编曲、插件处理、自动化混音及声音与画面同步等工作。它拥有 Intro、Artist、Studio 和 Ultimate 等方案。

    WINDOWS 更多
    PixPix 网页版
    PixPix 网页版

    PixPix 是面向品牌、卖家和内容团队的在线 AI 图片视频创作平台,提供图视频 Agent、无限画布、图片生成、视频生成、自然语言编辑及商品套图、产品精修和带货视频等电商工具。

    Postman Windows版
    Postman Windows版

    Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求,并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等

    Docker Desktop Windows版
    Docker Desktop Windows版

    Docker Desktop 为 Windows 开发者提供集成式容器环境,内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件,可在本机完成镜像构建、容器运行、日志查看和资源管理。

    Android Studio Windows版
    Android Studio Windows版

    Android Studio 是 Google 面向 Android 应用开发提供的官方集成开发环境,以 IntelliJ IDEA 为基础,集成智能代码编辑、Gradle 构建、设备模拟、界面预览、调试测试及性能分析工具,

    JetBrains WebStorm Windows版
    JetBrains WebStorm Windows版

    WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

    JetBrains PhpStorm Windows版
    JetBrains PhpStorm Windows版

    PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

    JetBrains PyCharm Windows版
    JetBrains PyCharm Windows版

    PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

    JetBrains IntelliJ IDEA Windows版
    JetBrains IntelliJ IDEA Windows版

    JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

    Visual Studio Code Windows版
    Visual Studio Code Windows版

    Visual Studio Code 是微软推出的免费代码编辑器,Windows 版集成智能补全、代码导航、调试、终端和版本控制,并可通过扩展添加语言、格式化及远程开发能力。它启动较快、配置灵活,

    REAPER Windows版
    REAPER Windows版

    REAPER 是 Cockos 推出的数字音频工作站,适用于录音、MIDI 编曲、音频编辑、混音、母带制作及声音设计。软件安装包小巧,支持多轨录制、灵活路由、自动化、第三方插件和脚本扩展,并提供完整功能的 60 天免费评估期。

    Adobe Audition Windows版
    Adobe Audition Windows版

    Adobe Audition 是面向播客、影视后期、广播与音乐制作的专业音频工作站,提供波形编辑、多轨混音、频谱分析、录音、降噪修复和效果处理等功能。Windows 版通过 Adobe Creative Cloud 安装和管理,

    Pro Tools Windows版
    Pro Tools Windows版

    Pro Tools 是 Avid 推出的专业数字音频工作站,提供多轨录音、音频剪辑、MIDI编曲、插件处理、自动化混音及影视声音制作能力。它适合音乐人、录音师、制作人和音频后期团队使用,并提供免费入门版、订阅方案及永久授权选择。