Menggunakan JMS di Spring untuk mengakses Azure Service Bus

Tutorial ini menunjukkan cara menggunakan Spring Boot Starter untuk Azure Service Bus JMS untuk mengirim pesan ke dan menerima pesan dari Bus Layanan queues dan topics.

Azure menyediakan platform olahpesan asinkron yang disebut Azure Service Bus ("Bus Layanan") yang didasarkan pada standar Advanced Message Queueing Protocol 1.0 ("AMQP 1.0"). Anda dapat menggunakan Bus Layanan di berbagai platform Azure yang didukung.

Spring Boot Starter untuk Azure Service Bus JMS menyediakan integrasi Spring JMS dengan Bus Layanan.

Video berikut menjelaskan cara mengintegrasikan aplikasi Spring JMS dengan Azure Service Bus menggunakan JMS 2.0.


Dalam tutorial ini, kami menyertakan dua metode autentikasi: autentikasi Microsoft Entra dan autentikasi Shared Access Signatures (SAS). Tab Passwordless memperlihatkan autentikasi Microsoft Entra dan string Connection memperlihatkan autentikasi SAS.

autentikasi Microsoft Entra adalah mekanisme untuk menyambungkan ke Azure Service Bus JMS menggunakan identitas yang ditentukan dalam Microsoft Entra ID. Dengan autentikasi Microsoft Entra, Anda dapat mengelola identitas pengguna database dan layanan Microsoft lainnya di lokasi pusat, yang menyederhanakan manajemen izin.

Autentikasi SAS menggunakan string koneksi namespace Azure Service Bus Anda untuk akses yang dideligasikan ke Bus Layanan JMS. Jika Anda memilih untuk menggunakan Tanda Tangan Akses Bersama sebagai kredensial, Anda perlu mengelola string koneksi sendiri.

Prasyarat

Penting

Spring Boot versi 2.5 atau yang lebih tinggi diperlukan untuk menyelesaikan langkah-langkah dalam tutorial ini.

Mengirim dan menerima pesan dari Azure Service Bus

Dengan antrean atau topik untuk Azure Service Bus, Anda dapat mengirim dan menerima pesan menggunakan Spring Cloud Azure Service Bus JMS.

Untuk menginstal modul Spring Cloud Azure Service Bus JMS Starter, tambahkan dependensi berikut ke file pom.xml Anda:

  • Spring Cloud Azure Bill of Materials (BOM):

    <dependencyManagement>
      <dependencies>
        <dependency>
          <groupId>com.azure.spring</groupId>
          <artifactId>spring-cloud-azure-dependencies</artifactId>
          <version>7.4.0</version>
          <type>pom</type>
          <scope>import</scope>
        </dependency>
      </dependencies>
    </dependencyManagement>
    

    Catatan

    Jika Anda menggunakan Spring Boot 4.0.x, atur versi ke spring-cloud-azure-dependencies7.4.0.

    Jika Anda menggunakan Spring Boot 3.5.x, atur versi ke spring-cloud-azure-dependencies6.5.0.

    Jika Anda menggunakan Spring Boot 3.1.x-3.5.x, pastikan untuk mengatur versi ke spring-cloud-azure-dependencies5.25.0.

    Jika Anda menggunakan Spring Boot 2.x, pastikan untuk mengatur versi spring-cloud-azure-dependencies ke 4.20.0.

    Bill of Material (BOM) ini harus dikonfigurasi di bagian <dependencyManagement> dari file pom.xml Anda. Ini memastikan bahwa semua dependensi Spring Cloud Azure menggunakan versi yang sama.

    Untuk informasi selengkapnya tentang versi yang digunakan untuk BOM ini, lihat Versi Spring Cloud Azure Harus Saya Gunakan.

  • Artifak Spring Cloud Azure Service Bus JMS Starter:

    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-starter-servicebus-jms</artifactId>
    </dependency>
    

Kodekan aplikasi

