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

吸积效应：为什么接口会越来越臃肿？我们从一个接口说起

article 2024/11/15 21:37:44

欢迎大家关注公众号「JAVA前线」查看更多精彩分享文章，主要包括源码分析、实际应用、架构思维、职场分享、产品思考等等，同时欢迎大家加我微信「java_front」一起交流学习

1 从一个接口说起

1.1 初始接口

假设现在有一个创建订单接口：

public OrderCreateResultDTO createOrder(OrderCreateDTO order)

创建订单对象

public class OrderCreateDTO {
    private String bizColumnA;
    private String bizColumnB;
    private String bizColumnC;
    private String bizColumnD;
}

订单响应对象

public class OrderCreateResultDTO {
	private String orderId;
    private String bizColumnA;
    private String bizColumnB;
    private String bizColumnC;
    private String bizColumnD;
}

1.2 发生变化

现在业务发生变化，产品经理提出需求：创建订单时不需要C和D字段，新增E和F字段。如果你是开发人员，你会怎么设计这个接口？有一种比较朴素的思路是直接删除C和D字段，新增E和F字段：

创建订单对象

public class OrderCreateDTO {
    private String bizColumnA;
    private String bizColumnB;
    private String bizColumnE;
    private String bizColumnF;
}

订单响应对象

public class OrderCreateResultDTO {
	private String orderId;
    private String bizColumnA;
    private String bizColumnB;
    private String bizColumnE;
    private String bizColumnF;
}

1.3 发现问题

我们想一想上述方案是否可行呢？答案是不行，有以下三方面原因：

原因一是接口契约性：接口是本服务暴露给外部使用的，相当于上下游签了合同，如果随意修改合同，那么合同严肃性荡然无存。

原因二是版本兼容性：我们知道APP是有版本号的，假设APP版本1使用的是初始接口，这时APP版本2由于新业务需要使用新接口，但是你不能直接把初始接口改的面目全非，因为APP版本1有很多用户在用，如果只考虑新版本，那老版本将会报错。

原因三是时间窗口：我们知道APP发布版本是需要审核的，即使这一版本是强更，也会有一个时间窗口新功能和老功能是并存的，所以服务端接口在升级是必须考虑这种情况。

2 如何思考

既然不能直接升级，那么应该如何解决这个问题？我认为需要从两个维度思考：

分层维度
分端维度

2.1 分层思考

在代码结构落地实践中可以分为多层，但是核心还是三层，我们分别分析每一层如何适配接口变更：

数据层
业务层
表现层

2.1.1 数据层

因为要考虑新老版本并存的问题，所以数据层必须保留新老版本所有字段，标记老字段标记为废弃，但是需要修改字段是否必填性，因为一些老版本字段变成不必填：

public class OrderCreateDO {
    private String orderId;
    private String bizColumnA;
    private String bizColumnB;
    @Deprecated
    private String bizColumnC;
    @Deprecated
    private String bizColumnD;
    private String bizColumnE;
    private String bizColumnF;
}

2.1.2 业务层

业务层是承载核心业务的层级，所以包含大量的业务逻辑，有两种方案：

方案一：新增业务对象，重写业务方法
方案二：修改业务对象，适配业务方法

方案一优点是不与老业务耦合，缺点是新老方法逻辑可能只有少部分不一样，所以需要复制老业务方法大量逻辑到新方法中。

方法二优点是可以复用老逻辑，缺点是新老逻辑耦合，如果适配逻辑没有处理好，可能会影响老逻辑。

所以两种方案有各自使用场景，方案一适用于业务逻辑重大变动场景，既然是重构所以可以重新声明新业务对象：

public class OrderCreateNewBO {
    private String bizColumnA;
    private String bizColumnB;
    private String bizColumnE;
    private String bizColumnF;
}

方案二适用于业务逻辑微调变动场景，所以老业务对象需要包含新老字段，标记老字段标记为废弃：

public class OrderCreateBO {
    private String bizColumnA;
    private String bizColumnB;
    @Deprecated
    private String bizColumnC;
    @Deprecated
    private String bizColumnD;
    private String bizColumnE;
    private String bizColumnF;
}

2.1.3 展示层

展示层不应该处理复杂业务逻辑，而应该是对业务对象的裁剪和适配，所以可以新增一个新版本接口，没有业务层那种负担：

创建订单对象

public class OrderCreateDTOV2 {
    private String bizColumnA;
    private String bizColumnB;
    private String bizColumnE;
    private String bizColumnF;
}

订单响应对象

public class OrderCreateResultDTOV2 {
	private String orderId;
    private String bizColumnA;
    private String bizColumnB;
    private String bizColumnE;
    private String bizColumnF;
}

但是如果展示层不规范，包含大量业务逻辑，那么思考方式和业务层一样，也需要使用方案二。