基于责任链模式实现多平台外卖API统一接入网关的设计与实践
·
基于责任链模式实现多平台外卖API统一接入网关的设计与实践
在涉及美团、饿了么等多个外卖平台的聚合业务场景中,各平台API接口规范、鉴权方式及数据结构差异巨大。为了屏蔽底层复杂性,对外提供统一的调用入口,本文采用责任链模式设计并实现了一个高扩展性的API接入网关。
1. 核心设计思路
责任链模式允许我们将请求沿着处理者链条传递,直到有一个处理者处理它。在此场景下,每个具体的外卖平台(如美团、饿了么)都对应一个处理器,网关根据请求中的平台标识,将请求分发给对应的处理器进行处理。
这种设计的优势在于开闭原则:当需要接入新的外卖平台时,只需新增一个处理器类,无需修改现有网关代码,极大降低了维护成本。
2. 定义处理器接口与抽象基类
在baodanbao.com.cn.gateway包下定义核心结构。
处理器接口:
package com.baodanbao.cn.gateway;
import com.baodanbao.cn.model.ApiResponse;
public interface PlatformHandler {
/**
* 处理API请求
* @param request 请求参数
* @return 响应结果
*/
ApiResponse<?> handle(ApiRequest request);
/**
* 获取该处理器支持的平台类型
* @return 平台枚举
*/
PlatformEnum getPlatform();
}
抽象基类(提供公共逻辑):
package com.baodanbao.cn.gateway;
public abstract class AbstractPlatformHandler implements PlatformHandler {
// 模板方法,子类可覆盖具体步骤
@Override
public ApiResponse<?> handle(ApiRequest request) {
// 1. 参数预处理
preprocess(request);
// 2. 具体平台逻辑由子类实现
return doHandle(request);
}
protected void preprocess(ApiRequest request) {
// 统一的日志记录或基础校验
System.out.println("正在处理平台请求: " + request.getPlatform());
}
protected abstract ApiResponse<?> doHandle(ApiRequest request);
}

3. 实现具体平台处理器
美团处理器示例:
package com.baodanbao.cn.gateway.meituan;
import com.baodanbao.cn.gateway.AbstractPlatformHandler;
import com.baodanbao.cn.gateway.ApiRequest;
import com.baodanbao.cn.gateway.ApiResponse;
import com.baodanbao.cn.gateway.PlatformEnum;
import com.baodanbao.cn.util.OkHttpUtil;
public class MeituanHandler extends AbstractPlatformHandler {
private static final String API_URL = "https://openapi.meituan.com/api";
@Override
protected ApiResponse<?> doHandle(ApiRequest request) {
// 这里模拟调用美团原生API
// 实际应用中应使用OkHttp或HttpClient
String result = OkHttpUtil.post(API_URL, request.getParams());
// 解析并封装美团特有的响应
return parseMeituanResponse(result);
}
@Override
public PlatformEnum getPlatform() {
return PlatformEnum.MEITUAN;
}
private ApiResponse<?> parseMeituanResponse(String raw) {
// 省略具体的JSON解析逻辑
return new ApiResponse<>();
}
}
饿了么处理器示例:
package com.baodanbao.cn.gateway.eleme;
import com.baodanbao.cn.gateway.AbstractPlatformHandler;
import com.baodanbao.cn.gateway.ApiRequest;
import com.baodanbao.cn.gateway.ApiResponse;
import com.baodanbao.cn.gateway.PlatformEnum;
public class ElemeHandler extends AbstractPlatformHandler {
@Override
protected ApiResponse<?> doHandle(ApiRequest request) {
// 模拟饿了么API调用逻辑
// 饿了么可能使用OAuth2.0鉴权,逻辑与美团不同
return new ApiResponse<>();
}
@Override
public PlatformEnum getPlatformEnum() {
return PlatformEnum.ELEME;
}
}
4. 构建责任链与网关服务
使用枚举或Spring容器管理所有的处理器,并构建调用逻辑。
平台枚举:
package com.baodanbao.cn.gateway;
public enum PlatformEnum {
MEITUAN,
ELEME,
SHENMEI; // 甚至可以支持更多平台
}
统一网关服务:
package com.baodanbao.cn.service;
import com.baodanbao.cn.gateway.*;
import org.springframework.stereotype.Service;
import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import java.util.HashMap;
import java.util.Map;
@Service
public class UnifiedGatewayService {
@Resource
private MeituanHandler meituanHandler;
@Resource
private ElemeHandler elemeHandler;
// 存储处理器映射关系
private final Map<PlatformEnum, PlatformHandler> handlerMap = new HashMap<>();
@PostConstruct
public void init() {
handlerMap.put(meituanHandler.getPlatform(), meituanHandler);
handlerMap.put(elemeHandler.getPlatform(), elemeHandler);
}
/**
* 统一入口
*/
public ApiResponse<?> execute(ApiRequest request) {
PlatformHandler handler = handlerMap.get(request.getPlatform());
if (handler == null) {
return ApiResponse.fail("不支持的平台类型");
}
return handler.handle(request);
}
}
5. 使用示例
调用方无需关心具体平台细节,只需通过网关即可。
// 构建请求
ApiRequest request = new ApiRequest();
request.setPlatform(PlatformEnum.MEITUAN);
request.setParams(Map.of("shopId", "12345"));
// 调用网关
ApiResponse<?> response = unifiedGatewayService.execute(request);
本文著作权归 俱美开放平台 ,转载请注明出处!
更多推荐
所有评论(0)