שימוש בקמונדה לתזמור קל המבוסס על REST ו-Workflow Engine (ללא Java)

היי הבר! אני מציג לתשומת לבך את התרגום של המאמר "השתמש בקמונדה כמנוע תזמור וזרימת עבודה קל לשימוש מבוסס REST (מבלי לגעת ב-Java)" מאת ברנד רוקר.

07.07.2020/XNUMX/XNUMX, תרגום מאמרים ברנד ראקר

לעתים קרובות אני דן בארכיטקטורת מיקרו-שירותים עם אנשים שאינם ב-Java: מפתחי C#, מפתחי Node.JS/JavaScript או חובבי Golang. כולם מתמודדים עם העובדה שהם צריכים מנגנון תזמור בארכיטקטורת מיקרו-שירותים, או סתם כלי לייעול זרימת העבודה ולקבל את היכולת לבצע הזמנה, טיפול בתזמון זמן, סאגה ועסקאות פיצוי.

פלטפורמת BPM עם קוד פתוח מקאמונדה נהדר עבור משימות כאלה. ידידותיות למפתחים היא אחת מתכונות המפתח של המוצר. אבל אם תסתכל על התיעוד שלה, אולי תתרשם שה"ידידותיות" של קאמונדה מכוונת בעיקר למפתחי ג'אווה. הפלטפורמה מספקת הרבה אפשרויות לחיבור פונקציות והרחבות משלך, אבל הכל נעשה ב-Java. באמת?

לא! למעשה, אתה יכול בקלות להפעיל את Camunda ללא כל ידע בג'אווה ולהגדיר את הארכיטקטורה לקוד בכל שפה שתבחר. במאמר זה נסתכל על:

• אדריכלות בסיסית;
• REST API
• ייעוץ לגבי ספריות לקוחות קיימות לשפות שאינן Java;
• דוגמה באמצעות C# ו-Node.JS;
• דרכים להפעיל את שרת Camunda (Docker או Tomcat).

אדריכלות

Camunda כתוב ב-Java וצריך מכונת Java Virtual Machine (JVM) כדי לפעול. Camunda מספקת REST API המאפשר לך לכתוב בכל שפה שתרצה ולהשתמש ב-REST עם Camunda:

זרימות עבודה בקמונדה מוגדרות ב-BPMN, שהוא בעצם קובץ XML. אפשר לעצב איתו קמונדה דוגמנית.

הפעלת Camunda דרך תמונת Docker בנויה מראש

הדרך הקלה ביותר להפעיל את Camunda היא להשתמש ב-Docker. דרכים חלופיות להפעלת Camunda מתוארות בהמשך מאמר זה.

במקרה זה, פשוט הפעל:

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

אתה לא צריך לדאוג לגבי לינוקס, JVMs או Tomcats. קבצי Docker ותיעוד בסיסי (לדוגמה, הוראות לחיבור לבסיסי הנתונים הנדרשים) זמינים בכתובת GitHub.

אם אתה רוצה להפעיל את Camunda Enterprise Edition אתה יכול בקלות לשנות דוקרפיל.

עם זאת, להרצת Camunda עם Docker יש חיסרון אחד: בסופו של דבר תהיה לך גרסה של Tomcat שלא תמיד כוללת את התיקונים האחרונים. כדי לעקוף זאת, אתה יכול ליצור תמונת Docker משלך בהתבסס על הפצת Tomcat הרצויה, כפי שמוצג בדוגמה זו, או להשתמש באחד מהפתרונות המתוארים להלן.

פריסת מודל תהליך

הבה נסתכל על דוגמה באמצעות תבנית Saga עבור הזמנת טיול קלאסית שבה אתה רוצה להפעיל שלוש פעולות ברציפות ולפצות בחן על פעולות שהושלמו בהצלחה במקרה של כשל מאוחר יותר. מיוצג בצורת BPMN, זה נראה כך:

עכשיו אתה יכול להשתמש REST API עבור פריסת מודל תהליך. נניח שאתה שומר אותו בתור trip.bpmn ומפעיל את Camunda דרך Docker כך שהוא זמין ב-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 לא יכול רק להתקשר לשירותים באופן מיידי (Push-Principle) באמצעות חלק מובנה מחברים, אבל גם לשים פריטי עבודה במעין סדר מובנה. לאחר מכן העובד יכול להביא פריטי עבודה דרך REST, לבצע את העבודה ולהורות לקמונדה להשלים (Pull-Principle).

