Memulai Dengan Mule ESB

1. Ikhtisar

Mule ESB adalah Enterprise Service Bus berbasis Java yang ringan. Ini memungkinkan pengembang untuk menghubungkan beberapa aplikasi bersama dengan bertukar data dalam format yang berbeda. Ini membawa data dalam bentuk pesan.

ESB menawarkan kemampuan yang kuat dengan menyediakan sejumlah layanan, seperti:

  • Pembuatan layanan dan hosting
  • Mediasi layanan
  • Perutean pesan
  • Transformasi data

Kami akan menemukan ESB berguna jika kami perlu mengintegrasikan beberapa aplikasi bersama-sama, atau jika kami memiliki gagasan untuk menambahkan lebih banyak aplikasi di masa mendatang.

ESB juga digunakan untuk menangani lebih dari satu jenis protokol komunikasi dan ketika kapabilitas perutean pesan diperlukan.

Mari buat proyek contoh di Bagian 5 menggunakan AnyPoint Studio yang tersedia untuk diunduh di sini.

2. Struktur Pesan Mule

Sederhananya, tujuan utama ESB adalah untuk menengahi antara layanan dan merutekan pesan ke berbagai titik akhir. Jadi perlu berurusan dengan berbagai jenis konten atau payload.

Struktur pesan dibagi menjadi dua bagian:

  • Header, yangberisi metadata pesan
  • Payload, yang berisi data khusus bisnis

Pesan tersebut disematkan di dalam objek pesan. Kita dapat mengambil objek pesan dari konteksnya. Kita dapat mengubah properti dan payloadnya menggunakan komponen dan transformator Java khusus di dalam aliran Mule.

Setiap aplikasi terdiri dari satu alur atau lebih.

Dalam suatu aliran, kita dapat menggunakan komponen untuk mengakses, memfilter atau mengubah pesan dan propertinya yang berbeda.

Misalnya, kita bisa mendapatkan sebuah instance dari sebuah pesan menggunakan komponen Java. Komponen alat kelas Callable antarmuka dari org.mule.api.lifecycle paket:

public Object onCall(MuleEventContext eventContext) throws Exception { MuleMessage message = eventContext.getMessage(); message.setPayload("Message payload is changed here."); return message; }

3. Properti dan Variabel

Metadata pesan terdiri dari properti. Variabel merepresentasikan data tentang sebuah pesan. Bagaimana properti dan variabel diterapkan di seluruh siklus hidup pesan ditentukan oleh cakupannya. Properti dapat terdiri dari dua jenis, berdasarkan cakupannya: masuk dan keluar.

Properti masuk berisi metadata yang mencegah pesan teracak saat melintasi alur. Properti masuk tidak dapat diubah dan tidak dapat diubah oleh pengguna. Properti tersebut hanya ada selama aliran - setelah pesan keluar dari aliran, properti masuk tidak lagi ada.

Properti keluar dapat disetel secara otomatis oleh Mule, atau pengguna dapat menyetelnya melalui konfigurasi aliran. Properti ini bisa berubah. Mereka menjadi properti masuk saat pesan memasuki aliran lain setelah melewati penghalang transportasi.

Kita bisa menyetel dan mendapatkan properti keluar dan masuk masing-masing dengan memanggil metode penyetel dan pengambil terkait dalam cakupannya masing-masing:

message.setProperty( "outboundKey", "outboundpropertyvalue", PropertyScope.OUTBOUND); String inboundProp = (String) message.getInboundProperty("outboundKey");

Ada dua jenis variabel yang tersedia untuk dideklarasikan dalam aplikasi.

Salah satunya adalah variabel aliran yang bersifat lokal ke aliran Mule dan tersedia di seluruh aliran, sub-aliran dan aliran pribadi.

Variabel sesi setelah dideklarasikan akan tersedia di seluruh aplikasi.

4. Hambatan Transportasi dan arus ref

Hambatan transportasi adalah konektor HTTP, VM, JMS, atau konektor serupa yang memerlukan jalur atau titik akhir agar pesan dirutekan. Variabel aliran tidak tersedia di semua hambatan transportasi, tetapi variabel sesi tersedia di seluruh proyek di semua aliran.

Ketika kita perlu membuat aliran sub atau aliran privat, kita bisa merujuk ke aliran dari orang tua atau aliran lain menggunakan komponen aliran-ref . Variabel aliran dan variabel sesi tersedia di sub-aliran dan aliran pribadi yang dirujuk menggunakan aliran-ref .

5. Proyek Contoh

Mari buat aplikasi di Anypoint Studio yang berisi banyak aliran, yang berkomunikasi di antara mereka sendiri melalui konektor masuk dan keluar.

Mari kita lihat aliran pertama:

Kita dapat mengonfigurasi pendengar HTTP sebagai:

Komponen aliran harus berada di dalam a menandai. Jadi, contoh aliran dengan banyak komponen adalah:

