当前位置：首页 > news >正文

《代码整洁之道》第8章边界 - 笔记

news 2025/4/28 5:31:56

甚至是你团队里其他组写的你无法随意修改的代码。

这些外部代码是你的**“边界”。它们可能会升级、可能会有 Bug、可能会有反人类的设计、甚至你将来可能想换一个类似的库或服务。如果你的应用代码直接且紧密地依赖**这些外部代码的具体类、方法、异常等细节，那么一旦外部代码发生变化，你的大量应用代码就可能需要修改，变得非常脆弱和难以维护。

我们要将外来代码干净利落的整合进自己的项目中。

使用边界层分隔第三方程序

举例说明

当你使用的第三方库或外部系统返回给你一个通用的数据结构（比如 Map，或者 List<String> 等），并且这个数据结构里的数据的意义和结构（比如 Map 的 Key 是什么，Value 是什么类型）是由第三方定义的，那么你的代码就和这个第三方的具体实现细节耦合（绑定）在了一起。

场景： 假设你使用了一个第三方库，这个库提供一个方法来获取某个配置信息。这个方法返回给你一个 Map<String, String>。

// --- 假设这是第三方库的代码 ---
package com.thirdparty.config;import java.util.HashMap;
import java.util.Map;class ThirdPartyConfigLib {// 这个方法返回配置信息，使用 Map<String, String>public Map<String, String> getConfiguration(String configName) {Map<String, String> config = new HashMap<>();// 这些 Key ("timeout", "retries", "featureEnabled") 是第三方库定义好的config.put("timeout", "5000");config.put("retries", "3");config.put("featureEnabled", "true");// 第三方库可能随时添加、删除或修改这些 Keyreturn config;}
}

你的应用代码（直接使用第三方返回的 Map）：

package com.myproject.app;import com.thirdparty.config.ThirdPartyConfigLib;
import java.util.Map; // 需要导入 java.util.Mapclass MyAppConfig {private ThirdPartyConfigLib configLib = new ThirdPartyConfigLib();public int getTimeout() {Map<String, String> config = configLib.getConfiguration("network");// !!! 你的代码必须知道第三方库返回的 Map 里有一个 Key 叫 "timeout" !!!// !!! 并且知道 Value 是 String 类型，需要手动转换为 int !!!String timeoutStr = config.get("timeout");if (timeoutStr != null) {try {return Integer.parseInt(timeoutStr);} catch (NumberFormatException e) {// 格式错误，也需要处理e.printStackTrace();return 1000; // 使用默认值}}return 1000; // 如果 Key 不存在，使用默认值}public boolean isFeatureEnabled() {Map<String, String> config = configLib.getConfiguration("network");// !!! 你的代码必须知道 Key 叫 "featureEnabled" !!!// !!! 并且知道 Value 是 String 类型，需要手动转换为 boolean !!!String enabledStr = config.get("featureEnabled");if (enabledStr != null) {return Boolean.parseBoolean(enabledStr);}return false; // 默认不启用}// ... 更多依赖 Map Key 的方法 ...
}

问题在于：

耦合： 你的 MyAppConfig 类需要了解第三方库返回的 Map 的内部结构（具体的 Key 字符串 "timeout", "retries", "featureEnabled"）以及 Value 的类型（都是 String，需要手动转换）。你的代码和第三方库的这个 Map 结构紧紧地耦合在一起了。
脆弱性： 如果第三方库在新版本中，把 Key "timeout" 改成了 "requestTimeout"，或者把 Value 从 String 改成了 int（虽然 Map 限制了是 String，但如果第三方返回 Map<String, Object> 就更乱了），或者删除了某个 Key，你的 MyAppConfig 类中的相关方法就会立即出错（比如 config.get("timeout") 返回 null，或者类型转换失败）。
不直观： 你的应用代码看到 Map<String, String> 并不知道里面具体有什么配置项，需要查阅第三方库的文档才能知道有哪些 Key 可用。

解决：自己写一个要用到的第三方配置类，然后加一个边界层，专门用来对接第三方程序，返回一个配置类给业务代码使用，这样以后第三方程序发生变动，我们只需要找到对应的边界层修改，配置类不修改，业务代码也不用修改，否则在业务代码中找第三方程序参数修改能把人累死。

