springBoot + 工廠模式 實現 快遞鳥、順豐和快遞100的物流查詢

古渡藍按發表於2023-11-25

前言:

在Spring Boot中實現快遞鳥、順豐和快遞100的物流查詢功能通常需要與它們提供的API進行互動。當然使用他們的API 我們是需要申請和註冊,從而去拿到 key 來進行呼叫。所以為註冊的必須先進行註冊,以下是他們的官網地址,可以快捷到達。

快遞鳥官網:快遞鳥 - 快遞查詢介面_免費快遞查詢api介面 (kdniao.com)

順豐快遞官網:順豐開放平臺 (sf-express.com) 介面名為:物流軌跡查詢介面

快遞100官網:快遞物流介面文件_電子面單介面文件_快遞100api介面文件 (kuaidi100.com)

為了實現這一功能,可以建立一個工廠類,用於封裝不同快遞查詢服務的邏輯,併為每個服務建立一個實現類。以下是一個簡單的示例,演示如何在Spring Boot中建立這些類和實現快遞查詢功能。

1. 建立工廠類

首先,建立一個工廠類,該類根據不同的快遞服務建立對應的查詢例項。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class ExpressServiceFactory {

    private final Kuaidi100Service kuaidi100Service;
    private final KdniaoService kdniaoService;
    private final ShunfengService shunfengService;

    @Autowired
    public ExpressServiceFactory(Kuaidi100Service kuaidi100Service, KdniaoService kdniaoService, ShunfengService shunfengService) {
        this.kuaidi100Service = kuaidi100Service;
        this.kdniaoService = kdniaoService;
        this.shunfengService = shunfengService;
    }

    public ExpressService getExpressService(String provider) {
        switch (provider) {
            case "kuaidi100":
                return kuaidi100Service;
            case "kdniao":
                return kdniaoService;
            case "shunfeng":
                return shunfengService;
            default:
                throw new IllegalArgumentException("Invalid provider: " + provider);
        }
    }
}

2. 建立介面和實現類

接下來,為每個快遞服務建立一個介面和實現類,分別實現快遞查詢的邏輯。以下是示例程式碼:

快遞100 (Kuaidi100)

import org.springframework.stereotype.Service;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RestTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import java.util.Map;

@Service
public class Kuaidi100Service implements ExpressService {
    
    @Autowired
    private RestTemplate restTemplate;

    @Override
    public ExpressInfo queryExpress(String trackingNumber) {
        // 呼叫Kuaidi100的API,查詢物流資訊
        // 以下是虛擬碼,實際中需要呼叫Kuaidi100的API並解析返回的資料
        String apiUrl = "https://api.kuaidi100.com/query";
        String apiKey = "your_api_key";
        
        // 構建請求引數
        Map<String, String> params = new HashMap<>();
        params.put("com", "your_com_code");  // 快遞公司編碼
        params.put("num", trackingNumber);   // 快遞單號
        params.put("key", apiKey);           // API金鑰,可以使用@Vaer註解配置在yaml
        
        // 傳送HTTP請求並獲取響應
        ResponseEntity<String> response = restTemplate.getForEntity(apiUrl, String.class, params);
        
        if (response.getStatusCode() == HttpStatus.OK) {
            // 解析返回的JSON資料,構建ExpressInfo物件
            String responseBody = response.getBody();
            ExpressInfo expressInfo = parseKuaidi100Response(responseBody);
            return expressInfo;
        } else {
            throw new RuntimeException("Failed to query Kuaidi100: " + response.getStatusCode());
        }
    }

    private ExpressInfo parseKuaidi100Response(String responseBody) {
        // 解析Kuaidi100返回的JSON資料並構建ExpressInfo物件的邏輯
        // 以下是示例程式碼,實際中需要根據API返回的資料結構進行解析
        ObjectMapper objectMapper = new ObjectMapper();
        try {
            Kuaidi100Response kuaidi100Response = objectMapper.readValue(responseBody, Kuaidi100Response.class);
            ExpressInfo expressInfo = new ExpressInfo();
            expressInfo.setTrackingNumber(kuaidi100Response.getTrackingNumber());
            expressInfo.setLogisticsStatus(kuaidi100Response.getLogisticsStatus());
            expressInfo.setLogisticsDetail(kuaidi100Response.getLogisticsDetail());
            return expressInfo;
        } catch (IOException e) {
            throw new RuntimeException("Failed to parse Kuaidi100 response", e);
        }
    }
}

快遞鳥 (Kdniao)

import org.springframework.stereotype.Service;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RestTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.util.MultiValueMap;

@Service
public class KdniaoService implements ExpressService {

    @Autowired
    private RestTemplate restTemplate;

