代码中的硬编码怎么消除？

本文目录导读：

1. 快速检查清单：哪些东西最容易硬编码？
2. 注意事项（避坑指南）

消除代码中的“硬编码”（Hard Coding）是指将那些可能变化的值（如配置参数、字符串、API密钥、URL、业务规则等）从代码逻辑中抽离出来，使其变得可配置、可维护、可复用。

根据你的场景和编程语言,消除硬编码最核心的方法有以下几种：

使用常量（Constants）

适用场景：项目内部使用、不跨环境变化、所有开发者约定好不会改的值（如数学常数 PI、状态码、固定错误信息）。

# 硬编码
if status == 1:
    print("订单已支付")
# 消除后
PAYMENT_STATUS_PAID = 1
if status == PAYMENT_STATUS_PAID:
    print("订单已支付")

使用配置文件（Configuration Files）

适用场景：数据库连接、外部API地址、端口号、日志级别等随环境变化的值。

推荐格式：

• JSON / YAML：适合复杂结构、多语言项目。
• .env 文件：特别适合敏感信息（密钥、密码）和本地开发。

示例（Python + configparser）：

# config.ini
[database]
host = localhost
port = 3306
# 代码中
import configparser
config = configparser.ConfigParser()
config.read('config.ini')
db_host = config['database']['host']   # 不再是硬编码 "localhost"

示例（Node.js + .env）：

// .env
DB_HOST=localhost
DB_PORT=27017
// 代码中
require('dotenv').config();
const dbHost = process.env.DB_HOST;  // 不再是硬编码 "localhost"

使用数据库或外部存储

适用场景：业务逻辑中的规则列表、价格表、用户个性化配置，这些值会频繁变动且需要热更新。

• 数据库表：动态读取配置（SELECT value FROM config WHERE key = 'max_login_attempts'）。
• Redis / 配置中心：高频读取且需实时更新时使用（如 Apollo, Nacos, Consul）。

命令行参数或环境变量

适用场景：启动时需要临时指定的值，如调试模式、不同环境的API base URL。

命令行示例：

python my_app.py --port 8080 --mode debug
# 代码中读取 sys.argv 或使用 argparse

环境变量示例：

import os
mode = os.getenv('APP_MODE', 'production')  # 默认是 production，不是硬编码

依赖注入（Dependency Injection）

适用场景：消除代码中“内部 new 出来的具体实现”（如直接 new 了一个数据库连接或第三方服务）。

示例（Java / C# 风格）：

// 硬编码
public class OrderService {
    private EmailSender sender = new SmtpEmailSender("smtp.gmail.com");
}
// 消除后（注入）
public class OrderService {
    private EmailSender sender;
    public OrderService(EmailSender sender) {
        this.sender = sender;  // 由调用者决定使用哪个EmailSender
    }
}

使用资源文件 / 国际化文件

适用场景：UI界面显示的文字、错误提示消息、多语言文本。

示例（i18n）：

// 硬编码
alert("Hello, world!");
// 消除后
alert(i18n.t('welcome_message'));
// lang.json: { "welcome_message": "Hello, world!" }

快速检查清单：哪些东西最容易硬编码？

注意事项（避坑指南）

1. 不要过度抽象：如果某个值永远不会变（HTTP 状态码 200 的含义），硬编码常量的可读性反而更好。
2. 敏感信息：密码、Token等永远不要硬编码或提交到版本控制，必须使用环境变量或密钥管理工具。
3. 统一入口：大型项目中，建议统一一个配置读取模块或类，避免散落各处读取 os.getenv 或 config.get('key')。

一句话总结：把 “人可能会改的东西” 与 “代码逻辑” 分离，分离程度越高，代码的可维护性和移植性就越好。