REST 및 워크플로우 엔진(Java 없음) 기반의 손쉬운 오케스트레이션을 위해 Camunda 사용

헤이 하브르! 나는 기사의 번역을 당신의 관심에 제시합니다 "(Java를 건드리지 않고) 사용하기 쉬운 REST 기반 오케스트레이션 및 워크플로 엔진으로 Camunda를 사용하세요." 베른트 뤼커.

07.07.2020년 XNUMX월 XNUMX일, 번역 조항 번드 러커

저는 종종 Java가 아닌 C# 개발자, Node.JS/JavaScript 개발자 또는 Golang 애호가와 마이크로서비스 아키텍처에 대해 논의합니다. 이들 모두는 마이크로서비스 아키텍처의 오케스트레이션 메커니즘이 필요하거나 워크플로를 간소화하고 주문, 시간 초과 처리, Saga 및 보상 트랜잭션 기능을 얻기 위한 도구가 필요하다는 사실에 직면해 있습니다.

BPM 플랫폼 Camunda의 오픈 소스 그러한 작업에 좋습니다. 개발자 친화성은 제품의 주요 기능 중 하나입니다. 그러나 해당 문서를 살펴보면 Camunda의 "친숙함"이 주로 Java 개발자를 대상으로 한다는 인상을 받을 수 있습니다. 플랫폼은 자신의 기능과 확장을 연결하기 위한 많은 옵션을 제공하지만 모두 Java로 수행됩니다. 진짜야?

아니요! 실제로 Java 지식 없이도 Camunda를 쉽게 실행할 수 있으며 원하는 언어로 코드 아키텍처를 설정할 수 있습니다. 이 기사에서는 다음을 살펴보겠습니다.

• 기본 아키텍처;
• REST API
• Java 이외의 언어에 대한 기존 클라이언트 라이브러리에 대한 조언
• C# 및 Node.JS를 사용한 예;
• Camunda 서버(Docker 또는 Tomcat)를 시작하는 방법.

구조

Camunda는 Java로 작성되었으며 실행하려면 JVM(Java Virtual Machine)이 필요합니다. Camunda는 원하는 언어로 작성하고 Camunda와 함께 REST를 사용할 수 있는 REST API를 제공합니다.

Camunda의 워크플로우는 기본적으로 XML 파일인 BPMN으로 정의됩니다. 으로 모델링할 수 있습니다. 카문다 모델러.

사전 빌드된 Docker 이미지를 통해 Camunda 실행

Camunda를 실행하는 가장 쉬운 방법은 Docker를 사용하는 것입니다. Camunda를 시작하는 다른 방법은 이 문서의 뒷부분에서 설명합니다.

이 경우 간단히 다음을 실행하십시오.

  docker run -d -p 8080:8080 camunda/camunda-bpm-platform:latest

Linux, JVM 또는 Tomcat에 대해 걱정할 필요가 없습니다. Dockerfile 및 기본 문서(예: 필수 데이터베이스 연결 지침)는 다음에서 확인할 수 있습니다. 깃허브.

Camunda Enterprise Edition을 실행하려면 쉽게 변경할 수 있습니다 도커 파일.

그러나 Docker로 Camunda를 실행하면 한 가지 단점이 있습니다. 즉, 항상 최신 수정 사항이 포함되지 않는 Tomcat 버전이 생성된다는 것입니다. 이 문제를 해결하려면 이 예제에 표시된 대로 원하는 Tomcat 배포를 기반으로 고유한 Docker 이미지를 생성하거나 아래 설명된 솔루션 중 하나를 사용할 수 있습니다.

프로세스 모델 배포

세 가지 작업을 연속으로 트리거하고 나중에 실패할 경우 성공적으로 완료된 작업을 적절하게 보상하려는 일반적인 여행 예약에 Saga 템플릿을 사용하는 예를 살펴보겠습니다. BPMN 형식으로 표현하면 다음과 같습니다.

이제 사용할 수 있습니다. 프로세스 모델 배포를 위한 REST API. 이를 trip.bpmn으로 저장하고 Docker를 통해 Camunda를 실행하여 localhost:8080에서 사용할 수 있다고 가정해 보겠습니다.

  curl -w "n" 
