Camunda Rest响应有Java类吗?

时间:2019-10-23 14:41:20

标签: json spring rest camunda spring-webclient

我目前正在尝试使用camunda rest api建立从Spring到我的本地camunda实例的REST调用。

这是我设置的方式:

  1. 像这样https://hub.docker.com/r/camunda/camunda-bpm-platform在我的localhost:8080上启动本地camunda docker容器: (我已经测试了与邮递员的通话,并且可以正常工作)

  2. 在我的pom.xml中使用几个camunda构建了一个maven项目并保留了依赖项:

        <dependency>
            <groupId>org.camunda.bpm.springboot</groupId>
            <artifactId>camunda-bpm-spring-boot-starter</artifactId>
            <version>3.3.1</version>
        </dependency>

        <dependency>
            <groupId>org.camunda.bpm</groupId>
            <artifactId>camunda-engine-rest-core</artifactId>
            <version>7.11.0</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectreactor</groupId>
            <artifactId>reactor-spring</artifactId>
            <version>1.0.1.RELEASE</version>
        </dependency>
  1. 编写了一个简单的服务,以便从Spring(来自https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-webclient的电话)进行剩余呼叫:
import org.camunda.bpm.engine.impl.persistence.entity.ProcessDefinitionEntity;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Service;
import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;

@Service
public class MyExampleService {

    private final WebClient webClient;

    public MyExampleService (WebClient.Builder webClientBuilder) {
        this.webClient = webClientBuilder.baseUrl("http://localhost:8080").build();
    }

