Rename some variables to avoid possible confusion between Result and AppResponse. (#3889)

chickenlj · carryxyh · commit 13c157176a46 · 2019-04-19T11:47:20.000+08:00
Clear that the `Result` of the call back is actually an `AppResponse`.
diff --git a/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/FailsafeClusterInvoker.java b/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/FailsafeClusterInvoker.java
@@ -29,7 +29,7 @@
 import java.util.List;
 
 /**
- * When invoke fails, log the error message and ignore this error by returning an empty RpcResult.
+ * When invoke fails, log the error message and ignore this error by returning an empty Result.
  * Usually used to write audit logs and other operations
  *
  * <a href="http://en.wikipedia.org/wiki/Fail-safe">Fail-safe</a>
diff --git a/dubbo-remoting/dubbo-remoting-api/src/test/java/org/apache/dubbo/remoting/MockResult.java b/dubbo-remoting/dubbo-remoting-api/src/test/java/org/apache/dubbo/remoting/MockResult.java
@@ -19,7 +19,7 @@
 import java.io.Serializable;
 
 /**
- * RpcResult.
+ * AppResponse.
  */
 
 public class MockResult implements Serializable {
diff --git a/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/AsyncRpcResult.java b/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/AsyncRpcResult.java
@@ -47,7 +47,7 @@ public AsyncRpcResult(CompletableFuture<AppResponse> future, Invocation invocati
 
     @Override
     public Object getValue() {
-        return getRpcResult().getValue();
+        return getAppResponse().getValue();
     }
 
     @Override
@@ -57,7 +57,7 @@ public void setValue(Object value) {
 
     @Override
     public Throwable getException() {
-        return getRpcResult().getException();
+        return getAppResponse().getException();
     }
 
     @Override
@@ -67,7 +67,7 @@ public void setException(Throwable t) {
 
     @Override
     public boolean hasException() {
-        return getRpcResult().hasException();
+        return getAppResponse().hasException();
     }
 
     public CompletableFuture<AppResponse> getResponseFuture() {
@@ -78,7 +78,7 @@ public void setResponseFuture(CompletableFuture<AppResponse> responseFuture) {
         this.responseFuture = responseFuture;
     }
 
-    public Result getRpcResult() {
+    public Result getAppResponse() {
         try {
             if (responseFuture.isDone()) {
                 return responseFuture.get();
@@ -94,9 +94,9 @@ public Result getRpcResult() {
     public Object recreate() throws Throwable {
         RpcInvocation rpcInvocation = (RpcInvocation) invocation;
         if (InvokeMode.FUTURE == rpcInvocation.getInvokeMode()) {
-            AppResponse rpcResult = new AppResponse();
+            AppResponse appResponse = new AppResponse();
             CompletableFuture<Object> future = new CompletableFuture<>();
-            rpcResult.setValue(future);
+            appResponse.setValue(future);
             responseFuture.whenComplete((result, t) -> {
                 if (t != null) {
                     if (t instanceof CompletionException) {
@@ -111,7 +111,7 @@ public Object recreate() throws Throwable {
                     }
                 }
             });
-            return rpcResult.recreate();
+            return appResponse.recreate();
         } else if (responseFuture.isDone()) {
             return responseFuture.get().recreate();
         }
@@ -135,32 +135,32 @@ public <U> CompletableFuture<U> thenApply(Function<Result,? extends U> fn) {
 
     @Override
     public Map<String, String> getAttachments() {
-        return getRpcResult().getAttachments();
+        return getAppResponse().getAttachments();
     }
 
     @Override
     public void setAttachments(Map<String, String> map) {
-        getRpcResult().setAttachments(map);
+        getAppResponse().setAttachments(map);
     }
 
     @Override
     public void addAttachments(Map<String, String> map) {
-        getRpcResult().addAttachments(map);
+        getAppResponse().addAttachments(map);
     }
 
     @Override
     public String getAttachment(String key) {
-        return getRpcResult().getAttachment(key);
+        return getAppResponse().getAttachment(key);
     }
 
     @Override
     public String getAttachment(String key, String defaultValue) {
-        return getRpcResult().getAttachment(key, defaultValue);
+        return getAppResponse().getAttachment(key, defaultValue);
     }
 
     @Override
     public void setAttachment(String key, String value) {
-        getRpcResult().setAttachment(key, value);
+        getAppResponse().setAttachment(key, value);
     }
 
     /**
diff --git a/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/Filter.java b/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/Filter.java
@@ -49,7 +49,7 @@ public interface Filter {
 
     interface Listener {
 
-        void onResponse(Result result, Invoker<?> invoker, Invocation invocation);
+        void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation);
 
         void onError(Throwable t, Invoker<?> invoker, Invocation invocation);
     }
diff --git a/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/ActiveLimitFilter.java b/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/ActiveLimitFilter.java
@@ -83,7 +83,7 @@ public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcExcept
 
     static class ActiveLimitListener implements Listener {
         @Override
-        public void onResponse(Result result, Invoker<?> invoker, Invocation invocation) {
+        public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {
             String methodName = invocation.getMethodName();
             URL url = invoker.getUrl();
             int max = invoker.getUrl().getMethodParameter(methodName, Constants.ACTIVES_KEY, 0);
diff --git a/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/CompatibleFilter.java b/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/CompatibleFilter.java
@@ -60,9 +60,9 @@ public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcExcept
 
     static class CompatibleListener implements Listener {
         @Override
-        public void onResponse(Result result, Invoker<?> invoker, Invocation invocation) {
-            if (!invocation.getMethodName().startsWith("$") && !result.hasException()) {
-                Object value = result.getValue();
+        public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {
+            if (!invocation.getMethodName().startsWith("$") && !appResponse.hasException()) {
+                Object value = appResponse.getValue();
                 if (value != null) {
                     try {
                         Method method = invoker.getInterface().getMethod(invocation.getMethodName(), invocation.getParameterTypes());
@@ -81,7 +81,7 @@ public void onResponse(Result result, Invoker<?> invoker, Invocation invocation)
                             newValue = value;
                         }
                         if (newValue != value) {
-                            result.setValue(newValue);
+                            appResponse.setValue(newValue);
                         }
                     } catch (Throwable t) {
                         logger.warn(t.getMessage(), t);
diff --git a/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/ConsumerContextFilter.java b/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/ConsumerContextFilter.java
@@ -62,8 +62,8 @@ public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcExcept
 
     static class ConsumerContextListener implements Listener {
         @Override
-        public void onResponse(Result result, Invoker<?> invoker, Invocation invocation) {
-            RpcContext.getServerContext().setAttachments(result.getAttachments());
+        public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {
+            RpcContext.getServerContext().setAttachments(appResponse.getAttachments());
         }
 
         @Override
diff --git a/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/ContextFilter.java b/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/ContextFilter.java
@@ -90,9 +90,9 @@ public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcExcept
 
     static class ContextListener implements Listener {
         @Override
-        public void onResponse(Result result, Invoker<?> invoker, Invocation invocation) {
+        public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {
             // pass attachments to result
-            result.addAttachments(RpcContext.getServerContext().getAttachments());
+            appResponse.addAttachments(RpcContext.getServerContext().getAttachments());
         }
 
         @Override
diff --git a/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/ExceptionFilter.java b/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/ExceptionFilter.java
@@ -60,10 +60,10 @@ static class ExceptionListener implements Listener {
         private Logger logger = LoggerFactory.getLogger(ExceptionListener.class);
 
         @Override
-        public void onResponse(Result result, Invoker<?> invoker, Invocation invocation) {
-            if (result.hasException() && GenericService.class != invoker.getInterface()) {
+        public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {
+            if (appResponse.hasException() && GenericService.class != invoker.getInterface()) {
                 try {
-                    Throwable exception = result.getException();
+                    Throwable exception = appResponse.getException();
 
                     // directly throw if it's checked exception
                     if (!(exception instanceof RuntimeException) && (exception instanceof Exception)) {
@@ -102,7 +102,7 @@ public void onResponse(Result result, Invoker<?> invoker, Invocation invocation)
                     }
 
                     // otherwise, wrap with RuntimeException and throw back to the client
-                    result.setException(new RuntimeException(StringUtils.toString(exception)));
+                    appResponse.setException(new RuntimeException(StringUtils.toString(exception)));
                     return;
                 } catch (Throwable e) {
                     logger.warn("Fail to ExceptionFilter when called by " + RpcContext.getContext().getRemoteHost() + ". service: " + invoker.getInterface().getName() + ", method: " + invocation.getMethodName() + ", exception: " + e.getClass().getName() + ": " + e.getMessage(), e);
diff --git a/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/ExecuteLimitFilter.java b/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/ExecuteLimitFilter.java
@@ -68,7 +68,7 @@ public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcExcept
 
     static class ExecuteLimitListener implements Listener {
         @Override
-        public void onResponse(Result result, Invoker<?> invoker, Invocation invocation) {
+        public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {
             RpcStatus.endCount(invoker.getUrl(), invocation.getMethodName(), getElapsed(invocation), true);
         }
 
diff --git a/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/GenericFilter.java b/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/GenericFilter.java
@@ -124,7 +124,7 @@ public Result invoke(Invoker<?> invoker, Invocation inv) throws RpcException {
     static class GenericListener implements Listener {
 
         @Override
-        public void onResponse(Result result, Invoker<?> invoker, Invocation inv) {
+        public void onResponse(Result appResponse, Invoker<?> invoker, Invocation inv) {
             if ((inv.getMethodName().equals(Constants.$INVOKE) || inv.getMethodName().equals(Constants.$INVOKE_ASYNC))
                     && inv.getArguments() != null
                     && inv.getArguments().length == 3
@@ -135,21 +135,21 @@ public void onResponse(Result result, Invoker<?> invoker, Invocation inv) {
                     generic = RpcContext.getContext().getAttachment(Constants.GENERIC_KEY);
                 }
 
-                if (result.hasException() && !(result.getException() instanceof GenericException)) {
-                    result.setException(new GenericException(result.getException()));
+                if (appResponse.hasException() && !(appResponse.getException() instanceof GenericException)) {
+                    appResponse.setException(new GenericException(appResponse.getException()));
                 }
                 if (ProtocolUtils.isJavaGenericSerialization(generic)) {
                     try {
                         UnsafeByteArrayOutputStream os = new UnsafeByteArrayOutputStream(512);
-                        ExtensionLoader.getExtensionLoader(Serialization.class).getExtension(Constants.GENERIC_SERIALIZATION_NATIVE_JAVA).serialize(null, os).writeObject(result.getValue());
-                        result.setValue(os.toByteArray());
+                        ExtensionLoader.getExtensionLoader(Serialization.class).getExtension(Constants.GENERIC_SERIALIZATION_NATIVE_JAVA).serialize(null, os).writeObject(appResponse.getValue());
+                        appResponse.setValue(os.toByteArray());
                     } catch (IOException e) {
                         throw new RpcException("Serialize result failed.", e);
                     }
                 } else if (ProtocolUtils.isBeanGenericSerialization(generic)) {
-                    result.setValue(JavaBeanSerializeUtil.serialize(result.getValue(), JavaBeanAccessor.METHOD));
+                    appResponse.setValue(JavaBeanSerializeUtil.serialize(appResponse.getValue(), JavaBeanAccessor.METHOD));
                 } else {
-                    result.setValue(PojoUtils.generalize(result.getValue()));
+                    appResponse.setValue(PojoUtils.generalize(appResponse.getValue()));
                 }
             }
         }
diff --git a/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/GenericImplFilter.java b/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/GenericImplFilter.java
@@ -121,34 +121,34 @@ private void error(String generic, String expected, String actual) throws RpcExc
 
     static class GenericImplListener implements Listener {
         @Override
-        public void onResponse(Result result, Invoker<?> invoker, Invocation invocation) {
+        public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {
             String generic = invoker.getUrl().getParameter(Constants.GENERIC_KEY);
             String methodName = invocation.getMethodName();
             Class<?>[] parameterTypes = invocation.getParameterTypes();
             if (ProtocolUtils.isGeneric(generic)
                     && (!Constants.$INVOKE.equals(invocation.getMethodName()) && !Constants.$INVOKE_ASYNC.equals(invocation.getMethodName()))
                     && invocation instanceof RpcInvocation) {
-                if (!result.hasException()) {
-                    Object value = result.getValue();
+                if (!appResponse.hasException()) {
+                    Object value = appResponse.getValue();
                     try {
                         Method method = invoker.getInterface().getMethod(methodName, parameterTypes);
                         if (ProtocolUtils.isBeanGenericSerialization(generic)) {
                             if (value == null) {
-                                result.setValue(value);
+                                appResponse.setValue(value);
                             } else if (value instanceof JavaBeanDescriptor) {
-                                result.setValue(JavaBeanSerializeUtil.deserialize((JavaBeanDescriptor) value));
+                                appResponse.setValue(JavaBeanSerializeUtil.deserialize((JavaBeanDescriptor) value));
                             } else {
                                 throw new RpcException("The type of result value is " + value.getClass().getName() + " other than " + JavaBeanDescriptor.class.getName() + ", and the result is " + value);
                             }
                         } else {
                             Type[] types = ReflectUtils.getReturnTypes(method);
-                            result.setValue(PojoUtils.realize(value, (Class<?>) types[0], types[1]));
+                            appResponse.setValue(PojoUtils.realize(value, (Class<?>) types[0], types[1]));
                         }
                     } catch (NoSuchMethodException e) {
                         throw new RpcException(e.getMessage(), e);
                     }
-                } else if (result.getException() instanceof GenericException) {
-                    GenericException exception = (GenericException) result.getException();
+                } else if (appResponse.getException() instanceof GenericException) {
+                    GenericException exception = (GenericException) appResponse.getException();
                     try {
                         String className = exception.getExceptionClass();
                         Class<?> clazz = ReflectUtils.forName(className);
@@ -177,7 +177,7 @@ public void onResponse(Result result, Invoker<?> invoker, Invocation invocation)
                             } catch (Throwable e) {
                                 logger.warn(e.getMessage(), e);
                             }
-                            result.setException(targetException);
+                            appResponse.setException(targetException);
                         } else if (lastException != null) {
                             throw lastException;
                         }
diff --git a/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/TimeoutFilter.java b/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/filter/TimeoutFilter.java
@@ -51,7 +51,7 @@ public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcExcept
     static class TimeoutListener implements Listener {
 
         @Override
-        public void onResponse(Result result, Invoker<?> invoker, Invocation invocation) {
+        public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {
             String startAttach = invocation.getAttachment(TIMEOUT_FILTER_START_TIME);
             if (startAttach != null) {
                 long elapsed = System.currentTimeMillis() - Long.valueOf(startAttach);
diff --git a/dubbo-rpc/dubbo-rpc-api/src/test/java/org/apache/dubbo/rpc/RpcResultTest.java b/dubbo-rpc/dubbo-rpc-api/src/test/java/org/apache/dubbo/rpc/RpcResultTest.java
@@ -26,9 +26,9 @@ public class RpcResultTest {
     @Test
     public void testRecreateWithNormalException() {
         NullPointerException npe = new NullPointerException();
-        AppResponse rpcResult = new AppResponse(npe);
+        AppResponse appResponse = new AppResponse(npe);
         try {
-            rpcResult.recreate();
+            appResponse.recreate();
             fail();
         } catch (Throwable throwable) {
             StackTraceElement[] stackTrace = throwable.getStackTrace();
@@ -64,9 +64,9 @@ public void testRecreateWithEmptyStackTraceException() {
         }
         // end construct a NullPointerException with empty stackTrace
 
-        AppResponse rpcResult = new AppResponse(throwable);
+        AppResponse appResponse = new AppResponse(throwable);
         try {
-            rpcResult.recreate();
+            appResponse.recreate();
             fail();
         } catch (Throwable t) {
             StackTraceElement[] stackTrace = t.getStackTrace();
diff --git a/dubbo-rpc/dubbo-rpc-api/src/test/java/org/apache/dubbo/rpc/filter/CompatibleFilterFilterTest.java b/dubbo-rpc/dubbo-rpc-api/src/test/java/org/apache/dubbo/rpc/filter/CompatibleFilterFilterTest.java
@@ -105,9 +105,9 @@ public void testInvokerJsonPojoSerialization() throws Exception {
         given(invoker.getUrl()).willReturn(url);
 
         Result asyncResult = compatibleFilter.invoke(invoker, invocation);
-        Result rpcResult = asyncResult.get();
-        compatibleFilter.listener().onResponse(rpcResult, invoker, invocation);
-        assertEquals(Type.High, rpcResult.getValue());
+        AppResponse appResponse = (AppResponse) asyncResult.get();
+        compatibleFilter.listener().onResponse(appResponse, invoker, invocation);
+        assertEquals(Type.High, appResponse.getValue());
     }
 
     @Test
@@ -127,9 +127,9 @@ public void testInvokerNonJsonEnumSerialization() throws Exception {
         given(invoker.getUrl()).willReturn(url);
 
         Result asyncResult = compatibleFilter.invoke(invoker, invocation);
-        Result rpcResult = asyncResult.get();
-        compatibleFilter.listener().onResponse(rpcResult, invoker, invocation);
-        assertEquals(Type.High, rpcResult.getValue());
+        AppResponse appResponse = (AppResponse) asyncResult.get();
+        compatibleFilter.listener().onResponse(appResponse, invoker, invocation);
+        assertEquals(Type.High, appResponse.getValue());
     }
 
     @Test
diff --git a/dubbo-rpc/dubbo-rpc-api/src/test/java/org/apache/dubbo/rpc/filter/ExceptionFilterTest.java b/dubbo-rpc/dubbo-rpc-api/src/test/java/org/apache/dubbo/rpc/filter/ExceptionFilterTest.java
diff --git a/dubbo-rpc/dubbo-rpc-api/src/test/java/org/apache/dubbo/rpc/filter/GenericFilterTest.java b/dubbo-rpc/dubbo-rpc-api/src/test/java/org/apache/dubbo/rpc/filter/GenericFilterTest.java
diff --git a/dubbo-rpc/dubbo-rpc-thrift/src/main/java/org/apache/dubbo/rpc/protocol/thrift/ThriftCodec.java b/dubbo-rpc/dubbo-rpc-thrift/src/main/java/org/apache/dubbo/rpc/protocol/thrift/ThriftCodec.java
diff --git a/dubbo-rpc/dubbo-rpc-thrift/src/test/java/org/apache/dubbo/rpc/protocol/thrift/ThriftCodecTest.java b/dubbo-rpc/dubbo-rpc-thrift/src/test/java/org/apache/dubbo/rpc/protocol/thrift/ThriftCodecTest.java

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`import java.util.List;`
`30`	`30`
`31`	`31`	`/**`
`32`		`- * When invoke fails, log the error message and ignore this error by returning an empty RpcResult.`
	`32`	`+ * When invoke fails, log the error message and ignore this error by returning an empty Result.`
`33`	`33`	`* Usually used to write audit logs and other operations`
`34`	`34`	`*`
`35`	`35`	`* <a href="http://en.wikipedia.org/wiki/Fail-safe">Fail-safe</a>`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public interface Filter {`
`49`	`49`
`50`	`50`	`interface Listener {`
`51`	`51`
`52`		`- void onResponse(Result result, Invoker<?> invoker, Invocation invocation);`
	`52`	`+ void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation);`
`53`	`53`
`54`	`54`	`void onError(Throwable t, Invoker<?> invoker, Invocation invocation);`
`55`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,8 +62,8 @@ public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcExcept`
`62`	`62`
`63`	`63`	`static class ConsumerContextListener implements Listener {`
`64`	`64`	`@Override`
`65`		`- public void onResponse(Result result, Invoker<?> invoker, Invocation invocation) {`
`66`		`- RpcContext.getServerContext().setAttachments(result.getAttachments());`
	`65`	`+ public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {`
	`66`	`+ RpcContext.getServerContext().setAttachments(appResponse.getAttachments());`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcExcept`
`68`	`68`
`69`	`69`	`static class ExecuteLimitListener implements Listener {`
`70`	`70`	`@Override`
`71`		`- public void onResponse(Result result, Invoker<?> invoker, Invocation invocation) {`
	`71`	`+ public void onResponse(Result appResponse, Invoker<?> invoker, Invocation invocation) {`
`72`	`72`	`RpcStatus.endCount(invoker.getUrl(), invocation.getMethodName(), getElapsed(invocation), true);`
`73`	`73`	`}`
`74`	`74`