package com.myproject.app; // 你的应用核心层// 定义一个你自己的配置类，不依赖于第三方的 Map 结构
class AppConfigSettings {private int timeout;private int retries;private boolean featureEnabled;// 使用构造函数来接收处理好的数据public AppConfigSettings(int timeout, int retries, boolean featureEnabled) {this.timeout = timeout;this.retries = retries;this.featureEnabled = featureEnabled;}public int getTimeout() { return timeout; }public int getRetries() { return retries; }public boolean isFeatureEnabled() { return featureEnabled; }// Getters...
}// 边界层：负责与第三方库的 Map 打交道，并转换为我们自己的对象
class ThirdPartyConfigAdapter { // 也可以叫 ThirdPartyConfigWrapperprivate ThirdPartyConfigLib configLib = new ThirdPartyConfigLib();/*** 从第三方库获取配置，并转换为我们自己的 AppConfigSettings 对象。* 隐藏了第三方 Map 的细节。*/public AppConfigSettings getAppSettings(String configName) {Map<String, String> configMap = configLib.getConfiguration(configName);// !!! 在边界层内部处理 Map 的 Key 和 Value 转换细节 !!!// 即使第三方改了 Key，只需要改这里int timeout = 1000; // 默认值String timeoutStr = configMap.get("timeout"); // 这里的 Key 是第三方定义的if (timeoutStr != null) {try {timeout = Integer.parseInt(timeoutStr);} catch (NumberFormatException e) {// 在边界层处理转换错误，可以记录日志或使用默认值System.err.println("Warning: Invalid timeout format from third party.");}}int retries = 1; // 默认值String retriesStr = configMap.get("retries"); // 这里的 Key 是第三方定义的if (retriesStr != null) {try {retries = Integer.parseInt(retriesStr);} catch (NumberFormatException e) {System.err.println("Warning: Invalid retries format from third party.");}}boolean featureEnabled = false; // 默认值String enabledStr = configMap.get("featureEnabled"); // 这里的 Key 是第三方定义的if (enabledStr != null) {featureEnabled = Boolean.parseBoolean(enabledStr);}// 返回我们自己定义好的对象，隐藏了底层 Map 的存在return new AppConfigSettings(timeout, retries, featureEnabled);}
}// 你的应用代码（使用封装后的 Adapter）
class MyAppConfig {// 依赖的是我们自己定义的 Adapterprivate ThirdPartyConfigAdapter configAdapter = new ThirdPartyConfigAdapter();public int getTimeout() {// 调用 Adapter 的方法，直接获取我们自己的 AppConfigSettings 对象AppConfigSettings settings = configAdapter.getAppSettings("network");// !!! 直接调用我们自己的对象的方法，完全不知道底层是 Map !!!return settings.getTimeout();}public boolean isFeatureEnabled() {// 直接调用我们自己的对象的方法AppConfigSettings settings = configAdapter.getAppSettings("network");return settings.isFeatureEnabled();}// ... 其他方法都依赖 AppConfigSettings 对象 ...
}

Adapter 模式分隔第三方程序

Adapter 模式是什么？

目的： 将一个类的接口，转换成客户期望的另一个接口。让原本接口不兼容的那些类可以一起工作。
角色：

- 目标接口 (Target Interface)： 这是客户端（你的应用代码）期望使用的接口。
- 被适配者 (Adaptee)： 这是那个接口你不兼容的第三方类或对象。
- 适配器 (Adapter)： 这是一个类，它实现目标接口，同时内部持有被适配者的实例。适配器的方法会将对目标接口的调用，转发并转换成对被适配者方法的调用。

Adapter 模式如何用于边界层？

当你使用第三方库时：

你的应用代码期望使用一个符合你项目规范、易于理解的接口（目标接口）。
第三方库提供的 API 是一个不兼容的接口（被适配者）。

这时，你可以创建一个适配器类，它实现了你期望的接口，并在内部使用第三方库的功能来完成实际工作。你的应用代码就只需要与你定义的这个“目标接口”打交道，完全不知道背后是哪个第三方库在干活。

代码例子：使用 Adapter 模式封装第三方日志库

假设你不想直接使用第三方日志库（比如 Log4j 或 Logback）的 API，而是想在你的应用中定义一个简单的日志接口，并且能够方便地切换底层日志实现。

// --- 你的应用代码，定义了目标接口 ---
package com.myproject.app.logging;// 应用内部使用的标准日志接口
public interface AppLogger {void logInfo(String message); // 记录信息日志void logError(String message, Throwable error); // 记录错误日志
}

假设的第三方日志库（Adaptee）： 这是一个第三方库，它有自己的日志类和方法名，与你的 AppLogger 接口不完全兼容。

// --- 假设这是第三方日志库的代码 ---
package com.thirdparty.loglib;// 第三方日志库的日志类 (接口可能不兼容 AppLogger)
public class ThirdPartyLogger {private String name;public ThirdPartyLogger(String name) {this.name = name;}// 第三方库记录信息日志的方法 (方法名和参数可能与你的接口不同)public void logMessage(String msg) {System.out.println("[INFO] (" + name + ") " + msg);}// 第三方库记录错误日志的方法 (方法名和参数可能与你的接口不同)public void logErrorMsg(String msg, Throwable e) {System.err.println("[ERROR] (" + name + ") " + msg);if (e != null) {e.printStackTrace(System.err);}}// 第三方库可能有自己的配置、初始化方法等，这里省略
}

