在软件开发中,防御性编程和进攻性编程是确保代码质量和安全性的两种重要策略。本文将探讨这两种编程方法,并通过对应的代码示例来演示它们的应用。

参考文章:

防御性编程(Defensive Programming)

防御性编程是一种预防性的编程方法,旨在确保软件在面对错误输入或意外情况时仍能正常运行。这种方法强调代码的健壮性和错误处理能力。

关键原则包括:

  • 输入验证:始终验证外部输入,确保它们符合预期的格式和范围。
  • 错误处理:使用异常处理机制来捕获和处理可能发生的错误。
  • 代码审计:编写清晰、可读的代码,并进行代码审计以检测潜在的安全漏洞。

Golang 示例:

package main

import (
	"errors"
	"fmt"
)

// 定义一个函数,用于处理用户输入
func ProcessInput(input string) (string, error) {
	if len(input) == 0 {
		return "", errors.New("input cannot be empty")
	}
	// 假设我们期望的输入长度不超过1000个字符
	if len(input) > 1000 {
		return "", errors.New("input is too long")
	}
	// 处理输入...
	return input, nil
}

func main() {
	input := "用户输入的数据"
	output, err := ProcessInput(input)
	if err != nil {
		fmt.Println("Error:", err)
	} else {
		fmt.Println("Processed input:", output)
	}
}

在上述代码中,ProcessInput 函数首先检查输入是否为空或过长,如果是,则返回错误。这是防御性编程的一个典型例子,通过检查和验证输入来防止错误。


关于大家日常调侃的“防御性编程”我们称它为忍者代码,关于忍者代码在 现代 JavaScript 教程 中讲的即讽刺幽默又真实全面,这些难懂的代码风格都是从真实的代码中提炼而来的,有的甚至是经验丰富的大神的代码,大家可以前往学习:《忍者代码指南:“防御性编程技巧”保卫你的职业生涯》

进攻性编程(Offensive Programming)

进攻性编程是防御性编程的补充,它的核心思想是“信任但验证”。这种方法假设内部代码是可靠的,但仍会进行必要的检查以防止潜在的错误。

关键原则包括:

  • 断言:使用断言来验证代码的关键部分,确保它们的正确性。
  • 信任内部数据:假设内部数据是可信的,但对外部来源的数据进行严格的验证。
  • 错误传播:当错误发生时,允许它们在调用堆栈中传播,直到被适当的处理程序捕获。

Golang 示例:

package main

import (
	"fmt"
)

// 定义一个枚举类型,表示交通信号灯的颜色
type TrafficLightColor int

const (
	TRAFFICLIGHT_RED TrafficLightColor = iota
	TRAFFICLIGHT_YELLOW
	TRAFFICLIGHT_GREEN
)

// 使用断言来确保只处理预期的枚举值
func TrafficLightColorName(c TrafficLightColor) string {
	switch c {
	case TRAFFICLIGHT_RED:
		return "red"
	case TRAFFICLIGHT_YELLOW:
		return "yellow"
	case TRAFFICLIGHT_GREEN:
		return "green"
	default:
		panic("invalid traffic light color")
	}
}

func main() {
	color := TRAFFICLIGHT_RED
	fmt.Println("The traffic light color is:", TrafficLightColorName(color))
}

在这个例子中,TrafficLightColorName 函数使用了panic来处理不期望的枚举值,这是进攻性编程的一个实例,它允许程序在遇到不可恢复的错误时失败。


防御性编程的进阶实践

阅读全文:https://blog.axiaoxin.com/post/defensive-coding/