-H "Accept: application/json" 
-F "deployment-name=trip" 
-F "enable-duplicate-filtering=true" 
-F "deploy-changed-only=true" 
-F "[email protected]" 
http://localhost:8080/engine-rest/deployment/creat

이제 실행할 수 있습니다 새 워크플로 인스턴스 REST API를 사용하여 보려는 데이터를 워크플로 인스턴스 변수로 전달합니다.

  curl 
-H "Content-Type: application/json" 
-X POST 
-d '{"variables":{"someData" : {"value" : "someValue", "type": "String"}},"businessKey" : "12345"}}' 
http://localhost:8080/engine-rest/<!-- -->process-definition/key/<!-- -->FlowingTripBookingSaga<!-- -->/start

다음 흥미로운 질문은 Camunda가 자동차 예약과 같은 절차를 어떻게 호출하는가입니다. Camunda는 내장된 일부 기능을 사용하여 즉시 서비스를 호출할 수 있을 뿐만 아니라(Push-Principle) 커넥터, 작업 항목을 일종의 기본 제공 순서로 배치합니다. 그런 다음 작업자는 REST를 통해 작업 항목을 가져오고, 작업을 수행하고, Camunda에게 완료하라고 지시할 수 있습니다(풀 원칙).

먼저 실행해야합니다 가져오기 및 잠금 (다른 작업자가 동시에 작업을 받아 시스템을 확장할 수 있기 때문입니다):

  curl 
-H "Content-Type: application/json" 
-X POST 
-d <!-- -->'{"workerId":"worker123","maxTasks":1,"usePriority":true,"topics":[{"topicName": "reserve-car"}, "lockDuration": 10000, "variables": ["someData"]}]}'<!-- --> 
http://localhost:8080/engine-rest/external-task/fetchAndLock

그럼 Camunda에게 말해줘 작업자가 작업을 완료했습니다. (첫 번째 요청에서 받은 외부 작업 ID를 입력해야 합니다.):

  curl 
-H "Content-Type: application/json" 
-X POST 
-d <!-- -->'{"workerId":"worker123", "variables": {}}'<!-- --> 
http://localhost:8080/engine-rest/<!-- -->external-task/EXTERNAL_TASK_ID/complete

그게 다입니다. 아직 Java가 필요하지 않습니다. 그렇죠? 시작하기에 충분합니다!

클라이언트 라이브러리

REST API를 호출하는 것은 모든 프로그래밍 언어에서 쉽습니다. JavaScript에서는 JQuery를 사용하고 C#에서는 System.Net.Http 및 Newtonsoft.Json을 사용하여 이 작업을 편리하게 수행합니다. 하지만 시간이 좀 걸릴 거예요. 따라서 일부 클라이언트 라이브러리를 사용할 수 있습니다.

현재 몇 가지 기성 클라이언트 라이브러리를 사용할 수 있습니다.

• 자바 스크립트 : 링크. Camunda의 지원;
• 자바 : 링크. Camunda의 지원;
• 씨#:링크 и 링크. 이 두 프로젝트는 모두 중간 상태에 있으며 사실상 휴면 상태이지만 좋은 출발점이 될 수 있습니다.
• PHP : 링크 - 너무 완전하지도 않고 최신 API 변경 사항도 포함하지 않지만 이를 사용하는 프로젝트를 알고 있습니다.

JavaScript 및 Java를 제외하고 클라이언트 라이브러리는 Camunda 제품 자체의 일부가 아닙니다. Camunda의 REST API 기능을 모두 지원할 것이라고 기대하지 마십시오. 라이브러리가 특정 기능을 제공하지 않는다고 해서 그것이 존재하지 않는다는 것을 의미하지는 않습니다. 항상 Camunda의 REST API를 확인하세요. 참조 프로젝트는 라이브러리를 시작점과 템플릿으로 사용합니다.

C# 예

