SpringBoot(47) 实现快递物流查询(快递鸟)

文章目录

- - 一、前言
  - 二、快递物流查询
  - - 1、快递鸟工具类
    - 2、请求类
    - 3、响应结果类
    - 4、物流编码、状态枚举类
    - 5、测试api
  - 三、本文demo源码

一、前言

本文将基于springboot2.4.0实现快递物流查询，物流信息的获取通过快递鸟第三方实现

http://www.kdniao.com

二、快递物流查询 1、快递鸟工具类

@Slf4j
public class KdniaoUtil {

    
    public static KdniaoApiVO getLogisticInfo(KdniaoApiDTO queryDTO) {
        KdniaoApiVO kdniaoApiVO = new KdniaoUtil().getLogisticbase(queryDTO);
        Assert.isTrue("true".equals(kdniaoApiVO.getSuccess()), kdniaoApiVO.getReason());
        kdniaoApiVO.handleData();
        return kdniaoApiVO;
    }

    
    @SneakyThrows(Exception.class)
    private KdniaoApiVO getLogisticbase(KdniaoApiDTO queryDTO) {
        String EBusinessID = queryDTO.getEBusinessID();
        String ApiKey = queryDTO.getApiKey();
        String ReqURL = queryDTO.getReqURL();
        String shipperCode = queryDTO.getShipperCode();
        String logisticCode = queryDTO.getLogisticCode();

        // 组装应用级参数
        Map requestParamMap = Maps.newHashMap();
        requestParamMap.put("shipperCode", shipperCode);
        requestParamMap.put("LogisticCode", logisticCode);
        String RequestData = JSON.toJSONString(requestParamMap);
        // 组装系统级参数
        Map params = Maps.newHashMap();
        params.put("RequestData", this.urlEncoder(RequestData, "UTF-8"));
        params.put("EBusinessID", EBusinessID);
        params.put("RequestType", "8001");
        String dataSign = this.encrypt(RequestData, ApiKey, "UTF-8");
        params.put("DataSign", this.urlEncoder(dataSign, "UTF-8"));
        params.put("DataType", "2");
        // 以form表单形式提交post请求，post请求体中包含了应用级参数和系统级参数
        String resultJson = this.sendPost(ReqURL, params);
        return JSON.parseObject(resultJson, KdniaoApiVO.class);
    }

    
    @SuppressWarnings("unused")
    private String MD5(String str, String charset) throws Exception {
        MessageDigest md = MessageDigest.getInstance("MD5");
        md.update(str.getBytes(charset));
        byte[] result = md.digest();
        StringBuffer sb = new StringBuffer(32);
        for (int i = 0; i < result.length; i++) {
            int val = result[i] & 0xff;
            if (val <= 0xf) {
                sb.append("0");
            }
            sb.append(Integer.toHexString(val));
        }
        return sb.toString().toLowerCase();
    }

    
    private String base64(String str, String charset) throws UnsupportedEncodingException {
        String encoded = base64.encode(str.getBytes(charset));
        return encoded;
    }

