Spring REST服务中浏览IBM MQ时出现ResourceException问题排查

Hey there, let's break down why your IBM MQ code works standalone but fails in a Spring/Tomcat environment. This is a common issue tied to container-specific behavior, class loading, or resource management—here are the most likely culprits and fixes:

1. Class Loader Conflicts (Most Common) #

Tomcat uses a hierarchical class loader system that can clash with your application's dependencies, especially for JMS and IBM MQ classes.

What's happening: #

• Tomcat's lib directory might include older versions of javax.jms-api or IBM MQ jars that override your application's bundled versions.
• You've included both com.ibm.mq.allclient-9.0.5.0.jar and com.ibm.mq.jar in your dependencies—the allclient jar already contains all classes from com.ibm.mq.jar, so this creates duplicate classes that cause runtime conflicts.

Fixes: #

• Clean up Gradle dependencies: Remove com.ibm.mq.jar from your build.gradle. Your dependency block should look like this:

  dependencies {
      implementation 'com.ibm.mq:com.ibm.mq.allclient:9.0.5.0'
      implementation 'javax.jms:javax.jms-api:2.0.1'
      // Your Spring/Spring Boot dependencies here
  }
  

• Check Tomcat's lib folder: If you find any JMS or IBM MQ-related jars (like jms.jar or old com.ibm.mq.* jars) in TOMCAT_HOME/lib, delete them. Your application should provide its own compatible versions.
• Force class loading priority: For Spring Boot, add this to your build.gradle to ensure your app's jars take precedence over Tomcat's:

  bootWar {
      manifest {
          attributes 'Class-Path': configurations.runtimeClasspath.files.collect { it.name }.join(' ')
      }
  }
  

2. Improper Resource Management in Spring Context #

Standalone apps often manage MQ connections manually, but in a containerized Spring environment, this can lead to resource leaks, connection pool exhaustion, or initialization timing issues.

What's happening: #

• You're manually creating MQQueueConnection/MQQueueSession objects without properly closing them, leading to exhausted MQ connections over time.
• MQ resources aren't being managed as Spring beans, so they might not initialize correctly before REST requests hit.

Fixes: #

• Use Spring's JmsTemplate for MQ operations: Let Spring handle connection pooling and resource lifecycle. Define MQ beans in your configuration:

  import com.ibm.mq.jms.MQQueueConnectionFactory;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  import org.springframework.jms.core.JmsTemplate;
  import com.ibm.msg.client.wmq.WMQConstants;
  
  @Configuration
  public class MQConfig {
  
      @Bean
      public MQQueueConnectionFactory mqConnectionFactory() {
          MQQueueConnectionFactory factory = new MQQueueConnectionFactory();
          // Configure your MQ settings
          factory.setHostName("your-mq-host");
          factory.setPort(1414);
          factory.setQueueManager("YOUR_QMGR");
          factory.setChannel("YOUR_CHANNEL");
          factory.setTransportType(WMQConstants.WMQ_CM_CLIENT);
          // Add authentication if needed
          // factory.setUserName("mq-user");
          // factory.setPassword("mq-password");
          return factory;
      }
  
      @Bean
      public JmsTemplate jmsTemplate(MQQueueConnectionFactory connectionFactory) {
          JmsTemplate jmsTemplate = new JmsTemplate(connectionFactory);
          jmsTemplate.setDefaultDestinationName("YOUR_QUEUE_NAME");
          // Set receive timeout or other properties as needed
          return jmsTemplate;
      }
  }
  

• Inject JmsTemplate in your REST controller:

  import org.springframework.jms.core.JmsTemplate;
  import org.springframework.web.bind.annotation.GetMapping;
  import org.springframework.web.bind.annotation.RestController;
  
  @RestController
  public class MQRestController {
  
      private final JmsTemplate jmsTemplate;
  
      public MQRestController(JmsTemplate jmsTemplate) {
          this.jmsTemplate = jmsTemplate;
      }
  
      @GetMapping("/browse-mq")
      public String browseQueue() {
          // Use jmsTemplate to browse or process messages
          jmsTemplate.browse((session, queue) -> {
              // Your queue browsing logic here
              return null;
          });
          return "Queue browsed successfully";
      }
  }
  

3. Permission or Environment Restrictions #

Tomcat runs under a different user context than your standalone app, which can cause access issues to MQ resources.

What's happening: #

• The user running Tomcat doesn't have read access to MQ configuration files (like a CCDT file if you're using one).
• MQ server is blocking connections from Tomcat's host IP, or the MQ user lacks permissions to browse the target queue.

Fixes: #

• Verify Tomcat user permissions: Ensure the user running Tomcat can access any MQ-related config files (e.g., ccdt.json) if you're using them.
• Check MQ server logs: Look for error codes like MQRC_NOT_AUTHORIZED (2035) or MQRC_CONNECTION_BROKEN (2009) in the MQ server logs. These codes directly point to permission or connectivity issues.
• Validate MQ channel settings: Ensure the MQ channel allows connections from Tomcat's server IP, and channel authentication records (CHLAUTH) are configured correctly.

4. Version Compatibility Checks #

Double-check that your dependencies play well together:

• Spring Boot + Spring 4: Make sure you're using Spring Boot 1.x (Spring Boot 2.x requires Spring 5). Spring Boot 1.5.x is fully compatible with Spring 4.3.x, which works with IBM MQ 9.0.5.0.
• IBM MQ + JMS 2.0: IBM MQ 9.0+ fully supports JMS 2.0, so your javax.jms-api-2.0.1 dependency is valid.

Final Tip: Dig Into Exception Details #

The ResourceException includes a reason code and completion code that pinpoint the exact issue. Log these details with:

catch (ResourceException e) {
    System.err.println("MQ Reason Code: " + e.getReasonCode());
    System.err.println("Completion Code: " + e.getCompletionCode());
    e.printStackTrace();
}

For example:

• 2035 = Permission denied
• 2009 = Connection lost/broken
• 2059 = Queue manager unavailable

内容的提问来源于stack exchange，提问作者satishkk