Gunakan langkah-langkah berikut untuk mengonfigurasi aplikasi Anda untuk menggunakan antrean atau topik Bus Layanan untuk mengirim dan menerima pesan.

  1. Konfigurasikan kredensial Bus Layanan dengan menambahkan properti berikut ke file application.properties Anda.

    Catatan

    Azure Service Bus JMS mendukung penggunaan Microsoft Entra ID untuk mengotorisasi permintaan ke sumber daya Bus Layanan. Dengan Microsoft Entra ID, Anda dapat menggunakan kontrol akses berbasis peran Azure (Azure RBAC) untuk memberikan izin kepada entitas keamanan, yang dapat berupa pengguna atau prinsipal layanan aplikasi.

    Penting

    Sebelum memulai, pastikan Anda telah menetapkan peran Pemilik Data Azure Service Bus pada akun Microsoft Entra yang saat ini Anda gunakan. Untuk informasi selengkapnya, lihat Menetapkan peran Azure menggunakan portal Azure.

    spring.jms.servicebus.namespace=<ServiceBusNamespace>
    spring.jms.servicebus.pricing-tier=<ServiceBusPricingTier>
    spring.jms.servicebus.passwordless-enabled=true
    spring.jms.listener.receive-timeout=60000
    

    Tabel berikut ini menjelaskan bidang dalam konfigurasi:

    Bidang Deskripsi
    spring.jms.servicebus.namespace Tentukan namespace layanan yang Anda peroleh di instans layanan Bus Layanan Anda dari portal Azure.
    spring.jms.servicebus.pricing-tier Tentukan tingkat harga bus layanan Anda. Nilai yang didukung adalah premium dan standard. Tingkat premium menggunakan Java Message Service (JMS) 2.0, sementara tingkat standar menggunakan JMS 1.1 untuk berinteraksi dengan Azure Service Bus.
    spring.jms.servicebus.passwordless-enabled Tentukan apakah akan menggunakan tanpa kata sandi.
    spring.jms.listener.receive-timeout Secara default, nilai batas waktu penerimaan adalah 1000. Kami menyarankan agar Anda mengaturnya ke 60000
  2. Tambahkan @EnableJms untuk mengaktifkan dukungan bagi endpoint yang memiliki anotasi pendengar JMS. Gunakan JmsTemplate untuk mengirim pesan dan @JmsListener menerima pesan, seperti yang ditunjukkan dalam contoh berikut:

    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.jms.annotation.EnableJms;
    import org.springframework.boot.CommandLineRunner;
    import org.springframework.jms.annotation.JmsListener;
    import org.springframework.jms.core.JmsTemplate;
    
    @SpringBootApplication
    @EnableJms
    public class ServiceBusJMSQueueApplication implements CommandLineRunner {
    
        private static final Logger LOGGER = LoggerFactory.getLogger(ServiceBusJMSQueueApplication.class);
        private static final String QUEUE_NAME = "<QueueName>";
    
        @Autowired
        private JmsTemplate jmsTemplate;
    
        public static void main(String[] args) {
            SpringApplication.run(ServiceBusJMSQueueApplication.class, args);
        }
    
        @Override
        public void run(String... args) {
            LOGGER.info("Sending message");
            jmsTemplate.convertAndSend(QUEUE_NAME, "Hello World");
        }
    
        @JmsListener(destination = QUEUE_NAME, containerFactory = "jmsListenerContainerFactory")
        public void receiveMessage(String message) {
            LOGGER.info("Message received: {}", message);
        }
    
    }
    

    Ganti <QueueName> dengan nama antrean Anda sendiri yang dikonfigurasi di namespace Bus Layanan Anda.

    Petunjuk / Saran

    Dalam tutorial ini, tidak ada operasi autentikasi dalam konfigurasi atau kode. Namun, menyambungkan ke layanan Azure memerlukan autentikasi. Untuk menyelesaikan autentikasi, Anda perlu menggunakan identitas Azure. Spring Cloud Azure menggunakan DefaultAzureCredential, yang disediakan pustaka identitas Azure untuk membantu Anda mendapatkan kredensial tanpa perubahan kode apa pun.

    DefaultAzureCredential mendukung beberapa metode autentikasi dan menentukan metode mana yang akan digunakan saat runtime. Pendekatan ini memungkinkan aplikasi Anda menggunakan metode autentikasi yang berbeda di lingkungan yang berbeda (seperti lingkungan lokal dan produksi) tanpa menerapkan kode khusus lingkungan. Untuk informasi selengkapnya, lihat DefaultAzureCredential.

    Untuk menyelesaikan autentikasi di lingkungan pengembangan lokal, Anda dapat menggunakan Azure CLI, Visual Studio Code, PowerShell, atau metode lainnya. Untuk informasi selengkapnya, lihat autentikasi Azure di lingkungan pengembangan Java. Untuk menyelesaikan autentikasi di lingkungan hosting Azure, sebaiknya gunakan identitas terkelola yang ditetapkan pengguna. Untuk informasi selengkapnya, lihat Apa identitas terkelola untuk sumber daya Azure?

  3. Mulai aplikasi. Anda melihat Sending message dan Halo Dunia memposting ke log aplikasi Anda, seperti yang ditunjukkan dalam contoh output berikut:

    Sending message
    Message received: Hello World
    

Menyebarkan ke Azure Spring Apps

Sekarang setelah Anda memiliki aplikasi Spring Boot yang berjalan secara lokal, saatnya untuk memindahkannya ke produksi. Azure Spring Apps memudahkan penyebaran aplikasi Spring Boot ke Azure tanpa perubahan kode apa pun. Layanan ini mengelola infrastruktur aplikasi Spring sehingga pengembang dapat fokus pada kode mereka. Azure Spring Apps menyediakan manajemen siklus hidup menggunakan pemantauan dan diagnostik yang komprehensif, manajemen konfigurasi, penemuan layanan, integrasi CI/CD, penyebaran biru-hijau, dan banyak lagi. Untuk menyebarkan aplikasi Anda ke Azure Spring Apps, lihat Deploy aplikasi pertama Anda ke Azure Spring Apps.

Langkah berikutnya