fix getAttchments return copy map problem. (#9571)

This commit is contained in:
赵延 2022-01-29 15:56:03 +08:00 committed by GitHub
parent 01a0d55499
commit 7aa6ea2a01
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 30 additions and 93 deletions

View File

@ -16,17 +16,19 @@
*/ */
package org.apache.dubbo.rpc.cluster.directory; package org.apache.dubbo.rpc.cluster.directory;
import org.apache.dubbo.rpc.AttachmentsAdapter;
import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import static org.apache.dubbo.common.constants.CommonConstants.DUBBO_VERSION_KEY; import static org.apache.dubbo.common.constants.CommonConstants.DUBBO_VERSION_KEY;
import static org.apache.dubbo.common.constants.CommonConstants.GROUP_KEY; import static org.apache.dubbo.common.constants.CommonConstants.GROUP_KEY;
import static org.apache.dubbo.common.constants.CommonConstants.PATH_KEY; import static org.apache.dubbo.common.constants.CommonConstants.PATH_KEY;
import static org.apache.dubbo.common.constants.CommonConstants.TIMEOUT_KEY; import static org.apache.dubbo.common.constants.CommonConstants.TIMEOUT_KEY;
import static org.apache.dubbo.common.constants.CommonConstants.VERSION_KEY; import static org.apache.dubbo.common.constants.CommonConstants.VERSION_KEY;
import org.apache.dubbo.common.utils.MapUtils;
import static org.apache.dubbo.rpc.Constants.TOKEN_KEY; import static org.apache.dubbo.rpc.Constants.TOKEN_KEY;
import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker;
/** /**
* MockInvocation.java * MockInvocation.java
@ -73,7 +75,7 @@ public class MockDirInvocation implements Invocation {
} }
public Map<String, String> getAttachments() { public Map<String, String> getAttachments() {
return MapUtils.objectToStringMap(attachments); return new AttachmentsAdapter.ObjectToStringMap(attachments);
} }
@Override @Override
@ -88,7 +90,7 @@ public class MockDirInvocation implements Invocation {
@Override @Override
public void setAttachment(String key, Object value) { public void setAttachment(String key, Object value) {
setObjectAttachment(key, value); setObjectAttachment(key, value);
} }
@Override @Override

View File

@ -1,65 +0,0 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.dubbo.common.utils;
import java.util.HashMap;
import java.util.Map;
/**
* Map tools
*/
public class MapUtils {
/**
* switch Map<String, Object> to Map<String, String>
*
* If the value of the original Map is not of type String, then toString() of value will be called
*
* @param originMap
* @return
*/
public static Map<String, String> objectToStringMap(Map<String, Object> originMap) {
Map<String, String> newStrMap = new HashMap<>();
if (originMap == null) {
return newStrMap;
}
for (Map.Entry<String, Object> entry : originMap.entrySet()) {
String stringValue = convertToString(entry.getValue());
if (stringValue != null) {
newStrMap.put(entry.getKey(), stringValue);
}
}
return newStrMap;
}
/**
* use {@link Object#toString()} switch Obj to String
*
* @param obj
* @return
*/
private static String convertToString(Object obj) {
if (obj == null) {
return null;
} else {
return obj.toString();
}
}
}

View File

@ -16,7 +16,7 @@
*/ */
package org.apache.dubbo.service; package org.apache.dubbo.service;
import org.apache.dubbo.common.utils.MapUtils; import org.apache.dubbo.rpc.AttachmentsAdapter;
import org.apache.dubbo.rpc.Invocation; import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker; import org.apache.dubbo.rpc.Invoker;
@ -79,7 +79,7 @@ public class MockInvocation implements Invocation {
} }
public Map<String, String> getAttachments() { public Map<String, String> getAttachments() {
return MapUtils.objectToStringMap(attachments); return new AttachmentsAdapter.ObjectToStringMap(attachments);
} }
@Override @Override

View File

