Bitzsoft.Integrations.Express.Zto 1.0.1

Bitzsoft.Integrations.Express.Zto

中通快递物流服务实现 -- 面向中通开放平台提供物流轨迹查询接入结构。

功能特性

• 基于中通开放平台 API，支持物流轨迹查询
• 认证方式：AppKey + AppSecret（HMAC-SHA256 签名）
• 对接流程：注册用户 → 资质认证 → 创建应用 → 添加服务 → 联调测试 → 上线
• 统一异常处理，供应商错误码自动映射为 ExpressException
• 实现 IExpressProvider 统一契约，可无缝替换其他供应商实现

安装

.NET CLI

dotnet add package Bitzsoft.Integrations.Express.Zto

PackageReference

<PackageReference Include="Bitzsoft.Integrations.Express.Zto" Version="1.0.0" />

配置

appsettings.json

{
  "Express": {
    "Zto": {
      "AppKey": "你的AppKey",
      "AppSecret": "你的AppSecret",
      "BaseUrl": "https://jwzto.zto.com",
      "HttpClientName": "ZtoExpress"
    }
  }
}

注册服务

从 IConfiguration 绑定（推荐）

using Bitzsoft.Integrations.Express.Zto;

builder.Services.AddBitzsoftZtoExpress(
    builder.Configuration.GetSection("Express:Zto"));

委托配置

builder.Services.AddBitzsoftZtoExpress(options =>
{
    options.AppKey = "your_app_key";
    options.AppSecret = "your_app_secret";
});

请求审计

内置 Bitzsoft.Integrations.RequestLogging 出站请求记录管道，默认使用 NullRequestLogStore 不持久化。

// ① 默认：启用记录管道但不持久化（日志丢弃）
services.AddBitzsoftZtoExpress(options => { /* ... */ });

// ② 持久化：宿主注册 IRequestLogStore 实现后，所有出站请求自动落库
services.AddRequestLogging<MyRequestLogStore>(opts =>
{
    opts.MaxInMemoryBodyBytes = 64 * 1024; // 仅控制内存/加密临时文件切换，不截断正文
    opts.SensitiveFields.Add("AppSecret");
});
services.AddBitzsoftZtoExpress(options => { /* ... */ });

使用示例

物流轨迹查询

using Bitzsoft.Integrations.Express.Interfaces;
using Bitzsoft.Integrations.Express.Models;

public class TrackingService
{
    private readonly IExpressProvider _express;

    public TrackingService(IExpressProvider express) => _express = express;

    public async Task TrackAsync(string trackingNumber)
    {
        // 查询单个运单轨迹
        ExpressTrackingInfo info = await _express.TrackAsync(trackingNumber);
        Console.WriteLine($"状态: {info.State}, 轨迹数: {info.Traces.Count}");

        foreach (var step in info.Traces)
            Console.WriteLine($"[{step.Time:yyyy-MM-dd HH:mm}] {step.Description}");

        // 批量查询
        IReadOnlyList<ExpressTrackingInfo> batch =
            await _express.BatchTrackAsync(new[] { "731001", "731002" });
    }
}

核心类型一览

实现状态

未实现的操作会抛出 NotSupportedException，提示需在中通开放平台注册并申请相关服务权限后获取接口文档。

依赖

注意事项

• 中通开放平台（https://open.zto.com/）需完成企业注册、资质认证、创建应用等流程
• 接口文档和服务权限以中通开放平台应用开通结果为准
• 仅轨迹查询已实现，寄件、取消、订阅等能力待按已开通服务扩展
• IExpressProvider 使用 TryAddSingleton 注册，如需同时注册多个供应商请单独引用并自行解析

相关包

• Bitzsoft.Integrations.Express -- 抽象层
• Bitzsoft.Integrations.Express.All -- 聚合包
• Bitzsoft.Integrations.Express.Kdniao -- 快递鸟
• Bitzsoft.Integrations.Compatibility -- 基础工具库