    @SuppressWarnings("unused")
    private String urlEncoder(String str, String charset) throws UnsupportedEncodingException {
        String result = URLEncoder.encode(str, charset);
        return result;
    }

    
    @SuppressWarnings("unused")
    private String encrypt(String content, String keyValue, String charset) throws UnsupportedEncodingException, Exception {
        if (keyValue != null) {
            return base64(MD5(content + keyValue, charset), charset);
        }
        return base64(MD5(content, charset), charset);
    }

    
    @SuppressWarnings("unused")
    private String sendPost(String url, Map params) {
        OutputStreamWriter out = null;
        BufferedReader in = null;
        StringBuilder result = new StringBuilder();
        try {
            URL realUrl = new URL(url);
            HttpURLConnection conn = (HttpURLConnection) realUrl.openConnection();
            // 发送POST请求必须设置如下两行
            conn.setDoOutput(true);
            conn.setDoInput(true);
            // POST方法
            conn.setRequestMethod("POST");
            // 设置通用的请求属性
            conn.setRequestProperty("accept", "*
    @ApiModelProperty("增值物流状态")
    private Integer StateEx;

    @ApiModelProperty("增值物流状态名称")
    private String statusExName;

    @ApiModelProperty("快递单号")
    private String LogisticCode;

    @ApiModelProperty("快递公司编码")
    private String ShipperCode;

    @ApiModelProperty("失败原因")
    private String Reason;

    @ApiModelProperty("事件轨迹集")
    private List Traces;

    
    @ApiModelProperty("物流状态：0-暂无轨迹信息,1-已揽收,2-在途中,3-签收,4-问题件")
    private Integer State;

    @ApiModelProperty("状态名称")
    private String statusName;

    @ApiModelProperty("用户ID")
    private String EBusinessID;

    @ApiModelProperty("送货人")
    private String DeliveryMan;

    @ApiModelProperty("送货人电话号码")
    private String DeliveryManTel;

    @ApiModelProperty("成功与否 true/false")
    private String Success;

    @ApiModelProperty("所在城市")
    private String Location;

    @Data
    @Builder
    @NoArgsConstructor
    @AllArgsConstructor
    @ApiModel("事件轨迹集")
    public static class TraceItem {
        
        @ApiModelProperty("当前状态(同StateEx)")
        private Integer Action;

        @ApiModelProperty("状态名称")
        private String actionName;

        @ApiModelProperty("描述")
        private String AcceptStation;

        @ApiModelProperty("时间")
        private String AcceptTime;

        @ApiModelProperty("所在城市")
        private String Location;
    }


    public void handleData() {
        this.statusName = KdniaoLogisticsStatusEnum.getEnum(this.State).getDesc();
        this.statusExName = KdniaoLogisticsStatusEnum.getEnum(this.StateEx).getDesc();
        if (CollectionUtils.isEmpty(this.Traces)) {
            this.Traces = Lists.newArrayList();
        }
        this.Traces.forEach(item -> item.actionName = KdniaoLogisticsStatusEnum.getEnum(item.Action).getDesc());
    }

}

4、物流编码、状态枚举类

温馨小提示：更多物流编码值可参考官网快递鸟接口支持的快递公司编码。

@Getter
@AllArgsConstructor
public enum KdniaoLogisticsCodeEnum {

    
    STO("STO", "申通"),
    
    ZTO("ZTO", "中通"),
    
    YTO("YTO", "圆通"),
    
    YD("YD", "韵达"),
    
    SF("SF", "顺丰");

    
    private final String code;
    
    private final String name;


    private static final List LIST = Lists.newArrayList();

    static {
        LIST.addAll(Arrays.asList(KdniaoLogisticsCodeEnum.values()));
    }

    
    @SneakyThrows(Exception.class)
    public static KdniaoLogisticsCodeEnum getEnumByName(String name) {
        for (KdniaoLogisticsCodeEnum itemEnum : LIST) {
            if (itemEnum.getName().equals(name)) {
                return itemEnum;
            }
        }
        throw new Exception("暂无此物流编码信息，请联系系统管理员！");
    }

}

@Getter
@AllArgsConstructor
public enum KdniaoLogisticsStatusEnum {

    
    NO_TRACE(0, "暂无轨迹信息"),
    
    HAVE_PAID(1, "已揽收"),
    
    ON_THE_WAY(2, "在途中"),
    
    ARRIVE_AT_THE_DISPATCH_CITY(201, "到达派件城市"),
    
    IN_THE_DELIVERY(202, "派件中"),
    
    HAS_STORED(211, "已放入快递柜或驿站"),
    
    SIGN(3, "签收"),
    
    SIGN_NORMAL(301, "正常签收"),
    
    SIGN_ABNORMAL(302, "派件异常后最终签收"),
    
    SIGN_COLLECTION(304, "代收签收"),
    
    SIGN_STORED(311, "快递柜或驿站签收"),
    
    PROBLEM_SHIPMENT(4, "问题件"),
    
    DELIVERY_NO_INFO(401, "发货无信息"),
    
    NO_SIGN_OVER_TIME(402, "超时未签收"),
    
    NOT_UPDATED_DUE_TO_TIMEOUT(403, "超时未更新"),
    
    REJECTION(404, "拒收(退件)"),
    
    SEND_A_ABNORMAL(405, "派件异常"),
    
    RETURN_TO_SIGN_FOR(406, "退货签收"),
    
    RETURN_NOT_SIGNED_FOR(407, "退货未签收"),
    
    STORED_OVER_TIME(412, "快递柜或驿站超时未取"),
    
    DEFAULT(0, "-");

    
    private final Integer status;
    
    private final String desc;

    private static final List LIST = Lists.newArrayList();

    static {
        LIST.addAll(Arrays.asList(KdniaoLogisticsStatusEnum.values()));
    }

    
    public static KdniaoLogisticsStatusEnum getEnum(Integer status) {
        for (KdniaoLogisticsStatusEnum itemEnum : LIST) {
            if (itemEnum.getStatus().equals(status)) {
                return itemEnum;
            }
        }
        return KdniaoLogisticsStatusEnum.DEFAULT;
    }

}

5、测试api

@Slf4j
@RestController
@RequestMapping("/test")
@Api(tags = "测试api")
public class TestController {

    @ApiOperation("查询物流信息-快递鸟")
    @GetMapping("getLogisticByKdniao")
    public KdniaoApiVO getLogisticByKdniao(@ModelAttribute KdniaoApiDTO params) {
        return KdniaoUtil.getLogisticInfo(params);
    }

}

接口文档 http://127.0.0.1/doc.html

三、本文demo源码

https://gitee.com/zhengqingya/java-workspace

今日分享语句：
没有不会做的事,只有不想做的事。

SpringBoot(47) 实现快递物流查询(快递鸟)

Java相关栏目本月热门文章