@ -17,7 +17,6 @@
package org.apache.dubbo.rpc; package org.apache.dubbo.rpc;
import org.apache.dubbo.common.utils.MapUtils;
import org.apache.dubbo.rpc.proxy.InvokerInvocationHandler; import org.apache.dubbo.rpc.proxy.InvokerInvocationHandler;
import java.util.HashMap; import java.util.HashMap;
@ -122,7 +121,7 @@ public class AppResponse implements Result {
@Override @Override
@Deprecated @Deprecated
public Map<String, String> getAttachments() { public Map<String, String> getAttachments() {
return MapUtils.objectToStringMap(attachments); return new AttachmentsAdapter.ObjectToStringMap(attachments);
} }
@Override @Override

View File

@ -22,18 +22,12 @@ import java.util.Map;
/** /**
* This class provides map adapters to support attachments in RpcContext, Invocation and Result switch from * This class provides map adapters to support attachments in RpcContext, Invocation and Result switch from
* <String, String> to <String, Object> * <String, String> to <String, Object>
*
* please use {@link org.apache.dubbo.common.utils.MapUtils}
*
*/ */
@Deprecated
public class AttachmentsAdapter { public class AttachmentsAdapter {
@Deprecated
public static class ObjectToStringMap extends HashMap<String, String> { public static class ObjectToStringMap extends HashMap<String, String> {
private Map<String, Object> attachments; private Map<String, Object> attachments;
@Deprecated
public ObjectToStringMap(Map<String, Object> attachments) { public ObjectToStringMap(Map<String, Object> attachments) {
for (Entry<String, Object> entry : attachments.entrySet()) { for (Entry<String, Object> entry : attachments.entrySet()) {
String convertResult = convert(entry.getValue()); String convertResult = convert(entry.getValue());
@ -57,11 +51,10 @@ public class AttachmentsAdapter {
} }
private String convert(Object obj) { private String convert(Object obj) {
if (obj == null) { if (obj instanceof String) {
return null; return (String) obj;
} else {
return obj.toString();
} }
return null; // or JSON.toString(obj);
} }
@Override @Override

View File

@ -20,7 +20,6 @@ import org.apache.dubbo.common.Experimental;
import org.apache.dubbo.common.URL; import org.apache.dubbo.common.URL;
import org.apache.dubbo.common.threadlocal.InternalThreadLocal; import org.apache.dubbo.common.threadlocal.InternalThreadLocal;
import org.apache.dubbo.common.utils.CollectionUtils; import org.apache.dubbo.common.utils.CollectionUtils;
import org.apache.dubbo.common.utils.MapUtils;
import org.apache.dubbo.common.utils.NetUtils; import org.apache.dubbo.common.utils.NetUtils;
import org.apache.dubbo.common.utils.StringUtils; import org.apache.dubbo.common.utils.StringUtils;
@ -547,15 +546,13 @@ public class RpcContext {
} }
/** /**
* get String type attachments. * get attachments.
*
* Best to use {{@link #getObjectAttachments()}}
* *
* @return attachments * @return attachments
*/ */
@Deprecated @Deprecated
public Map<String, String> getAttachments() { public Map<String, String> getAttachments() {
return MapUtils.objectToStringMap(this.getObjectAttachments()); return new AttachmentsAdapter.ObjectToStringMap(this.getObjectAttachments());
} }
/** /**

View File

@ -17,7 +17,6 @@
package org.apache.dubbo.rpc; package org.apache.dubbo.rpc;
import org.apache.dubbo.common.URL; import org.apache.dubbo.common.URL;
import org.apache.dubbo.common.utils.MapUtils;
import org.apache.dubbo.common.utils.ReflectUtils; import org.apache.dubbo.common.utils.ReflectUtils;
import org.apache.dubbo.common.utils.StringUtils; import org.apache.dubbo.common.utils.StringUtils;
import org.apache.dubbo.rpc.model.ApplicationModel; import org.apache.dubbo.rpc.model.ApplicationModel;
@ -278,7 +277,7 @@ public class RpcInvocation implements Invocation, Serializable {
@Deprecated @Deprecated
@Override @Override
public Map<String, String> getAttachments() { public Map<String, String> getAttachments() {
return MapUtils.objectToStringMap(attachments); return new AttachmentsAdapter.ObjectToStringMap(attachments);
} }
@Deprecated @Deprecated

View File

@ -117,6 +117,9 @@ public class AppResponseTest {
Assertions.assertEquals(1, response.getObjectAttachment("objectKey3")); Assertions.assertEquals(1, response.getObjectAttachment("objectKey3"));
Assertions.assertEquals(3, response.getObjectAttachments().size()); Assertions.assertEquals(3, response.getObjectAttachments().size());
response.getAttachments().put("objectKey4", "value4");
Assertions.assertEquals(response.getAttachment("objectKey4"), "value4");
HashMap<String, Object> map = new HashMap<>(); HashMap<String, Object> map = new HashMap<>();
map.put("mapKey1", 1); map.put("mapKey1", 1);
map.put("mapKey2", "mapValue2"); map.put("mapKey2", "mapValue2");

View File

@ -108,8 +108,13 @@ public class RpcContextTest {
Assertions.assertNull(context.getAttachment("_33")); Assertions.assertNull(context.getAttachment("_33"));
Assertions.assertEquals("3333", context.getAttachment(".33")); Assertions.assertEquals("3333", context.getAttachment(".33"));
context.getAttachments().put("44", "4444");
Assertions.assertEquals(context.getAttachment("44"), "4444");
context.clearAttachments(); context.clearAttachments();
Assertions.assertNull(context.getAttachment("_11")); Assertions.assertNull(context.getAttachment("_11"));
} }
@Test @Test

View File

@ -37,6 +37,10 @@ public class RpcInvocationTest {
Assertions.assertEquals(1, invocation.getObjectAttachment("objectKey3")); Assertions.assertEquals(1, invocation.getObjectAttachment("objectKey3"));
Assertions.assertEquals(3, invocation.getObjectAttachments().size()); Assertions.assertEquals(3, invocation.getObjectAttachments().size());
invocation.getAttachments().put("object4", "value4");
Assertions.assertEquals(invocation.getAttachment("object4"), "value4");
HashMap<String, Object> map = new HashMap<>(); HashMap<String, Object> map = new HashMap<>();
map.put("mapKey1", 1); map.put("mapKey1", 1);
map.put("mapKey2", "mapValue2"); map.put("mapKey2", "mapValue2");

View File

@ -16,7 +16,7 @@
*/ */
package org.apache.dubbo.rpc.support; package org.apache.dubbo.rpc.support;
import org.apache.dubbo.common.utils.MapUtils; import org.apache.dubbo.rpc.AttachmentsAdapter;
import org.apache.dubbo.rpc.Invocation; import org.apache.dubbo.rpc.Invocation;
import org.apache.dubbo.rpc.Invoker; import org.apache.dubbo.rpc.Invoker;
@ -75,7 +75,7 @@ public class MockInvocation implements Invocation {
} }
public Map<String, String> getAttachments() { public Map<String, String> getAttachments() {
return MapUtils.objectToStringMap(attachments); return new AttachmentsAdapter.ObjectToStringMap(attachments);
} }
@Override @Override