    @Override
    public ExpressInfo queryExpress(String trackingNumber) {
        // 呼叫快遞鳥的API,查詢物流資訊
        // 以下是虛擬碼,實際中需要呼叫Kdniao的API並解析返回的資料
        String apiUrl = "https://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx";
        String apiKey = "your_api_key";

        // 構建請求引數
        MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
        params.add("ShipperCode", "your_shipper_code");  // 快遞公司編碼
        params.add("LogisticCode", trackingNumber);       // 快遞單號
        params.add("RequestType", "1002");               // 查詢方式
        params.add("apiKey", apiKey);

        // 傳送HTTP請求並獲取響應
        ResponseEntity<String> response = restTemplate.postForEntity(apiUrl, params, String.class);

        if (response.getStatusCode() == HttpStatus.OK) {
            // 解析返回的XML資料,構建ExpressInfo物件
            String responseBody = response.getBody();
            ExpressInfo expressInfo = parseKdniaoResponse(responseBody);
            return expressInfo;
        } else {
            throw new RuntimeException("Failed to query Kdniao: " + response.getStatusCode());
        }
    }

    private ExpressInfo parseKdniaoResponse(String responseBody) {
        // 解析Kdniao返回的XML資料並構建ExpressInfo物件的邏輯
        // 以下是示例程式碼,實際中需要根據API返回的資料結構進行解析
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        DocumentBuilder builder;
        Document doc;

        try {
            builder = factory.newDocumentBuilder();
            doc = builder.parse(new InputSource(new StringReader(responseBody)));
        } catch (Exception e) {
            throw new RuntimeException("Failed to parse Kdniao response", e);
        }

        // 解析XML資料並構建ExpressInfo物件
        ExpressInfo expressInfo = new ExpressInfo();
        // 根據XML結構解析資料並設定到ExpressInfo物件中
        return expressInfo;
    }
}

順豐 (Shunfeng)

import org.springframework.stereotype.Service;

@Service
public class ShunfengService implements ExpressService {

    @Override
    public ExpressInfo queryExpress(String trackingNumber) {
        // 呼叫順豐的API,查詢物流資訊
        // 以下是虛擬碼,實際中需要呼叫順豐的API並解析返回的資料
        String apiUrl = "https://api.sf-express.com/std/service";
        String apiKey = "your_api_key";
        
        // 構建請求引數
        Map<String, Object> params = new HashMap<>();
        params.put("tracking_number", trackingNumber);
        params.put("api_key", apiKey);
        
        // 傳送HTTP請求並獲取響應
        ResponseEntity<String> response = restTemplate.postForEntity(apiUrl, params, String.class);
        
        if (response.getStatusCode() == HttpStatus.OK) {
            // 解析返回的JSON資料,構建ExpressInfo物件
            String responseBody = response.getBody();
            // 解析JSON資料並構建ExpressInfo物件
            ExpressInfo expressInfo = parseShunfengResponse(responseBody);
            return expressInfo;
        } else {
            throw new RuntimeException("Failed to query Shunfeng: " + response.getStatusCode());
        }
    }

    private ExpressInfo parseShunfengResponse(String responseBody) {
        // 解析順豐API響應的JSON資料
        try {
            // 解析JSON資料,具體欄位和格式需要根據順豐API文件來定義
            ObjectMapper objectMapper = new ObjectMapper();
            JsonNode root = objectMapper.readTree(responseBody);

            // 檢查響應狀態
            String status = root.get("status").asText();
            if ("OK".equals(status)) {
                // 從響應中提取物流資訊
                JsonNode dataNode = root.get("data");
                String trackingNumber = dataNode.get("tracking_number").asText();
                String deliveryStatus = dataNode.get("delivery_status").asText();
                String lastUpdateTime = dataNode.get("last_update_time").asText();

                // 構建ExpressInfo物件
                ExpressInfo expressInfo = new ExpressInfo();
                expressInfo.setTrackingNumber(trackingNumber);
                expressInfo.setDeliveryStatus(deliveryStatus);
                expressInfo.setLastUpdateTime(lastUpdateTime);

                return expressInfo;
            } else {
                // 響應中包含錯誤資訊
                String errorMsg = root.get("message").asText();
                throw new RuntimeException("Shunfeng API error: " + errorMsg);
            }
        } catch (IOException e) {
            // 處理解析錯誤
            throw new RuntimeException("Failed to parse Shunfeng API response", e);
        }
    }
}

3. 建立介面

建立一個通用的快遞查詢服務介面,以便在工廠類中使用。

public interface ExpressService {

    /**
     * 根據快遞單號查詢快遞物流資訊
     * @param trackingNumber  快遞單號
     * @return 快遞物流資訊
     */
    ExpressInfo queryExpress(String trackingNumber);
}

4. 使用工廠類查詢物流資訊

在你的控制器或服務類中,使用工廠類來獲取適當的快遞查詢服務例項,並查詢物流資訊。

@RestController
public class ExpressController {

    private final ExpressServiceFactory expressServiceFactory;

    @Autowired
    public ExpressController(ExpressServiceFactory expressServiceFactory) {
        this.expressServiceFactory = expressServiceFactory;
    }


     /**
     * 根據快遞型別和單號查詢快遞物流資訊
     * @param provider 快遞型別
     * @param trackingNumber  快遞單號
     * @return 快遞物流資訊
     */
    @GetMapping("/query-express")
    public ExpressInfo queryExpress(@RequestParam String provider, @RequestParam String trackingNumber) {
        ExpressService expressService = expressServiceFactory.getExpressService(provider);
        return expressService.queryExpress(trackingNumber);
    }
}

到這裡程式碼就寫好!!!接下來就可以進行測試或者前端呼叫介面!!!

如果對你有用就點個贊或者關注一下吧!