
本教程旨在澄清在使用JMS与IBM MQ集成时,关于MQRFH2消息头、XML负载以及附件处理的常见误区。我们将深入探讨JMS应用中如何正确设置消息属性、传输二进制数据,并提供符合JMS规范的发送与接收代码示例,避免手动构建MQRFH2头,从而确保消息的正确解析与互操作性。
1. 引言:JMS与复杂消息传输挑战
在企业级应用集成中,特别是在金融领域,通过消息队列系统(如IBM MQ)发送和接收复杂消息(如SWIFT FileAct消息,其中可能包含XML数据和二进制附件)是常见需求。Java Message Service (JMS) 作为Java EE的标准API,为消息的发送和接收提供了统一的接口。然而,在实际操作中,开发者常对底层消息格式(如IBM MQ的MQRFH2头)的理解存在误区,尤其是在尝试手动处理这些底层细节时,容易导致消息格式不正确,从而影响消息的互操作性和解析。本教程将聚焦于如何以符合JMS规范的方式,高效、准确地处理这类复杂消息。
2. MQRFH2在JMS中的角色:自动处理而非手动构建
MQRFH2(Message Queue Reason Format Header 2)是IBM MQ特有的一种消息头格式,用于承载消息的各种属性,包括JMS消息属性。它是IBM MQ实现JMS规范的关键组成部分。
核心概念:
- JMS的抽象层: JMS API为应用程序提供了一个高级、平台无关的消息编程模型。当JMS应用程序与IBM MQ交互时,JMS客户端库(如com.ibm.mq.jms)负责将JMS消息对象转换为IBM MQ能够理解的格式,并在其中自动创建和管理MQRFH2头。这个MQRFH2头用于封装JMS消息的各种属性(如JMSCorrelationID、JMSType以及自定义属性等)。
- 误区纠正: 许多开发者误以为需要手动构建MQRFH2对象并将其作为消息体的一部分发送。这是不正确的。 如果你的应用程序是一个纯粹的JMS应用程序,那么你不应该手动创建MQRFH2头。IBM MQ客户端会自动为你处理。手动构建MQRFH2通常只适用于非JMS的原生IBM MQ应用程序,它们直接使用MQI(Message Queue Interface)进行编程。
结论: 在JMS应用程序中,无需手动创建MQRFH2实例。所有通过JMS API设置的消息属性都会被自动映射到由IBM MQ客户端生成的MQRFH2头中。
3. 正确设置JMS消息属性
JMS提供了一套标准化的API来设置和获取消息属性。这些属性是键值对,可以用于传递消息的元数据,而无需修改消息体内容。这些JMS属性在底层会被IBM MQ客户端自动封装到MQRFH2头的特定“文件夹”中,例如自定义属性通常会放入“usr”文件夹。
发送方设置JMS属性示例:
以下代码演示了如何使用JMSProducer设置与SWIFT FileAct相关的消息属性。这些属性将由JMS客户端自动转换为MQRFH2头的一部分。
import com.ibm.mq.jms.MQConnectionFactory;
import com.ibm.msg.client.wmq.WMQConstants;
import javax.jms.*;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
public class SwiftMessageSender {
public void sendSwiftFileActMessage(JmsConnectionFactory connectionFactory, Destination destination, String filePath) throws JMSException, IOException {
try (JMSContext producerContext = connectionFactory.createContext();
FileInputStream inStream = new FileInputStream(filePath)) {
JMSProducer producer = producerContext.createProducer();
BytesMessage bytesMessage = producerContext.createBytesMessage();
// 设置JMS属性,这些属性将自动映射到MQRFH2头
// 注意:属性名应遵循JMS规范或特定协议要求
producer.setProperty("OriginatorApplication", "IF_COBA");
producer.setProperty("Requestor", "ou=data,o=data,o=swift");
producer.setProperty("Responder", "ou=data,o=data,o=swift");
producer.setProperty("Service", "swift.data");
producer.setProperty("RequestType", "data");
producer.setProperty("Compression", "Zip");
producer.setProperty("FileName", new File(filePath).getName());
producer.setProperty("FileReference", new File(filePath).getName());
// 可选:设置IBM MQ特定的格式属性,告知MQ消息体是什么格式
// 对于二进制文件,通常设置为MQFMT_NONE (0x00000000)
producer.setProperty(WMQConstants.JMS_IBM_FORMAT, WMQConstants.MQFMT_NONE);
// 对于二进制文件,字符集通常不适用,但如果属性值有非ASCII字符,可能需要设置
// producer.setProperty(WMQConstants.JMS_IBM_CHARACTER_SET, 1208); // UTF-8
byte[] buffer = new byte[8192]; // 缓冲区大小
int bytesRead;
long bytesTotalSize = 0;
// 将文件内容写入BytesMessage的负载
while ((bytesRead = inStream.read(buffer)) != -1) {
bytesMessage.writeBytes(buffer, 0, bytesRead);
bytesTotalSize += bytesRead;
}
System.out.println("Finished writing " + bytesTotalSize + " bytes into message payload!");
producer.send(destination, bytesMessage);
System.out.println("Message sent successfully with properties and file payload.");
} catch (JMSException | IOException e) {
System.err.println("Error sending message: " + e.getMessage());
throw e;
}
}
// 假设这是一个主方法或测试方法
public static void main(String[] args) {
// 实际应用中,JmsConnectionFactory和Destination需要正确配置
// 这里仅为演示目的提供一个占位符
JmsConnectionFactory connectionFactory = null; // ... 实际初始化
Destination destination = null; // ... 实际初始化
String testFilePath = "/opt/mq/TC.SB13.0015484631.zip"; // 示例文件路径
try {
// 假设connectionFactory和destination已被正确初始化
// connectionFactory = new MQConnectionFactory();
// connectionFactory.setHostName("localhost");
// connectionFactory.setPort(1414);
// connectionFactory.setQueueManager("QM1");
// connectionFactory.setChannel("DEV.APP.SVRCONN");
// destination = connectionFactory.createContext().createQueue("DEV.QUEUE.1");
new SwiftMessageSender().sendSwiftFileActMessage(connectionFactory, destination, testFilePath);
} catch (JMSException | IOException e) {
e.printStackTrace();
}
}
}4. 传输XML负载与二进制附件
根据消息内容的类型和结构,JMS提供了不同的消息类型来处理:
- XML负载:
-
二进制附件(文件):
- 直接作为BytesMessage负载: 如果整个消息体就是一个二进制文件(如SWIFT FileAct中的ZIP文件),最简单且推荐的方式是将其作为BytesMessage的负载。文件的元数据(如文件名、压缩类型)应通过JMS属性传递,如上节所示。
-
在XML中嵌入二进制数据: 如果二进制附件需要作为XML消息的一部分传输,通常有两种方法:
- CDATA节: 对于较小的二进制数据,可以将其Base64编码后,放入XML的CDATA节中。
- Base64编码: 将二进制数据进行Base64编码,然后作为XML元素的值。接收方需要解码以还原原始二进制数据。
本教程的示例将重点放在将二进制文件作为BytesMessage的负载,并利用JMS属性传递元数据。
5. 接收和解析JMS消息
接收方应用程序需要能够识别消息类型,并正确地从JMS消息中提取属性和负载。
接收方解析JMS消息示例:
以下代码演示了如何接收JMS消息,判断其类型,并提取JMS属性以及BytesMessage中的文件负载。
import com.ibm.mq.jms.MQConnectionFactory;
import com.ibm.msg.client.wmq.WMQConstants;
import javax.jms.*;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
public class SwiftMessageReceiver {
public void receiveSwiftFileActMessage(Message message, String outputDirPath) throws JMSException, IOException {
if (