אז קודם כל אתה צריך לבצע fetchAndLock (מכיוון שעובדים אחרים יכולים לקבל משימות בו-זמנית להגדלת המערכת):

  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

אז תגיד את זה לקמונדה העובד השלים את העבודה (שים לב שעליך להזין את מזהה המשימה החיצונית שהתקבל בבקשה הראשונה):

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

זהו - עדיין לא היית צריך שום ג'אווה, נכון? וזה מספיק כדי להתחיל!

ספריות לקוחות

קל לקרוא ל- REST API בכל שפת תכנות. ב-JavaScript, זה נעשה בצורה נוחה באמצעות JQuery, וב-C#, באמצעות System.Net.Http ו- Newtonsoft.Json. אבל זה ייקח זמן. אז אתה יכול פשוט להשתמש באיזו ספריית לקוח.

כרגע, מספר ספריות לקוחות מוכנות זמינות:

• javascript: קשר. נתמך על ידי Camunda;
• Java you קשר. נתמך על ידי Camunda;
• C #:קשר и קשר. שני הפרויקטים הללו נמצאים במצב ביניים ולמעשה רדומים, אך יכולים לשמש כנקודת התחלה טובה;
• PHP: קשר - לא שלם מדי ואינו כולל את השינויים האחרונים ב-API, אבל אני מכיר פרויקטים שמשתמשים בו.

למעט JavaScript ו-Java, ספריות הלקוח אינן חלק ממוצר Camunda עצמו. אל תצפה מהם לתמוך בכל תכונות ה-REST API של Camunda. זה שספריה לא מספקת פונקציה מסוימת לא אומר שהיא לא שם, בדוק תמיד את REST API של Camunda. פרויקטי עיון משתמשים בספריות כנקודת התחלה וכתבנית.

דוגמה 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

תמונת Docker מותאמת אישית עם "Camunda WAR עצמאית"

כחלופה לתמונת Docker שנבנתה מראש מ-Camunda, אתה יכול להכין את Tomcat בעצמך (לדוגמה, על סמך התמונות הרשמיות של Docker Tomcat) ואז להעתיק את Camunda לתוכה כאחד מהקבצים שנקראים WAR.

אם יש לך דרישות נוספות רבות ואתה יכול להגדיר סביבת בנייה של Java, אתה יכול גם להגדיר את Camunda Standalone War. הגדר מבנה של Maven כמו בדוגמאות הבאות: build Maven עם תצורת מלחמה או הרכבה Maven עם שכבת על.

התחלת הפצת Camunda Tomcat

אפשרות נוספת היא פשוט להוריד את הפצת Camunda Tomcat, לפתוח אותה ולהפעיל אותה. זה דורש רק את Java Runtime Environment (JRE) המותקנת במחשב שלך. זה יכול להיות בקלות להוריד מכאן.

כדי לשנות את מסד הנתונים או לעשות כל דבר אחר, אתה צריך להגדיר את Tomcat like מתואר בתיעוד. אני יודע ש-Tomcat אולי נשמע מסובך, אבל זה בעצם מאוד פשוט. וגוגל יודעת את התשובות לכל מה שיידרש בתהליך.

הפעלת Camunda באמצעות Tomcat

האלטרנטיבה האחרונה היא להגדיר את Tomcat בעצמך ולהתקין בו את Camunda, בעקבות תיאור ההתקנה. זה ייתן לך את האפשרות להשתמש בכל גרסה של Tomcat שאתה מעדיף, או להתקין אותה כשירות Windows, למשל.

השקת קאמונדה לייצור

זה בדרך כלל ידרוש הגדרה סופית כלשהי כדי להפעיל את Camunda. ישנן הנחיות בקמונדה שמתארות זאת בפירוט רב, אך לא אכנס אליהן במאמר זה – אציין רק דוגמה אחת: REST API של ההפצה אינו מוגדר לאימות כברירת מחדל. אולי תרצה לשנות זאת.

הסיכום שלו

כפי שאתה יכול לראות, קל מאוד להתחיל עם Camunda, ללא קשר לשפה שבה אתה משתמש. נקודת המפתח היא שכל האינטראקציה נעשית דרך REST API. גם ההתקנה די קלה, במיוחד בעת שימוש ב- Docker.

מקור: www.habr.com