Merge remote-tracking branch 'origin/feature/mall_product' into feature/mall_product

This commit is contained in:
YunaiV 2023-06-11 23:19:09 +08:00
commit 0c283ded5d
22 changed files with 918 additions and 1 deletions

View File

@ -4,6 +4,7 @@ import cn.hutool.core.util.ArrayUtil;
import cn.hutool.core.util.StrUtil;
import cn.hutool.json.JSONUtil;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
@ -29,6 +30,7 @@ public class JsonUtils {
static {
objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
objectMapper.registerModules(new JavaTimeModule()); // 解决 LocalDateTime 的序列化
}

View File

@ -10,11 +10,14 @@ import cn.iocoder.yudao.framework.web.core.util.WebFrameworkUtils;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.util.AntPathMatcher;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;
@ -107,6 +110,15 @@ public class YudaoWebAutoConfiguration implements WebMvcConfigurer {
return createFilterBean(new DemoFilter(), WebFilterOrderEnum.DEMO_FILTER);
}
/**
* 创建 RestTemplate 实例
* @param restTemplateBuilder {@link RestTemplateAutoConfiguration#restTemplateBuilder}
*/
@Bean
public RestTemplate restTemplate(RestTemplateBuilder restTemplateBuilder){
return restTemplateBuilder.build();
}
public static <T extends Filter> FilterRegistrationBean<T> createFilterBean(T filter, Integer order) {
FilterRegistrationBean<T> bean = new FilterRegistrationBean<>(filter);
bean.setOrder(order);

View File

@ -53,7 +53,9 @@ public interface ErrorCodeConstants {
ErrorCode EXPRESS_TEMPLATE_NAME_DUPLICATE = new ErrorCode(1011003003, "已经存在该运费模板名");
ErrorCode DELIVERY_EXPRESS_USER_ADDRESS_IS_EMPTY = new ErrorCode(1011003004, "计算快递运费时,收件人地址编号为空");
ErrorCode PRODUCT_EXPRESS_TEMPLATE_NOT_FOUND = new ErrorCode(1011003005, "找不到到商品对应的运费模板");
ErrorCode PICK_UP_STORE_NOT_EXISTS = new ErrorCode(1011003006, "自提门店不存在");
ErrorCode EXPRESS_API_QUERY_ERROR = new ErrorCode(1011003006, "快递查询接口异常");
ErrorCode EXPRESS_API_QUERY_FAILED = new ErrorCode(1011003007, "快递查询返回失败, 原因:{}");
ErrorCode PICK_UP_STORE_NOT_EXISTS = new ErrorCode(1011003008, "自提门店不存在");
// ========== Price 相关 1011004000 ============
ErrorCode PRICE_CALCULATE_PAY_PRICE_ILLEGAL = new ErrorCode(1011004000, "支付价格计算异常,原因:价格小于等于 0");

View File

@ -0,0 +1,75 @@
package cn.iocoder.yudao.module.trade.framework.delivery.config;
import cn.iocoder.yudao.module.trade.framework.delivery.core.ExpressQueryProviderEnum;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;
import javax.validation.constraints.NotEmpty;
/**
* 交易快递查询的配置项
*
* @author jason
*/
@Component
@ConfigurationProperties(prefix = "yudao.trade.express.query")
@Data
@Validated
public class TradeExpressQueryProperties {
/**
* 快递查询服务商, 如果未配置默认使用快递鸟
*/
private ExpressQueryProviderEnum expressQueryProvider;
/**
* 快递鸟配置
*/
@Valid
private KdNiaoConfig kdNiao;
/**
* 快递 100 配置
*/
@Valid
private Kd100Config kd100;
/**
* 快递鸟配置项目
*/
@Data
public static class KdNiaoConfig {
/**
* 快递鸟用户 ID
*/
@NotEmpty(message = "快递鸟用户 ID 配置项不能为空")
private String businessId;
/**
* 快递鸟 API Key
*/
@NotEmpty(message = "快递鸟 Api Key 配置项不能为空")
private String apiKey;
}
/**
* 快递100 配置项
*/
@Data
public static class Kd100Config {
/**
* 快递 100 授权码
*/
@NotEmpty(message = "快递 100 授权码配置项不能为空")
private String customer;
/**
* 快递 100 授权 key
*/
@NotEmpty(message = "快递 100 授权 Key 配置项不能为空")
private String key;
}
}

View File

@ -0,0 +1,21 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryReqDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryRespDTO;
import java.util.List;
/**
* 快递查询客户端
*
* @author jason
*/
public interface ExpressQueryClient {
/**
* 快递实时查询
*
* @param reqDTO 查询请求参数
*/
List<ExpressQueryRespDTO> realTimeQuery(ExpressQueryReqDTO reqDTO);
}

View File

@ -0,0 +1,20 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryReqDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryRespDTO;
import java.util.List;
/**
* 快递查询服务商
*
* @author jason
*/
public interface ExpressQueryProvider {
/**
* 快递实时查询
*
* @param reqDTO 查询请求参数
*/
List<ExpressQueryRespDTO> realTimeQueryExpress(ExpressQueryReqDTO reqDTO);
}

View File

@ -0,0 +1,28 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core;
import lombok.Getter;
/**
* 快递查询服务商枚举
*
* @author jason
*/
@Getter
public enum ExpressQueryProviderEnum {
KD_NIAO("kd-niao", "快递鸟"),
KD_100("kd-100", "快递100");
/**
* 快递服务商唯一编码
*/
private final String code;
/**
* 快递服务商名称
*/
private final String name;
ExpressQueryProviderEnum(String code, String name) {
this.code = code;
this.name = name;
}
}

View File

@ -0,0 +1,14 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core;
/**
* 快递服务商工厂 用于创建和缓存快递服务商服务
* @author jason
*/
public interface ExpressQueryProviderFactory {
/**
* 通过枚举获取快递查询服务商 如果不存在就创建一个对应的快递查询服务商
* @param queryProviderEnum 快递服务商枚举
*/
ExpressQueryProvider getOrCreateExpressQueryProvider(ExpressQueryProviderEnum queryProviderEnum);
}

View File

@ -0,0 +1,26 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.convert;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryReqDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryRespDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kd100.Kd100ExpressQueryReqDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kd100.Kd100ExpressQueryRespDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kdniao.KdNiaoExpressQueryReqDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kdniao.KdNiaoExpressQueryRespDTO;
import org.mapstruct.Mapper;
import org.mapstruct.factory.Mappers;
import java.util.List;
@Mapper
public interface ExpressQueryConvert {
ExpressQueryConvert INSTANCE = Mappers.getMapper(ExpressQueryConvert.class);
List<ExpressQueryRespDTO> convertList(List<KdNiaoExpressQueryRespDTO.ExpressTrack> expressTrackList);
List<ExpressQueryRespDTO> convertList2(List<Kd100ExpressQueryRespDTO.ExpressTrack> expressTrackList);
KdNiaoExpressQueryReqDTO convert(ExpressQueryReqDTO dto);
Kd100ExpressQueryReqDTO convert2(ExpressQueryReqDTO dto);
}

View File

@ -0,0 +1,30 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.dto;
import cn.iocoder.yudao.module.trade.dal.dataobject.delivery.DeliveryExpressDO;
import lombok.Data;
/**
* 快递查询 Req DTO
*
* @author jason
*/
@Data
public class ExpressQueryReqDTO {
/**
* 快递公司编码
*
* 对应 {@link DeliveryExpressDO#getCode()} }
*/
private String expressCompanyCode;
/**
* 发货快递单号
*/
private String logisticsNo;
/**
* 寄件人的电话号码
*/
private String phone;
}

View File

@ -0,0 +1,22 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.dto;
import lombok.Data;
/**
* 快递查询 Resp DTO
*
* @author jason
*/
@Data
public class ExpressQueryRespDTO {
/**
* 发生时间
*/
private String time;
/**
* 快递状态
*/
private String state;
}

View File

@ -0,0 +1,47 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kd100;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;
/**
* 快递 100 快递查询 Req DTO
*
* @author jason
*/
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Kd100ExpressQueryReqDTO {
/**
* 快递公司编码
*/
@JsonProperty("com")
private String expressCompanyCode;
/**
* 快递单号
*/
@JsonProperty("num")
private String logisticsNo;
/**
* 寄件人的电话号码
*/
private String phone;
/**
* 出发地城市
*/
private String from;
/**
* 目的地城市到达目的地后会加大监控频率
*/
private String to;
/**
* 返回结果排序:desc降序默认,asc 升序
*/
private String order;
}

View File

@ -0,0 +1,59 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kd100;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;
import java.util.List;
/**
* 快递 100 实时快递查询 Resp DTO 参见 <a href="https://api.kuaidi100.com/document/5f0ffb5ebc8da837cbd8aefc">快递 100 文档</a>
*
* @author jason
*/
@Data
public class Kd100ExpressQueryRespDTO {
/**
* 快递公司编码
*/
@JsonProperty("com")
private String expressCompanyCode;
/**
* 快递单号
*/
@JsonProperty("nu")
private String logisticsNo;
/**
* 快递单当前状态
*/
private String state;
/**
* 查询结果 失败返回 "false"
*/
private String result;
/**
* 查询结果失败时的错误信息
*/
private String message;
@JsonProperty("data")
private List<ExpressTrack> tracks;
@Data
public static class ExpressTrack {
/**
* 轨迹发生时间
*/
@JsonProperty("time")
private String time;
/**
* 轨迹描述
*/
@JsonProperty("context")
private String state;
}
}

View File

@ -0,0 +1,32 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kdniao;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;
/**
* 快递鸟快递查询 Req DTO
*
* @author jason
*/
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class KdNiaoExpressQueryReqDTO {
/**
* 快递公司编码
*/
@JsonProperty("ShipperCode")
private String expressCompanyCode;
/**
* 快递单号
*/
@JsonProperty("LogisticCode")
private String logisticsNo;
/**
* 订单编号
*/
@JsonProperty("OrderCode")
private String orderNo;
}

View File

@ -0,0 +1,75 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kdniao;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;
import java.util.List;
/**
* 快递鸟快递查询 Resp DTO 参见 <a href="https://www.yuque.com/kdnjishuzhichi/dfcrg1/wugo6k">快递鸟接口文档</a>
*
* @author jason
*/
@Data
public class KdNiaoExpressQueryRespDTO {
/**
* 快递公司编码
*/
@JsonProperty("ShipperCode")
private String expressCompanyCode;
/**
* 快递单号
*/
@JsonProperty("LogisticCode")
private String logisticsNo;
/**
* 订单编号
*/
@JsonProperty("OrderCode")
private String orderNo;
@JsonProperty("EBusinessID")
private String businessId;
@JsonProperty("State")
private String state;
/**
* 成功与否
*/
@JsonProperty("Success")
private Boolean success;
/**
* 失败原因
*/
@JsonProperty("Reason")
private String reason;
@JsonProperty("Traces")
private List<ExpressTrack> tracks;
@Data
public static class ExpressTrack {
/**
* 轨迹发生时间
*/
@JsonProperty("AcceptTime")
private String time;
/**
* 轨迹描述
*/
@JsonProperty("AcceptStation")
private String state;
}
// {
// "EBusinessID": "1237100",
// "Traces": [],
// "State": "0",
// "ShipperCode": "STO",
// "LogisticCode": "638650888018",
// "Success": true,
// "Reason": "暂无轨迹信息"
// }
}

View File

@ -0,0 +1,53 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.impl;
import cn.hutool.core.lang.Assert;
import cn.iocoder.yudao.module.trade.framework.delivery.config.TradeExpressQueryProperties;
import cn.iocoder.yudao.module.trade.framework.delivery.core.ExpressQueryClient;
import cn.iocoder.yudao.module.trade.framework.delivery.core.ExpressQueryProvider;
import cn.iocoder.yudao.module.trade.framework.delivery.core.ExpressQueryProviderEnum;
import cn.iocoder.yudao.module.trade.framework.delivery.core.ExpressQueryProviderFactory;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryReqDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryRespDTO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import java.util.List;
import static cn.iocoder.yudao.module.trade.framework.delivery.core.ExpressQueryProviderEnum.KD_NIAO;
/**
* 快递查询客户端实现
*
* @author jason
*/
@Component
@Slf4j
public class ExpressQueryClientImpl implements ExpressQueryClient {
@Resource
private ExpressQueryProviderFactory expressQueryProviderFactory;
@Resource
private TradeExpressQueryProperties tradeExpressQueryProperties;
private ExpressQueryProvider expressQueryProvider;
@PostConstruct
private void init(){
ExpressQueryProviderEnum queryProvider = tradeExpressQueryProperties.getExpressQueryProvider();
if (queryProvider == null) {
// 如果未设置默认使用快递鸟
queryProvider = KD_NIAO;
}
expressQueryProvider = expressQueryProviderFactory.getOrCreateExpressQueryProvider(queryProvider);
if (expressQueryProvider == null) {
// 记录错误日志
log.error("获取创建快递查询服务商{}失败,请检查相关配置", queryProvider);
}
Assert.notNull(expressQueryProvider, "快递查询服务商不能为空");
}
@Override
public List<ExpressQueryRespDTO> realTimeQuery(ExpressQueryReqDTO reqDTO) {
return expressQueryProvider.realTimeQueryExpress(reqDTO);
}
}

View File

@ -0,0 +1,45 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.impl;
import cn.iocoder.yudao.module.trade.framework.delivery.config.TradeExpressQueryProperties;
import cn.iocoder.yudao.module.trade.framework.delivery.core.ExpressQueryProvider;
import cn.iocoder.yudao.module.trade.framework.delivery.core.ExpressQueryProviderEnum;
import cn.iocoder.yudao.module.trade.framework.delivery.core.ExpressQueryProviderFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;
import javax.annotation.Resource;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
* @author jason
*/
@Component
public class ExpressQueryProviderFactoryImpl implements ExpressQueryProviderFactory {
private final Map<ExpressQueryProviderEnum, ExpressQueryProvider> providerMap = new ConcurrentHashMap<>(8);
@Resource
private TradeExpressQueryProperties tradeExpressQueryProperties;
@Resource
private RestTemplate restTemplate;
@Override
public ExpressQueryProvider getOrCreateExpressQueryProvider(ExpressQueryProviderEnum queryProviderEnum) {
return providerMap.computeIfAbsent(queryProviderEnum,
provider -> createExpressQueryProvider(provider, tradeExpressQueryProperties));
}
private ExpressQueryProvider createExpressQueryProvider(ExpressQueryProviderEnum queryProviderEnum,
TradeExpressQueryProperties tradeExpressQueryProperties) {
ExpressQueryProvider result = null;
switch (queryProviderEnum) {
case KD_NIAO:
result = new KdNiaoExpressQueryProvider(restTemplate, tradeExpressQueryProperties.getKdNiao());
break;
case KD_100:
result = new Kd100ExpressQueryProvider(restTemplate, tradeExpressQueryProperties.getKd100());
break;
}
return result;
}
}

View File

@ -0,0 +1,107 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.impl;
import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.util.HexUtil;
import cn.hutool.crypto.digest.DigestUtil;
import cn.iocoder.yudao.framework.common.util.json.JsonUtils;
import cn.iocoder.yudao.module.trade.framework.delivery.config.TradeExpressQueryProperties;
import cn.iocoder.yudao.module.trade.framework.delivery.core.ExpressQueryProvider;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryReqDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryRespDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kd100.Kd100ExpressQueryReqDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kd100.Kd100ExpressQueryRespDTO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.*;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestTemplate;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
import static cn.iocoder.yudao.module.trade.enums.ErrorCodeConstants.EXPRESS_API_QUERY_FAILED;
import static cn.iocoder.yudao.module.trade.enums.ErrorCodeConstants.EXPRESS_API_QUERY_ERROR;
import static cn.iocoder.yudao.module.trade.framework.delivery.core.convert.ExpressQueryConvert.INSTANCE;
/**
* 快递 100 服务商
*
* @author jason
*/
@Slf4j
public class Kd100ExpressQueryProvider implements ExpressQueryProvider {
private static final String REAL_TIME_QUERY_URL = "https://poll.kuaidi100.com/poll/query.do";
private final RestTemplate restTemplate;
private final TradeExpressQueryProperties.Kd100Config config;
public Kd100ExpressQueryProvider(RestTemplate restTemplate, TradeExpressQueryProperties.Kd100Config config) {
this.restTemplate = restTemplate;
this.config = config;
}
@Override
public List<ExpressQueryRespDTO> realTimeQueryExpress(ExpressQueryReqDTO reqDTO) {
Kd100ExpressQueryReqDTO kd100ReqParam = INSTANCE.convert2(reqDTO);
// 快递公司编码需要转成小写
kd100ReqParam.setExpressCompanyCode(kd100ReqParam.getExpressCompanyCode().toLowerCase());
Kd100ExpressQueryRespDTO respDTO = sendExpressQueryReq(REAL_TIME_QUERY_URL, kd100ReqParam,
Kd100ExpressQueryRespDTO.class);
log.debug("快递 100 接口 查询接口返回 {}", respDTO);
if (Objects.equals("false", respDTO.getResult())) {
log.error("快递 100 接口 返回失败 {} ", respDTO.getMessage());
throw exception(EXPRESS_API_QUERY_FAILED, respDTO.getMessage());
} else {
if (CollUtil.isNotEmpty(respDTO.getTracks())) {
return INSTANCE.convertList2(respDTO.getTracks());
} else {
return Collections.emptyList();
}
}
}
/**
* 发送快递 100 实时快递查询请求可以作为通用快递 100 通用请求接口 目前没有其它场景需要使用暂时放这里
* @param url 请求 url
* @param req 对应请求的请求参数
* @param respClass 对应请求的响应 class
* @param <Req> 每个请求的请求结构 Req DTO
* @param <Resp> 每个请求的响应结构 Resp DTO
*/
private <Req, Resp> Resp sendExpressQueryReq(String url, Req req, Class<Resp> respClass) {
// 请求头
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
// 生成签名
String param = JsonUtils.toJsonString(req);
String sign = generateReqSign(param, config.getKey(), config.getCustomer());
log.debug("快递 100 快递 接口生成签名的: {}", sign);
// 请求体
MultiValueMap<String, String> requestBody = new LinkedMultiValueMap<>();
requestBody.add("customer", config.getCustomer());
requestBody.add("sign", sign);
requestBody.add("param", param);
log.debug("快递 100 接口的请求参数: {}", requestBody);
HttpEntity<MultiValueMap<String, String>> requestEntity = new HttpEntity<>(requestBody, headers);
// 发送请求
ResponseEntity<String> responseEntity = restTemplate.exchange(url, HttpMethod.POST, requestEntity, String.class);
log.debug("快递 100 接口响应结果 {}", responseEntity);
// 处理响应
if (responseEntity.getStatusCode().is2xxSuccessful()) {
String response = responseEntity.getBody();
return JsonUtils.parseObject(response, respClass);
} else {
throw exception(EXPRESS_API_QUERY_ERROR);
}
}
private String generateReqSign(String param, String key, String customer) {
String plainText = String.format("%s%s%s", param, key, customer);
log.debug("快递 100 接口待签名的数据 {}", plainText);
return HexUtil.encodeHexStr(DigestUtil.md5(plainText), false);
}
}

View File

@ -0,0 +1,119 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.impl;
import cn.hutool.core.codec.Base64;
import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.net.URLEncodeUtil;
import cn.hutool.crypto.digest.DigestUtil;
import cn.iocoder.yudao.framework.common.util.json.JsonUtils;
import cn.iocoder.yudao.module.trade.framework.delivery.config.TradeExpressQueryProperties;
import cn.iocoder.yudao.module.trade.framework.delivery.core.ExpressQueryProvider;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryReqDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryRespDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kdniao.KdNiaoExpressQueryReqDTO;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.provider.kdniao.KdNiaoExpressQueryRespDTO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.*;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestTemplate;
import java.util.Collections;
import java.util.List;
import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
import static cn.iocoder.yudao.module.trade.enums.ErrorCodeConstants.EXPRESS_API_QUERY_FAILED;
import static cn.iocoder.yudao.module.trade.enums.ErrorCodeConstants.EXPRESS_API_QUERY_ERROR;
import static cn.iocoder.yudao.module.trade.framework.delivery.core.convert.ExpressQueryConvert.INSTANCE;
/**
* 快递鸟服务商
*
* @author jason
*/
@Slf4j
public class KdNiaoExpressQueryProvider implements ExpressQueryProvider {
private static final String REAL_TIME_QUERY_URL = "https://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx";
/**
* 快递鸟即时查询免费版 RequestType
*/
private static final String REAL_TIME_FREE_REQ_TYPE = "1002";
private final RestTemplate restTemplate;
private final TradeExpressQueryProperties.KdNiaoConfig config;
public KdNiaoExpressQueryProvider(RestTemplate restTemplate, TradeExpressQueryProperties.KdNiaoConfig config) {
this.restTemplate = restTemplate;
this.config = config;
}
/**
* 快递鸟即时查询免费版本 参见 <a href="https://www.yuque.com/kdnjishuzhichi/dfcrg1/wugo6k">快递鸟接口文档</a>
* @param reqDTO 查询请求参数
*/
@Override
public List<ExpressQueryRespDTO> realTimeQueryExpress(ExpressQueryReqDTO reqDTO) {
KdNiaoExpressQueryReqDTO kdNiaoReqData = INSTANCE.convert(reqDTO);
// 快递公司编码需要转成大写
kdNiaoReqData.setExpressCompanyCode(reqDTO.getExpressCompanyCode().toUpperCase());
KdNiaoExpressQueryRespDTO respDTO = sendKdNiaoApiRequest(REAL_TIME_QUERY_URL, REAL_TIME_FREE_REQ_TYPE,
kdNiaoReqData, KdNiaoExpressQueryRespDTO.class);
log.debug("快递鸟即时查询接口返回 {}", respDTO);
if(!respDTO.getSuccess()){
throw exception(EXPRESS_API_QUERY_FAILED, respDTO.getReason());
}else{
if (CollUtil.isNotEmpty(respDTO.getTracks())) {
return INSTANCE.convertList(respDTO.getTracks());
}else{
return Collections.emptyList();
}
}
}
/**
* 快递鸟 通用的 API 请求, 暂时没有其他应用场景 暂时放这里
* @param url 请求 url
* @param requestType 对应的请求指令 (快递鸟的RequestType)
* @param req 对应请求的请求参数
* @param respClass 对应请求的响应 class
* @param <Req> 每个请求的请求结构 Req DTO
* @param <Resp> 每个请求的响应结构 Resp DTO
*/
private <Req, Resp> Resp sendKdNiaoApiRequest(String url, String requestType, Req req,
Class<Resp> respClass){
// 请求头
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
// 请求体
String reqData = JsonUtils.toJsonString(req);
String dataSign = generateDataSign(reqData, config.getApiKey());
log.trace("得到快递鸟接口 RequestType : {} 的 签名: {}", requestType, dataSign);
MultiValueMap<String, String> requestBody = new LinkedMultiValueMap<>();
requestBody.add("RequestData", reqData);
requestBody.add("DataType", "2");
requestBody.add("EBusinessID", config.getBusinessId());
requestBody.add("DataSign", dataSign);
requestBody.add("RequestType", requestType);
log.debug("快递鸟接口 RequestType : {}, 的请求参数 {}", requestType, requestBody);
HttpEntity<MultiValueMap<String, String>> requestEntity = new HttpEntity<>(requestBody, headers);
// 发送请求
ResponseEntity<String> responseEntity = restTemplate.exchange(url, HttpMethod.POST, requestEntity, String.class);
log.debug("快递鸟接口 RequestType : {}, 的响应结果 {}", requestType, responseEntity);
// 处理响应
if (responseEntity.getStatusCode().is2xxSuccessful()) {
String response = responseEntity.getBody();
return JsonUtils.parseObject(response, respClass);
} else {
throw exception(EXPRESS_API_QUERY_ERROR);
}
}
/**
* 快递鸟生成请求签名 参见 <a href="https://www.yuque.com/kdnjishuzhichi/dfcrg1/zes04h">签名说明</a>
* @param reqData 请求实体
* @param apiKey api Key
*/
private String generateDataSign(String reqData, String apiKey) {
String plainText = String.format("%s%s", reqData, apiKey);
log.trace("签名前的数据 {}", plainText);
return URLEncodeUtil.encode(Base64.encode(DigestUtil.md5Hex(plainText)));
}
}

View File

@ -0,0 +1,56 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.impl;
import cn.iocoder.yudao.framework.common.exception.ServiceException;
import cn.iocoder.yudao.module.trade.framework.delivery.config.TradeExpressQueryProperties;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryReqDTO;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.context.annotation.Import;
import org.springframework.test.context.ActiveProfiles;
import javax.annotation.Resource;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
/**
* @author jason
*/
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = Kd100ExpressQueryProviderTest.Application.class)
@ActiveProfiles("trade-delivery-query") // 设置使用 trade-delivery-query 配置文件
public class Kd100ExpressQueryProviderTest {
@Resource
private RestTemplateBuilder builder;
@Resource
private TradeExpressQueryProperties expressQueryProperties;
private Kd100ExpressQueryProvider kd100ExpressQueryProvider;
@BeforeEach
public void init(){
kd100ExpressQueryProvider = new Kd100ExpressQueryProvider(builder.build(),expressQueryProperties.getKd100());
}
@Test
@Disabled("需要 授权 key. 暂时忽略")
void testRealTimeQueryExpressFailed() {
ServiceException t = assertThrows(ServiceException.class, () -> {
ExpressQueryReqDTO reqDTO = new ExpressQueryReqDTO();
reqDTO.setExpressCompanyCode("yto");
reqDTO.setLogisticsNo("YT9383342193097");
kd100ExpressQueryProvider.realTimeQueryExpress(reqDTO);
});
assertEquals(1011003007, t.getCode());
}
@Import({
RestTemplateAutoConfiguration.class
})
@EnableConfigurationProperties(TradeExpressQueryProperties.class)
public static class Application {
}
}

View File

@ -0,0 +1,54 @@
package cn.iocoder.yudao.module.trade.framework.delivery.core.impl;
import cn.iocoder.yudao.framework.common.exception.ServiceException;
import cn.iocoder.yudao.module.trade.framework.delivery.config.TradeExpressQueryProperties;
import cn.iocoder.yudao.module.trade.framework.delivery.core.dto.ExpressQueryReqDTO;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.context.annotation.Import;
import org.springframework.test.context.ActiveProfiles;
import javax.annotation.Resource;
import static org.junit.jupiter.api.Assertions.assertThrows;
/**
* @author jason
*/
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = KdNiaoExpressQueryProviderTest.Application.class)
@ActiveProfiles("trade-delivery-query") // 设置使用 trade-delivery-query 配置文件
public class KdNiaoExpressQueryProviderTest {
@Resource
private RestTemplateBuilder builder;
@Resource
private TradeExpressQueryProperties expressQueryProperties;
private KdNiaoExpressQueryProvider kdNiaoExpressQueryProvider;
@BeforeEach
public void init(){
kdNiaoExpressQueryProvider = new KdNiaoExpressQueryProvider(builder.build(),expressQueryProperties.getKdNiao());
}
@Test
@Disabled("需要 授权 key. 暂时忽略")
void testRealTimeQueryExpressFailed() {
assertThrows(ServiceException.class,() ->{
ExpressQueryReqDTO reqDTO = new ExpressQueryReqDTO();
reqDTO.setExpressCompanyCode("yy");
reqDTO.setLogisticsNo("YT9383342193097");
kdNiaoExpressQueryProvider.realTimeQueryExpress(reqDTO);
});
}
@Import({
RestTemplateAutoConfiguration.class
})
@EnableConfigurationProperties(TradeExpressQueryProperties.class)
public static class Application {
}
}

View File

@ -0,0 +1,18 @@
spring:
main:
lazy-initialization: true # 开启懒加载,加快速度
banner-mode: off # 单元测试,禁用 Banner
--- #################### 交易快递查询相关配置 ####################
yudao:
trade:
express:
query:
express-query-provider: kd_niao
kd-niao:
api-key: xxx
business-id: xxxxxxxx
kd100:
customer: xxxx
key: xxxxx