当前位置: 欣欣网 > 码农

如何优雅地实现接口统一调用

2024-03-04码农

架构师(JiaGouX)

我们都是架构师!
架构未来,你来不来?

一、耦 合问题

有些时候我们在进行接口调用的时候,比如说一个 push 推送接口,有可能会涉及到不同渠道的推送。以我目前业务场景为例,我做结算后端服务的,会与金蝶财务系统进行交互,那么我结算后端会涉及到多个结算单类型,如果每一个种类型的结算单都去暴露一个 contoller 接口给前端提供,而且其实对接第三方的接口,有些接口是共通的。

前端涉及到的问题

  • 需要调用后端多个 controller,不同接口 不同的参数,如果遇到后端接口修改,会涉及到多个页面的修改,耦合度很高;

  • 需要对多个按钮设置权限配置。


  • 后端涉及到的问题

  • 需要每个业务接口,都去写一个对接第三方接口的 push 推送方法,无形中增加很多重复的代码,耦合度也很高;

  • 如果涉及到第三方服务接口改造,后端接口也需要进行更改,会修改大量代码。

  • 二、如何解决

    1. 创建对接第三方服务的微服务,暂定为 tps 服务,该服务只作为一个后端微服务,与第三方服务进行对接,并且合理封装调用参数,将公共参数提出进行封装;

    2. 后端其余业务系统对接这个独立的微服务,比如订单、结算、供应商系统对接这个服务,由 tps 服务统一提供对接接口,其余服务实现这个 tps 提供的 feign 接口;

    3. 业务系统只需要关注 service 层业务的实现,无需处理对接的业务逻辑。

    大致的流程图就是这样的:


    三、具体实现

    Tps 服务

    Tps 服务暴露为 feign 接口,前端统一通过 Tps 提供的接口进行调用。

    //对接第三方服务接口publicinterfaceIKingdeeManagementService {Boolean push(KingdeePushCO.Request request);}

    Feign 接口实现类:

    @Slf4j@Servicepublic classKingdeeManagementServiceImplimplementsIKingdeeManagementService{@Autowiredprivate ApplicationContext applicationContext;@Autowiredprivate KingdeeThirdSettingService kingdeeThirdSettingService;@Overridepublic Boolean push(KingdeePushCO.Request request){ KingdeeBusinessPushServiceEnum kingdeePushServiceEnum = KingdeeBusinessPushServiceEnum.getKingdeePushServiceEnumByType(request.getBusinessType()); IKingdeeBusinessPushService kingdeePushService = null;try { kingdeePushService = (IKingdeeBusinessPushService) applicationContext.getBean(kingdeePushServiceEnum.getClazz()); } catch (BeansException e) { log.error("当前类型暂未实现,请联系开发");thrownew ServiceException("当前类型暂未实现,请联系开发"); } R<Boolean> result = null; result = kingdeePushService.pushKingdee(request);returntrue; }}

    枚举类定义:

    publicenum KingdeeBusinessPushServiceEnum {private class clazz;private Integer type;privateString interFaceName; KingdeeBusinessPushServiceEnum( class clazz, Integer type, String interFaceName) {this.clazz = clazz;this.type = type;this.interFaceName = interFaceName; } RECEIPT_VOUCHER(IJaKingdeeBillClient. class, KingdeeBusinessTypeConstant.RECEIPT_VOUCHER, KingdeeSettingEnum.INTERFACE_TYPE_JA_RECEIPT_VOUCHER.getCode()), ;}

    分别有 clazz、type、interFaceName 属性,

  • clazz 定义为 feign 接口,业务系统提供的服务接口;

  • type 代表前端需要传的参数,不同的 Integer 值代表不同的 feign 接口映射;

  • interFaceName 第三方接口枚举,表示需要具体调用哪个第三方接口。

  • 业务系统

    拿 bms 服务举例说明:继承 Tps 服务的 feign 接口,重写 push 方法;

    Feign 接口实现,通过 factory 工厂类初始化,不同的 service 实现类;

    JaKingdeeFactoryUtil 工厂工具类,获取工厂实例,这里其实也可以使用枚举映射,避免以后接口太多,需要写很多 case when。

    JaKingdeeServiceFactory 是个接口,提供方法:

    实现上面的接口,通过单例工厂的模式 double check 的模式实现,并且加悲观锁,避免一个工作线程多次创建工厂实例,SpringContextUtils/getBean/ 获取 servcie 实例,业务层只需要实现 service 接口,实现不同业务逻辑的 push 推送方法。

    四、总结

    这是我之前设计的关于接口统一调用的流程,当然其实还是包括对接第三方重复调用的问题、调用结果缓存、调用超时解决、失败降级的一些策略,作为抛砖引玉。

    如喜欢本文,请点击右上角,把文章分享到朋友圈
    如有想了解学习的技术点,请留言给若飞安排分享

    因公众号更改推送规则,请点「在看」并加「星标」 第一时间获取精彩技术分享

    ·END·

    相关阅读:

    作者:Lxlxxx

    来源:juejin.cn/post/7276261829726191676

    版权申明:内容来源网络,仅供学习研究,版权归原创者所有。如有侵权烦请告知,我们会立即删除并表示歉意。谢谢!

    架构师

    我们都是架构师!

    关注 架构师(JiaGouX),添加「星标」

    获取每天技术干货,一起成为牛逼架构师

    技术群请 加若飞: 1321113940 进架构师群

    投稿、合作、版权等邮箱: [email protected]