위의 클라이언트 라이브러리를 사용하여 다음과 같이 간단히 작성할 수 있습니다.

  var camunda = new CamundaEngineClient("http://localhost:8080/engine-rest/engine/default/", null, null);
  // Deploy the BPMN XML file from the resources
  camunda.RepositoryService.Deploy("trip-booking", new List<object> {
        FileParameter.FromManifestResource(Assembly.GetExecutingAssembly(), "FlowingTripBookingSaga.Models.FlowingTripBookingSaga.bpmn")
     });
  
  // Register workers
  registerWorker("reserve-car", externalTask => {
    // here you can do the real thing! Like a sysout :-)
    Console.WriteLine("Reserving car now...");
    camunda.ExternalTaskService.Complete(workerId, externalTask.Id);
  });
  registerWorker("cancel-car", externalTask => {
    Console.WriteLine("Cancelling car now...");
    camunda.ExternalTaskService.Complete(workerId, externalTask.Id);
  });
  registerWorker("book-hotel", externalTask => {
    Console.WriteLine("Reserving hotel now...");
    camunda.ExternalTaskService.Complete(workerId, externalTask.Id);
  });
  // Register more workers...
  
  StartPolling();
  
  string processInstanceId = camunda.BpmnWorkflowService.StartProcessInstance("FlowingTripBookingSaga", new Dictionary<string, object>()
    {
      {"someBookingData", "..." }
    });

완전히 작동하는 소스 코드는 온라인에서 찾을 수 있습니다. 링크. 또 다른 예는 다음에서 확인할 수 있습니다. 링크.

Node.js의 예

  var Workers = require('camunda-worker-node');
  var workers = Workers('http://localhost:8080/engine-rest', {
    workerId: 'some-worker-id'
  });
  
  workers.registerWorker('reserve-car', [ 'someData' ], function(context, callback) {
    var someNewData = context.variables.someData + " - added something";
    callback(null, {
      variables: {
        someNewData: someNewData
      }
    });
  });
  
  workers.shutdown();

더 많은 정보는 홈페이지에서 확인하실 수 있습니다 github.com

Camunda를 시작하는 다른 방법

"Camunda 독립형 WAR"이 포함된 사용자 정의 Docker 이미지

Camunda의 사전 구축된 Docker 이미지 대신 Tomcat을 직접 준비한 다음(예: 공식 Docker Tomcat 이미지 기반) Camunda를 소위 WAR 파일 중 하나로 복사할 수 있습니다.

추가 요구 사항이 많고 Java 빌드 환경을 설정할 수 있는 경우 Camunda Standalone War를 설정할 수도 있습니다. 다음 예시와 같이 Maven 빌드를 설정합니다. 전쟁 설정이 포함된 Maven 또는 조립 오버레이를 사용한 Maven.

Camunda Tomcat 배포 시작

또 다른 옵션은 Camunda Tomcat 배포판을 다운로드하여 압축을 풀고 실행하는 것입니다. 이를 위해서는 컴퓨터에 JRE(Java Runtime Environment)만 설치되어 있어야 합니다. 쉽게 할 수 있습니다 여기에서 다운로드하세요.

데이터베이스를 변경하거나 다른 작업을 수행하려면 다음과 같이 Tomcat을 구성해야 합니다. 문서에 설명되어 있음. Tomcat이 복잡해 보일 수도 있지만 실제로는 매우 간단합니다. 그리고 Google은 그 과정에서 필요할 수 있는 모든 것에 대한 답을 알고 있습니다.

Tomcat을 사용하여 Camunda 실행

마지막 대안은 Tomcat을 직접 설정하고 Camunda를 설치하는 것입니다. 설치 설명에 따라. 예를 들어, 원하는 Tomcat 버전을 사용하거나 Windows 서비스로 설치할 수 있는 옵션이 제공됩니다.

Camunda를 생산에 투입

일반적으로 Camunda를 실행하려면 몇 가지 최종 설정이 필요합니다. Camunda에는 이에 대해 자세히 설명하는 지침이 있지만 이 기사에서는 이에 대해 다루지 않을 것입니다. 예를 하나만 들겠습니다. 배포판의 REST API는 기본적으로 인증을 위해 구성되지 않습니다. 이것을 변경하고 싶을 수도 있습니다.

통계

보시다시피, 사용하는 언어에 관계없이 Camunda를 시작하는 것은 매우 쉽습니다. 중요한 점은 모든 상호 작용이 REST API를 통해 수행된다는 것입니다. 특히 Docker를 사용할 때 설치도 매우 쉽습니다.

출처 : habr.com