Di dalam alur, kami menyediakan referensi ke pemroses HTTP yang dikonfigurasi. Kemudian kami menyimpan logger untuk mencatat payload yang diterima pendengar HTTP melalui metode POST.

Setelah itu, kelas transformator Java khusus ditempatkan, yang mengubah payload setelah menerima pesan:

public Object transformMessage( MuleMessage message, String outputEncoding) throws TransformerException { message.setPayload("Payload is transferred here."); message.setProperty( "outboundKey", "outboundpropertyvalue", PropertyScope.OUTBOUND); return message; }

Kelas transformator harus memperluas AbstractMessageTransformer . Kami juga menetapkan properti outbound di dalam kelas.

Sekarang, kami telah mengubah payload di dalam objek pesan, dan telah mencatatnya di konsol menggunakan logger. Kami menetapkan variabel aliran dan variabel sesi.

Terakhir, kami mengirimkan payload melalui konektor VM keluar. Jalur di konektor VM menentukan titik akhir penerima:

Pesan yang dibawa dan diubah oleh aliran awal mencapai Flow1 melalui titik akhir VM masuk.

Komponen Java mengambil properti keluar yang disetel oleh aliran pertama dan mengembalikan objek yang menjadi payload pesan.

Metode transformMessage () untuk tugas ini:

public Object transformMessage( MuleMessage message, String outputEncoding) throws TransformerException { return (String) message.getInboundProperty("outboundKey"); }

Kemudian, variabel aliran dan sesi ditetapkan ke aliran kedua. Setelah itu, kita mendapat referensi ke Flow2 menggunakan komponen flow-ref .

In Flow2, we've transformed the message using Java component class and logged it in the console. We've also set a flow variable F3.

After calling Flow2 using flow-ref, Flow1 will wait for the message to be processed in Flow2.

Any flow variable set in Flow1 and Flow2 will be available in both flows since these flows aren't separated by any transport barriers.

Finally, the message is sent back to the HTTP requester through VMs. We configured all VMs as request-response.

We can invoke this application from any REST client by posting any JSON data in the body. The URL will be localhost:8081 as configured in HTTP listener.

6. Maven Archetype

We can build a Mule ESB project using Mulesoft's Maven archetype.

In Maven's settings.xml file, we first need to add the org.mule.tools plugin group:

 org.mule.tools 

Then, we need to add a profile tag that says where Maven should look for Mulesoft artifacts:

 Mule Org  true    mulesoft-releases MuleSoft Repository //repository-master.mulesoft.org/releases/ default   

Finally, we can create the project using mule-project-archetype:create:

mvn mule-project-archetype:create -DartifactId=muleesb -DmuleVersion=3.9.0

After configuring our project, we can create a deployable archive using mvn package.

After that, we'd deploy the archive into the apps folder of any standalone Mule server.

7. A Standalone Mule Server via MuleSoft's Maven Repository

As just noted, the project we just created requires a standalone Mule server.

If we don't already have one, we can edit our pom.xml to pull one from MuleSoft's Maven repository:

 org.mule.tools.maven mule-maven-plugin 2.2.1  standalone 3.9.0    deploy deploy  deploy    

8. Conclusion

In this article, we've gone through different necessary concepts of building as ESB application in Mule. We've created a sample project illustrating all the described concepts.

We can now start creating ESB application using Anypoint Studio to meet our various needs.

As usual, the complete project can be found over on GitHub.

1. Overview

Mule ESB is a lightweight Java-based Enterprise Service Bus. It allows developers to connect multiple applications together by exchanging data in different formats. It carries data in the form of a message.

ESBs offer powerful capabilities by providing a number of services, such as:

  • Service creation and hosting
  • Service mediation
  • Message routing
  • Data transformation

We'll find ESBs useful if we need to integrate multiple applications together, or if we have the notion of adding more applications in the future.

ESB is also used for dealing with more than one type of communication protocol and when message routing capabilities are required.

Let's create a sample project in Section 5 using AnyPoint Studio which is available for download here.

2. Mule Message Structure

Simply put, the primary purpose of an ESB is to mediate between services and route messages to various endpoints. So it needs to deal with different types of content or payload.

The message structure is divided into two parts:

  • The header, whichcontains message metadata
  • The payload, which contains business-specific data

The message is embedded within a message object. We can retrieve the message object from the context. We can change its properties and payload using custom Java components and transformers inside a Mule flow.

Each application consists of one or more flows.

In a flow, we can use components to access, filter or alter a message and its different properties.

For example, we can obtain an instance of a message using Java component. This component class implements a Callable interface from org.mule.api.lifecycle package:

public Object onCall(MuleEventContext eventContext) throws Exception { MuleMessage message = eventContext.getMessage(); message.setPayload("Message payload is changed here."); return message; }

3. Properties and Variables

