diff --git a/eclipse/checkstyle-suppressions.xml b/eclipse/checkstyle-suppressions.xml new file mode 100644 index 0000000000..a83004af1e --- /dev/null +++ b/eclipse/checkstyle-suppressions.xml @@ -0,0 +1,8 @@ + + + + + + \ No newline at end of file diff --git a/pom.xml b/pom.xml index cc677ad229..b1ad7acb14 100644 --- a/pom.xml +++ b/pom.xml @@ -282,6 +282,24 @@ org.apache.maven.plugins maven-checkstyle-plugin + + + checkstyle-validation + validate + + check + + + + eclipse/checkstyle-suppressions.xml + true + true + true + true + warning + + + org.apache.maven.plugins diff --git a/spring-cloud-alibaba-dubbo/src/test/java/com/alibaba/cloud/dubbo/autoconfigure/DubboServiceRegistrationAutoConfigurationTest.java b/spring-cloud-alibaba-dubbo/src/test/java/com/alibaba/cloud/dubbo/autoconfigure/DubboServiceRegistrationAutoConfigurationTest.java index b3fa84d6f6..0fac7ac244 100644 --- a/spring-cloud-alibaba-dubbo/src/test/java/com/alibaba/cloud/dubbo/autoconfigure/DubboServiceRegistrationAutoConfigurationTest.java +++ b/spring-cloud-alibaba-dubbo/src/test/java/com/alibaba/cloud/dubbo/autoconfigure/DubboServiceRegistrationAutoConfigurationTest.java @@ -19,7 +19,7 @@ import org.springframework.boot.test.context.SpringBootTest; /** - * {@link DubboServiceRegistrationAutoConfiguration} Test + * {@link DubboServiceRegistrationAutoConfiguration} Test. * * @author Mercy */ diff --git a/spring-cloud-alibaba-dubbo/src/test/java/com/alibaba/cloud/dubbo/http/matcher/AbstractMediaTypeExpressionTest.java b/spring-cloud-alibaba-dubbo/src/test/java/com/alibaba/cloud/dubbo/http/matcher/AbstractMediaTypeExpressionTest.java index e45c040fcb..c38b5ba694 100644 --- a/spring-cloud-alibaba-dubbo/src/test/java/com/alibaba/cloud/dubbo/http/matcher/AbstractMediaTypeExpressionTest.java +++ b/spring-cloud-alibaba-dubbo/src/test/java/com/alibaba/cloud/dubbo/http/matcher/AbstractMediaTypeExpressionTest.java @@ -26,7 +26,7 @@ import org.springframework.http.MediaType; /** - * {@link AbstractMediaTypeExpression} Test + * {@link AbstractMediaTypeExpression} Test. * * @author Mercy */ diff --git a/spring-cloud-alibaba-examples/oss-example/src/main/java/com/alibaba/cloud/examples/OssApplication.java b/spring-cloud-alibaba-examples/oss-example/src/main/java/com/alibaba/cloud/examples/OssApplication.java index 0e3f7b8a4e..678d7551ee 100644 --- a/spring-cloud-alibaba-examples/oss-example/src/main/java/com/alibaba/cloud/examples/OssApplication.java +++ b/spring-cloud-alibaba-examples/oss-example/src/main/java/com/alibaba/cloud/examples/OssApplication.java @@ -35,6 +35,9 @@ @SpringBootApplication public class OssApplication { + /** + * Bucket Name of OSS Example. + */ public static final String BUCKET_NAME = "spring-cloud-alibaba-test"; public static void main(String[] args) throws URISyntaxException { diff --git a/spring-cloud-alibaba-examples/seata-example/business-service/src/main/java/com/alibaba/cloud/examples/Order.java b/spring-cloud-alibaba-examples/seata-example/business-service/src/main/java/com/alibaba/cloud/examples/Order.java index 06ecbde48b..fbcb8391d4 100644 --- a/spring-cloud-alibaba-examples/seata-example/business-service/src/main/java/com/alibaba/cloud/examples/Order.java +++ b/spring-cloud-alibaba-examples/seata-example/business-service/src/main/java/com/alibaba/cloud/examples/Order.java @@ -20,14 +20,29 @@ public class Order implements Serializable { + /** + * order id. + */ public long id; + /** + * user id. + */ public String userId; + /** + * commodity code. + */ public String commodityCode; + /** + * count. + */ public int count; + /** + * money. + */ public int money; @Override diff --git a/spring-cloud-alibaba-examples/seata-example/order-service/src/main/java/com/alibaba/cloud/examples/Order.java b/spring-cloud-alibaba-examples/seata-example/order-service/src/main/java/com/alibaba/cloud/examples/Order.java index 06ecbde48b..6ad92cc5b0 100644 --- a/spring-cloud-alibaba-examples/seata-example/order-service/src/main/java/com/alibaba/cloud/examples/Order.java +++ b/spring-cloud-alibaba-examples/seata-example/order-service/src/main/java/com/alibaba/cloud/examples/Order.java @@ -20,14 +20,29 @@ public class Order implements Serializable { + /** + * id. + */ public long id; + /** + * user id. + */ public String userId; + /** + * commodity code. + */ public String commodityCode; + /** + * count. + */ public int count; + /** + * money. + */ public int money; @Override diff --git a/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/java/com/alibaba/cloud/examples/ExceptionUtil.java b/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/java/com/alibaba/cloud/examples/ExceptionUtil.java index ef41bda9ab..591756f80d 100644 --- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/java/com/alibaba/cloud/examples/ExceptionUtil.java +++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/src/main/java/com/alibaba/cloud/examples/ExceptionUtil.java @@ -25,7 +25,11 @@ /** * @author fangjian */ -public class ExceptionUtil { +public final class ExceptionUtil { + + private ExceptionUtil() { + + } public static SentinelClientHttpResponse handleException(HttpRequest request, byte[] body, ClientHttpRequestExecution execution, BlockException ex) { diff --git a/spring-cloud-alibaba-examples/sentinel-example/sentinel-feign-example/sentinel-feign-consumer-example/src/main/java/com/alibaba/cloud/examples/fallback/EchoServiceFallback.java b/spring-cloud-alibaba-examples/sentinel-example/sentinel-feign-example/sentinel-feign-consumer-example/src/main/java/com/alibaba/cloud/examples/fallback/EchoServiceFallback.java index 3b3afc007b..30a9de2bec 100644 --- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-feign-example/sentinel-feign-consumer-example/src/main/java/com/alibaba/cloud/examples/fallback/EchoServiceFallback.java +++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-feign-example/sentinel-feign-consumer-example/src/main/java/com/alibaba/cloud/examples/fallback/EchoServiceFallback.java @@ -33,7 +33,7 @@ public class EchoServiceFallback implements EchoService { } /** - * 调用服务提供方的输出接口 + * 调用服务提供方的输出接口. * @param str 用户输入 * @return */ diff --git a/spring-cloud-alibaba-examples/sentinel-example/sentinel-feign-example/sentinel-feign-consumer-example/src/main/java/com/alibaba/cloud/examples/service/EchoService.java b/spring-cloud-alibaba-examples/sentinel-example/sentinel-feign-example/sentinel-feign-consumer-example/src/main/java/com/alibaba/cloud/examples/service/EchoService.java index 120e711cc2..4e0da067b7 100644 --- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-feign-example/sentinel-feign-consumer-example/src/main/java/com/alibaba/cloud/examples/service/EchoService.java +++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-feign-example/sentinel-feign-consumer-example/src/main/java/com/alibaba/cloud/examples/service/EchoService.java @@ -33,9 +33,9 @@ public interface EchoService { /** - * 调用服务提供方的输出接口 + * 调用服务提供方的输出接口. * @param str 用户输入 - * @return + * @return echo result */ @GetMapping("/echo/{str}") String echo(@PathVariable("str") String str); diff --git a/spring-cloud-alibaba-examples/spring-cloud-bus-rocketmq-example/src/main/java/com/alibaba/cloud/examples/rocketmq/RocketMQBusApplication.java b/spring-cloud-alibaba-examples/spring-cloud-bus-rocketmq-example/src/main/java/com/alibaba/cloud/examples/rocketmq/RocketMQBusApplication.java index eff0e4fb8e..91a3ffb359 100644 --- a/spring-cloud-alibaba-examples/spring-cloud-bus-rocketmq-example/src/main/java/com/alibaba/cloud/examples/rocketmq/RocketMQBusApplication.java +++ b/spring-cloud-alibaba-examples/spring-cloud-bus-rocketmq-example/src/main/java/com/alibaba/cloud/examples/rocketmq/RocketMQBusApplication.java @@ -65,7 +65,7 @@ public static void main(String[] args) { private ObjectMapper objectMapper; /** - * Publish the {@link UserRemoteApplicationEvent} + * Publish the {@link UserRemoteApplicationEvent}. * @param name the user name * @param destination the destination * @return If published @@ -82,7 +82,7 @@ public boolean publish(@RequestParam String name, } /** - * Listener on the {@link UserRemoteApplicationEvent} + * Listener on the {@link UserRemoteApplicationEvent}. * @param event {@link UserRemoteApplicationEvent} */ @EventListener diff --git a/spring-cloud-alibaba-nacos-config-server/src/test/java/com/alibaba/cloud/nacos/config/server/bootstrap/NacosConfigServerBootstrap.java b/spring-cloud-alibaba-nacos-config-server/src/test/java/com/alibaba/cloud/nacos/config/server/bootstrap/NacosConfigServerBootstrap.java index 2ff7dc1c2f..cba01073fc 100644 --- a/spring-cloud-alibaba-nacos-config-server/src/test/java/com/alibaba/cloud/nacos/config/server/bootstrap/NacosConfigServerBootstrap.java +++ b/spring-cloud-alibaba-nacos-config-server/src/test/java/com/alibaba/cloud/nacos/config/server/bootstrap/NacosConfigServerBootstrap.java @@ -23,7 +23,7 @@ import org.springframework.context.annotation.Bean; /** - * Nacos Config Server Bootstrap + * Nacos Config Server Bootstrap. * * @author Mercy * @since 0.2.0 diff --git a/spring-cloud-alibaba-nacos-discovery/src/test/java/com/alibaba/cloud/nacos/test/NacosMockTest.java b/spring-cloud-alibaba-nacos-discovery/src/test/java/com/alibaba/cloud/nacos/test/NacosMockTest.java index 684ab749d3..a541fd23fc 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/test/java/com/alibaba/cloud/nacos/test/NacosMockTest.java +++ b/spring-cloud-alibaba-nacos-discovery/src/test/java/com/alibaba/cloud/nacos/test/NacosMockTest.java @@ -24,7 +24,11 @@ /** * @author xiaojing */ -public class NacosMockTest { +public final class NacosMockTest { + + private NacosMockTest() { + + } public static Instance serviceInstance(String serviceName, boolean isHealthy, Map metadata) { diff --git a/spring-cloud-alibaba-sentinel/src/test/java/com/alibaba/cloud/sentinel/ContextIdSentinelFeignTests.java b/spring-cloud-alibaba-sentinel/src/test/java/com/alibaba/cloud/sentinel/ContextIdSentinelFeignTests.java index f6996fdbca..7bd67724bc 100644 --- a/spring-cloud-alibaba-sentinel/src/test/java/com/alibaba/cloud/sentinel/ContextIdSentinelFeignTests.java +++ b/spring-cloud-alibaba-sentinel/src/test/java/com/alibaba/cloud/sentinel/ContextIdSentinelFeignTests.java @@ -37,7 +37,7 @@ import static org.assertj.core.api.Assertions.assertThat; /** - * Add this unit test to verify https://github.com/alibaba/spring-cloud-alibaba/pull/838 + * Add this unit test to verify https://github.com/alibaba/spring-cloud-alibaba/pull/838. * * @author Jim */ diff --git a/spring-cloud-alicloud-ans/src/test/java/com/alibaba/alicloud/ans/test/AnsMockTest.java b/spring-cloud-alicloud-ans/src/test/java/com/alibaba/alicloud/ans/test/AnsMockTest.java index 694672f85f..0b18f41e39 100644 --- a/spring-cloud-alicloud-ans/src/test/java/com/alibaba/alicloud/ans/test/AnsMockTest.java +++ b/spring-cloud-alicloud-ans/src/test/java/com/alibaba/alicloud/ans/test/AnsMockTest.java @@ -23,7 +23,11 @@ /** * @author xiaojing */ -public class AnsMockTest { +public final class AnsMockTest { + + private AnsMockTest() { + + } public static Host hostInstance(String serviceName, boolean valid, Map metadata) { diff --git a/spring-cloud-alicloud-context/src/test/java/com/alibaba/alicloud/context/oss/OssAutoConfigurationTests.java b/spring-cloud-alicloud-context/src/test/java/com/alibaba/alicloud/context/oss/OssAutoConfigurationTests.java index 5195cbe030..0772e30e12 100644 --- a/spring-cloud-alicloud-context/src/test/java/com/alibaba/alicloud/context/oss/OssAutoConfigurationTests.java +++ b/spring-cloud-alicloud-context/src/test/java/com/alibaba/alicloud/context/oss/OssAutoConfigurationTests.java @@ -27,7 +27,7 @@ import static org.assertj.core.api.Assertions.assertThat; /** - * {@link OSS} {@link OssProperties} Test + * {@link OSS} {@link OssProperties} Test. * * @author Jim */