如何通过Spring JmsTemplate在JMS消息MQRFH2 usr目录设自定义属性

我来帮你搞定这个MQRFH2 usr属性的问题，之前对接WMB（现在叫IBM App Connect Enterprise）的时候也踩过类似的坑，这里有两种靠谱的实现方式，看你哪种更顺手：

方法一：直接操作MQRFH2头部（更灵活，适合复杂场景） #

这种方式需要直接使用IBM MQ的专属API来构造RFH2头，适合需要对RFH2做更多自定义配置的场景：

首先确保你的项目里引入了IBM MQ JMS客户端依赖（如果是Maven的话）：

<dependency>
    <groupId>com.ibm.mq</groupId>
    <artifactId>mq-jms-client</artifactId>
    <version>9.3.3.0</version> <!-- 用最新稳定版即可 -->
</dependency>

然后在发送消息的代码里，直接操作MQRFH2对象来添加usr目录的属性：

import com.ibm.mq.jms.MQMessage;
import com.ibm.mq.headers.MQRFH2;
import com.ibm.mq.headers.datatypes.MQString;
import com.ibm.mq.jms.MQQueue;
import org.springframework.jms.core.JmsTemplate;

// 假设你已经注入了JmsTemplate和目标队列
jmsTemplate.send((MQQueue) destination, session -> {
    // 创建MQ消息实例
    MQMessage mqMessage = new MQMessage();
    // 先设置你已经在处理的MQMD头，比如msgid、correlid等
    mqMessage.messageId = yourMsgId.getBytes();
    mqMessage.correlationId = yourCorrelId.getBytes();
    
    // 构造MQRFH2头并设置usr属性
    MQRFH2 rfh2Header = new MQRFH2();
    // 初始化usr文件夹（必须先做这一步）
    rfh2Header.setUsrFolder();
    // 添加MYKEY属性，字符串类型用MQString包装
    rfh2Header.getUsrFolder().addField("MYKEY", new MQString("你的自定义字符串值"));
    
    // 将RFH2头写入消息
    rfh2Header.write(mqMessage);
    
    // 设置消息体（如果需要的话）
    mqMessage.writeUTF("你的消息内容");
    
    return session.createMessage(mqMessage);
});

方法二：利用WMQ属性自动映射（更简洁，适合简单场景） #

IBM WMQ的JMS客户端支持一种快捷方式：只要你设置的JMS属性以usr.为前缀，客户端会自动把它放到MQRFH2的usr目录里，不需要手动操作RFH2头，非常方便：

import org.springframework.jms.core.JmsTemplate;

jmsTemplate.send(destination, session -> {
    Message message = session.createTextMessage("你的消息内容");
    
    // 设置MQMD头（你原来的逻辑保留）
    message.setStringProperty(WMQConstants.WMQ_MQMD_MSGID, yourMsgId);
    message.setStringProperty(WMQConstants.WMQ_MQMD_CORRELID, yourCorrelId);
    
    // 关键：用usr.前缀设置属性，WMQ会自动映射到RFH2的usr目录
    message.setStringProperty("usr.MYKEY", "你的自定义字符串值");
    
    return message;
});

几个重要注意事项： #

• 确保你的ConnectionFactory是IBM WMQ的实现（com.ibm.mq.jms.MQConnectionFactory），而不是通用的JMS连接工厂，否则前缀映射不会生效
• 如果用Spring Boot，配置文件里要指定正确的WMQ连接参数，比如spring.jms.jndi-name或者直接配置mqConnectionFactory的属性
• 测试的时候可以用IBM MQ Explorer查看消息的头部，找到RFH2的usr文件夹，确认MYKEY是否存在
• WMB Flow的监听队列节点要开启RFH2头的解析，默认一般是开启的，但如果没收到属性的话可以检查一下Flow的配置

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