类 MessageHeaders
- java.lang.Object
- org.springframework.messaging.MessageHeaders
- 所有已实现的接口:
Serializable,Map<String,Object>
public class MessageHeaders extends Object implements Map<String,Object>, Serializable
The headers for aMessage.IMPORTANT: This class is immutable. Any mutating operation such as
put(..),putAll(..)and others will throwUnsupportedOperationException.Subclasses do have access to the raw headers, however, via
getRawHeaders().One way to create message headers is to use the
MessageBuilder:MessageBuilder.withPayload("foo").setHeader("key1", "value1").setHeader("key2", "value2");A second option is to createGenericMessagepassing a payload asObjectand headers as ajava.util.Map:Map headers = new HashMap(); headers.put("key1", "value1"); headers.put("key2", "value2"); new GenericMessage("foo", headers);A third option is to useMessageHeaderAccessoror one of its subclasses to create specific categories of headers.- 从以下版本开始:
- 4.0
- 作者:
- Arjen Poutsma, Mark Fisher, Gary Russell, Juergen Hoeller
- 另请参阅:
MessageBuilder,MessageHeaderAccessor, 序列化表格
字段概要
字段 修饰符和类型 字段 说明 static StringCONTENT_TYPEThe key for the message content type.static StringERROR_CHANNELThe key for the message error channel.static StringIDThe key for the Message ID.static UUIDID_VALUE_NONEUUID for none.static StringREPLY_CHANNELThe key for the message reply channel.static StringTIMESTAMPThe key for the message timestamp.
构造器概要
构造器 限定符 构造器 说明 MessageHeaders(Map<String,Object> headers)Construct aMessageHeaderswith the given headers.protectedMessageHeaders(Map<String,Object> headers, UUID id, Long timestamp)Constructor providing control over the ID and TIMESTAMP header values.
方法概要
所有方法 静态方法 实例方法 具体方法 修饰符和类型 方法 说明 voidclear()Since MessageHeaders are immutable, the call to this method will result inUnsupportedOperationException.booleancontainsKey(Object key)booleancontainsValue(Object value)Set<Map.Entry<String,Object>>entrySet()booleanequals(Object other)Objectget(Object key)<T> Tget(Object key, Class<T> type)ObjectgetErrorChannel()UUIDgetId()protected static IdGeneratorgetIdGenerator()protected Map<String,Object>getRawHeaders()ObjectgetReplyChannel()LonggetTimestamp()inthashCode()booleanisEmpty()Set<String>keySet()Objectput(String key, Object value)Since MessageHeaders are immutable, the call to this method will result inUnsupportedOperationException.voidputAll(Map<? extends String,? extends Object> map)Since MessageHeaders are immutable, the call to this method will result inUnsupportedOperationException.Objectremove(Object key)Since MessageHeaders are immutable, the call to this method will result inUnsupportedOperationException.intsize()StringtoString()Collection<Object>values()从接口继承的方法 java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
字段详细资料
ID_VALUE_NONE
public static final UUID ID_VALUE_NONE
UUID for none.
ID
public static final String ID
The key for the Message ID. This is an automatically generated UUID and should never be explicitly set in the header map except in the case of Message deserialization where the serialized Message's generated UUID is being restored.- 另请参阅:
- 常量字段值
CONTENT_TYPE
public static final String CONTENT_TYPE
The key for the message content type.- 另请参阅:
- 常量字段值
REPLY_CHANNEL
public static final String REPLY_CHANNEL
The key for the message reply channel.- 另请参阅:
- 常量字段值
ERROR_CHANNEL
public static final String ERROR_CHANNEL
The key for the message error channel.- 另请参阅:
- 常量字段值
构造器详细资料
MessageHeaders
public MessageHeaders(@Nullable Map<String,Object> headers)
Construct aMessageHeaderswith the given headers. AnIDandTIMESTAMPheaders will also be added, overriding any existing values.- 参数:
headers- a map with headers to add
方法详细资料
getRawHeaders
protected Map<String,Object> getRawHeaders()
getIdGenerator
protected static IdGenerator getIdGenerator()
getTimestamp
@Nullable public Long getTimestamp()
getReplyChannel
@Nullable public Object getReplyChannel()
getErrorChannel
@Nullable public Object getErrorChannel()
containsKey
public boolean containsKey(Object key)
- 指定者:
containsKey在接口中Map<String,Object>
containsValue
public boolean containsValue(Object value)
- 指定者:
containsValue在接口中Map<String,Object>
put
public Object put(String key, Object value)
Since MessageHeaders are immutable, the call to this method will result inUnsupportedOperationException.
putAll
public void putAll(Map<? extends String,? extends Object> map)
Since MessageHeaders are immutable, the call to this method will result inUnsupportedOperationException.
remove
public Object remove(Object key)
Since MessageHeaders are immutable, the call to this method will result inUnsupportedOperationException.
clear
public void clear()
Since MessageHeaders are immutable, the call to this method will result inUnsupportedOperationException.