Message metadata consists of properties. Variables represent data about a message. How properties and variables are applied across the message's life-cycle is defined by their scopes. Properties can be of two types, based on their scope: inbound and outbound.

Inbound properties contain metadata that prevents messages to become scrambled while traversing across flows. Inbound properties are immutable and cannot be altered by the user. They're present only for the duration of the flow – once the message exits the flow, inbound properties are no longer there.

Outbound properties can be set automatically by Mule, or a user can set them through flow configuration. These properties are mutable. They become inbound properties when a message enters another flow after crossing transport-barriers.

We can set and get outbound and inbound properties respectively by calling associated setter and getter methods in their respective scopes:

message.setProperty( "outboundKey", "outboundpropertyvalue", PropertyScope.OUTBOUND); String inboundProp = (String) message.getInboundProperty("outboundKey");

There are two types of variables available to declare in applications.

One is flow variable which is local to a Mule flow and available across the flow, sub-flows and private flows.

Session variables once declared become available across the entire application.

4. Transport Barriers and flow-ref

Transport barriers are HTTP-connectors, VMs, JMS or similar connectors that require paths or endpoints for messages to be routed. Flow variables aren't available across transport barriers, but session variables are available across the project in all flows.

When we need to create sub-flow or private flow, we can refer to the flow from a parent or another flow using flow-ref component. Both flow variables and session variables are available in sub-flows and private flows referred to using flow-ref.

5. Example Project

Let's create an application in Anypoint Studio that contains multiple flows, which communicate between themselves through inbound and outbound connectors.

Let's look at the first flow:

We can configure an HTTP listener as:

Flow components must be inside a tag. So, an example flow with multiple components is:

Inside the flow, we're providing a reference to a configured HTTP listener. Then we're keeping a logger to log the payload that HTTP listener is receiving through POST method.

After that, a custom Java transformer class is placed, that transforms the payload after receiving the message:

public Object transformMessage( MuleMessage message, String outputEncoding) throws TransformerException { message.setPayload("Payload is transferred here."); message.setProperty( "outboundKey", "outboundpropertyvalue", PropertyScope.OUTBOUND); return message; }

The transformer class must extend AbstractMessageTransformer. We're also setting an outbound property inside the class.

Now, we have already converted payload inside the message object, and have logged that in the console using logger. We're setting a flow variable and a session variable.

Finally, we are sending our payload through outbound VM connector. The path in VM connector determines the receiving endpoint:

The message carried and transformed by the initial flow reaches Flow1 through an inbound VM endpoint.

The Java component retrieves outbound properties set by the first flow and returns the object which becomes the message payload.

The transformMessage() method for this task:

public Object transformMessage( MuleMessage message, String outputEncoding) throws TransformerException { return (String) message.getInboundProperty("outboundKey"); }

Then, flow and session variables are set to the second flow. After that, we've got a reference to Flow2 using flow-ref component.

In Flow2, we've transformed the message using Java component class and logged it in the console. We've also set a flow variable F3.

After calling Flow2 using flow-ref, Flow1 will wait for the message to be processed in Flow2.

Any flow variable set in Flow1 and Flow2 will be available in both flows since these flows aren't separated by any transport barriers.

Finally, the message is sent back to the HTTP requester through VMs. We configured all VMs as request-response.

We can invoke this application from any REST client by posting any JSON data in the body. The URL will be localhost:8081 as configured in HTTP listener.

6. Maven Archetype

We can build a Mule ESB project using Mulesoft's Maven archetype.

In Maven's settings.xml file, we first need to add the org.mule.tools plugin group:

 org.mule.tools 

Then, we need to add a profile tag that says where Maven should look for Mulesoft artifacts:

 Mule Org  true    mulesoft-releases MuleSoft Repository //repository-master.mulesoft.org/releases/ default   

Finally, we can create the project using mule-project-archetype:create:

mvn mule-project-archetype:create -DartifactId=muleesb -DmuleVersion=3.9.0

After configuring our project, we can create a deployable archive using mvn package.

After that, we'd deploy the archive into the apps folder of any standalone Mule server.

7. A Standalone Mule Server via MuleSoft's Maven Repository

As just noted, the project we just created requires a standalone Mule server.

Jika kita belum memilikinya, kita dapat mengedit pom.xml kita untuk menariknya dari repositori Maven MuleSoft:

 org.mule.tools.maven mule-maven-plugin 2.2.1  standalone 3.9.0    deploy deploy  deploy    

8. Kesimpulan

Pada artikel ini, kami telah membahas berbagai konsep yang diperlukan untuk membangun sebagai aplikasi ESB di Mule. Kami telah membuat proyek contoh yang menggambarkan semua konsep yang dijelaskan.

Kami sekarang dapat mulai membuat aplikasi ESB menggunakan Anypoint Studio untuk memenuhi berbagai kebutuhan kami.

Seperti biasa, proyek lengkap dapat ditemukan di GitHub.