Demo project

Prerequisites

• Install the IDE.

  You can use IntelliJ IDEA or Eclipse. In this example, IntelliJ IDEA is used. Download the IntelliJ IDEA Ultimate version in the https://www.jetbrains.com/idea/ and install it by referring to IntelliJ IDEA.

• Download the demo project.

  In the https://github.com/sofastack-guides/sofamq-demo, download the demo project to your local computer, and then decompress it to see that sofamq-demo folders are added to your local computer.

• Download and install the JDK.

Configure a demo project

1. Import the demo project file to IntelliJ IDEA.

   1. On the IntelliJ IDEA page, choose New > Project From Existing Sources… and select the sofamq-demo folder.

   2. Select Maven as the Import type.

      

   3. By default, click Finish until the import is complete. The demo project needs to load dependent JAR packages. Therefore, the import process takes 2-3 minutes.

2. Create a resource.

   You must first create the required resources in the console, including the MSMQ workspace, topic, group ID(GID), and AccessKey pair (AK) required for authentication.

3. Configure the access credential.

   When connecting to middleware, you must properly authenticate your application to avoid unauthorized access due to security risk considerations. Therefore, you must configure the AccessKey pair and AccessSecret of your account in the environment variables of the machine where your application resides.

   The procedure is as follows:

   • Linux and macOS system configuration methods

     Run the following command:

     export SOFA_AK_ENV=<access_key_id>
     export SOFA_SK_ENV=<access_key_secret>

     Replace <access_key_id> with the prepared AccessKey ID and <access_key_secret> with the AccessKey secret.

   • Windows system configuration method

     1. Create an environment variable file, add the environment variable SOFA_AK_ENV and SOFA_SK_ENV, and then write the prepared AccessKey ID and AccessKey secret.

     2. Restart the Windows system.

        Important

        • Do not use the AccessKey of an Alibaba Cloud account because the leakage of the AccessKey of an Alibaba Cloud account will threaten the security of all your resources. Use the AccessKey pair of a RAM user to reduce the risk of AccessKey disclosure.

        • In the production environment, we recommend that you create a RAM user for middleware. This allows you to control permissions and facilitate management.

4. You must configure the resource information created in Step 2 to the MqConfig class.

   public static final String TOPIC ="The topic created in Step 2";
   public static final String GROUP_ID ="Group ID created in Step 2";
   // The AccessKey pair of an Alibaba Cloud account has permissions to access all API operations. This is a high risk. We strongly recommend that you create and use a RAM user for API access or routine O&M. Log on to the RAM console to create a RAM user. 
   // Save the AccessKey pair and AccessKeySecret in environment variables. 
   // We strongly recommend that you do not save the AccessKey and AccessKeySecret in the code. This may cause key leakage.
   public static final String ACCESS_KEY = System.getenv("SOFA_AK_ENV");
   public static final String SECRECT_KEY = System.getenv("SOFA_SK_ENV");
   public static final String INSTANCE ="The ID of your instance. You can access the configuration at the bottom of the Overview page in the console to obtain the instance ID";
   public static final String TAG ="TAG used when you publish and subscribe. If not, it can be empty";
   public static final String ENDPOINT ="Your TCP endpoint. You can access the configuration at the bottom of the Overview page to obtain the TCP endpoint"; 

Run the demo in Main mode

1. Sends a message.

   • Send normal messages:

     • Send normal messages in pure Java: Run the SimpleProducer class.

     • Send normal messages in Spring mode: Run the ProducerClient class.

   • Send transactional messages: Run the SimpleTransactionProducer class. The LocalTransactionCheckerImpl class is a local transaction check interface class that is used to check transactions. For more information, see Send and receive transactional messages.

   • Send ordered messages: Run SimpleOrderProducer class. In this mode, messages are published and consumed in sequence. For more information, see Send and receive ordered messages.

   • Send scheduled (delayed) messages: Run the SimpleDelayProducer class to send messages. Delay delivery after 3 seconds. You can also specify a precise delivery time.

   To check that the method message is sent successfully, perform the following steps:

   1. Log on to the SOFAStack console.

   2. In the left-side navigation pane, choose Middleware > MSMQ > Message Query.

   3. On the Message Query page, click Query by Topic.

   4. Click the name of the target topic to query. You can see that the message has been sent to the topic.

2. Receive messages.

   • Receive normal messages:

     • Receive normal messages in pure Java: Run the SimpleConsumer class.

     • Spring to receive normal messages: Run the ConsumerClient class.

   • Receive transactional messages: Run the SimpleConsumer class.

   • Receive ordered messages: Run SimpleOrderConsumer class.

   • Receive timed (delayed) messages: Run SimpleConsumer class. You can see the log of the message being received and printed. Because there is initialization, you must wait a few seconds. In the production environment, initialization is not frequent.

   To check that the method message is sent successfully, perform the following steps:

   1. Log on to the SOFAStack console.

   2. In the left-side navigation pane, choose Middleware > MSMQ > Group Management.

   3. Click the group ID to go to the details page.

   4. Click Consumer Status. You can see that the started consumer is online and the subscriptions are consistent.

More information

• Spring integration

• Send normal messages (three methods)

• Send messages (multi-threading)