创建适配器（Adapter）： 这个类实现了你的 AppLogger 接口，并在内部使用了 ThirdPartyLogger。它将对 AppLogger 方法的调用，“适配”到 ThirdPartyLogger 相应的方法上。

// --- 你的应用代码，实现了适配器 ---
package com.myproject.app.logging.adapters; // 通常放在 adapters 包下import com.myproject.app.logging.AppLogger; // 导入你的目标接口
import com.thirdparty.loglib.ThirdPartyLogger; // 导入第三方库// 这是一个适配器类，将 ThirdPartyLogger 适配到 AppLogger 接口
public class ThirdPartyLoggerAdapter implements AppLogger {private final ThirdPartyLogger thirdPartyLogger; // 内部持有被适配者 (第三方 Logger)// 构造函数接收必要的参数来初始化第三方 Loggerpublic ThirdPartyLoggerAdapter(String loggerName) {// 在适配器内部处理第三方 Logger 的初始化this.thirdPartyLogger = new ThirdPartyLogger(loggerName);}// !!! 实现 AppLogger 接口的方法 !!!// 在实现方法内部，调用第三方 Logger 的相应方法@Overridepublic void logInfo(String message) {// 将 logInfo 的调用适配到 thirdPartyLogger.logMessagethirdPartyLogger.logMessage(message);}@Overridepublic void logError(String message, Throwable error) {// 将 logError 的调用适配到 thirdPartyLogger.logErrorMsgthirdPartyLogger.logErrorMsg(message, error);}// 如果 AppLogger 有其他方法，也要在这里实现并适配到第三方 Logger 的方法
}

你的应用代码（使用适配器后的方式）：

你的应用代码现在只需要依赖你自己的 AppLogger 接口，而不需要知道 ThirdPartyLoggerAdapter 或 ThirdPartyLogger 的存在。

// --- 你的应用代码，使用 AppLogger 接口 ---
package com.myproject.app.service;import com.myproject.app.logging.AppLogger; // 只导入你的接口
// 假设这里通过某种方式获取 AppLogger 的实现 (比如工厂或依赖注入)
// 实际项目中，你会在初始化时决定使用哪个日志适配器 (比如 ThirdPartyLoggerAdapter)
// 并将其注入到需要日志功能的类中class BusinessService {private final AppLogger logger; // 依赖的是你自己的 AppLogger 接口// 构造函数通过接口注入 logger 实例public BusinessService(AppLogger logger) {this.logger = logger;}public void processOrder(String orderId) {logger.logInfo("开始处理订单: " + orderId); // 调用你自己的接口方法try {// ... 处理订单的业务逻辑 ...// 模拟一个可能出错的操作if (Math.random() < 0.2) {throw new RuntimeException("模拟处理订单时出错");}logger.logInfo("订单 " + orderId + " 处理成功。");} catch (Exception e) {// 使用你的接口方法记录错误logger.logError("处理订单 " + orderId + " 失败！", e); // 调用你自己的接口方法// ... 处理失败逻辑 ...}}
}// --- 应用启动时的初始化代码 (或者依赖注入框架配置) ---
class AppRunner {public static void main(String[] args) {// !!! 在应用的入口或配置层，决定使用哪个具体的日志实现 !!!// 这里使用 ThirdPartyLoggerAdapter 作为 AppLogger 的实现AppLogger appLoggerInstance = new ThirdPartyLoggerAdapter("OrderProcessor");// 将这个实例传递给需要日志功能的业务类BusinessService businessService = new BusinessService(appLoggerInstance);// 运行业务逻辑businessService.processOrder("ORDER_123");businessService.processOrder("ORDER_456");}
}

这个例子展示了 Adapter 模式作为边界层的好处：

隔离第三方细节：BusinessService 完全不知道 ThirdPartyLogger 的存在，它只认识 AppLogger 接口。第三方库的类名、方法名、构造函数等细节都被隐藏在 ThirdPartyLoggerAdapter 内部。
易于替换底层实现： 如果将来你想换成另一个日志库（比如提供 AnotherLogger 类），你只需要编写一个新的适配器 AnotherLoggerAdapter，让它也实现 AppLogger 接口，并在内部使用 AnotherLogger。然后修改 AppRunner 中初始化 AppLogger 实例的代码，将其切换为 new AnotherLoggerAdapter(...) 即可。BusinessService 的代码完全不需要改动。
提供统一接口： 无论底层用什么日志库，你的应用代码都通过统一的 AppLogger 接口来记录日志，代码风格保持一致。
适配 API： 适配器将第三方库与你的应用所需的接口进行了转换，即使第三方库的方法名或参数不同，你也能在适配器中进行映射。