Merge pull request #880 from liudaomanbu/master
issue737 实现rocketmq的header的value的无感知序列化和反序列化pull/913/head
format
6 years ago
committed by
GitHub
commit
0b296cb264
@ -0,0 +1,63 @@
|
||||
/*
|
||||
* Copyright (C) 2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package com.alibaba.cloud.stream.binder.rocketmq.support;
|
||||
|
||||
import java.nio.charset.Charset;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
|
||||
import org.apache.rocketmq.common.message.MessageConst;
|
||||
import org.springframework.messaging.MessageHeaders;
|
||||
import org.springframework.util.Assert;
|
||||
|
||||
/**
|
||||
* Base for RocketMQ header mappers.
|
||||
*
|
||||
* @author caotc
|
||||
* @since 2.1.1.RELEASE
|
||||
*/
|
||||
public abstract class AbstractRocketMQHeaderMapper implements RocketMQHeaderMapper {
|
||||
private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
|
||||
|
||||
private Charset charset;
|
||||
|
||||
public AbstractRocketMQHeaderMapper() {
|
||||
this(DEFAULT_CHARSET);
|
||||
}
|
||||
|
||||
public AbstractRocketMQHeaderMapper(Charset charset) {
|
||||
Assert.notNull(charset, "'charset' cannot be null");
|
||||
this.charset = charset;
|
||||
}
|
||||
|
||||
protected boolean matches(String headerName) {
|
||||
return !MessageConst.STRING_HASH_SET.contains(headerName)
|
||||
&& !MessageHeaders.ID.equals(headerName)
|
||||
&& !MessageHeaders.TIMESTAMP.equals(headerName)
|
||||
&& !MessageHeaders.CONTENT_TYPE.equals(headerName)
|
||||
&& !MessageHeaders.REPLY_CHANNEL.equals(headerName)
|
||||
&& !MessageHeaders.ERROR_CHANNEL.equals(headerName);
|
||||
}
|
||||
|
||||
public Charset getCharset() {
|
||||
return charset;
|
||||
}
|
||||
|
||||
public void setCharset(Charset charset) {
|
||||
Assert.notNull(charset, "'charset' cannot be null");
|
||||
this.charset = charset;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,278 @@
|
||||
/*
|
||||
* Copyright (C) 2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package com.alibaba.cloud.stream.binder.rocketmq.support;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.Charset;
|
||||
import java.util.*;
|
||||
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.lang.Nullable;
|
||||
import org.springframework.messaging.MessageHeaders;
|
||||
import org.springframework.util.ClassUtils;
|
||||
|
||||
import com.fasterxml.jackson.core.JsonProcessingException;
|
||||
import com.fasterxml.jackson.core.type.TypeReference;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.google.common.collect.Maps;
|
||||
|
||||
/**
|
||||
* jackson header mapper for RocketMQ. Header types are added to a special header
|
||||
* {@link #JSON_TYPES}.
|
||||
*
|
||||
* @author caotc
|
||||
* @since 2.1.1.RELEASE
|
||||
*/
|
||||
public class JacksonRocketMQHeaderMapper extends AbstractRocketMQHeaderMapper {
|
||||
private final static Logger log = LoggerFactory
|
||||
.getLogger(JacksonRocketMQHeaderMapper.class);
|
||||
|
||||
private static final List<String> DEFAULT_TRUSTED_PACKAGES = Arrays
|
||||
.asList("java.lang", "java.net", "java.util", "org.springframework.util");
|
||||
|
||||
/**
|
||||
* Header name for java types of other headers.
|
||||
*/
|
||||
public static final String JSON_TYPES = "spring_json_header_types";
|
||||
|
||||
private final ObjectMapper objectMapper;
|
||||
private final Set<String> trustedPackages = new LinkedHashSet<>(
|
||||
DEFAULT_TRUSTED_PACKAGES);
|
||||
|
||||
public JacksonRocketMQHeaderMapper(ObjectMapper objectMapper) {
|
||||
this.objectMapper = objectMapper;
|
||||
}
|
||||
|
||||
public JacksonRocketMQHeaderMapper(Charset charset, ObjectMapper objectMapper) {
|
||||
super(charset);
|
||||
this.objectMapper = objectMapper;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Map<String, String> fromHeaders(MessageHeaders headers) {
|
||||
final Map<String, String> target = Maps.newHashMap();
|
||||
final Map<String, String> jsonHeaders = Maps.newHashMap();
|
||||
headers.forEach((key, value) -> {
|
||||
if (matches(key)) {
|
||||
if (value instanceof String) {
|
||||
target.put(key, (String) value);
|
||||
}
|
||||
else {
|
||||
try {
|
||||
String className = value.getClass().getName();
|
||||
target.put(key, objectMapper.writeValueAsString(value));
|
||||
jsonHeaders.put(key, className);
|
||||
}
|
||||
catch (Exception e) {
|
||||
log.debug("Could not map " + key + " with type "
|
||||
+ value.getClass().getName(), e);
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
if (jsonHeaders.size() > 0) {
|
||||
try {
|
||||
target.put(JSON_TYPES, objectMapper.writeValueAsString(jsonHeaders));
|
||||
}
|
||||
catch (IllegalStateException | JsonProcessingException e) {
|
||||
log.error("Could not add json types header", e);
|
||||
}
|
||||
}
|
||||
return target;
|
||||
}
|
||||
|
||||
@Override
|
||||
public MessageHeaders toHeaders(Map<String, String> source) {
|
||||
final Map<String, Object> target = Maps.newHashMap();
|
||||
final Map<String, String> jsonTypes = decodeJsonTypes(source);
|
||||
source.forEach((key, value) -> {
|
||||
if (matches(key) && !(key.equals(JSON_TYPES))) {
|
||||
if (jsonTypes != null && jsonTypes.containsKey(key)) {
|
||||
Class<?> type = Object.class;
|
||||
String requestedType = jsonTypes.get(key);
|
||||
boolean trusted = trusted(requestedType);
|
||||
if (trusted) {
|
||||
try {
|
||||
type = ClassUtils.forName(requestedType, null);
|
||||
}
|
||||
catch (Exception e) {
|
||||
log.error("Could not load class for header: " + key, e);
|
||||
}
|
||||
}
|
||||
|
||||
if (trusted) {
|
||||
try {
|
||||
Object val = decodeValue(value, type);
|
||||
target.put(key, val);
|
||||
}
|
||||
catch (IOException e) {
|
||||
log.error("Could not decode json type: " + value
|
||||
+ " for key: " + key, e);
|
||||
target.put(key, value);
|
||||
}
|
||||
}
|
||||
else {
|
||||
target.put(key, new NonTrustedHeaderType(value, requestedType));
|
||||
}
|
||||
}
|
||||
else {
|
||||
target.put(key, value);
|
||||
}
|
||||
}
|
||||
});
|
||||
return new MessageHeaders(target);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param packagesToTrust the packages to trust.
|
||||
* @see #addTrustedPackages(Collection)
|
||||
*/
|
||||
public void addTrustedPackages(String... packagesToTrust) {
|
||||
if (Objects.nonNull(packagesToTrust)) {
|
||||
addTrustedPackages(Arrays.asList(packagesToTrust));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add packages to the trusted packages list (default {@code java.util, java.lang})
|
||||
* used when constructing objects from JSON. If any of the supplied packages is
|
||||
* {@code "*"}, all packages are trusted. If a class for a non-trusted package is
|
||||
* encountered, the header is returned to the application with value of type
|
||||
* {@link NonTrustedHeaderType}.
|
||||
* @param packagesToTrust the packages to trust.
|
||||
*/
|
||||
public void addTrustedPackages(Collection<String> packagesToTrust) {
|
||||
if (packagesToTrust != null) {
|
||||
for (String whiteList : packagesToTrust) {
|
||||
if ("*".equals(whiteList)) {
|
||||
this.trustedPackages.clear();
|
||||
break;
|
||||
}
|
||||
else {
|
||||
this.trustedPackages.add(whiteList);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public Set<String> getTrustedPackages() {
|
||||
return this.trustedPackages;
|
||||
}
|
||||
|
||||
public ObjectMapper getObjectMapper() {
|
||||
return objectMapper;
|
||||
}
|
||||
|
||||
private Object decodeValue(String jsonString, Class<?> type)
|
||||
throws IOException, LinkageError {
|
||||
Object value = objectMapper.readValue(jsonString, type);
|
||||
if (type.equals(NonTrustedHeaderType.class)) {
|
||||
// Upstream NTHT propagated; may be trusted here...
|
||||
NonTrustedHeaderType nth = (NonTrustedHeaderType) value;
|
||||
if (trusted(nth.getUntrustedType())) {
|
||||
try {
|
||||
value = objectMapper.readValue(nth.getHeaderValue(),
|
||||
ClassUtils.forName(nth.getUntrustedType(), null));
|
||||
}
|
||||
catch (Exception e) {
|
||||
log.error("Could not decode header: " + nth, e);
|
||||
}
|
||||
}
|
||||
}
|
||||
return value;
|
||||
}
|
||||
|
||||
@Nullable
|
||||
private Map<String, String> decodeJsonTypes(Map<String, String> source) {
|
||||
if (source.containsKey(JSON_TYPES)) {
|
||||
String value = source.get(JSON_TYPES);
|
||||
try {
|
||||
return objectMapper.readValue(value,
|
||||
new TypeReference<Map<String, String>>() {
|
||||
});
|
||||
}
|
||||
catch (IOException e) {
|
||||
log.error("Could not decode json types: " + value, e);
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
protected boolean trusted(String requestedType) {
|
||||
if (requestedType.equals(NonTrustedHeaderType.class.getName())) {
|
||||
return true;
|
||||
}
|
||||
if (!this.trustedPackages.isEmpty()) {
|
||||
int lastDot = requestedType.lastIndexOf('.');
|
||||
if (lastDot < 0) {
|
||||
return false;
|
||||
}
|
||||
String packageName = requestedType.substring(0, lastDot);
|
||||
for (String trustedPackage : this.trustedPackages) {
|
||||
if (packageName.equals(trustedPackage)
|
||||
|| packageName.startsWith(trustedPackage + ".")) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents a header that could not be decoded due to an untrusted type.
|
||||
*/
|
||||
public static class NonTrustedHeaderType {
|
||||
|
||||
private String headerValue;
|
||||
|
||||
private String untrustedType;
|
||||
|
||||
public NonTrustedHeaderType() {
|
||||
super();
|
||||
}
|
||||
|
||||
NonTrustedHeaderType(String headerValue, String untrustedType) {
|
||||
this.headerValue = headerValue;
|
||||
this.untrustedType = untrustedType;
|
||||
}
|
||||
|
||||
public void setHeaderValue(String headerValue) {
|
||||
this.headerValue = headerValue;
|
||||
}
|
||||
|
||||
public String getHeaderValue() {
|
||||
return this.headerValue;
|
||||
}
|
||||
|
||||
public void setUntrustedType(String untrustedType) {
|
||||
this.untrustedType = untrustedType;
|
||||
}
|
||||
|
||||
public String getUntrustedType() {
|
||||
return this.untrustedType;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "NonTrustedHeaderType [headerValue=" + headerValue + ", untrustedType="
|
||||
+ this.untrustedType + "]";
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,43 @@
|
||||
/*
|
||||
* Copyright (C) 2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package com.alibaba.cloud.stream.binder.rocketmq.support;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
import org.springframework.messaging.MessageHeaders;
|
||||
|
||||
/**
|
||||
* header value mapper for RocketMQ
|
||||
*
|
||||
* @author caotc
|
||||
* @since 2.1.1.RELEASE
|
||||
*/
|
||||
public interface RocketMQHeaderMapper {
|
||||
/**
|
||||
* Map from the given {@link MessageHeaders} to the specified target message.
|
||||
* @param headers the abstracted MessageHeaders.
|
||||
* @return the native target message.
|
||||
*/
|
||||
Map<String, String> fromHeaders(MessageHeaders headers);
|
||||
|
||||
/**
|
||||
* Map from the given target message to abstracted {@link MessageHeaders}.
|
||||
* @param source the native target message.
|
||||
* @return the target headers.
|
||||
*/
|
||||
MessageHeaders toHeaders(Map<String, String> source);
|
||||
}
|
||||
Loading…
Reference in New Issue