Bitzsoft.Integrations.ProjectManagement.PingCode 1.0.4

Bitzsoft.Integrations.ProjectManagement.PingCode

PingCode 敏捷研发项目管理 REST API 连接器实现。遵循项目管理通用抽象规范，实现通用 IProjectManagementService 接口。

功能特性

• 通用契约对齐：完整实现 IProjectManagementService 抽象规范，支持项目查询、任务创建、详情获取、属性更新、任务完成与状态过滤查询。
• API Token 鉴权：通过 PingCode 开放平台提供的个人 API Token 开展身份认证，全链路注入 Bearer 认证标头。
• 研发敏捷流转：适配 PingCode 敏捷开发标准工作项（工作项/任务/缺陷），提供标准统一的模型映射。
• 企业多组织隔离：支持配置独立的 PingCode 企业端点基地址，适配公有云或混合云环境。
• 工业级弹性韧性：内置 Polly 标准韧性管道（429 Too Many Requests / 503 Service Unavailable 指数退避重试与熔断保护）及出站审计日志（RequestLogging）。

安装

dotnet add package Bitzsoft.Integrations.ProjectManagement.PingCode

<PackageReference Include="Bitzsoft.Integrations.ProjectManagement.PingCode" Version="1.0.0" />

配置

在 appsettings.json 中配置 PingCode 连接器参数：

{
  "ProjectManagement": {
    "PingCode": {
      "AccessToken": "your-pingcode-access-token",
      "BaseUrl": "https://open.pingcode.com/api"
    }
  }
}

配置项说明

注册服务

支持通过配置源绑定或委托方式进行依赖注入注册：

using Microsoft.Extensions.DependencyInjection;

// 方式 1：通过 IConfiguration 绑定注册（推荐，默认读取 ProjectManagement:PingCode）
services.AddPingCodeProjectManagement(configuration);

// 自定义配置节路径：
// services.AddPingCodeProjectManagement(configuration, "Integrations:PingCode");

// 方式 2：通过委托手动配置注册
services.AddPingCodeProjectManagement(options =>
{
    options.AccessToken = "your-pingcode-access-token";
    options.BaseUrl = "https://open.pingcode.com/api";
});

使用示例（通用 IProjectManagementService）

以下代码演示如何在业务类中通过依赖注入使用通用的 IProjectManagementService 契约操作 PingCode 敏捷工单：

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Bitzsoft.Integrations.ProjectManagement;
using Bitzsoft.Integrations.ProjectManagement.Dtos;
using TaskStatus = Bitzsoft.Integrations.ProjectManagement.Dtos.TaskStatus;

namespace YourNamespace;

public class PingCodeTaskAppService
{
    private readonly IProjectManagementService _pmService;

    public PingCodeTaskAppService(IProjectManagementService pmService)
    {
        _pmService = pmService;
    }

    public async Task<List<PmProject>> GetProjectsAsync(
        CancellationToken cancellationToken = default)
    {
        return await _pmService.ListProjectsAsync(cancellationToken);
    }

    public async Task<PmTask> CreateTaskAsync(
        string projectId,
        string taskName,
        string description,
        string? assigneeId = null,
        DateTimeOffset? dueDate = null,
        CancellationToken cancellationToken = default)
    {
        var request = new CreateTaskRequest
        {
            ProjectId = projectId,
            Name = taskName,
            Description = description,
            AssigneeId = assigneeId,
            DueDate = dueDate,
            Priority = TaskPriority.High
        };

        return await _pmService.CreateTaskAsync(request, cancellationToken);
    }

    public async Task<PmTask> GetTaskDetailAsync(
        string taskId,
        CancellationToken cancellationToken = default)
    {
        return await _pmService.GetTaskAsync(taskId, cancellationToken);
    }

    public async Task<PmTask> UpdateTaskAsync(
        string taskId,
        string newName,
        string? newDescription = null,
        CancellationToken cancellationToken = default)
    {
        var request = new UpdateTaskRequest
        {
            Name = newName,
            Description = newDescription
        };

        return await _pmService.UpdateTaskAsync(taskId, request, cancellationToken);
    }

    public async Task<PmResult> CompleteTaskAsync(
        string taskId,
        CancellationToken cancellationToken = default)
    {
        return await _pmService.CompleteTaskAsync(taskId, cancellationToken);
    }

    public async Task<List<PmTask>> ListTasksAsync(
        string projectId,
        TaskStatus? status = null,
        CancellationToken cancellationToken = default)
    {
        var query = new TaskQuery
        {
            ProjectId = projectId,
            Status = status
        };

        return await _pmService.ListTasksAsync(query, cancellationToken);
    }
}

架构与鉴权原理

PingCode 连接器内部通过专门的 PingCodeHttpClient 调度 REST API：

• 认证注入：在每次 HTTP 请求发出前，通过 Authorization: Bearer {AccessToken} 标头传递身份凭据。
• 强类型转换：PingCode 响应的 JSON 实体经由 PingCodeModelMapper 统一规范化转换为标准 PmProject 与 PmTask。

异常处理与弹性策略

连接器集成了基于 Polly 的指数退避重试与熔断机制：

• 限流防护：当触发 PingCode 服务端调用频率限制（HTTP 429）或服务端瞬时异常（HTTP 503）时，系统自动按照指数递增等待时间进行重试。
• 故障诊断：出站请求全程记录请求路径、状态码与耗时，便于排查企业级网络抖动。

依赖

相关包