    @Override
    public ProcessDefinitionEntity[] getCamundaProcesses() {

        ProcessDefinitionEntity[] myResponse = this.webClient.get().uri("/engine-rest/process-definition/")
                .retrieve()
                .onStatus(HttpStatus::is4xxClientError, response -> {
                    System.out.println("4xx eror");
                    return Mono.error(new RuntimeException("4xx"));
                })
                .onStatus(HttpStatus::is5xxServerError, response -> {
                    System.out.println("5xx eror");
                    return Mono.error(new RuntimeException("5xx"));
                })
                .bodyToMono(ProcessDefinitionEntity[].class)
                .block();

        return myResponse;
}

因此,我基本上使用Spring WebClient对localhost:8080/engine-rest/deployment/进行了一次调用,这应该给我一个以JSON格式列出的所有进程的列表(根据https://docs.camunda.org/manual/latest/reference/rest/deployment/get-query/)。

现在,当我将响应直接转换为ProcessDefinitionEntity []时,它不会将JSON转换为它。我还尝试了来自camunda Java API(https://docs.camunda.org/javadoc/camunda-bpm-platform/7.11/)的其他类,例如ProcessDefinitionDto

这些课程似乎都不适合我从camunda得到的答复。响应如下所示:

[
    {
        "id": "invoice:1:cdbc3f02-e6a1-11e9-8de8-0242ac110002",
        "key": "invoice",
        "category": "http://www.omg.org/spec/BPMN/20100524/MODEL",
        "description": null,
        "name": "Invoice Receipt",
        "version": 1,
        "resource": "invoice.v1.bpmn",
        "deploymentId": "cda115de-e6a1-11e9-8de8-0242ac110002",
        "diagram": null,
        "suspended": false,
        "tenantId": null,
        "versionTag": "V1.0",
        "historyTimeToLive": 30,
        "startableInTasklist": true
    },
    {
        "id": "invoice:2:ce03f66c-e6a1-11e9-8de8-0242ac110002",
        "key": "invoice",
        "category": "http://www.omg.org/spec/BPMN/20100524/MODEL",
        "description": null,
        "name": "Invoice Receipt",
        "version": 2,
        "resource": "invoice.v2.bpmn",
        "deploymentId": "cdfbb908-e6a1-11e9-8de8-0242ac110002",
        "diagram": null,
        "suspended": false,
        "tenantId": null,
        "versionTag": "V2.0",
        "historyTimeToLive": 45,
        "startableInTasklist": true
    }
]

(这只是docker容器中的两个标准进程)

camunda java api中是否存在与camunda rest api的响应正确匹配的类?

PS: 我从maven依赖项(位于package org.camunda.bpm.engine.rest.dto.repository.ProcessDefinitionDto中获得的ProcessDefinitionDto看起来像这样:

public class ProcessDefinitionDto {
    protected String id;
    protected String key;
    protected String category;
    protected String description;
    protected String name;
    protected int version;
    protected String resource;
    protected String deploymentId;
    protected String diagram;
    protected boolean suspended;
    protected String tenantId;
    protected String versionTag;
    protected Integer historyTimeToLive;
    protected boolean isStartableInTasklist;
...

我从邮递员打给http://localhost:8080/engine-rest/process-definition的回复中看起来像这样:

[
    {
        "id": "b506eb34-e6b1-11e9-8de8-0242ac110002",
        "key": "example_workflow",
        "category": "http://bpmn.io/schema/bpmn",
        "description": null,
        "name": "Just an Example",
        "version": 1,
        "resource": "example_workflow.bpmn",
        "deploymentId": "b503b6e2-e6b1-11e9-8de8-0242ac110002",
        "diagram": null,
        "suspended": false,
        "tenantId": null,
        "versionTag": null,
        "historyTimeToLive": null,
        "startableInTasklist": true
    },
    {
        "id": "invoice:1:cdbc3f02-e6a1-11e9-8de8-0242ac110002",
        "key": "invoice",
        "category": "http://www.omg.org/spec/BPMN/20100524/MODEL",
        "description": null,
        "name": "Invoice Receipt",
        "version": 1,
        "resource": "invoice.v1.bpmn",
        "deploymentId": "cda115de-e6a1-11e9-8de8-0242ac110002",
        "diagram": null,
        "suspended": false,
        "tenantId": null,
        "versionTag": "V1.0",
        "historyTimeToLive": 30,
        "startableInTasklist": true
    },
    {
        "id": "invoice:2:ce03f66c-e6a1-11e9-8de8-0242ac110002",
        "key": "invoice",
        "category": "http://www.omg.org/spec/BPMN/20100524/MODEL",
        "description": null,
        "name": "Invoice Receipt",
        "version": 2,
        "resource": "invoice.v2.bpmn",
        "deploymentId": "cdfbb908-e6a1-11e9-8de8-0242ac110002",
        "diagram": null,
        "suspended": false,
        "tenantId": null,
        "versionTag": "V2.0",
        "historyTimeToLive": 45,
        "startableInTasklist": true
    }
]

2 个答案:

答案 0 :(得分:2)

中的类
  

org.camunda.bpm.engine.rest.dto.runtime

是合适的。 (https://github.com/camunda/camunda-bpm-platform/tree/master/engine-rest/engine-rest/src/main/java/org/camunda/bpm/engine/rest/dto

<dependency>
  <groupId>org.camunda.bpm</groupId>
  <artifactId>camunda-engine-rest-core</artifactId>
</dependency>

在您的情况下,该名称为 ProcessDefinitionDto Spring REST模板的用法示例:

@Service
@Slf4j
public class RuntimeServiceImpl implements RuntimeService {

    private final RestTemplate rest;
    @Value("${camunda.server.rest.url}")
    private String restURL;

    public RuntimeServiceImpl(RestTemplateBuilder builder) {
        this.rest = builder.build();
    }

    public ProcessDefinitionDto[] getProcessDefinitions() {

        ResponseEntity<ProcessDefinitionDto[]> response = rest.getForEntity(restURL + "process-definition/",
                ProcessDefinitionDto[].class);
        ProcessDefinitionDto[] processes = response.getBody();

        Arrays.stream(processes).forEach(pd -> log.info("Found process definition {} with id {} and key {}", pd.getName(), pd.getId(), pd.getKey()));

        return processes;
    }
}

完整的客户项目:https://github.com/rob2universe/camunda-rest-client

external class client包含其他可以重用的接口和DTO,例如

  

org.camunda.bpm.client.topic.impl.dto.FetchAndLockRequestDto;   org.camunda.bpm.client.topic.impl.dto.TopicRequestDto;

或者只使用/派生整个客户端项目。在那里,您已经完成了很多工作。

P.s。以下评论: 响应包括带有以下字段的一系列流程定义:

[
    {
        "id": "AccountOpening:1:a6f88770-0ae7-11ea-9ef3-00155d00d800",
        "key": "AccountOpening",
        "category": "http://bpmn.io/schema/bpmn",
        "description": null,
        "name": "Account Opening",
        "version": 1,
        "resource": "C:\\account-opening\\target\\classes\\bpmn\\AccountOpening.bpmn",
        "deploymentId": "a6cc4747-0ae7-11ea-9ef3-00155d00d800",
        "diagram": null,
        "suspended": false,
        "tenantId": null,
        "versionTag": null,
        "historyTimeToLive": null,
        "startableInTasklist": true
    }

org.camunda.bpm.engine.rest.dto.repository 中的目标数据结构包含相同的字段:

public class ProcessDefinitionDto {
    protected String id;
    protected String key;
    protected String category;
    protected String description;
    protected String name;
    protected int version;
    protected String resource;
    protected String deploymentId;
    protected String diagram;
    protected boolean suspended;
    protected String tenantId;
    protected String versionTag;
    protected Integer historyTimeToLive;
    protected boolean isStartableInTasklist;
   ...}

如果反序列化失败,那么请确保您使用的是正确的程序包(例如org.camunda.bpm.cockpit.impl.plugin.base.dto)

答案 1 :(得分:1)

您在寻找正确的包装吗? Camunda代码库中有多个ProcessDefinitionDto类。 您要查找的是位于camunda-engine-rest-core.jar

中的软件包org.camunda.bpm.engine.rest.dto.repository

该类如下所示,该类与您的输出完全匹配:

package org.camunda.bpm.engine.rest.dto.repository;

import org.camunda.bpm.engine.repository.ProcessDefinition;

public class ProcessDefinitionDto {

  protected String id;
  protected String key;
  protected String category;
  protected String description;
  protected String name;
  protected int version;
  protected String resource;
  protected String deploymentId;
  protected String diagram;
  protected boolean suspended;
  protected String tenantId;
  protected String versionTag;
  protected Integer historyTimeToLive;
  protected boolean isStartableInTasklist;

  ...