From d07d17b4ca813f1fca94613ff18c1c2eeeaad29f Mon Sep 17 00:00:00 2001 From: Eric Zhao Date: Tue, 3 Mar 2020 17:08:08 +0800 Subject: [PATCH] Polish code and document of sentinel-sofa-rpc-adapter Signed-off-by: Eric Zhao --- .../sentinel-sofa-rpc-adapter/README.md | 1 + .../sofa/rpc/AbstractSofaRpcFilter.java | 25 +++++++++++++---- .../adapter/sofa/rpc/SentinelConstants.java | 27 +++++++++++++++++++ .../rpc/SentinelSofaRpcConsumerFilter.java | 4 ++- .../rpc/SentinelSofaRpcProviderFilter.java | 10 +++---- .../adapter/sofa/rpc/SofaRpcUtils.java | 2 ++ .../sofa/rpc/config/SofaRpcConfig.java | 9 ------- .../rpc/fallback/SofaRpcFallbackRegistry.java | 4 +++ .../sofa/rpc/AbstractSofaRpcFilterTest.java | 23 ++++++++-------- .../sentinel-demo-sofa-rpc/README.md | 14 +++++----- 10 files changed, 80 insertions(+), 39 deletions(-) create mode 100644 sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelConstants.java delete mode 100644 sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/config/SofaRpcConfig.java diff --git a/sentinel-adapter/sentinel-sofa-rpc-adapter/README.md b/sentinel-adapter/sentinel-sofa-rpc-adapter/README.md index ee9d2522..5cc54a91 100755 --- a/sentinel-adapter/sentinel-sofa-rpc-adapter/README.md +++ b/sentinel-adapter/sentinel-sofa-rpc-adapter/README.md @@ -28,6 +28,7 @@ consumerConfig.setParameter("sofa.rpc.sentinel.enabled", "false"); ``` or add setting in `rpc-config.json` file, and its priority is lower than above. + ```json { "sofa.rpc.sentinel.enabled": true diff --git a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/AbstractSofaRpcFilter.java b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/AbstractSofaRpcFilter.java index 850f255a..5ea2239f 100644 --- a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/AbstractSofaRpcFilter.java +++ b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/AbstractSofaRpcFilter.java @@ -1,8 +1,23 @@ +/* + * Copyright 1999-2020 Alibaba Group Holding Ltd. + * + * 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 + * + * https://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.csp.sentinel.adapter.sofa.rpc; import com.alibaba.csp.sentinel.Entry; import com.alibaba.csp.sentinel.Tracer; -import com.alibaba.csp.sentinel.adapter.sofa.rpc.config.SofaRpcConfig; + import com.alipay.sofa.rpc.common.RpcConfigs; import com.alipay.sofa.rpc.common.utils.StringUtils; import com.alipay.sofa.rpc.config.AbstractInterfaceConfig; @@ -19,14 +34,14 @@ abstract class AbstractSofaRpcFilter extends Filter { @Override public boolean needToLoad(FilterInvoker invoker) { - AbstractInterfaceConfig config = invoker.getConfig(); + AbstractInterfaceConfig config = invoker.getConfig(); - String enabled = config.getParameter(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED); + String enabled = config.getParameter(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED); if (StringUtils.isNotBlank(enabled)) { - return Boolean.valueOf(enabled); + return Boolean.parseBoolean(enabled); } - return RpcConfigs.getOrDefaultValue(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED, true); + return RpcConfigs.getOrDefaultValue(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED, true); } protected void traceResponseException(SofaResponse response, Entry interfaceEntry, Entry methodEntry) { diff --git a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelConstants.java b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelConstants.java new file mode 100644 index 00000000..17eb1b0f --- /dev/null +++ b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelConstants.java @@ -0,0 +1,27 @@ +/* + * Copyright 1999-2020 Alibaba Group Holding Ltd. + * + * 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 + * + * https://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.csp.sentinel.adapter.sofa.rpc; + +/** + * @author cdfive + * @since 1.7.2 + */ +public final class SentinelConstants { + + public static final String SOFA_RPC_SENTINEL_ENABLED = "sofa.rpc.sentinel.enabled"; + + private SentinelConstants() {} +} diff --git a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelSofaRpcConsumerFilter.java b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelSofaRpcConsumerFilter.java index c881be5a..c0f916f2 100644 --- a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelSofaRpcConsumerFilter.java +++ b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelSofaRpcConsumerFilter.java @@ -18,6 +18,7 @@ package com.alibaba.csp.sentinel.adapter.sofa.rpc; import com.alibaba.csp.sentinel.*; import com.alibaba.csp.sentinel.adapter.sofa.rpc.fallback.SofaRpcFallbackRegistry; import com.alibaba.csp.sentinel.slots.block.BlockException; + import com.alipay.sofa.rpc.common.RpcConstants; import com.alipay.sofa.rpc.core.exception.SofaRpcException; import com.alipay.sofa.rpc.core.request.SofaRequest; @@ -59,7 +60,8 @@ public class SentinelSofaRpcConsumerFilter extends AbstractSofaRpcFilter { Entry methodEntry = null; try { interfaceEntry = SphU.entry(interfaceResourceName, ResourceTypeConstants.COMMON_RPC, EntryType.OUT); - methodEntry = SphU.entry(methodResourceName, ResourceTypeConstants.COMMON_RPC, EntryType.OUT, getMethodArguments(request)); + methodEntry = SphU.entry(methodResourceName, ResourceTypeConstants.COMMON_RPC, + EntryType.OUT, getMethodArguments(request)); SofaResponse response = invoker.invoke(request); diff --git a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelSofaRpcProviderFilter.java b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelSofaRpcProviderFilter.java index 6ffa95a9..0cc11f44 100644 --- a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelSofaRpcProviderFilter.java +++ b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SentinelSofaRpcProviderFilter.java @@ -19,6 +19,7 @@ import com.alibaba.csp.sentinel.*; import com.alibaba.csp.sentinel.adapter.sofa.rpc.fallback.SofaRpcFallbackRegistry; import com.alibaba.csp.sentinel.context.ContextUtil; import com.alibaba.csp.sentinel.slots.block.BlockException; + import com.alipay.sofa.rpc.common.RpcConstants; import com.alipay.sofa.rpc.core.exception.SofaRpcException; import com.alipay.sofa.rpc.core.request.SofaRequest; @@ -58,17 +59,18 @@ public class SentinelSofaRpcProviderFilter extends AbstractSofaRpcFilter { return invoker.invoke(request); } - String applicationName = getApplicationName(request); + String callerApp = getApplicationName(request); String interfaceResourceName = getInterfaceResourceName(request); String methodResourceName = getMethodResourceName(request); Entry interfaceEntry = null; Entry methodEntry = null; try { - ContextUtil.enter(methodResourceName, applicationName); + ContextUtil.enter(methodResourceName, callerApp); interfaceEntry = SphU.entry(interfaceResourceName, ResourceTypeConstants.COMMON_RPC, EntryType.IN); - methodEntry = SphU.entry(methodResourceName, ResourceTypeConstants.COMMON_RPC, EntryType.IN, getMethodArguments(request)); + methodEntry = SphU.entry(methodResourceName, ResourceTypeConstants.COMMON_RPC, + EntryType.IN, getMethodArguments(request)); SofaResponse response = invoker.invoke(request); @@ -82,11 +84,9 @@ public class SentinelSofaRpcProviderFilter extends AbstractSofaRpcFilter { if (methodEntry != null) { methodEntry.exit(1, getMethodArguments(request)); } - if (interfaceEntry != null) { interfaceEntry.exit(); } - ContextUtil.exit(); } } diff --git a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SofaRpcUtils.java b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SofaRpcUtils.java index f313c8a1..3c180cb6 100644 --- a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SofaRpcUtils.java +++ b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/SofaRpcUtils.java @@ -56,4 +56,6 @@ public class SofaRpcUtils { public static Object[] getMethodArguments(SofaRequest request) { return request.getMethodArgs(); } + + private SofaRpcUtils() {} } diff --git a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/config/SofaRpcConfig.java b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/config/SofaRpcConfig.java deleted file mode 100644 index b63755ec..00000000 --- a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/config/SofaRpcConfig.java +++ /dev/null @@ -1,9 +0,0 @@ -package com.alibaba.csp.sentinel.adapter.sofa.rpc.config; - -/** - * @author cdfive - */ -public class SofaRpcConfig { - - public static final String SOFA_RPC_SENTINEL_ENABLED = "sofa.rpc.sentinel.enabled"; -} diff --git a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/fallback/SofaRpcFallbackRegistry.java b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/fallback/SofaRpcFallbackRegistry.java index 15361e3b..29ac9e3b 100644 --- a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/fallback/SofaRpcFallbackRegistry.java +++ b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/main/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/fallback/SofaRpcFallbackRegistry.java @@ -15,6 +15,8 @@ */ package com.alibaba.csp.sentinel.adapter.sofa.rpc.fallback; +import com.alibaba.csp.sentinel.util.AssertUtil; + /** * Global Sentinel fallback registry for SOFARPC services. * @@ -30,6 +32,7 @@ public final class SofaRpcFallbackRegistry { } public static void setProviderFallback(SofaRpcFallback providerFallback) { + AssertUtil.notNull(providerFallback, "providerFallback cannot be null"); SofaRpcFallbackRegistry.providerFallback = providerFallback; } @@ -38,6 +41,7 @@ public final class SofaRpcFallbackRegistry { } public static void setConsumerFallback(SofaRpcFallback consumerFallback) { + AssertUtil.notNull(consumerFallback, "consumerFallback cannot be null"); SofaRpcFallbackRegistry.consumerFallback = consumerFallback; } diff --git a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/AbstractSofaRpcFilterTest.java b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/AbstractSofaRpcFilterTest.java index 5d1d5303..7a0b93b9 100644 --- a/sentinel-adapter/sentinel-sofa-rpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/AbstractSofaRpcFilterTest.java +++ b/sentinel-adapter/sentinel-sofa-rpc-adapter/src/test/java/com/alibaba/csp/sentinel/adapter/sofa/rpc/AbstractSofaRpcFilterTest.java @@ -1,6 +1,5 @@ package com.alibaba.csp.sentinel.adapter.sofa.rpc; -import com.alibaba.csp.sentinel.adapter.sofa.rpc.config.SofaRpcConfig; import com.alipay.sofa.rpc.codec.Serializer; import com.alipay.sofa.rpc.common.RpcConfigs; import com.alipay.sofa.rpc.config.ConsumerConfig; @@ -23,12 +22,12 @@ public class AbstractSofaRpcFilterTest { @Before public void setUp() { - removeRpcConfig(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED); + removeRpcConfig(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED); } @After public void cleanUp() { - removeRpcConfig(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED); + removeRpcConfig(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED); } @Test @@ -40,13 +39,13 @@ public class AbstractSofaRpcFilterTest { FilterInvoker invoker = new FilterInvoker(null, null, providerConfig); assertTrue(providerFilter.needToLoad(invoker)); - providerConfig.setParameter(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED, "false"); + providerConfig.setParameter(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED, "false"); assertFalse(providerFilter.needToLoad(invoker)); - providerConfig.setParameter(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED, ""); + providerConfig.setParameter(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED, ""); assertTrue(providerFilter.needToLoad(invoker)); - RpcConfigs.putValue(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED, "false"); + RpcConfigs.putValue(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED, "false"); assertFalse(providerFilter.needToLoad(invoker)); } @@ -59,13 +58,13 @@ public class AbstractSofaRpcFilterTest { FilterInvoker invoker = new FilterInvoker(null, null, consumerConfig); assertTrue(consumerFilter.needToLoad(invoker)); - consumerConfig.setParameter(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED, "false"); + consumerConfig.setParameter(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED, "false"); assertFalse(consumerFilter.needToLoad(invoker)); - consumerConfig.setParameter(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED, ""); + consumerConfig.setParameter(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED, ""); assertTrue(consumerFilter.needToLoad(invoker)); - RpcConfigs.putValue(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED, "false"); + RpcConfigs.putValue(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED, "false"); assertFalse(consumerFilter.needToLoad(invoker)); } @@ -85,14 +84,14 @@ public class AbstractSofaRpcFilterTest { FilterInvoker consumerInvoker = new FilterInvoker(null, null, consumerConfig); assertTrue(consumerFilter.needToLoad(consumerInvoker)); - providerConfig.setParameter(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED, "false"); + providerConfig.setParameter(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED, "false"); assertFalse(providerFilter.needToLoad(providerInvoker)); assertTrue(consumerFilter.needToLoad(consumerInvoker)); - providerConfig.setParameter(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED, ""); + providerConfig.setParameter(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED, ""); assertTrue(providerFilter.needToLoad(providerInvoker)); - RpcConfigs.putValue(SofaRpcConfig.SOFA_RPC_SENTINEL_ENABLED, "false"); + RpcConfigs.putValue(SentinelConstants.SOFA_RPC_SENTINEL_ENABLED, "false"); assertFalse(providerFilter.needToLoad(providerInvoker)); assertFalse(consumerFilter.needToLoad(consumerInvoker)); } diff --git a/sentinel-demo/sentinel-demo-sofa-rpc/README.md b/sentinel-demo/sentinel-demo-sofa-rpc/README.md index ddf08319..3712718a 100644 --- a/sentinel-demo/sentinel-demo-sofa-rpc/README.md +++ b/sentinel-demo/sentinel-demo-sofa-rpc/README.md @@ -12,7 +12,7 @@ Sentinel 提供了与 SOFARPC 整合的模块 - `sentinel-sofa-rpc-adapter`， 引入此依赖后，SOFARPC 的服务接口和方法（包括调用端和服务端）就会成为 Sentinel 中的资源，在配置了规则后就可以自动享受到 Sentinel 的防护能力。 -> **注：若希望接入 Dashboard，请参考demo中的注释添加VM参数，只引入`sentinel-sofa-rpc-adapter`无法接入控制台！** +> **注：若希望接入 Dashboard，请参考 demo 中的注释添加启动参数。只引入 `sentinel-sofa-rpc-adapter` 依赖无法接入控制台！** 若不希望开启 Sentinel SOFARPC Adapter 中的某个 Filter，可以手动关闭对应的 Filter，比如： @@ -21,7 +21,7 @@ providerConfig.setParameter("sofa.rpc.sentinel.enabled", "false"); consumerConfig.setParameter("sofa.rpc.sentinel.enabled", "false"); ``` -或者在`rpc-config.json`文件中设置，它的优先级要低一些。 +或者在 `rpc-config.json` 文件中设置，它的优先级要低一些。 ```json { @@ -29,14 +29,14 @@ consumerConfig.setParameter("sofa.rpc.sentinel.enabled", "false"); } ``` -# 运行Demo +## 运行 Demo -1. 启动控制台，运行`DashboardApplication` +1. 启动控制台，运行 `DashboardApplication` -2. 启动Provider，运行`DemoProvider`（VM参数：`-Dproject.name=DemoProvider -Dcsp.sentinel.dashboard.server=localhost:8080`） +2. 启动 Provider，运行 `DemoProvider`（VM参数：`-Dproject.name=DemoProvider -Dcsp.sentinel.dashboard.server=localhost:8080`） -3. 启动Consumer，运行`DemoConsumer`（VM参数：`-Dproject.name=DemoConsumer -Dcsp.sentinel.dashboard.server=localhost:8080`） +3. 启动 Consumer，运行 `DemoConsumer`（VM参数：`-Dproject.name=DemoConsumer -Dcsp.sentinel.dashboard.server=localhost:8080`） 通过控制台实时监控、簇点链路菜单观察接口调用、资源情况；对资源设置不同流控规则，进行观察和调试。 -参考：[Sentinel控制台](https://github.com/alibaba/Sentinel/wiki/控制台). \ No newline at end of file +参考：[Sentinel 控制台文档](https://github.com/alibaba/Sentinel/wiki/控制台). \ No newline at end of file