Java后端如何优雅地封装第三方API调用逻辑以对接美团外卖霸王餐接口
Java后端如何优雅地封装第三方API调用逻辑以对接美团外卖霸王餐接口
在Java后端开发中，对接第三方API（如美团外卖霸王餐接口）是常见的需求。直接在业务代码中拼接URL、处理JSON、写HTTP请求不仅导致代码臃肿，还难以维护和测试。
本文将介绍一种基于Spring Boot的优雅封装方案，采用“客户端-请求-响应”分离的设计模式，结合OkHttp作为底层HTTP客户端，实现高内聚、低耦合的API调用逻辑。
1. 引入依赖
首先，在pom.xml中引入必要的依赖，包括Spring Web、OkHttp以及JSON处理库（如Jackson或Fastjson）。
<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>com.squareup.okhttp3</groupId><artifactId>okhttp</artifactId><version>4.9.3</version></dependency><dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.83</version></dependency></dependencies>2. 定义通用的数据传输对象
为了统一处理API响应，我们定义通用的请求和响应基类。
API响应封装：
packagecom.baodanbao.cn.model;publicclassMeituanResponse<T>{privateintcode;privateStringmessage;privateTdata;// 构造函数publicMeituanResponse(){}publicMeituanResponse(intcode,Stringmessage,Tdata){this.code=code;this.message=message;this.data=data;}// Getter和SetterpublicintgetCode(){returncode;}publicvoidsetCode(intcode){this.code=code;}publicStringgetMessage(){returnmessage;}publicvoidsetMessage(Stringmessage){this.message=message;}publicTgetData(){returndata;}publicvoidsetData(Tdata){this.data=data;}publicbooleanisSuccess(){returnthis.code==0;// 假设0为成功}}霸王餐活动请求对象：
packagecom.baodanbao.cn.model.request;publicclassBawangcanActivityRequest{privateStringappId;privatelongtimestamp;privateStringsign;privateActivityBodybody;// Getter和SetterpublicstaticclassActivityBody{privateStringshopId;privateintlimitCount;privateStringstartDate;privateStringendDate;// Getter和Setter}}3. 封装HTTP客户端
创建一个专门的OkHttpClient Bean，并配置超时、拦截器等。
packagecom.baodanbao.cn.config;importokhttp3.OkHttpClient;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importjava.util.concurrent.TimeUnit;@ConfigurationpublicclassHttpClientConfig{@BeanpublicOkHttpClientmeituanOkHttpClient(){returnnewOkHttpClient.Builder().connectTimeout(10,TimeUnit.SECONDS).readTimeout(30,TimeUnit.SECONDS).writeTimeout(30,TimeUnit.SECONDS).build();}}4. 核心API客户端封装
这是最核心的部分。我们创建一个MeituanBawangcanClient类，专门负责与美团接口通信。
packagecom.baodanbao.cn.client;importcom.alibaba.fastjson.JSON;importcom.baodanbao.cn.model.MeituanResponse;importcom.baodanbao.cn.model.request.BawangcanActivityRequest;importcom.baodanbao.cn.util.SignUtil;importokhttp3.*;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.stereotype.Component;importjava.io.IOException;@ComponentpublicclassMeituanBawangcanClient{privatefinalOkHttpClienthttpClient;privatefinalStringappKey;privatefinalStringappSecret;privatefinalStringapiUrl;@AutowiredpublicMeituanBawangcanClient(OkHttpClienthttpClient,@Value("${meituan.app-key}")StringappKey,@Value("${meituan.app-secret}")StringappSecret,@Value("${meituan.api-url}")StringapiUrl){this.httpClient=httpClient;this.appKey=appKey;this.appSecret=appSecret;this.apiUrl=apiUrl;}/** * 创建霸王餐活动 */publicMeituanResponse<String>createActivity(BawangcanActivityRequest.ActivityBodybody)throwsIOException{// 1. 构建请求体BawangcanActivityRequestrequest=newBawangcanActivityRequest();request.setAppId(appKey);request.setTimestamp(System.currentTimeMillis()/1000);request.setBody(body);// 2. 生成签名（重要）StringjsonBody=JSON.toJSONString(request);Stringsign=SignUtil.generateSign(jsonBody,appSecret);request.setSign(sign);// 3. 序列化最终请求StringfinalJson=JSON.toJSONString(request);// 4. 构建HTTP请求RequesthttpRequest=newRequest.Builder().url(apiUrl+"/bawangcan/activity/create").post(RequestBody.create(finalJson,MediaType.get("application/json; charset=utf-8"))).build();// 5. 执行调用try(Responseresponse=httpClient.newCall(httpRequest).execute()){if(!response.isSuccessful())thrownewIOException("Unexpected code "+response);ResponseBodyresponseBody=response.body();if(responseBody==null)thrownewIOException("Empty response body");Stringresult=responseBody.string();// 6. 解析响应returnJSON.parseObject(result,newTypeReference<MeituanResponse<String>>(){}.getType());}}}5. 签名工具类
第三方API通常需要签名验证，我们将签名逻辑独立出来。
packagecom.baodanbao.cn.util;importjavax.crypto.Mac;importjavax.crypto.spec.SecretKeySpec;importjava.nio.charset.StandardCharsets;importjava.security.InvalidKeyException;importjava.security.NoSuchAlgorithmException;publicclassSignUtil{privatestaticfinalStringHMAC_SHA256="HmacSHA256";publicstaticStringgenerateSign(Stringcontent,Stringsecret)throwsException{try{Macmac=Mac.getInstance(HMAC_SHA256);SecretKeySpecsecretKeySpec=newSecretKeySpec(secret.getBytes(StandardCharsets.UTF_8),HMAC_SHA256);mac.init(secretKeySpec);byte[]signData=mac.doFinal(content.getBytes(StandardCharsets.UTF_8));// 这里简化，实际需要转为Hex字符串returnbytesToHex(signData);}catch(NoSuchAlgorithmException|InvalidKeyExceptione){thrownewException("签名生成失败",e);}}privatestaticStringbytesToHex(byte[]bytes){StringBuilderresult=newStringBuilder();for(byteb:bytes){result.append(String.format("%02x",b));}returnresult.toString();}}6. 在业务Service中使用
封装完成后，业务层代码变得非常简洁清晰。
packagecom.baodanbao.cn.service;importcom.baodanbao.cn.client.MeituanBawangcanClient;importcom.baodanbao.cn.model.MeituanResponse;importcom.baodanbao.cn.model.request.BawangcanActivityRequest;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.stereotype.Service;@ServicepublicclassMarketingService{@AutowiredprivateMeituanBawangcanClientmeituanClient;publicStringlaunchBawangcanCampaign(StringshopId,intlimit){try{BawangcanActivityRequest.ActivityBodybody=newBawangcanActivityRequest.ActivityBody();body.setShopId(shopId);body.setLimitCount(limit);// ... 设置其他参数MeituanResponse<String>response=meituanClient.createActivity(body);if(response.isSuccess()){return"活动创建成功，ID: "+response.getData();}else{return"API调用失败: "+response.getMessage();}}catch(Exceptione){e.printStackTrace();return"系统异常";}}}7. 配置文件示例
在application.yml中配置美团相关的参数。
meituan:app-key:your_app_key_hereapp-secret:your_app_secret_hereapi-url:https://openapi.meituan.com本文著作权归 俱美开放平台 ，转载请注明出处！