Browse Source

docs(guide): 补充端点写成常量、SDK 不碰存储不读配置两条约定

feature/supplier-lingxing
chenchuchuan 3 weeks ago
parent
commit
5bd69e7f1c
  1. 17
      GUIDE.md

17
GUIDE.md

@ -459,6 +459,23 @@ public final class AcmeOrderDto {
省掉全部样板;`core` 的模型是不可变 + Builder,本来就没有 setter,且 `core` 要尽量少依赖 省掉全部样板;`core` 的模型是不可变 + Builder,本来就没有 setter,且 `core` 要尽量少依赖
编译期工具。Lombok 声明为 `scope=provided`,不进宿主运行时。 编译期工具。Lombok 声明为 `scope=provided`,不进宿主运行时。
**端点和路径写成常量,不做配置。** 协议细节(URL、字段名、限流值)是代码的一部分——
配置化会让线上和测试跑不同协议,出问题无法从代码复现。`AdapterConfig` 不是配置项,
它只承载「测试时替换目标地址」这一种由调用方显式传入的参数。
```java
public final class AcmeConstants {
/** 生产基址;仅测试/联调时由 AdapterConfig 覆盖。 */
public static final String DEFAULT_BASE_URL = "https://api.acme.example.com";
public static final String PATH_TOKEN = "/oauth/token";
public static final String PATH_ORDERS = "/v1/orders";
public static final int MAX_PAGE_SIZE = 100;
}
```
**SDK 不碰存储、不读配置。** 账户、密钥、token、水位线、幂等记录全部经 SPI 由宿主提供;
适配器构造函数里只接收这些 SPI 与 `Clock`,不接收 `DataSource`、`Properties` 之类的对象。
### 第 4 步:Mapper —— DTO → 统一模型 ### 第 4 步:Mapper —— DTO → 统一模型
```java ```java

Loading…
Cancel
Save