diff --git a/.circleci/config.yml b/.circleci/config.yml index cb0469bc..8fbf11a2 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -24,7 +24,7 @@ jobs: - ~/.m2 - run: name: "Running build" - command: ./mvnw -Pspring -Pdocs clean install cobertura:cobertura -U -nsu --batch-mode -Dmaven.test.redirectTestOutputToFile=true -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn + command: ./mvnw -Pspring -Pdocs clean install -U -nsu --batch-mode -Dmaven.test.redirectTestOutputToFile=true -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn - run: name: "Aggregate test results" when: always diff --git a/pom.xml b/pom.xml index 57652f34..bffa398f 100644 --- a/pom.xml +++ b/pom.xml @@ -8,7 +8,7 @@ org.springframework.cloud spring-cloud-build - 2.0.4.RELEASE + 2.1.2.RELEASE @@ -66,10 +66,10 @@ - 2.0.2.RELEASE - 2.0.2.RELEASE - 2.0.2.RELEASE - 2.0.0.RELEASE + 2.1.0.RELEASE + 2.1.0.RELEASE + 2.1.0.RELEASE + 2.1.0.RELEASE 4.12 3.0 @@ -81,8 +81,7 @@ 2.8.2 2.21.0 1.6 - 2.1.1 - 2.7 + 0.7.9 @@ -166,25 +165,10 @@ pom import - - net.sourceforge.cobertura - cobertura-runtime - ${cobertura.version} - provided - pom - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.apache.maven.plugins @@ -208,30 +192,25 @@ - org.codehaus.mojo - cobertura-maven-plugin - ${cobertura-maven-plugin.version} - - - org.ow2.asm - asm - 5.0.3 - - + org.jacoco + jacoco-maven-plugin + ${jacoco.version} - true - - html - xml - - - + target/coverage-reports/jacoco-unit.exec + target/coverage-reports/jacoco-unit.exec - package + jacoco-initialize - cobertura + prepare-agent + + + + jacoco-site + test + + report diff --git a/spring-cloud-alibaba-dependencies/pom.xml b/spring-cloud-alibaba-dependencies/pom.xml index 048078fe..1f7b2e0b 100644 --- a/spring-cloud-alibaba-dependencies/pom.xml +++ b/spring-cloud-alibaba-dependencies/pom.xml @@ -6,7 +6,7 @@ spring-cloud-dependencies-parent org.springframework.cloud - 2.0.4.RELEASE + 2.1.2.RELEASE @@ -17,10 +17,10 @@ Spring Cloud Alibaba Dependencies - 1.4.1 + 1.4.2 3.1.0 0.1.3 - 0.8.0 + 0.8.2 0.8.0 1.0.8 1.0.1 @@ -203,22 +203,6 @@ ${fescar.version} - - - com.aliyun.oss - aliyun-sdk-oss - ${oss.version} - - - - - com.alibaba - dubbo-dependencies-bom - ${dubbo.version} - pom - import - - com.alibaba @@ -254,6 +238,13 @@ ${dubbo-registry-nacos.version} + + + com.aliyun.oss + aliyun-sdk-oss + ${oss.version} + + org.springframework.cloud @@ -453,26 +444,4 @@ - - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - - - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - - - - + \ No newline at end of file diff --git a/spring-cloud-alibaba-docs/pom.xml b/spring-cloud-alibaba-docs/pom.xml index cb755091..87014d57 100644 --- a/spring-cloud-alibaba-docs/pom.xml +++ b/spring-cloud-alibaba-docs/pom.xml @@ -49,28 +49,5 @@ - - - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - - - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - - - diff --git a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/acm.adoc b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/acm.adoc index db4f4318..d5cc93a6 100644 --- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/acm.adoc +++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/acm.adoc @@ -6,7 +6,7 @@ Spring Cloud AliCloud ACM 是 Config Server 和 Client 的替代方案，客户 === 如何引入 Spring Cloud AliCloud ACM -Spring Cloud Alibaba 已经发布了 0.2.2.BUILD-SNAPSHOT 版本，需要首先导入依赖管理POM。 +Spring Cloud Alibaba 已经发布了 0.2.2.BUILD-SNAPSHOT 版本，需要首先导入依赖管理 POM。 [source,xml] ---- @@ -23,7 +23,7 @@ Spring Cloud Alibaba 已经发布了 0.2.2.BUILD-SNAPSHOT 版本，需要首先 ---- -接下来引入 Spring Cloud AliCloud ACM Starter 即可。 +并引入 Spring Cloud AliCloud ACM Starter 依赖。 [source,xml] ---- @@ -53,7 +53,7 @@ public class ProviderApplication { } ---- -既然需要从配置中心服务端获取配置信息，那么肯定需要配置服务端的地址，在 bootstrap.properties 中，还需要配置上以下信息。 +在从配置中心服务端获取配置信息之前，还需要配置服务端的地址，在 bootstrap.properties 中，还需要配置以下信息。 [source,properties] ---- @@ -68,18 +68,18 @@ spring.cloud.alicloud.acm.server-port=8080 NOTE: 此时没有启动配置中心，启动应用会报错，因此在应用启动之前，应当首先启动配置中心。 -=== 启动配置中心 +==== 启动配置中心 -ACM 使用的配置中心有两种，一种是完全免费的轻量版配置中心，主要用于开发和本地调试，一种是云上配置中心ACM。通常情况下，可以使用轻量版配置中心作为开发和测试环境，使用云上的 ACM 作为灰度和生产环境。 +ACM 使用的配置中心有两种，一种是本地运行的轻量版配置中心，主要用于开发和本地调试，一种是阿里云产品 ACM。通常情况下，可以使用轻量版配置中心作为开发和测试环境，使用云上的 ACM 作为灰度和生产环境。 -==== 启动轻量版配置中心 +===== 使用轻量版配置中心 -轻量版配置中心的下载和启动方式可参考 https://help.aliyun.com/document_detail/44163.html?spm=a2c4g.11186623.6.677.5f206b82Z2mTCF[这里] +轻量版配置中心的下载和启动方式可参考 https://help.aliyun.com/document_detail/44163.html[这里] -NOTE: 只需要进行第1步（下载轻量配置中心）和第2步（启动轻量配置中心）即可，第3步（配置hosts）在与 ACM 结合使用时，不需要操作。 +NOTE: 只需要执行文档中的第1步 (下载轻量配置中心) 和第2步 (启动轻量配置中心)。 -==== 使用云上配置中心 +===== 使用阿里云配置中心 使用云上 ACM ，可以省去服务端的维护工作，同时稳定性也会更有保障。当使用云上配置中心时，代码部分和使用轻量配置中心并没有区别，但是配置上会有一些区别。 @@ -88,7 +88,7 @@ NOTE: 只需要进行第1步（下载轻量配置中心）和第2步（启动轻 [source,properties] ---- # 应用名会被作为从服务端获取配置 key 的关键词组成部分，因此是必选 -spring.application.name=ans-provider +spring.application.name=acm-config # 端口配置自由配置即可 server.port=18081 # 以下就是配置中心的IP和端口配置 @@ -99,9 +99,9 @@ spring.cloud.alicloud.acm.endpoint=acm.aliyun.com spring.cloud.alicloud.acm.namespace=你的 ACM namespace，需要在 ACM 控制台查询 ---- -NOTE: EDAS 提供应用托管服务，如果你将应用托管到 EDAS，那么 EDAS 将会自动为你填充所有配置。 +NOTE: EDAS 提供应用托管服务，如果你将应用托管到 EDAS，那么 EDAS 将会自动为你填充所有与业务无关的配置。 -=== 在配置中心添加配置 +==== 在配置中心添加配置 1. 启动好轻量版配置中心之后，在控制台中添加如下的配置。 @@ -115,9 +115,9 @@ Content: user.name=james user.age=18 ---- -NOTE: DataId 的格式为 `{prefix}. {file-extension}`,prefix 默认从配置 spring.application.name 中取值，file-extension 默认的值为 "properties"。 +NOTE: DataId 的格式为 `{prefix}.{file-extension}`,prefix 默认从配置 spring.application.name 中取值，file-extension 默认的值为 "properties"。 -=== 启动应用验证 +==== 启动应用验证 启动这个Example，可以在控制台看到打印出的值正是我们在轻量版配置中心上预先配置的值。 @@ -133,16 +133,16 @@ spring-cloud-starter-alicloud-acm 中 DataId 默认的文件扩展名是 propert NOTE: 修改文件扩展名后，在配置中心中的 DataID 以及 Content 的格式都必须做相应的修改。 -=== 支持配置的动态更新 +=== 动态更新 -spring-cloud-starter-alicloud-acm 默认支持配置的动态更新，当您在配置中心修改配置的内容时，会触发 Spring 中的 Context Refresh 动作。 +spring-cloud-starter-alicloud-acm 默认支持配置的动态更新，当您在配置中心修改配置的内容时，会发布 Spring 中的 RefreshEvent 事件。 带有 @RefreshScope 和 @ConfigurationProperties 注解的类会自动刷新。 -NOTE: 你可以通过配置 spring.cloud.alicloud.acm.refresh.enabled=false 来关闭动态刷新 +NOTE: 你可以通过配置 spring.cloud.alicloud.acm.refresh.enabled=false 来关闭动态刷新。 -=== profile 粒度的配置 +=== Profile 粒度的配置 -spring-cloud-starter-alicloud-acm 在加载配置的时候，首先会尝试去加载 dataid 为{spring.application.name}.{file-extension}的配置，当设置了 spring.profiles.active 中配置有内容时，还会尝试依次去加载 spring.profile 对应的内容， dataid 的格式为{spring.application.name}-{profile}.{file-extension}的配置，且后者的优先级高于前者。 +spring-cloud-starter-alicloud-acm 在加载配置的时候，首先会加载 DataId 为{spring.application.name}.{file-extension}的配置，当 spring.profiles.active 中配置有内容时，还会依次去加载 spring.profile 对应的内容， DataId 的格式为{spring.application.name}-{profile}.{file-extension}的配置，且后者的优先级高于前者。 spring.profiles.active 属于配置的元数据，所以也必须配置在 bootstrap.properties 或 bootstrap.yaml 中。比如可以在 bootstrap.properties 中增加如下内容。 @@ -154,8 +154,11 @@ spring.profiles.active={profile-name} Note: 也可以通过 JVM 参数 -Dspring.profiles.active=develop 或者 --spring.profiles.active=develop 这类优先级更高的方式来配置，只需遵循 Spring Boot 规范即可。 +=== 自定义配置中心超时时间 -=== 支持自定义 Group 的配置 +ACM Client 与 Server 通信的超时时间默认是 3000ms，可以通过 `spring.cloud.alicloud.acm.timeout` 来修改超时时间，单位为 ms 。 + +=== 自定义 Group 的配置 在没有明确指定 `{spring.cloud.alicloud.acm.group}` 配置的情况下， 默认使用的是 DEFAULT_GROUP 。如果需要自定义自己的 Group，可以通过以下配置来实现： @@ -164,9 +167,9 @@ Note: 也可以通过 JVM 参数 -Dspring.profiles.active=develop 或者 --sprin spring.cloud.alicloud.acm.group=DEVELOP_GROUP ---- -NOTE: 该配置必须放在 bootstrap.properties 文件中。并且在添加配置时 Group 的值一定要和 `spring.cloud.alicloud.acm.group` 的配置值一致。 +NOTE: 该配置必须放在 bootstrap.properties 文件中。并且在添加配置时 Group 的值要和 `spring.cloud.alicloud.acm.group` 的配置值一致。 -==== 支持共享配置 +=== 共享配置 ACM 提供了一种多个应用之间共享配置中心的同一个配置的推荐方式，供多个应用共享一些配置时使用，您在使用的时候需要添加在 bootstrap 中添加一个配置项 `spring.application.group`。 @@ -175,11 +178,14 @@ ACM 提供了一种多个应用之间共享配置中心的同一个配置的推 spring.application.group=company.department.team ---- -这时你的应用在获取之前提到的自身所独有的配置之前，会先依次从这些 DataId 去获取，分别是 company:application.properties, company.department:application.properties, company.department.team:application.properties。 -然后，还会从 {spring.application.group}:{spring.application.name}.{file-extension} 中获取 -越往后优先级越高，最高的仍然是应用自身所独有的配置。 +这时应用在获取上文提到的自身所独有的配置之前，会先依次从这些 DataId 去获取，分别是 company:application.properties, company.department:application.properties, company.department.team:application.properties。 +然后，还会从 {spring.application.group}:{spring.application.name}.{file-extension} 中获取，越往后优先级越高，最高的仍然是应用自身所独有的配置。 NOTE: 共享配置中 DataId 默认后缀为 properties，可以通过 spring.cloud.alicloud.acm.file-extension 配置. `{spring.application.group}:{spring.application.name}.{file-extension}` 。 NOTE: 如果设置了 `spring.profiles.active` ，DataId 的格式还支持 `{spring.application.group}:{spring.application.name}-{spring.profiles.active}.{file-extension}`。优先级高于 `{spring.application.group}:{spring.application.name}.{file-extension}` + +=== Actuator 监控 + +ACM 对应的 Actuator 监控地址为 `/acm`，其中 config 代表了 ACM 元数据配置的信息，`runtime.sources` 对应的是从 ACM 服务端获取的配置的信息及最后刷新时间， `runtime.refreshHistory` 对应的是动态刷新的历史记录。 \ No newline at end of file diff --git a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/nacos-discovery.adoc b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/nacos-discovery.adoc index bd88310a..57b3a656 100644 --- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/nacos-discovery.adoc +++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/nacos-discovery.adoc @@ -261,9 +261,9 @@ public class NacosConsumerApp { public String echoAppName(){ //使用 LoadBalanceClient 和 RestTemolate 结合的方式来访问 ServiceInstance serviceInstance = loadBalancerClient.choose("nacos-provider"); - String url = String.format("http://%s:%s/echo/%s",serviceInstance.getHost(),serviceInstance.getPort(),appName); - System.out.println("request url:"+url); - return restTemplate.getForObject(url,String.class); + String path = String.format("http://%s:%s/echo/%s",serviceInstance.getHost(),serviceInstance.getPort(),appName); + System.out.println("request path:"+path); + return restTemplate.getForObject(path,String.class); } } diff --git a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc index 5d106bd3..b0a5fb45 100644 --- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc +++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc @@ -100,7 +100,7 @@ spring: ### Feign 支持 -Sentinel 适配了 https://github.com/OpenFeign/feign[Feign] 组件。如果想使用，除了引入 `sentinel-starter` 的依赖外还需要 3 个步骤： +Sentinel 适配了 https://github.com/OpenFeign/feign[Feign] 组件。如果想使用，除了引入 `sentinel-starter` 的依赖外还需要 2 个步骤： * 配置文件打开 sentinel 对 feign 的支持：`feign.sentinel.enabled=true` * 加入 `feign starter` 依赖触发 `sentinel starter` 的配置类生效： @@ -110,15 +110,8 @@ Sentinel 适配了 https://github.com/OpenFeign/feign[Feign] 组件。如果想 spring-cloud-starter-openfeign ``` -* `feign` 内部的 `loadbalance` 功能依赖 Netflix 的 `ribbon` 模块(如果不使用 `loadbalance` 功能可不引入)： -```xml - - org.springframework.cloud - spring-cloud-starter-netflix-ribbon - -``` -这是一个 `FeignClient` 对应的接口： +这是一个 `FeignClient` 的简单使用示例： ```java @FeignClient(name = "service-provider", fallback = EchoServiceFallback.class, configuration = FeignConfiguration.class) @@ -142,12 +135,10 @@ class EchoServiceFallback implements EchoService { } ``` -NOTE: Feign 对应的接口中的资源名策略定义：httpmethod:protocol://requesturl +NOTE: Feign 对应的接口中的资源名策略定义：httpmethod:protocol://requesturl。`@FeignClient` 注解中的所有属性，Sentinel 都做了兼容。 `EchoService` 接口中方法 `echo` 对应的资源名为 `GET:http://service-provider/echo/{str}`。 -请注意：`@FeignClient` 注解中的所有属性，Sentinel 都做了兼容。 - ### RestTemplate 支持 Spring Cloud Alibaba Sentinel 支持对 `RestTemplate` 的服务调用使用 Sentinel 进行保护，在构造 `RestTemplate` bean的时候需要加上 `@SentinelRestTemplate` 注解。 @@ -160,14 +151,13 @@ public RestTemplate restTemplate() { } ``` -`@SentinelRestTemplate` 注解的参数支持限流(`blockHandler`, `blockHandlerClass`)和降级(`fallback`, `fallbackClass`)的处理。 +`@SentinelRestTemplate` 注解的属性支持限流(`blockHandler`, `blockHandlerClass`)和降级(`fallback`, `fallbackClass`)的处理。 -其中 `blockHandler` 或 `fallback` 对应的方法必须是对应 `blockHandlerClass` 或 `fallbackClass` 中的静态方法。 +其中 `blockHandler` 或 `fallback` 属性对应的方法必须是对应 `blockHandlerClass` 或 `fallbackClass` 属性中的静态方法。 -该注解对应的方法参数跟 `ClientHttpRequestInterceptor` 接口中的参数一致，并多出了一个 `BlockException` 参数，且返回值是 `ClientHttpResponse`。 -被限流后如果不继续执行后面的 Http 请求拦截器，则可以通过 `SentinelClientHttpResponse` 的一个实例来自定义被限流后的返回值结果。 +该方法的参数跟返回值跟 `org.springframework.http.client.ClientHttpRequestInterceptor#interceptor` 方法一致，其中参数多出了一个 `BlockException` 参数用于获取 Sentinel 捕获的异常。 -比如上述 `ExceptionUtil` 的 `handleException` 方法对应的声明如下： +比如上述 `@SentinelRestTemplate` 注解中 `ExceptionUtil` 的 `handleException` 属性对应的方法声明如下： ```java public class ExceptionUtil { @@ -177,7 +167,11 @@ public class ExceptionUtil { } ``` -`@SentinelRestTemplate` 注解的限流(`blockHandler`, `blockHandlerClass`)和降级(`fallback`, `fallbackClass`)不强制填写，当被 Sentinel 熔断后，会返回 `RestTemplate request block by sentinel` 信息，或者也可以填写对应的方法自行处理。 +NOTE: 应用启动的时候会检查 `@SentinelRestTemplate` 注解对应的限流或降级方法是否存在，如不存在会抛出异常 + +`@SentinelRestTemplate` 注解的限流(`blockHandler`, `blockHandlerClass`)和降级(`fallback`, `fallbackClass`)属性不强制填写。 + +当使用 `RestTemplate` 调用被 Sentinel 熔断后，会返回 `RestTemplate request block by sentinel` 信息，或者也可以编写对应的方法自行处理返回信息。这里提供了 `SentinelClientHttpResponse` 用于构造返回信息。 Sentinel RestTemplate 限流的资源规则提供两种粒度： @@ -189,98 +183,45 @@ NOTE: 以 `https://www.taobao.com/test` 这个 url 为例。对应的资源名 ### 动态数据源支持 -#### 在我们的第一个版本 0.2.0.RELEASE 或 0.1.0.RELEASE 中的使用方式 +`SentinelProperties` 内部提供了 `TreeMap` 类型的 `datasource` 属性用于配置数据源信息。 -需要3个步骤才可完成数据源的配置： - -* 配置文件中定义数据源信息。比如使用文件： - -.application.properties ----- -spring.cloud.sentinel.datasource.type=file -spring.cloud.sentinel.datasource.recommendRefreshMs=3000 -spring.cloud.sentinel.datasource.bufSize=4056196 -spring.cloud.sentinel.datasource.charset=utf-8 -spring.cloud.sentinel.datasource.converter=flowConverter -spring.cloud.sentinel.datasource.file=/Users/you/yourrule.json ----- - -* 创建一个 Converter 类实现 `com.alibaba.csp.sentinel.datasource.Converter` 接口，并且需要在 `ApplicationContext` 中有该类的一个 Bean - -```java -@Component("flowConverter") -public class JsonFlowRuleListParser implements Converter> { - @Override - public List convert(String source) { - return JSON.parseObject(source, new TypeReference>() { - }); - } -} -``` - -这个 Converter 的 bean name 需要跟 `application.properties` 配置文件中的 converter 配置一致 - -* 在任意一个 Spring Bean 中定义一个被 `@SentinelDataSource` 注解修饰的 `ReadableDataSource` 属性 - -```java -@SentinelDataSource("spring.cloud.sentinel.datasource") -private ReadableDataSource dataSource; -``` - -`@SentinelDataSource` 注解的 value 属性表示数据源在 `application.properties` 配置文件中前缀。 该在例子中，前缀为 `spring.cloud.sentinel.datasource` 。 - -如果 `ApplicationContext` 中存在超过1个 `ReadableDataSource` bean，那么不会加载这些 `ReadableDataSource` 中的任意一个。 只有在 `ApplicationContext` 存在一个 `ReadableDataSource` 的情况下才会生效。 - -如果数据源生效并且规则成功加载，控制台会打印类似如下信息： - -``` -[Sentinel Starter] load 3 flow rules -``` - -#### 后续版本的使用方式 - -只需要1个步骤就可完成数据源的配置： - -* 直接在 `application.properties` 配置文件中配置数据源信息即可 - -比如配置了4个数据源： +比如配置 4 个数据源： ``` spring.cloud.sentinel.datasource.ds1.file.file=classpath: degraderule.json +spring.cloud.sentinel.datasource.ds1.file.rule-type=flow + +#spring.cloud.sentinel.datasource.ds1.file.file=classpath: flowrule.json +#spring.cloud.sentinel.datasource.ds1.file.data-type=custom +#spring.cloud.sentinel.datasource.ds1.file.converter-class=org.springframework.cloud.alibaba.cloud.examples.JsonFlowRuleListConverter +#spring.cloud.sentinel.datasource.ds1.file.rule-type=flow spring.cloud.sentinel.datasource.ds2.nacos.server-addr=localhost:8848 spring.cloud.sentinel.datasource.ds2.nacos.dataId=sentinel spring.cloud.sentinel.datasource.ds2.nacos.groupId=DEFAULT_GROUP spring.cloud.sentinel.datasource.ds2.nacos.data-type=json +spring.cloud.sentinel.datasource.ds2.nacos.rule-type=degrade spring.cloud.sentinel.datasource.ds3.zk.path = /Sentinel-Demo/SYSTEM-CODE-DEMO-FLOW spring.cloud.sentinel.datasource.ds3.zk.server-addr = localhost:2181 +spring.cloud.sentinel.datasource.ds3.zk.rule-type=authority spring.cloud.sentinel.datasource.ds4.apollo.namespace-name = application spring.cloud.sentinel.datasource.ds4.apollo.flow-rules-key = sentinel spring.cloud.sentinel.datasource.ds4.apollo.default-flow-rule-value = test +spring.cloud.sentinel.datasource.ds5.apollo.rule-type=param-flow ``` -这样配置方式参考了 Spring Cloud Stream Binder 的配置，内部使用了 `TreeMap` 进行存储，comparator 为 `String.CASE_INSENSITIVE_ORDER` 。 +这种配置方式参考了 Spring Cloud Stream Binder 的配置，内部使用了 `TreeMap` 进行存储，comparator 为 `String.CASE_INSENSITIVE_ORDER` 。 -NOTE: d1, ds2, ds3, ds4 是 `ReadableDataSource` 的名字，可随意编写。后面的 `file` ，`zk` ，`nacos` , `apollo` 就是对应具体的数据源。 它们后面的配置就是这些数据源各自的配置。 +NOTE: d1, ds2, ds3, ds4 是 `ReadableDataSource` 的名字，可随意编写。后面的 `file` ，`zk` ，`nacos` , `apollo` 就是对应具体的数据源。 它们后面的配置就是这些具体数据源各自的配置。 -每种数据源都有两个共同的配置项： `data-type` 和 `converter-class` 。 +每种数据源都有两个共同的配置项： `data-type`、 `converter-class` 以及 `rule-type`。 -`data-type` 配置项表示 `Converter`，Spring Cloud Alibaba Sentinel 默认提供两种内置的值，分别是 `json` 和 `xml` (不填默认是json)。 如果不想使用内置的 `json` 或 `xml` 这两种 `Converter`，可以填写 `custom` 表示自定义 `Converter`，然后再配置 `converter-class` 配置项，该配置项需要写类的全路径名。 +`data-type` 配置项表示 `Converter` 类型，Spring Cloud Alibaba Sentinel 默认提供两种内置的值，分别是 `json` 和 `xml` (不填默认是json)。 如果不想使用内置的 `json` 或 `xml` 这两种 `Converter`，可以填写 `custom` 表示自定义 `Converter`，然后再配置 `converter-class` 配置项，该配置项需要写类的全路径名(比如 `spring.cloud.sentinel.datasource.ds1.file.converter-class=org.springframework.cloud.alibaba.cloud.examples.JsonFlowRuleListConverter`)。 -这两种内置的 `Converter` 只支持解析 json 数组 或 xml 数组。内部解析的时候会自动判断每个 json 对象或xml对象属于哪4种 Sentinel 规则(`FlowRule`，`DegradeRule`，`SystemRule`，`AuthorityRule`, `ParamFlowRule`)。 - -比如10个规则数组里解析出5个限流规则和5个降级规则。 这种情况下该数据源不会注册，日志里页会进行警告。 - -如果10个规则里有9个限流规则，1个解析报错了。这种情况下日志会警告有个规则格式错误，另外9个限流规则会注册上去。 - -这里 json 或 xml 解析用的是 `jackson`。`ObjectMapper` 或 `XmlMapper` 使用默认的配置，遇到不认识的字段会解析报错。 因为不这样做的话限流 json 也会解析成 系统规则(系统规则所有的配置都有默认值)，所以需要这样严格解析。 - -当然还有一种情况是 json 对象或 xml 对象可能会匹配上所有4种规则(比如json对象里只配了 `resource` 字段，那么会匹配上4种规则)，这种情况下日志里会警告，并且过滤掉这个对象。 - -用户使用这种配置的时候只需要填写正确的json或xml就行，有任何不合理的信息都会在日志里打印出来。 +`rule-type` 配置表示该数据源中的规则属于哪种类型的规则(`flow`，`degrade`，`authority`，`system`, `param-flow`)。 如果数据源生效并且规则成功加载，控制台会打印类似如下信息： @@ -289,6 +230,8 @@ NOTE: d1, ds2, ds3, ds4 是 `ReadableDataSource` 的名字，可随意编写。 [Sentinel Starter] DataSource ds2-sentinel-nacos-datasource load 2 FlowRule ``` +NOTE: 当某个数据源规则信息加载失败的情况下，不会影响应用的启动，会在日志中打印出错误信息。 + NOTE: 默认情况下，xml 格式是不支持的。需要添加 `jackson-dataformat-xml` 依赖后才会自动生效。 关于 Sentinel 动态数据源的实现原理，参考： https://github.com/alibaba/Sentinel/wiki/%E5%8A%A8%E6%80%81%E8%A7%84%E5%88%99%E6%89%A9%E5%B1%95[动态规则扩展] @@ -300,6 +243,8 @@ NOTE: 默认情况下，xml 格式是不支持的。需要添加 `jackson-datafo * Spring Boot 1.x 中添加配置 `management.security.enabled=false`。暴露的 endpoint 路径为 `/sentinel` * Spring Boot 2.x 中添加配置 `management.endpoints.web.exposure.include=*`。暴露的 endpoint 路径为 `/actuator/sentinel` +Sentinel Endpoint 里暴露的信息非常有用。包括当前应用的所有规则信息、日志目录、当前实例的 IP，Sentinel Dashboard 地址，Block Page，应用与 Sentinel Dashboard 的心跳频率等等信息。 + ### More 下表显示当应用的 `ApplicationContext` 中存在对应的Bean的类型时，会进行的一些操作： @@ -310,6 +255,7 @@ NOTE: 默认情况下，xml 格式是不支持的。需要添加 `jackson-datafo ^|存在Bean的类型 ^|操作 ^|作用 |`UrlCleaner`|`WebCallbackManager.setUrlCleaner(urlCleaner)`|资源清理(资源（比如将满足 /foo/:id 的 URL 都归到 /foo/* 资源下）) |`UrlBlockHandler`|`WebCallbackManager.setUrlBlockHandler(urlBlockHandler)`|自定义限流处理逻辑 +|`RequestOriginParser`|`WebCallbackManager.setRequestOriginParser(requestOriginParser)`|设置来源信息 |==== 下表显示 Spring Cloud Alibaba Sentinel 的所有配置信息： @@ -322,14 +268,17 @@ NOTE: 默认情况下，xml 格式是不支持的。需要添加 `jackson-datafo |`spring.cloud.sentinel.eager`|取消Sentinel控制台懒加载|false |`spring.cloud.sentinel.transport.port`|应用与Sentinel控制台交互的端口，应用本地会起一个该端口占用的HttpServer|8721 |`spring.cloud.sentinel.transport.dashboard`|Sentinel 控制台地址| -|`spring.cloud.sentinel.transport.heartbeatIntervalMs`|应用与Sentinel控制台的心跳间隔时间| +|`spring.cloud.sentinel.transport.heartbeat-interval-ms`|应用与Sentinel控制台的心跳间隔时间| +|`spring.cloud.sentinel.transport.client-ip`|客户端IP| |`spring.cloud.sentinel.filter.order`|Servlet Filter的加载顺序。Starter内部会构造这个filter|Integer.MIN_VALUE -|`spring.cloud.sentinel.filter.spring.url-patterns`|数据类型是数组。表示Servlet Filter的url pattern集合|/* +|`spring.cloud.sentinel.filter.url-patterns`|数据类型是数组。表示Servlet Filter的url pattern集合|/* |`spring.cloud.sentinel.metric.charset`|metric文件字符集|UTF-8 -|`spring.cloud.sentinel.metric.fileSingleSize`|Sentinel metric 单个文件的大小| -|`spring.cloud.sentinel.metric.fileTotalCount`|Sentinel metric 总文件数量| +|`spring.cloud.sentinel.metric.file-single-size`|Sentinel metric 单个文件的大小| +|`spring.cloud.sentinel.metric.file-total-count`|Sentinel metric 总文件数量| |`spring.cloud.sentinel.log.dir`|Sentinel 日志文件所在的目录| |`spring.cloud.sentinel.log.switch-pid`|Sentinel 日志文件名是否需要带上pid|false -|`spring.cloud.sentinel.servlet.blockPage`| 自定义的跳转 URL，当请求被限流时会自动跳转至设定好的 URL | -|`spring.cloud.sentinel.flow.coldFactor`| https://github.com/alibaba/Sentinel/wiki/%E9%99%90%E6%B5%81---%E5%86%B7%E5%90%AF%E5%8A%A8[冷启动因子] |3 +|`spring.cloud.sentinel.servlet.block-page`| 自定义的跳转 URL，当请求被限流时会自动跳转至设定好的 URL | +|`spring.cloud.sentinel.flow.cold-factor`| https://github.com/alibaba/Sentinel/wiki/%E9%99%90%E6%B5%81---%E5%86%B7%E5%90%AF%E5%8A%A8[冷启动因子] |3 |==== + +NOTE: 请注意。这些配置只有在 Servlet 环境下才会生效，RestTemplate 和 Feign 针对这些配置都无法生效 \ No newline at end of file diff --git a/spring-cloud-alibaba-docs/src/main/asciidoc/acm.adoc b/spring-cloud-alibaba-docs/src/main/asciidoc/acm.adoc index 0e823577..41fdef33 100644 --- a/spring-cloud-alibaba-docs/src/main/asciidoc/acm.adoc +++ b/spring-cloud-alibaba-docs/src/main/asciidoc/acm.adoc @@ -6,7 +6,7 @@ Spring Cloud Alibaba Cloud ACM is an alternative solution for Config Server and === How to Introduce Spring Cloud Alibaba Cloud ACM -We’ve released Spring Cloud Alibaba version 0.2.1. You will need to add dependency management POM first. +We’ve released Spring Cloud Alibaba version 0.2.2.BUILD-SNAPSHOT. You will need to add dependency management POM first. [source,xml] ---- @@ -68,18 +68,18 @@ spring.cloud.alicloud.acm.server-port=8080 NOTE: By now the configuration center is not started yet, so you will get an error message if your application is started. Therefore, start the configuration center before you start your application. -=== Start Configuration Center +==== Start Configuration Center -ACM uses two types of configuration centers. One is a lightweight configuration center which is totally free, the other is ACM which is used on Alibaba Cloud. Generally, you can use the lightweight version for application development and local testing, and use ACM for canary deployment or production. +ACM uses two types of configuration centers. One is lightweight configuration center, the other is ACM which is used on Alibaba Cloud. Generally, you can use the lightweight version for application development and local testing, and use ACM for canary deployment or production. -==== Start Lightweight Configuration Center +===== Use Lightweight Configuration Center Refer to the https://help.aliyun.com/document_detail/44163.html[Configure Lightweight Configuration Center] for details about how to download and install lightweight configuration center. -NOTE: You only need to perform step 1(Download lightweight configuration center) and step 2(Start lightweight configuration center). Step 3(Configure hosts) is not required if you use ACM at the same time. +NOTE: You only need to perform step 1(Download lightweight configuration center) and step 2(Start lightweight configuration center). -==== Use ACM on the Cloud +===== Use ACM on the Alibaba Cloud Using ACM on the cloud saves you from the tedious work of server maintenance while at the same time provides a better stability. There is no difference at the code level between using ACM on cloud and lightweight configuration center, but there are some differences in configurations. @@ -88,7 +88,7 @@ The following is a simple sample of using ACM. You can view configuration detail [source,properties] ---- # The application name will be used as part of the keyword to obtain configuration key from the server, and is mandatory. -spring.application.name=ans-provider +spring.application.name=acm-config # Configure your own port number server.port=18081 # The following is the IP and port number of the configuration center. @@ -99,9 +99,9 @@ spring.cloud.alicloud.acm.endpoint=acm.aliyun.com spring.cloud.alicloud.acm.namespace=Your ACM namespace(You can find the namespace on the ACM console) ---- -NOTE: EDAS provides application hosting service and will fill in all configurations automatically for the hosted applications. +NOTE: EDAS provides application hosting service and will fill in all configurations about ACM automatically for the hosted applications. -=== Add Configuration in the Configuration Center +==== Add Configuration in the Configuration Center 1. After you start the lightweight configuration center, add the following configuration on the console. @@ -117,7 +117,7 @@ Content: user.name=james NOTE: The format of dataId is `{prefix}. {file-extension}`. “prefix” is obtained from spring.application.name by default, and the value of “file-extension” is "properties” by default. -=== Start Application Verification +==== Start Application Verification Start the following example and you can see that the value printed on the console is the value we configured in the lightweight configuration center. @@ -133,16 +133,16 @@ You can set the file extension using spring.cloud.alicloud.acm.file-extension. J NOTE: After you change the file extension, you need to make corresponding format changes in the DataID and content of the configuration center. -=== Dynamic Configuration Updates +=== Dynamic Configuration Refresh -spring-cloud-starter-alicloud-acm supports dynamic configuration updates. Context Refresh in Spring is triggered when you update configuration in the configuration center. -All classes with @RefreshScope and @ConfigurationProperties annotations will be refershed automatically. +spring-cloud-starter-alicloud-acm supports dynamic configuration updates. RefreshEvent in Spring is published when you update configuration in the configuration center. +All classes with @RefreshScope and @ConfigurationProperties annotations will be refreshed automatically. NOTE: You can disable automatic refresh by this setting: spring.cloud.alicloud.acm.refresh.enabled=false === Configure Profile Granularity -When configuration is loaded by spring-cloud-starter-alicloud-acm, configuration with dataid {spring.application.name}. {file-extension} will be loaded first. If there is content in spring.profiles.active, the content of spring.profile, and configuration with the dataid format of{spring.application.name}-{profile}. {file-extension} will also be loaded in turn, and the latter has higher priority. +When configuration is loaded by spring-cloud-starter-alicloud-acm, configuration with DataId {spring.application.name}. {file-extension} will be loaded first. If there is content in spring.profiles.active, the content of spring.profile, and configuration with the dataid format of{spring.application.name}-{profile}. {file-extension} will also be loaded in turn, and the latter has higher priority. spring.profiles.active is the configuration metadata, and should also be configured in bootstrap.properties or bootstrap.yaml. For example, you can add the following content in bootstrap.properties. @@ -154,6 +154,10 @@ spring.profiles.active={profile-name} Note: You can also configure the granularity through JVM parameters such as -Dspring.profiles.active=develop or --spring.profiles.active=develop, which have higher priority. Just follow the specifications of Spring Boot. +=== Support Custom ACM Timeout + +the default timeout of ACM client get config from sever is 3000 ms . If you need to define a timeout, set configuration `spring.cloud.alicloud.acm.timeout`,the unit is millisecond. + === Support Custom Group Configurations @@ -183,3 +187,7 @@ The later in order, the higer the priority, and the unique configuration of the NOTE: The default suffix of DataId is properties, and you can change it using spring.cloud.alicloud.acm.file-extension. `{spring.application.group}: {spring.application.name}. {file-extension}` 。 NOTE: If you configured `spring.profiles.active` , then the DataId format of `{spring.application.group}: {spring.application.name}-{spring.profiles.active}. {file-extension}` is also supported, and has higher priority than `{spring.application.group}: {spring.application.name}. {file-extension}` + +=== Actuator Endpoint + +the Actuator endpoint of ACM is `/acm`, `config` represents the ACM metadata configuration information, `runtime.sources` corresponds to the configuration information obtained from the ACM server and the last refresh time, `runtime.refreshHistory` corresponds to the dynamic refresh history. \ No newline at end of file diff --git a/spring-cloud-alibaba-docs/src/main/asciidoc/dependency-management.adoc b/spring-cloud-alibaba-docs/src/main/asciidoc/dependency-management.adoc index 07b4dd40..ac027a63 100644 --- a/spring-cloud-alibaba-docs/src/main/asciidoc/dependency-management.adoc +++ b/spring-cloud-alibaba-docs/src/main/asciidoc/dependency-management.adoc @@ -29,7 +29,7 @@ If you want to use the latest BUILD-SNAPSHOT version, add Spring Snapshot Reposi spring-snapshot Spring Snapshot Repository - https://repo.spring.io/snapshot + https://repo.spring.io/snapshot true diff --git a/spring-cloud-alibaba-docs/src/main/asciidoc/nacos-discovery.adoc b/spring-cloud-alibaba-docs/src/main/asciidoc/nacos-discovery.adoc index 44f2222f..21f0b144 100644 --- a/spring-cloud-alibaba-docs/src/main/asciidoc/nacos-discovery.adoc +++ b/spring-cloud-alibaba-docs/src/main/asciidoc/nacos-discovery.adoc @@ -261,9 +261,9 @@ public class NacosConsumerApp { public String echoAppName(){ //Access through the combination of LoadBalanceClient and RestTemolate ServiceInstance serviceInstance = loadBalancerClient.choose("nacos-provider"); - String url = String.format("http://%s:%s/echo/%s",serviceInstance.getHost(),serviceInstance.getPort(),appName); - System.out.println("request url:" +url); - return restTemplate.getForObject(url,String.class); + String path = String.format("http://%s:%s/echo/%s",serviceInstance.getHost(),serviceInstance.getPort(),appName); + System.out.println("request path:" +path); + return restTemplate.getForObject(path,String.class); } } diff --git a/spring-cloud-alibaba-docs/src/main/asciidoc/sentinel.adoc b/spring-cloud-alibaba-docs/src/main/asciidoc/sentinel.adoc index 40478e4b..d5e6d03a 100644 --- a/spring-cloud-alibaba-docs/src/main/asciidoc/sentinel.adoc +++ b/spring-cloud-alibaba-docs/src/main/asciidoc/sentinel.adoc @@ -100,7 +100,7 @@ For more information about Sentinel dashboard, please refer to https://github.co ### Feign Support -Sentinel is compatible with the https://github.com/OpenFeign/feign[Feign] component. To use it, in addition to introducing the `sentinel-starter` dependency, complete the following 3 steps: +Sentinel is compatible with the https://github.com/OpenFeign/feign[Feign] component. To use it, in addition to introducing the `sentinel-starter` dependency, complete the following 2 steps: * Enable the Sentinel support for feign in the properties file. `feign.sentinel.enabled=true` * Add the `feign starter` dependency to trigger and enable `sentinel starter`: @@ -110,15 +110,8 @@ Sentinel is compatible with the https://github.com/OpenFeign/feign[Feign] compon spring-cloud-starter-openfeign ``` -* The `loadbalance` in `feign` is dependent on the `ribbon` module of Netflix (You do not need to introduce it if `loadbalance` is not used)： -```xml - - org.springframework.cloud - spring-cloud-starter-netflix-ribbon - -``` -This is an interface for `FeignClient`: +This is a simple usage of `FeignClient`: ```java @FeignClient(name = "service-provider", fallback = EchoServiceFallback.class, configuration = FeignConfiguration.class) @@ -142,12 +135,10 @@ class EchoServiceFallback implements EchoService { } ``` -NOTE: The resource name policy in the corresponding interface of Feign is：httpmethod:protocol://requesturl +NOTE: The resource name policy in the corresponding interface of Feign is：httpmethod:protocol://requesturl. All the attributes in the `@FeignClient` annotation is supported by Sentinel. The corresponding resource name of the `echo` method in the `EchoService` interface is `GET:http://service-provider/echo/{str}`. -Note: All the attributes in the `@FeignClient` annotation is supported by Sentinel. - ### RestTemplate Support Spring Cloud Alibaba Sentinel supports the protection of `RestTemplate` service calls using Sentinel. To do this, you need to add the `@SentinelRestTemplate` annotation when constructing the `RestTemplate` bean. @@ -160,14 +151,13 @@ public RestTemplate restTemplate() { } ``` -The parameter of the `@SentinelRestTemplate` annotation support flow control(`blockHandler`, `blockHandlerClass`) and circuit breaking(`fallback`, `fallbackClass`). +The attribute of the `@SentinelRestTemplate` annotation support flow control(`blockHandler`, `blockHandlerClass`) and circuit breaking(`fallback`, `fallbackClass`). == The `blockHandler` or `fallback` is the static method of `blockHandlerClass` or `fallbackClass`. -The parameter of method in `@SentinelRestTemplate` is same as `ClientHttpRequestInterceptor`, but it has one more parameter `BlockException` and its value of return type should be `ClientHttpResponse`. -If you do not continue to execute the following Http request interceptor after being restricted, you can use the instance of `SentinelClientHttpResponse` to customize the return value result after the current limit. +The parameter and return value of method in `@SentinelRestTemplate` is same as `org.springframework.http.client.ClientHttpRequestInterceptor#interceptor`, but it has one more parameter `BlockException` to catch the exception by Sentinel. The method signature of `handleException` in `ExceptionUtil` above should be like this: @@ -179,7 +169,11 @@ public class ExceptionUtil { } ``` -It will return `RestTemplate request block by sentinel` when you do not write any flow control(`blockHandler`, `blockHandlerClass`) configuration or circuit breaking configuration(`fallback`, `fallbackClass`), you can override it by using your own method. +NOTE: When the application starts, it will check if the `@SentinelRestTemplate` annotation corresponding to the flow control or circuit breaking method exists, if it does not exist, it will throw an exception. + +The attribute of the `@SentinelRestTemplate` annotation is optional. + +It will return `RestTemplate request block by sentinel` when you using `RestTemplate` blocked by Sentinel. You can override it by your own logic. We provide `SentinelClientHttpResponse` to handle the response. Sentinel RestTemplate provides two granularities for resource rate limiting: @@ -191,98 +185,44 @@ NOTE: Take `https://www.taobao.com/test` as an example. The corresponding resour ### Dynamic Data Source Support -#### The usage of our first version 0.2.0.RELEASE or 0.1.0.RELEASE - -you need to complete the following 3 steps to configure your data source. - -* Define the data source information in your properties file. For example, you can use: - -.application.properties ----- -spring.cloud.sentinel.datasource.type=file -spring.cloud.sentinel.datasource.recommendRefreshMs=3000 -spring.cloud.sentinel.datasource.bufSize=4056196 -spring.cloud.sentinel.datasource.charset=utf-8 -spring.cloud.sentinel.datasource.converter=flowConverter -spring.cloud.sentinel.datasource.file=/Users/you/yourrule.json ----- - -* Create a Converter class to implement the `com.alibaba.csp.sentinel.datasource.Converter` interface, and you need to have a bean of this class in `ApplicationContext`. - -```java -@Component("flowConverter") -public class JsonFlowRuleListParser implements Converter> { - @Override - public List convert(String source) { - return JSON.parseObject(source, new TypeReference>() { - }); - } -} -``` - -The bean name of this Converter needs to be the same with the converter in the `application.properties` file. - -* Define a `ReadableDataSource` attribute that is modified by the `@SentinelDataSource` annotation in any Spring Bean `@SentinelDataSource`. - -```java -@SentinelDataSource("spring.cloud.sentinel.datasource") -private ReadableDataSource dataSource; -``` - -The value attribute of `@SentinelDataSource` means that the data source is in the prefix of the `application.properties` file. In this example, the prefix is `spring.cloud.sentinel.datasource`. - -If there are over 1 `ReadableDataSource` beans in `ApplicationContext`, then none of the data sources in `ReadableDataSource` will be loaded. It takes effect only when there is only 1 `ReadableDataSource` in `ApplicationContext`. - -If the data source takes effect and is loaded successfully, the dashboard will print information as shown below: - -``` -[Sentinel Starter] load 3 flow rules -``` - -#### The usage after first version - -You only need to complete 1 step to configure your data source: - -* Configure your data source in the `application.properties` file directly. +`SentinelProperties` provide `datasource` attribute to configure datasource. For example, 4 data sources are configures： ``` spring.cloud.sentinel.datasource.ds1.file.file=classpath: degraderule.json +spring.cloud.sentinel.datasource.ds1.file.rule-type=flow + +#spring.cloud.sentinel.datasource.ds1.file.file=classpath: flowrule.json +#spring.cloud.sentinel.datasource.ds1.file.data-type=custom +#spring.cloud.sentinel.datasource.ds1.file.converter-class=org.springframework.cloud.alibaba.cloud.examples.JsonFlowRuleListConverter +#spring.cloud.sentinel.datasource.ds1.file.rule-type=flow spring.cloud.sentinel.datasource.ds2.nacos.server-addr=localhost:8848 spring.cloud.sentinel.datasource.ds2.nacos.dataId=sentinel spring.cloud.sentinel.datasource.ds2.nacos.groupId=DEFAULT_GROUP spring.cloud.sentinel.datasource.ds2.nacos.data-type=json +spring.cloud.sentinel.datasource.ds2.nacos.rule-type=degrade spring.cloud.sentinel.datasource.ds3.zk.path = /Sentinel-Demo/SYSTEM-CODE-DEMO-FLOW spring.cloud.sentinel.datasource.ds3.zk.server-addr = localhost:2181 +spring.cloud.sentinel.datasource.ds3.zk.rule-type=authority spring.cloud.sentinel.datasource.ds4.apollo.namespace-name = application spring.cloud.sentinel.datasource.ds4.apollo.flow-rules-key = sentinel spring.cloud.sentinel.datasource.ds4.apollo.default-flow-rule-value = test - +spring.cloud.sentinel.datasource.ds5.apollo.rule-type=param-flow ``` This method follows the configuration of Spring Cloud Stream Binder. `TreeMap` is used for storage internally, and comparator is `String.CASE_INSENSITIVE_ORDER`. NOTE: d1, ds2, ds3, ds4 are the names of `ReadableDataSource`, and can be coded as you like. The `file`, `zk`, `nacos` , `apollo` refer to the specific data sources. The configurations following them are the specific configurations of these data sources respecitively. -Every data source has two common configuration items: `data-type` and `converter-class`. +Every data source has 3 common configuration items: `data-type`, `converter-class` and `rule-type`. -`data-type` refers to `Converter`. Spring Cloud Alibaba Sentinel provides two embedded values by defaul: `json` and `xml` (the default is json if not specified). If you do not want to use the embedded `json` or `xml` `Converter`, you can also fill in `custom` to indicate that you will define your own `Converter`, and then configure the `converter-class`. You need to specify the full path of the class for this configuration. +`data-type` refers to `Converter`. Spring Cloud Alibaba Sentinel provides two embedded values by default: `json` and `xml` (the default is json if not specified). If you do not want to use the embedded `json` or `xml` `Converter`, you can also fill in `custom` to indicate that you will define your own `Converter`, and then configure the `converter-class`. You need to specify the full path of the class for this configuration. -The two embedded `Converter` only supports parsing the Json array or XML array. Sentinel will determine automatically which of the 4 Sentinel rules that the Json or XML objext belongs to(`FlowRule`, `DegradeRule`, `SystemRule`, `AuthorityRule`, `ParamFlowRule`). - -For example, if 5 rate limiting rules and 5 degradation rules in the 10 rule arrays, then the data source will not be registered, and there will be warnings in the logs. - -If there are 9 rate limiting rules among the 10 arrays, and 1 error parsing the 10th array, then there will be warning in the log indicating that there is error in one of the rules, while the other 9 rules will be registered. - -Here `jackson` is used to parse the Json or XML arrays. `ObjectMapper` or `XmlMapper` uses the default configuration and will report error if there are unrecognized fields. The reason behind this logic is that without this strict parsing, Json will also be parsed as system rules(all system rules have default values). - -In another case, the Json or XML object might match all of the 4 rules(for example, if only the `resource` field is configured in the Json object, then it will match all 4 rules). In this case, there will be warnings in the log, and this object will be filtered. - -When you use this configuration, you only need to fill in the Json or XML correctly, and any of the unreasonable information will be printed in the log. +`rule-type` refers to the rule type in datasource(`flow`, `degrade`, `authority`, `system`, `param-flow`). If the data source takes effect and is loaded successfully, the dashboard will print information as shown below: @@ -302,6 +242,8 @@ Before you use the Endpoint feature, please add the `spring-boot-starter-actuat * Add `management.security.enabled=false` in Spring Boot 1.x. The exposed endpoint path is `/sentinel`. * Add `management.endpoints.web.exposure.include=*` in Spring Boot 2.x. The exposed endpoint path is `/actuator/sentinel`. +The information exposed in Sentinel Endpoint is very useful. It includes all the rules of the current application, the log directory, the IP of the current instance, the Sentinel Dashboard address, the Block Page, the heartbeat frequency of the application and the Sentinel Dashboard, and so on. + ### More The following table shows that when there are corresponding bean types in `ApplicationContext`, some actions will be taken: @@ -312,6 +254,7 @@ The following table shows that when there are corresponding bean types in `Appli ^|Existing Bean Type ^|Action ^|Function |`UrlCleaner`|`WebCallbackManager.setUrlCleaner(urlCleaner)`|Resource cleaning(resource(for example, classify all URLs of /foo/:id to the /foo/* resource)) |`UrlBlockHandler`|`WebCallbackManager.setUrlBlockHandler(urlBlockHandler)`|Customize rate limiting logic +|`RequestOriginParser`|`WebCallbackManager.setRequestOriginParser(requestOriginParser)`|Setting the origin |==== The following table shows all the configurations of Spring Cloud Alibaba Sentinel: @@ -325,13 +268,16 @@ The following table shows all the configurations of Spring Cloud Alibaba Sentine |`spring.cloud.sentinel.transport.port`|Port for the application to interact with Sentinel dashboard. An HTTP Server which uses this port will be started in the application|8721 |`spring.cloud.sentinel.transport.dashboard`|Sentinel dashboard address| |`spring.cloud.sentinel.transport.heartbeatIntervalMs`|Hearbeat interval between the application and Sentinel dashboard| +|`spring.cloud.sentinel.transport.client-ip`|Client IP| |`spring.cloud.sentinel.filter.order`|Loading order of Servlet Filter. The filter will be constructed in the Starter|Integer.MIN_VALUE -|`spring.cloud.sentinel.filter.spring.url-patterns`|Data type is array. Refers to the collection of Servlet Filter ULR patterns|/* +|`spring.cloud.sentinel.filter.url-patterns`|Data type is array. Refers to the collection of Servlet Filter ULR patterns|/* |`spring.cloud.sentinel.metric.charset`|metric file character set|UTF-8 |`spring.cloud.sentinel.metric.fileSingleSize`|Sentinel metric single file size| |`spring.cloud.sentinel.metric.fileTotalCount`|Sentinel metric total file number| |`spring.cloud.sentinel.log.dir`|Directory of Sentinel log files| |`spring.cloud.sentinel.log.switch-pid`|If PID is required for Sentinel log file names|false |`spring.cloud.sentinel.servlet.blockPage`| Customized redirection URL. When rate limited, the request will be redirected to the pre-defined URL | -|`spring.cloud.sentinel.flow.coldFactor`| https://github.com/alibaba/Sentinel/wiki/%E9%99%90%E6%B5%81---%E5%86%B7%E5%90%AF%E5%8A%A8[冷启动因子] |3 +|`spring.cloud.sentinel.flow.coldFactor`| https://github.com/alibaba/Sentinel/wiki/%E9%99%90%E6%B5%81---%E5%86%B7%E5%90%AF%E5%8A%A8[ColdFactor] |3 |==== + +NOTE: These configurations will only take effect in servlet environment. RestTemplate and Feign will not take effect for these configurations. \ No newline at end of file diff --git a/spring-cloud-alibaba-dubbo/pom.xml b/spring-cloud-alibaba-dubbo/pom.xml index 94467a24..61ccc471 100644 --- a/spring-cloud-alibaba-dubbo/pom.xml +++ b/spring-cloud-alibaba-dubbo/pom.xml @@ -3,8 +3,8 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> - spring-cloud-alibaba org.springframework.cloud + spring-cloud-alibaba 0.2.2.BUILD-SNAPSHOT ../pom.xml @@ -13,6 +13,37 @@ spring-cloud-alibaba-dubbo Spring Cloud Alibaba Dubbo + + 2.6.5 + 0.2.1.RELEASE + 0.0.2 + + + + + + + + org.springframework.boot + spring-boot-dependencies + ${spring-boot.version} + pom + import + + + + + com.alibaba + dubbo-dependencies-bom + ${dubbo.version} + pom + import + + + + + + @@ -170,9 +201,9 @@ - - - + + + diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/annotation/DubboTransported.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/annotation/DubboTransported.java new file mode 100644 index 00000000..2714923d --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/annotation/DubboTransported.java @@ -0,0 +1,67 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.annotation; + +import org.springframework.cloud.client.loadbalancer.LoadBalanced; +import org.springframework.cloud.openfeign.FeignClient; +import org.springframework.web.client.RestTemplate; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * {@link DubboTransported @DubboTransported} annotation indicates that the traditional Spring Cloud Service-to-Service call is transported + * by Dubbo under the hood, there are two main scenarios: + *
    + *
  1. {@link FeignClient @FeignClient} annotated classes: + *
      + * If {@link DubboTransported @DubboTransported} annotated classes, the invocation of all methods of + * {@link FeignClient @FeignClient} annotated classes. + *
    + *
      + * If {@link DubboTransported @DubboTransported} annotated methods of {@link FeignClient @FeignClient} annotated classes. + *
    + *
    2. + *
  2. {@link LoadBalanced @LoadBalanced} {@link RestTemplate} annotated field, method and parameters
    3. + *
+ *

+ * + * @see FeignClient + * @see LoadBalanced + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(value = {ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER}) +@Documented +public @interface DubboTransported { + + /** + * The protocol of Dubbo transport whose value could be used the placeholder "dubbo.transport.protocol" + * + * @return the default protocol is "dubbo" + */ + String protocol() default "${dubbo.transport.protocol:dubbo}"; + + /** + * The cluster of Dubbo transport whose value could be used the placeholder "dubbo.transport.cluster" + * + * @return the default cluster is "failover" + */ + String cluster() default "${dubbo.transport.cluster:failover}"; +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboLoadBalancedRestTemplateAutoConfiguration.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboLoadBalancedRestTemplateAutoConfiguration.java new file mode 100644 index 00000000..15eb6cf3 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboLoadBalancedRestTemplateAutoConfiguration.java @@ -0,0 +1,167 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.autoconfigure; + +import org.springframework.beans.factory.BeanClassLoaderAware; +import org.springframework.beans.factory.SmartInitializingSingleton; +import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.config.BeanDefinition; +import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; +import org.springframework.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.context.event.ApplicationStartedEvent; +import org.springframework.cloud.alibaba.dubbo.annotation.DubboTransported; +import org.springframework.cloud.alibaba.dubbo.client.loadbalancer.DubboMetadataInitializerInterceptor; +import org.springframework.cloud.alibaba.dubbo.client.loadbalancer.DubboTransporterInterceptor; +import org.springframework.cloud.alibaba.dubbo.metadata.DubboTransportedMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.repository.DubboServiceMetadataRepository; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceExecutionContextFactory; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceFactory; +import org.springframework.cloud.client.loadbalancer.LoadBalanced; +import org.springframework.cloud.client.loadbalancer.LoadBalancerAutoConfiguration; +import org.springframework.cloud.client.loadbalancer.LoadBalancerInterceptor; +import org.springframework.cloud.client.loadbalancer.RestTemplateCustomizer; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.event.EventListener; +import org.springframework.core.env.Environment; +import org.springframework.core.type.MethodMetadata; +import org.springframework.http.client.ClientHttpRequestInterceptor; +import org.springframework.util.CollectionUtils; +import org.springframework.web.client.RestTemplate; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Map; + +/** + * Dubbo Auto-{@link Configuration} for {@link LoadBalanced @LoadBalanced} {@link RestTemplate} + * + * @author Mercy + */ +@Configuration +@ConditionalOnClass(RestTemplate.class) +@AutoConfigureAfter(LoadBalancerAutoConfiguration.class) +public class DubboLoadBalancedRestTemplateAutoConfiguration implements BeanClassLoaderAware { + + private static final Class DUBBO_TRANSPORTED_CLASS = DubboTransported.class; + + private static final String DUBBO_TRANSPORTED_CLASS_NAME = DUBBO_TRANSPORTED_CLASS.getName(); + + @Autowired + private DubboServiceMetadataRepository repository; + + @Autowired + private LoadBalancerInterceptor loadBalancerInterceptor; + + @Autowired + private ConfigurableListableBeanFactory beanFactory; + + @Autowired + private DubboGenericServiceFactory serviceFactory; + + @Autowired + private DubboGenericServiceExecutionContextFactory contextFactory; + + @Autowired + private Environment environment; + + @LoadBalanced + @Autowired(required = false) + private Map restTemplates = Collections.emptyMap(); + + private ClassLoader classLoader; + + /** + * Adapt the {@link RestTemplate} beans that are annotated {@link LoadBalanced @LoadBalanced} and + * {@link LoadBalanced @LoadBalanced} when Spring Boot application started + * (after the callback of {@link SmartInitializingSingleton} beans or + * {@link RestTemplateCustomizer#customize(RestTemplate) customization}) + */ + @EventListener(ApplicationStartedEvent.class) + public void adaptRestTemplates() { + for (Map.Entry entry : restTemplates.entrySet()) { + String beanName = entry.getKey(); + Map dubboTranslatedAttributes = getDubboTranslatedAttributes(beanName); + if (!CollectionUtils.isEmpty(dubboTranslatedAttributes)) { + adaptRestTemplate(entry.getValue(), dubboTranslatedAttributes); + } + } + } + + /** + * Gets the annotation attributes {@link RestTemplate} bean being annotated + * {@link DubboTransported @DubboTransported} + * + * @param beanName the bean name of {@link LoadBalanced @LoadBalanced} {@link RestTemplate} + * @return non-null {@link Map} + */ + private Map getDubboTranslatedAttributes(String beanName) { + Map attributes = Collections.emptyMap(); + BeanDefinition beanDefinition = beanFactory.getBeanDefinition(beanName); + if (beanDefinition instanceof AnnotatedBeanDefinition) { + AnnotatedBeanDefinition annotatedBeanDefinition = (AnnotatedBeanDefinition) beanDefinition; + MethodMetadata factoryMethodMetadata = annotatedBeanDefinition.getFactoryMethodMetadata(); + attributes = factoryMethodMetadata != null ? + factoryMethodMetadata.getAnnotationAttributes(DUBBO_TRANSPORTED_CLASS_NAME) : Collections.emptyMap(); + } + return attributes; + } + + + /** + * Adapt the instance of {@link DubboTransporterInterceptor} to the {@link LoadBalancerInterceptor} Bean. + * + * @param restTemplate {@link LoadBalanced @LoadBalanced} {@link RestTemplate} Bean + * @param dubboTranslatedAttributes the annotation dubboTranslatedAttributes {@link RestTemplate} bean being annotated + * {@link DubboTransported @DubboTransported} + */ + private void adaptRestTemplate(RestTemplate restTemplate, Map dubboTranslatedAttributes) { + + DubboTransportedMetadata dubboTransportedMetadata = buildDubboTransportedMetadata(dubboTranslatedAttributes); + + List interceptors = new ArrayList<>(restTemplate.getInterceptors()); + + int index = interceptors.indexOf(loadBalancerInterceptor); + + index = index < 0 ? 0 : index; + + // Add ClientHttpRequestInterceptor instances before loadBalancerInterceptor + interceptors.add(index++, new DubboMetadataInitializerInterceptor(repository)); + + interceptors.add(index++, new DubboTransporterInterceptor(repository, restTemplate.getMessageConverters(), + classLoader, dubboTransportedMetadata, serviceFactory, contextFactory)); + + restTemplate.setInterceptors(interceptors); + } + + private DubboTransportedMetadata buildDubboTransportedMetadata(Map dubboTranslatedAttributes) { + DubboTransportedMetadata dubboTransportedMetadata = new DubboTransportedMetadata(); + String protocol = (String) dubboTranslatedAttributes.get("protocol"); + String cluster = (String) dubboTranslatedAttributes.get("cluster"); + // resolve placeholders + dubboTransportedMetadata.setProtocol(environment.resolvePlaceholders(protocol)); + dubboTransportedMetadata.setCluster(environment.resolvePlaceholders(cluster)); + return dubboTransportedMetadata; + } + + @Override + public void setBeanClassLoader(ClassLoader classLoader) { + this.classLoader = classLoader; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboMetadataAutoConfiguration.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboMetadataAutoConfiguration.java index cd4422c7..89a50578 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboMetadataAutoConfiguration.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboMetadataAutoConfiguration.java @@ -16,15 +16,22 @@ */ package org.springframework.cloud.alibaba.dubbo.autoconfigure; -import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; +import com.alibaba.dubbo.config.ProtocolConfig; +import com.alibaba.dubbo.config.spring.context.annotation.DubboComponentScan; + +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.cloud.alibaba.dubbo.metadata.repository.DubboServiceMetadataRepository; -import org.springframework.cloud.alibaba.dubbo.metadata.service.MetadataConfigService; -import org.springframework.cloud.alibaba.dubbo.metadata.service.NacosMetadataConfigService; -import org.springframework.cloud.alibaba.nacos.NacosConfigProperties; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceFactory; +import org.springframework.cloud.alibaba.dubbo.service.DubboMetadataConfigServiceProxy; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; +import java.util.Collection; +import java.util.Iterator; + +import static com.alibaba.dubbo.common.Constants.DEFAULT_PROTOCOL; + /** * Spring Boot Auto-Configuration class for Dubbo Metadata * @@ -32,12 +39,39 @@ import org.springframework.context.annotation.Import; */ @Configuration @Import(DubboServiceMetadataRepository.class) +@DubboComponentScan(basePackages = "org.springframework.cloud.alibaba.dubbo.service") public class DubboMetadataAutoConfiguration { - @Bean - @ConditionalOnBean(NacosConfigProperties.class) - public MetadataConfigService metadataConfigService() { - return new NacosMetadataConfigService(); + public static final String METADATA_PROTOCOL_BEAN_NAME = "metadata"; + + /** + * Build an alias Bean for {@link ProtocolConfig} + * + * @param protocols {@link ProtocolConfig} Beans + * @return {@link ProtocolConfig} bean + */ + @Bean(name = METADATA_PROTOCOL_BEAN_NAME) + public ProtocolConfig protocolConfig(Collection protocols) { + ProtocolConfig protocolConfig = null; + for (ProtocolConfig protocol : protocols) { + String protocolName = protocol.getName(); + if (DEFAULT_PROTOCOL.equals(protocolName)) { + protocolConfig = protocol; + break; + } + } + + if (protocolConfig == null) { // If The ProtocolConfig bean named "dubbo" is absent, take first one of them + Iterator iterator = protocols.iterator(); + protocolConfig = iterator.hasNext() ? iterator.next() : null; + } + + return protocolConfig; } + @Bean + @ConditionalOnMissingBean + public DubboMetadataConfigServiceProxy dubboMetadataConfigServiceProxy(DubboGenericServiceFactory factory) { + return new DubboMetadataConfigServiceProxy(factory); + } } \ No newline at end of file diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboOpenFeignAutoConfiguration.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboOpenFeignAutoConfiguration.java index d37d8dc0..55d2f0a9 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboOpenFeignAutoConfiguration.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboOpenFeignAutoConfiguration.java @@ -19,17 +19,19 @@ package org.springframework.cloud.alibaba.dubbo.autoconfigure; import feign.Contract; import feign.Feign; import org.springframework.beans.factory.ObjectProvider; -import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.autoconfigure.AutoConfigureAfter; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; -import org.springframework.cloud.alibaba.dubbo.metadata.resolver.FeignMetadataResolver; +import org.springframework.cloud.alibaba.dubbo.metadata.repository.DubboServiceMetadataRepository; +import org.springframework.cloud.alibaba.dubbo.metadata.resolver.DubboServiceBeanMetadataResolver; import org.springframework.cloud.alibaba.dubbo.metadata.resolver.MetadataResolver; -import org.springframework.cloud.alibaba.dubbo.openfeign.DubboFeignClientsConfiguration; -import org.springframework.cloud.openfeign.EnableFeignClients; +import org.springframework.cloud.alibaba.dubbo.openfeign.TargeterBeanPostProcessor; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceExecutionContextFactory; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceFactory; import org.springframework.cloud.openfeign.FeignAutoConfiguration; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; +import org.springframework.core.env.Environment; /** @@ -39,16 +41,22 @@ import org.springframework.context.annotation.Configuration; */ @ConditionalOnClass(value = Feign.class) @AutoConfigureAfter(FeignAutoConfiguration.class) -@EnableFeignClients(defaultConfiguration = DubboFeignClientsConfiguration.class) @Configuration public class DubboOpenFeignAutoConfiguration { - @Value("${spring.application.name}") - private String currentApplicationName; - @Bean @ConditionalOnMissingBean public MetadataResolver metadataJsonResolver(ObjectProvider contract) { - return new FeignMetadataResolver(currentApplicationName, contract); + return new DubboServiceBeanMetadataResolver(contract); } + + @Bean + public TargeterBeanPostProcessor targeterBeanPostProcessor(Environment environment, + DubboServiceMetadataRepository dubboServiceMetadataRepository, + DubboGenericServiceFactory dubboGenericServiceFactory, + DubboGenericServiceExecutionContextFactory contextFactory) { + return new TargeterBeanPostProcessor(environment, dubboServiceMetadataRepository, + dubboGenericServiceFactory, contextFactory); + } + } \ No newline at end of file diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboRestMetadataRegistrationAutoConfiguration.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboRestMetadataRegistrationAutoConfiguration.java index 7c7aa9fd..be821e17 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboRestMetadataRegistrationAutoConfiguration.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboRestMetadataRegistrationAutoConfiguration.java @@ -18,22 +18,18 @@ package org.springframework.cloud.alibaba.dubbo.autoconfigure; import com.alibaba.dubbo.config.spring.ServiceBean; import com.alibaba.dubbo.config.spring.context.event.ServiceBeanExportedEvent; -import com.fasterxml.jackson.core.JsonProcessingException; + import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.autoconfigure.AutoConfigureAfter; -import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; -import org.springframework.cloud.alibaba.dubbo.metadata.ServiceRestMetadata; import org.springframework.cloud.alibaba.dubbo.metadata.resolver.MetadataResolver; -import org.springframework.cloud.alibaba.dubbo.metadata.service.MetadataConfigService; -import org.springframework.cloud.client.discovery.event.InstancePreRegisteredEvent; +import org.springframework.cloud.alibaba.dubbo.service.PublishingDubboMetadataConfigService; import org.springframework.cloud.client.serviceregistry.Registration; import org.springframework.context.annotation.Configuration; import org.springframework.context.event.EventListener; -import java.util.LinkedHashSet; -import java.util.Set; - /** * The Auto-Configuration class for Dubbo REST metadata registration, * REST metadata that is a part of {@link Registration#getMetadata() Spring Cloud service instances' metadata} @@ -42,45 +38,25 @@ import java.util.Set; * @author Mercy */ @ConditionalOnProperty(value = "spring.cloud.service-registry.auto-registration.enabled", matchIfMissing = true) -@ConditionalOnMissingBean(value = { - MetadataResolver.class, - MetadataConfigService.class +@ConditionalOnBean(value = { + MetadataResolver.class }) @AutoConfigureAfter(value = {DubboMetadataAutoConfiguration.class}) @Configuration public class DubboRestMetadataRegistrationAutoConfiguration { - /** - * A Map to store REST metadata temporary, its' key is the special service name for a Dubbo service, - * the value is a JSON content of JAX-RS or Spring MVC REST metadata from the annotated methods. - */ - private final Set serviceRestMetadata = new LinkedHashSet<>(); - @Autowired private MetadataResolver metadataResolver; @Autowired - private MetadataConfigService metadataConfigService; + private PublishingDubboMetadataConfigService dubboMetadataConfigService; + + @Value("${spring.application.name:application}") + private String currentApplicationName; @EventListener(ServiceBeanExportedEvent.class) - public void recordRestMetadata(ServiceBeanExportedEvent event) throws JsonProcessingException { + public void recordRestMetadata(ServiceBeanExportedEvent event) { ServiceBean serviceBean = event.getServiceBean(); - serviceRestMetadata.addAll(metadataResolver.resolveServiceRestMetadata(serviceBean)); + dubboMetadataConfigService.publishServiceRestMetadata(metadataResolver.resolveServiceRestMetadata(serviceBean)); } - - /** - * Pre-handle Spring Cloud application service registered: - *

- * Put restMetadata with the JSON format into - * {@link Registration#getMetadata() service instances' metadata} - *

- * - * @param event {@link InstancePreRegisteredEvent} instance - */ - @EventListener(InstancePreRegisteredEvent.class) - public void registerRestMetadata(InstancePreRegisteredEvent event) throws Exception { - Registration registration = event.getRegistration(); - metadataConfigService.publishServiceRestMetadata(registration.getServiceId(), serviceRestMetadata); - } - } diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboServiceAutoConfiguration.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboServiceAutoConfiguration.java new file mode 100644 index 00000000..dc1ad286 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboServiceAutoConfiguration.java @@ -0,0 +1,54 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.autoconfigure; + +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceExecutionContextFactory; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceFactory; +import org.springframework.cloud.alibaba.dubbo.service.parameter.PathVariableServiceParameterResolver; +import org.springframework.cloud.alibaba.dubbo.service.parameter.RequestBodyServiceParameterResolver; +import org.springframework.cloud.alibaba.dubbo.service.parameter.RequestHeaderServiceParameterResolver; +import org.springframework.cloud.alibaba.dubbo.service.parameter.RequestParamServiceParameterResolver; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Import; + +/** + * Spring Boot Auto-Configuration class for Dubbo Service + * + * @author Mercy + */ +@Configuration +public class DubboServiceAutoConfiguration { + + @Bean + @ConditionalOnMissingBean + public DubboGenericServiceFactory dubboGenericServiceFactory() { + return new DubboGenericServiceFactory(); + } + + @Configuration + @Import(value = { + DubboGenericServiceExecutionContextFactory.class, + RequestParamServiceParameterResolver.class, + RequestBodyServiceParameterResolver.class, + RequestHeaderServiceParameterResolver.class, + PathVariableServiceParameterResolver.class + }) + static class ParameterResolversConfiguration { + } +} \ No newline at end of file diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboClientHttpResponse.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboClientHttpResponse.java new file mode 100644 index 00000000..25ba95a2 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboClientHttpResponse.java @@ -0,0 +1,79 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.client.loadbalancer; + +import com.alibaba.dubbo.rpc.service.GenericException; + +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatus; +import org.springframework.http.client.ClientHttpResponse; + +import java.io.IOException; +import java.io.InputStream; + +/** + * Dubbo {@link ClientHttpResponse} implementation + * + * @author Mercy + * @see DubboTransporterInterceptor + */ +class DubboClientHttpResponse implements ClientHttpResponse { + + private final HttpStatus httpStatus; + + private final String statusText; + + private final HttpHeaders httpHeaders = new HttpHeaders(); + + private final DubboHttpOutputMessage httpOutputMessage; + + public DubboClientHttpResponse(DubboHttpOutputMessage httpOutputMessage, GenericException exception) { + this.httpStatus = exception != null ? HttpStatus.INTERNAL_SERVER_ERROR : HttpStatus.OK; + this.statusText = exception != null ? exception.getExceptionMessage() : httpStatus.getReasonPhrase(); + this.httpOutputMessage = httpOutputMessage; + this.httpHeaders.putAll(httpOutputMessage.getHeaders()); + } + + @Override + public HttpStatus getStatusCode() throws IOException { + return httpStatus; + } + + @Override + public int getRawStatusCode() throws IOException { + return httpStatus.value(); + } + + @Override + public String getStatusText() throws IOException { + return statusText; + } + + @Override + public void close() { + } + + @Override + public InputStream getBody() throws IOException { + return httpOutputMessage.getBody().getInputStream(); + } + + @Override + public HttpHeaders getHeaders() { + return httpHeaders; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboClientHttpResponseFactory.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboClientHttpResponseFactory.java new file mode 100644 index 00000000..387cf6b1 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboClientHttpResponseFactory.java @@ -0,0 +1,64 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.client.loadbalancer; + +import com.alibaba.dubbo.rpc.service.GenericException; + +import org.springframework.cloud.alibaba.dubbo.http.converter.HttpMessageConverterHolder; +import org.springframework.cloud.alibaba.dubbo.http.util.HttpMessageConverterResolver; +import org.springframework.cloud.alibaba.dubbo.metadata.RequestMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; +import org.springframework.http.MediaType; +import org.springframework.http.client.ClientHttpResponse; +import org.springframework.http.converter.HttpMessageConverter; + +import java.io.IOException; +import java.util.List; + +/** + * Dubbo {@link ClientHttpResponse} Factory + * + * @author Mercy + */ +class DubboClientHttpResponseFactory { + + private final HttpMessageConverterResolver httpMessageConverterResolver; + + public DubboClientHttpResponseFactory(List> messageConverters, ClassLoader classLoader) { + this.httpMessageConverterResolver = new HttpMessageConverterResolver(messageConverters, classLoader); + } + + public ClientHttpResponse build(Object result, GenericException exception, + RequestMetadata requestMetadata, RestMethodMetadata restMethodMetadata) { + + DubboHttpOutputMessage httpOutputMessage = new DubboHttpOutputMessage(); + + HttpMessageConverterHolder httpMessageConverterHolder = httpMessageConverterResolver.resolve(requestMetadata, restMethodMetadata); + + if (httpMessageConverterHolder != null) { + MediaType mediaType = httpMessageConverterHolder.getMediaType(); + HttpMessageConverter converter = httpMessageConverterHolder.getConverter(); + try { + converter.write(result, mediaType, httpOutputMessage); + } catch (IOException e) { + e.printStackTrace(); + } + } + + return new DubboClientHttpResponse(httpOutputMessage, exception); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboHttpOutputMessage.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboHttpOutputMessage.java new file mode 100644 index 00000000..1906aeb0 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboHttpOutputMessage.java @@ -0,0 +1,45 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.client.loadbalancer; + +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpOutputMessage; +import org.springframework.util.FastByteArrayOutputStream; + +import java.io.IOException; + +/** + * Dubbo {@link HttpOutputMessage} implementation + * + * @author Mercy + */ +class DubboHttpOutputMessage implements HttpOutputMessage { + + private final FastByteArrayOutputStream outputStream = new FastByteArrayOutputStream(); + + private final HttpHeaders httpHeaders = new HttpHeaders(); + + @Override + public FastByteArrayOutputStream getBody() throws IOException { + return outputStream; + } + + @Override + public HttpHeaders getHeaders() { + return httpHeaders; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboMetadataInitializerInterceptor.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboMetadataInitializerInterceptor.java new file mode 100644 index 00000000..de488e67 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboMetadataInitializerInterceptor.java @@ -0,0 +1,54 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.client.loadbalancer; + +import org.springframework.cloud.alibaba.dubbo.metadata.repository.DubboServiceMetadataRepository; +import org.springframework.http.HttpRequest; +import org.springframework.http.client.ClientHttpRequestExecution; +import org.springframework.http.client.ClientHttpRequestInterceptor; +import org.springframework.http.client.ClientHttpResponse; + +import java.io.IOException; +import java.net.URI; + +/** + * Dubbo Metadata {@link ClientHttpRequestInterceptor} Initializing Interceptor executes intercept before + * {@link DubboTransporterInterceptor} + * + * @author Mercy + */ +public class DubboMetadataInitializerInterceptor implements ClientHttpRequestInterceptor { + + private final DubboServiceMetadataRepository repository; + + public DubboMetadataInitializerInterceptor(DubboServiceMetadataRepository repository) { + this.repository = repository; + } + + @Override + public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException { + + URI originalUri = request.getURI(); + + String serviceName = originalUri.getHost(); + + repository.initialize(serviceName); + + // Execute next + return execution.execute(request, body); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboTransporterInterceptor.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboTransporterInterceptor.java new file mode 100644 index 00000000..d7b9bb37 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/client/loadbalancer/DubboTransporterInterceptor.java @@ -0,0 +1,144 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.client.loadbalancer; + +import com.alibaba.dubbo.rpc.service.GenericException; +import com.alibaba.dubbo.rpc.service.GenericService; + +import org.springframework.cloud.alibaba.dubbo.http.MutableHttpServerRequest; +import org.springframework.cloud.alibaba.dubbo.metadata.DubboServiceMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.DubboTransportedMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.RequestMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.repository.DubboServiceMetadataRepository; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceExecutionContext; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceExecutionContextFactory; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceFactory; +import org.springframework.cloud.client.loadbalancer.LoadBalancerInterceptor; +import org.springframework.http.HttpRequest; +import org.springframework.http.client.ClientHttpRequestExecution; +import org.springframework.http.client.ClientHttpRequestInterceptor; +import org.springframework.http.client.ClientHttpResponse; +import org.springframework.http.converter.HttpMessageConverter; +import org.springframework.util.AntPathMatcher; +import org.springframework.util.CollectionUtils; +import org.springframework.util.PathMatcher; +import org.springframework.web.util.UriComponents; + +import java.io.IOException; +import java.net.URI; +import java.util.List; +import java.util.Map; + +import static org.springframework.web.util.UriComponentsBuilder.fromUri; + +/** + * Dubbo Transporter {@link ClientHttpRequestInterceptor} implementation + * + * @author Mercy + * @see LoadBalancerInterceptor + */ +public class DubboTransporterInterceptor implements ClientHttpRequestInterceptor { + + private final DubboServiceMetadataRepository repository; + + private final DubboClientHttpResponseFactory clientHttpResponseFactory; + + private final DubboTransportedMetadata dubboTransportedMetadata; + + private final DubboGenericServiceFactory serviceFactory; + + private final DubboGenericServiceExecutionContextFactory contextFactory; + + private final PathMatcher pathMatcher = new AntPathMatcher(); + + public DubboTransporterInterceptor(DubboServiceMetadataRepository dubboServiceMetadataRepository, + List> messageConverters, + ClassLoader classLoader, + DubboTransportedMetadata dubboTransportedMetadata, + DubboGenericServiceFactory serviceFactory, + DubboGenericServiceExecutionContextFactory contextFactory) { + this.repository = dubboServiceMetadataRepository; + this.dubboTransportedMetadata = dubboTransportedMetadata; + this.clientHttpResponseFactory = new DubboClientHttpResponseFactory(messageConverters, classLoader); + this.serviceFactory = serviceFactory; + this.contextFactory = contextFactory; + } + + @Override + public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException { + + URI originalUri = request.getURI(); + + String serviceName = originalUri.getHost(); + + RequestMetadata clientMetadata = buildRequestMetadata(request); + + DubboServiceMetadata dubboServiceMetadata = repository.get(serviceName, clientMetadata); + + if (dubboServiceMetadata == null) { + // if DubboServiceMetadata is not found, executes next + return execution.execute(request, body); + } + + RestMethodMetadata dubboRestMethodMetadata = dubboServiceMetadata.getRestMethodMetadata(); + + GenericService genericService = serviceFactory.create(dubboServiceMetadata, dubboTransportedMetadata); + + MutableHttpServerRequest httpServerRequest = new MutableHttpServerRequest(request, body); + + customizeRequest(httpServerRequest, dubboRestMethodMetadata, clientMetadata); + + DubboGenericServiceExecutionContext context = contextFactory.create(dubboRestMethodMetadata, httpServerRequest); + + Object result = null; + GenericException exception = null; + + try { + result = genericService.$invoke(context.getMethodName(), context.getParameterTypes(), context.getParameters()); + } catch (GenericException e) { + exception = e; + } + + return clientHttpResponseFactory.build(result, exception, clientMetadata, dubboRestMethodMetadata); + } + + protected void customizeRequest(MutableHttpServerRequest httpServerRequest, + RestMethodMetadata dubboRestMethodMetadata, RequestMetadata clientMetadata) { + + RequestMetadata dubboRequestMetadata = dubboRestMethodMetadata.getRequest(); + String pathPattern = dubboRequestMetadata.getPath(); + + Map pathVariables = pathMatcher.extractUriTemplateVariables(pathPattern, httpServerRequest.getPath()); + + if (!CollectionUtils.isEmpty(pathVariables)) { + // Put path variables Map into query parameters Map + httpServerRequest.params(pathVariables); + } + + } + + private RequestMetadata buildRequestMetadata(HttpRequest request) { + UriComponents uriComponents = fromUri(request.getURI()).build(true); + RequestMetadata requestMetadata = new RequestMetadata(); + requestMetadata.setPath(uriComponents.getPath()); + requestMetadata.setMethod(request.getMethod().name()); + requestMetadata.setParams(uriComponents.getQueryParams()); + requestMetadata.setHeaders(request.getHeaders()); + return requestMetadata; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/ByteArrayHttpInputMessage.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/ByteArrayHttpInputMessage.java new file mode 100644 index 00000000..c74f2e99 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/ByteArrayHttpInputMessage.java @@ -0,0 +1,56 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http; + +import com.alibaba.dubbo.common.io.UnsafeByteArrayInputStream; + +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpInputMessage; + +import java.io.IOException; +import java.io.InputStream; + +/** + * Byte array {@link HttpInputMessage} implementation + * + * @author Mercy + */ +class ByteArrayHttpInputMessage implements HttpInputMessage { + + private final HttpHeaders httpHeaders; + + private final InputStream inputStream; + + public ByteArrayHttpInputMessage(byte[] body) { + this(new HttpHeaders(), body); + } + + public ByteArrayHttpInputMessage(HttpHeaders httpHeaders, byte[] body) { + this.httpHeaders = httpHeaders; + this.inputStream = new UnsafeByteArrayInputStream(body); + } + + @Override + public InputStream getBody() throws IOException { + return inputStream; + } + + @Override + public HttpHeaders getHeaders() { + return httpHeaders; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/DefaultHttpRequest.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/DefaultHttpRequest.java new file mode 100644 index 00000000..3f1f376d --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/DefaultHttpRequest.java @@ -0,0 +1,130 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http; + +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.HttpRequest; +import org.springframework.util.LinkedMultiValueMap; +import org.springframework.util.MultiValueMap; +import org.springframework.web.util.UriComponentsBuilder; + +import java.net.URI; +import java.util.List; +import java.util.Map; + +import static org.springframework.web.util.UriComponentsBuilder.fromPath; + +/** + * Default {@link HttpRequest} implementation + * + * @author Mercy + */ +public class DefaultHttpRequest implements HttpRequest { + + private final String method; + + private final URI uri; + + private final HttpHeaders headers = new HttpHeaders(); + + public DefaultHttpRequest(String method, String path, Map> params, + Map> headers) { + this.method = method == null ? HttpMethod.GET.name() : method.toUpperCase(); + this.uri = buildURI(path, params); + this.headers.putAll(headers); + } + + private URI buildURI(String path, Map> params) { + UriComponentsBuilder builder = fromPath(path) + .queryParams(new LinkedMultiValueMap<>(params)); + return builder.build().toUri(); + } + + @Override + public HttpMethod getMethod() { + return HttpMethod.resolve(getMethodValue()); + } + + public String getMethodValue() { + return method; + } + + @Override + public URI getURI() { + return uri; + } + + @Override + public HttpHeaders getHeaders() { + return headers; + } + + public static Builder builder() { + return new Builder(); + } + + /** + * {@link HttpRequest} Builder + */ + public static class Builder { + + String method; + + String path; + + MultiValueMap params = new LinkedMultiValueMap<>(); + + MultiValueMap headers = new LinkedMultiValueMap<>(); + + public Builder method(String method) { + this.method = method; + return this; + } + + public Builder path(String path) { + this.path = path; + return this; + } + + public Builder param(String name, String value) { + this.params.add(name, value); + return this; + } + + public Builder header(String name, String value) { + this.headers.add(name, value); + return this; + } + + public Builder params(Map> params) { + this.params.putAll(params); + return this; + } + + public Builder headers(Map> headers) { + this.headers.putAll(headers); + return this; + } + + public HttpRequest build() { + return new DefaultHttpRequest(method, path, params, headers); + } + } + + +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/HttpServerRequest.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/HttpServerRequest.java new file mode 100644 index 00000000..f56a3f93 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/HttpServerRequest.java @@ -0,0 +1,42 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http; + +import org.springframework.http.HttpInputMessage; +import org.springframework.http.HttpRequest; +import org.springframework.util.MultiValueMap; + +/** + * HTTP Server Request + * + * @author Mercy + */ +public interface HttpServerRequest extends HttpRequest, HttpInputMessage { + + /** + * Return a path of current HTTP request + * + * @return + */ + String getPath(); + + /** + * Return a map with parsed and decoded query parameter values. + */ + MultiValueMap getQueryParams(); + +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/MutableHttpServerRequest.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/MutableHttpServerRequest.java new file mode 100644 index 00000000..62240f3b --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/MutableHttpServerRequest.java @@ -0,0 +1,99 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http; + +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpInputMessage; +import org.springframework.http.HttpMethod; +import org.springframework.http.HttpRequest; +import org.springframework.util.MultiValueMap; + +import java.io.IOException; +import java.io.InputStream; +import java.net.URI; +import java.util.Map; + +import static org.springframework.cloud.alibaba.dubbo.http.util.HttpUtils.getParameters; + +/** + * Mutable {@link HttpServerRequest} implementation + * + * @author Mercy + */ +public class MutableHttpServerRequest implements HttpServerRequest { + + private final HttpMethod httpMethod; + + private final URI uri; + + private final String path; + + private final MultiValueMap queryParams; + + private final HttpHeaders httpHeaders; + + private final HttpInputMessage httpInputMessage; + + public MutableHttpServerRequest(HttpRequest httpRequest, byte[] body) { + this.httpMethod = httpRequest.getMethod(); + this.uri = httpRequest.getURI(); + this.path = uri.getPath(); + this.httpHeaders = httpRequest.getHeaders(); + this.queryParams = getParameters(httpRequest); + this.httpInputMessage = new ByteArrayHttpInputMessage(body); + } + + public MutableHttpServerRequest params(Map params) { + queryParams.setAll(params); + return this; + } + + @Override + public InputStream getBody() throws IOException { + return httpInputMessage.getBody(); + } + + @Override + public HttpMethod getMethod() { + return httpMethod; + } + + // Override method since Spring Framework 5.0 + public String getMethodValue() { + return httpMethod.name(); + } + + @Override + public URI getURI() { + return uri; + } + + @Override + public HttpHeaders getHeaders() { + return httpHeaders; + } + + @Override + public String getPath() { + return path; + } + + @Override + public MultiValueMap getQueryParams() { + return queryParams; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/converter/HttpMessageConverterHolder.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/converter/HttpMessageConverterHolder.java new file mode 100644 index 00000000..e0d7d11f --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/converter/HttpMessageConverterHolder.java @@ -0,0 +1,45 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.converter; + +import org.springframework.http.MediaType; +import org.springframework.http.converter.HttpMessageConverter; + +/** + * {@link HttpMessageConverter} Holder with {@link MediaType}. + * + * @author Mercy + */ +public class HttpMessageConverterHolder { + + private final MediaType mediaType; + + private final HttpMessageConverter converter; + + public HttpMessageConverterHolder(MediaType mediaType, HttpMessageConverter converter) { + this.mediaType = mediaType; + this.converter = converter; + } + + public MediaType getMediaType() { + return mediaType; + } + + public HttpMessageConverter getConverter() { + return converter; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractHttpRequestMatcher.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractHttpRequestMatcher.java new file mode 100644 index 00000000..3e16664c --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractHttpRequestMatcher.java @@ -0,0 +1,74 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import java.util.Collection; +import java.util.Iterator; + +/** + * Abstract {@link HttpRequestMatcher} implementation + * + * @author Rossen Stoyanchev + * @author Mercy + */ +public abstract class AbstractHttpRequestMatcher implements HttpRequestMatcher { + + /** + * Return the discrete items a request condition is composed of. + *

For example URL patterns, HTTP request methods, param expressions, etc. + * + * @return a collection of objects, never {@code null} + */ + protected abstract Collection getContent(); + + /** + * The notation to use when printing discrete items of content. + *

For example {@code " || "} for URL patterns or {@code " && "} + * for param expressions. + */ + protected abstract String getToStringInfix(); + + @Override + public boolean equals(Object other) { + if (this == other) { + return true; + } + if (other == null || getClass() != other.getClass()) { + return false; + } + return getContent().equals(((AbstractHttpRequestMatcher) other).getContent()); + } + + @Override + public int hashCode() { + return getContent().hashCode(); + } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder("["); + for (Iterator iterator = getContent().iterator(); iterator.hasNext(); ) { + Object expression = iterator.next(); + builder.append(expression.toString()); + if (iterator.hasNext()) { + builder.append(getToStringInfix()); + } + } + builder.append("]"); + return builder.toString(); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractMediaTypeExpression.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractMediaTypeExpression.java new file mode 100644 index 00000000..de5d9f84 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractMediaTypeExpression.java @@ -0,0 +1,91 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.MediaType; + +/** + * The some source code is scratched from org.springframework.web.servlet.mvc.condition.AbstractMediaTypeExpression + * + * @author Arjen Poutsma + * @author Rossen Stoyanchev + * @author Mercy + */ +public class AbstractMediaTypeExpression implements MediaTypeExpression, Comparable { + + private final MediaType mediaType; + + private final boolean negated; + + AbstractMediaTypeExpression(String expression) { + if (expression.startsWith("!")) { + this.negated = true; + expression = expression.substring(1); + } else { + this.negated = false; + } + this.mediaType = MediaType.parseMediaType(expression); + } + + AbstractMediaTypeExpression(MediaType mediaType, boolean negated) { + this.mediaType = mediaType; + this.negated = negated; + } + + @Override + public MediaType getMediaType() { + return this.mediaType; + } + + @Override + public boolean isNegated() { + return this.negated; + } + + + @Override + public int compareTo(AbstractMediaTypeExpression other) { + return MediaType.SPECIFICITY_COMPARATOR.compare(this.getMediaType(), other.getMediaType()); + } + + @Override + public boolean equals(Object other) { + if (this == other) { + return true; + } + if (other == null || getClass() != other.getClass()) { + return false; + } + AbstractMediaTypeExpression otherExpr = (AbstractMediaTypeExpression) other; + return (this.mediaType.equals(otherExpr.mediaType) && this.negated == otherExpr.negated); + } + + @Override + public int hashCode() { + return this.mediaType.hashCode(); + } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + if (this.negated) { + builder.append('!'); + } + builder.append(this.mediaType.toString()); + return builder.toString(); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractNameValueExpression.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractNameValueExpression.java new file mode 100644 index 00000000..695e6792 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractNameValueExpression.java @@ -0,0 +1,146 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.HttpRequest; +import org.springframework.util.ObjectUtils; +import org.springframework.util.StringUtils; + +import static org.springframework.util.StringUtils.trimWhitespace; + +/** + * The some source code is scratched from org.springframework.web.servlet.mvc.condition.AbstractNameValueExpression + * + * @author Rossen Stoyanchev + * @author Arjen Poutsma + * @author Mercy + */ +abstract class AbstractNameValueExpression implements NameValueExpression { + + protected final String name; + + protected final T value; + + protected final boolean negated; + + AbstractNameValueExpression(String expression) { + int separator = expression.indexOf('='); + if (separator == -1) { + this.negated = expression.startsWith("!"); + this.name = trimWhitespace((this.negated ? expression.substring(1) : expression)); + this.value = null; + } else { + this.negated = (separator > 0) && (expression.charAt(separator - 1) == '!'); + this.name = trimWhitespace((this.negated ? expression.substring(0, separator - 1) + : expression.substring(0, separator))); + String valueExpression = getValueExpression(expression, separator); + this.value = isExcludedValue(valueExpression) ? null : parseValue(valueExpression); + } + } + + private String getValueExpression(String expression, int separator) { + return trimWhitespace(expression.substring(separator + 1)); + } + + /** + * Exclude the pattern value Expression: "{value}", subclass could override this method. + * + * @param valueExpression + * @return + */ + protected boolean isExcludedValue(String valueExpression) { + return StringUtils.hasText(valueExpression) && + valueExpression.startsWith("{") + && valueExpression.endsWith("}"); + } + + @Override + public String getName() { + return this.name; + } + + @Override + public T getValue() { + return this.value; + } + + @Override + public boolean isNegated() { + return this.negated; + } + + public final boolean match(HttpRequest request) { + boolean isMatch; + if (this.value != null) { + isMatch = matchValue(request); + } else { + isMatch = matchName(request); + } + return (this.negated ? !isMatch : isMatch); + } + + + protected abstract boolean isCaseSensitiveName(); + + protected abstract T parseValue(String valueExpression); + + protected abstract boolean matchName(HttpRequest request); + + protected abstract boolean matchValue(HttpRequest request); + + + @Override + public boolean equals(Object other) { + if (this == other) { + return true; + } + if (other == null || getClass() != other.getClass()) { + return false; + } + AbstractNameValueExpression that = (AbstractNameValueExpression) other; + return ((isCaseSensitiveName() ? this.name.equals(that.name) : this.name.equalsIgnoreCase(that.name)) && + ObjectUtils.nullSafeEquals(this.value, that.value) && this.negated == that.negated); + } + + @Override + public int hashCode() { + int result = (isCaseSensitiveName() ? this.name.hashCode() : this.name.toLowerCase().hashCode()); + result = 31 * result + (this.value != null ? this.value.hashCode() : 0); + result = 31 * result + (this.negated ? 1 : 0); + return result; + } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + if (this.value != null) { + builder.append(this.name); + if (this.negated) { + builder.append('!'); + } + builder.append('='); + builder.append(this.value); + } else { + if (this.negated) { + builder.append('!'); + } + builder.append(this.name); + } + return builder.toString(); + } + +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/CompositeHttpRequestMatcher.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/CompositeHttpRequestMatcher.java new file mode 100644 index 00000000..181edf2b --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/CompositeHttpRequestMatcher.java @@ -0,0 +1,73 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.HttpRequest; + +import java.util.Arrays; +import java.util.Collection; +import java.util.LinkedList; +import java.util.List; + +/** + * Composite {@link HttpRequestMatcher} implementation + * + * @author Mercy + */ +public abstract class CompositeHttpRequestMatcher extends AbstractHttpRequestMatcher { + + private final List matchers = new LinkedList<>(); + + public CompositeHttpRequestMatcher(HttpRequestMatcher... matchers) { + this.matchers.addAll(Arrays.asList(matchers)); + } + + public CompositeHttpRequestMatcher and(HttpRequestMatcher matcher) { + this.matchers.add(matcher); + return this; + } + + @Override + public boolean match(HttpRequest request) { + for (HttpRequestMatcher matcher : matchers) { + if (!matcher.match(request)) { + return false; + } + } + return true; + } + + protected List getMatchers() { + return this.matchers; + } + + @Override + protected Collection getContent() { + List content = new LinkedList<>(); + for (HttpRequestMatcher matcher : getMatchers()) { + if (matcher instanceof AbstractHttpRequestMatcher) { + content.addAll(((AbstractHttpRequestMatcher) matcher).getContent()); + } + } + return content; + } + + @Override + protected String getToStringInfix() { + return " && "; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ConsumeMediaTypeExpression.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ConsumeMediaTypeExpression.java new file mode 100644 index 00000000..3fe1f016 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ConsumeMediaTypeExpression.java @@ -0,0 +1,44 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.MediaType; + +/** + * Parses and matches a single media type expression to a request's 'Content-Type' header. + *

+ * The source code is scratched from + * org.springframework.web.servlet.mvc.condition.ConsumesRequestCondition.ConsumeMediaTypeExpression + * + * @author Rossen Stoyanchev + * @author Arjen Poutsma + */ +class ConsumeMediaTypeExpression extends AbstractMediaTypeExpression { + + ConsumeMediaTypeExpression(String expression) { + super(expression); + } + + ConsumeMediaTypeExpression(MediaType mediaType, boolean negated) { + super(mediaType, negated); + } + + public final boolean match(MediaType contentType) { + boolean match = getMediaType().includes(contentType); + return (!isNegated() ? match : !match); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HeaderExpression.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HeaderExpression.java new file mode 100644 index 00000000..d831a3b9 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HeaderExpression.java @@ -0,0 +1,60 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpRequest; +import org.springframework.util.ObjectUtils; + +/** + * Parses and matches a single header expression to a request. + *

+ * The some source code is scratched from org.springframework.web.servlet.mvc.condition.HeadersRequestCondition.HeaderExpression + * + * @author Arjen Poutsma + * @author Rossen Stoyanchev + * @author Mercy + */ +class HeaderExpression extends AbstractNameValueExpression { + + HeaderExpression(String expression) { + super(expression); + } + + @Override + protected boolean isCaseSensitiveName() { + return false; + } + + @Override + protected String parseValue(String valueExpression) { + return valueExpression; + } + + @Override + protected boolean matchName(HttpRequest request) { + HttpHeaders httpHeaders = request.getHeaders(); + return httpHeaders.containsKey(this.name); + } + + @Override + protected boolean matchValue(HttpRequest request) { + HttpHeaders httpHeaders = request.getHeaders(); + String headerValue = httpHeaders.getFirst(this.name); + return ObjectUtils.nullSafeEquals(this.value, headerValue); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestConsumersMatcher.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestConsumersMatcher.java new file mode 100644 index 00000000..e4d8296a --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestConsumersMatcher.java @@ -0,0 +1,123 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpRequest; +import org.springframework.http.MediaType; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Set; + +/** + * {@link HttpRequest} 'Content-Type' header {@link HttpRequestMatcher matcher} + * + * @author Arjen Poutsma + * @author Rossen Stoyanchev + * @author Mercy + */ +public class HttpRequestConsumersMatcher extends AbstractHttpRequestMatcher { + + private final List expressions; + + /** + * Creates a new instance from 0 or more "consumes" expressions. + * + * @param consumes consumes expressions if 0 expressions are provided, + * the condition will match to every request + */ + public HttpRequestConsumersMatcher(String... consumes) { + this(consumes, null); + } + + /** + * Creates a new instance with "consumes" and "header" expressions. + * "Header" expressions where the header name is not 'Content-Type' or have + * no header value defined are ignored. If 0 expressions are provided in + * total, the condition will match to every request + * + * @param consumes consumes expressions + * @param headers headers expressions + */ + public HttpRequestConsumersMatcher(String[] consumes, String[] headers) { + this(parseExpressions(consumes, headers)); + } + + /** + * Private constructor accepting parsed media type expressions. + */ + private HttpRequestConsumersMatcher(Collection expressions) { + this.expressions = new ArrayList<>(expressions); + Collections.sort(this.expressions); + } + + @Override + public boolean match(HttpRequest request) { + + if (expressions.isEmpty()) { + return true; + } + + HttpHeaders httpHeaders = request.getHeaders(); + + MediaType contentType = httpHeaders.getContentType(); + + if (contentType == null) { + contentType = MediaType.APPLICATION_OCTET_STREAM; + } + + for (ConsumeMediaTypeExpression expression : expressions) { + if (!expression.match(contentType)) { + return false; + } + } + + return true; + } + + private static Set parseExpressions(String[] consumes, String[] headers) { + Set result = new LinkedHashSet<>(); + if (headers != null) { + for (String header : headers) { + HeaderExpression expr = new HeaderExpression(header); + if ("Content-Type".equalsIgnoreCase(expr.name) && expr.value != null) { + for (MediaType mediaType : MediaType.parseMediaTypes(expr.value)) { + result.add(new ConsumeMediaTypeExpression(mediaType, expr.negated)); + } + } + } + } + for (String consume : consumes) { + result.add(new ConsumeMediaTypeExpression(consume)); + } + return result; + } + + @Override + protected Collection getContent() { + return this.expressions; + } + + @Override + protected String getToStringInfix() { + return " || "; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestHeadersMatcher.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestHeadersMatcher.java new file mode 100644 index 00000000..83577bb5 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestHeadersMatcher.java @@ -0,0 +1,71 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpRequest; + +import java.util.Collection; +import java.util.LinkedHashSet; +import java.util.Set; + +/** + * {@link HttpRequest} headers {@link HttpRequestMatcher matcher} + * + * @author Mercy + */ +public class HttpRequestHeadersMatcher extends AbstractHttpRequestMatcher { + + private final Set expressions; + + public HttpRequestHeadersMatcher(String... headers) { + this.expressions = parseExpressions(headers); + } + + private static Set parseExpressions(String... headers) { + Set expressions = new LinkedHashSet<>(); + for (String header : headers) { + HeaderExpression expr = new HeaderExpression(header); + if (HttpHeaders.ACCEPT.equalsIgnoreCase(expr.name) || + HttpHeaders.CONTENT_TYPE.equalsIgnoreCase(expr.name)) { + continue; + } + expressions.add(expr); + } + return expressions; + } + + @Override + public boolean match(HttpRequest request) { + for (HeaderExpression expression : this.expressions) { + if (!expression.match(request)) { + return false; + } + } + return true; + } + + @Override + protected Collection getContent() { + return this.expressions; + } + + @Override + protected String getToStringInfix() { + return " && "; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestMatcher.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestMatcher.java new file mode 100644 index 00000000..ddc395e7 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestMatcher.java @@ -0,0 +1,35 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.HttpRequest; + +/** + * {@link HttpRequest} Matcher + * + * @author Mercy + */ +public interface HttpRequestMatcher { + + /** + * Match {@link HttpRequest} or not + * + * @param request The {@link HttpRequest} instance + * @return if matched, return true, or false. + */ + boolean match(HttpRequest request); +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestMethodsMatcher.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestMethodsMatcher.java new file mode 100644 index 00000000..dd130b87 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestMethodsMatcher.java @@ -0,0 +1,82 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.HttpMethod; +import org.springframework.http.HttpRequest; +import org.springframework.util.StringUtils; + +import java.util.Collection; +import java.util.LinkedHashSet; +import java.util.Set; + +import static org.springframework.http.HttpMethod.resolve; + +/** + * {@link HttpRequest} {@link HttpMethod methods} {@link HttpRequestMatcher matcher} + * + * @author Mercy + */ +public class HttpRequestMethodsMatcher extends AbstractHttpRequestMatcher { + + private final Set methods; + + public HttpRequestMethodsMatcher(String... methods) { + this.methods = resolveHttpMethods(methods); + } + + private Set resolveHttpMethods(String[] methods) { + Set httpMethods = new LinkedHashSet<>(methods.length); + for (String method : methods) { + if (!StringUtils.hasText(method)) { + continue; + } + HttpMethod httpMethod = resolve(method); + httpMethods.add(httpMethod); + } + return httpMethods; + } + + public Set getMethods() { + return methods; + } + + @Override + public boolean match(HttpRequest request) { + boolean matched = false; + HttpMethod httpMethod = request.getMethod(); + if (httpMethod != null) { + for (HttpMethod method : getMethods()) { + if (httpMethod.equals(method)) { + matched = true; + break; + } + } + } + return matched; + } + + @Override + protected Collection getContent() { + return methods; + } + + @Override + protected String getToStringInfix() { + return " || "; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestParamsMatcher.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestParamsMatcher.java new file mode 100644 index 00000000..22f784b2 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestParamsMatcher.java @@ -0,0 +1,72 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.HttpRequest; + +import java.util.Collection; +import java.util.LinkedHashSet; +import java.util.Set; + +/** + * {@link HttpRequest} parameters {@link HttpRequestMatcher matcher} + * + * @author Mercy + */ +public class HttpRequestParamsMatcher extends AbstractHttpRequestMatcher { + + private final Set expressions; + + /** + * @param params The pattern of params : + *

    + *
  • name=value
    • + *
  • name
    • + *
+ */ + public HttpRequestParamsMatcher(String... params) { + this.expressions = parseExpressions(params); + } + + @Override + public boolean match(HttpRequest request) { + for (ParamExpression paramExpression : expressions) { + if (paramExpression.match(request)) { + return true; + } + } + return false; + } + + private static Set parseExpressions(String... params) { + Set expressions = new LinkedHashSet<>(); + for (String param : params) { + expressions.add(new ParamExpression(param)); + } + return expressions; + } + + @Override + protected Collection getContent() { + return this.expressions; + } + + @Override + protected String getToStringInfix() { + return " && "; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestPathMatcher.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestPathMatcher.java new file mode 100644 index 00000000..a9df2159 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestPathMatcher.java @@ -0,0 +1,117 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.HttpRequest; +import org.springframework.util.AntPathMatcher; +import org.springframework.util.PathMatcher; +import org.springframework.util.StringUtils; + +import java.net.URI; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Set; + +/** + * {@link HttpRequest} {@link URI} {@link HttpRequestMatcher matcher} + * + * @author Mercy + */ +public class HttpRequestPathMatcher extends AbstractHttpRequestMatcher { + + private final Set patterns; + + private final PathMatcher pathMatcher; + + public HttpRequestPathMatcher(String... patterns) { + this.patterns = Collections.unmodifiableSet(prependLeadingSlash(patterns)); + this.pathMatcher = new AntPathMatcher(); + } + + @Override + public boolean match(HttpRequest request) { + List matches = getMatchingPatterns(request); + return !matches.isEmpty(); + } + + public List getMatchingPatterns(HttpRequest request) { + String path = getPath(request); + List matches = getMatchingPatterns(path); + return matches; + } + + public List getMatchingPatterns(String lookupPath) { + List matches = new ArrayList<>(); + for (String pattern : this.patterns) { + String match = getMatchingPattern(pattern, lookupPath); + if (match != null) { + matches.add(match); + } + } + if (matches.size() > 1) { + matches.sort(this.pathMatcher.getPatternComparator(lookupPath)); + } + return matches; + } + + private String getMatchingPattern(String pattern, String lookupPath) { + if (pattern.equals(lookupPath)) { + return pattern; + } + boolean hasSuffix = pattern.indexOf('.') != -1; + if (!hasSuffix && this.pathMatcher.match(pattern + ".*", lookupPath)) { + return pattern + ".*"; + } + if (this.pathMatcher.match(pattern, lookupPath)) { + return pattern; + } + + if (!pattern.endsWith("/") && this.pathMatcher.match(pattern + "/", lookupPath)) { + return pattern + "/"; + } + return null; + } + + private String getPath(HttpRequest request) { + URI uri = request.getURI(); + return uri.getPath(); + } + + private static Set prependLeadingSlash(String[] patterns) { + Set result = new LinkedHashSet<>(patterns.length); + for (String pattern : patterns) { + if (StringUtils.hasLength(pattern) && !pattern.startsWith("/")) { + pattern = "/" + pattern; + } + result.add(pattern); + } + return result; + } + + @Override + protected Collection getContent() { + return this.patterns; + } + + @Override + protected String getToStringInfix() { + return " || "; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestProducesMatcher.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestProducesMatcher.java new file mode 100644 index 00000000..b607f122 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestProducesMatcher.java @@ -0,0 +1,119 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpRequest; +import org.springframework.http.MediaType; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Set; + +/** + * {@link HttpRequest} 'Accept' header {@link HttpRequestMatcher matcher} + * + * @author Arjen Poutsma + * @author Rossen Stoyanchev + * @author Mercy + */ +public class HttpRequestProducesMatcher extends AbstractHttpRequestMatcher { + + private final List expressions; + + /** + * Creates a new instance from "produces" expressions. If 0 expressions + * are provided in total, this condition will match to any request. + * + * @param produces produces expressions + */ + public HttpRequestProducesMatcher(String... produces) { + this(produces, null); + } + + /** + * Creates a new instance with "produces" and "header" expressions. "Header" + * expressions where the header name is not 'Accept' or have no header value + * defined are ignored. If 0 expressions are provided in total, this condition + * will match to any request. + * + * @param produces produces expressions + * @param headers headers expressions + */ + public HttpRequestProducesMatcher(String[] produces, String[] headers) { + this(parseExpressions(produces, headers)); + } + + /** + * Private constructor accepting parsed media type expressions. + */ + private HttpRequestProducesMatcher(Collection expressions) { + this.expressions = new ArrayList<>(expressions); + Collections.sort(this.expressions); + } + + @Override + public boolean match(HttpRequest request) { + + if (expressions.isEmpty()) { + return true; + } + + HttpHeaders httpHeaders = request.getHeaders(); + + List acceptedMediaTypes = httpHeaders.getAccept(); + + for (ProduceMediaTypeExpression expression : expressions) { + if (!expression.match(acceptedMediaTypes)) { + return false; + } + } + + return true; + } + + private static Set parseExpressions(String[] produces, String[] headers) { + Set result = new LinkedHashSet<>(); + if (headers != null) { + for (String header : headers) { + HeaderExpression expr = new HeaderExpression(header); + if (HttpHeaders.ACCEPT.equalsIgnoreCase(expr.name) && expr.value != null) { + for (MediaType mediaType : MediaType.parseMediaTypes(expr.value)) { + result.add(new ProduceMediaTypeExpression(mediaType, expr.negated)); + } + } + } + } + for (String produce : produces) { + result.add(new ProduceMediaTypeExpression(produce)); + } + return result; + } + + @Override + protected Collection getContent() { + return expressions; + } + + @Override + protected String getToStringInfix() { + return " || "; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/MediaTypeExpression.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/MediaTypeExpression.java new file mode 100644 index 00000000..8597b619 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/MediaTypeExpression.java @@ -0,0 +1,35 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.MediaType; + +/** + * A contract for media type expressions (e.g. "text/plain", "!text/plain") as + * defined in the for "consumes" and "produces". + *

+ * The source code is scratched from org.springframework.web.servlet.mvc.condition.MediaTypeExpression + * + * @author Rossen Stoyanchev + */ +interface MediaTypeExpression { + + MediaType getMediaType(); + + boolean isNegated(); + +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/NameValueExpression.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/NameValueExpression.java new file mode 100644 index 00000000..4f22cc9c --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/NameValueExpression.java @@ -0,0 +1,38 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + + +/** + * A contract for {@code "name!=value"} style expression used to specify request + * parameters and request header in HTTP request + *

+ * The some source code is scratched from org.springframework.web.servlet.mvc.condition.NameValueExpression + * + * @param the value type + * @author Rossen Stoyanchev + * @author Mercy + */ +interface NameValueExpression { + + String getName(); + + T getValue(); + + boolean isNegated(); + +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ParamExpression.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ParamExpression.java new file mode 100644 index 00000000..90bfccc5 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ParamExpression.java @@ -0,0 +1,62 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.HttpRequest; +import org.springframework.util.MultiValueMap; +import org.springframework.util.ObjectUtils; + +import static org.springframework.cloud.alibaba.dubbo.http.util.HttpUtils.getParameters; + +/** + * Parses and matches a single param expression to a request. + *

+ * The some source code is scratched from org.springframework.web.servlet.mvc.condition.ParamsRequestCondition.ParamExpression + * + * @author Arjen Poutsma + * @author Rossen Stoyanchev + * @author Mercy + */ +class ParamExpression extends AbstractNameValueExpression { + + ParamExpression(String expression) { + super(expression); + } + + @Override + protected boolean isCaseSensitiveName() { + return true; + } + + @Override + protected String parseValue(String valueExpression) { + return valueExpression; + } + + @Override + protected boolean matchName(HttpRequest request) { + MultiValueMap parametersMap = getParameters(request); + return parametersMap.containsKey(this.name); + } + + @Override + protected boolean matchValue(HttpRequest request) { + MultiValueMap parametersMap = getParameters(request); + String parameterValue = parametersMap.getFirst(this.name); + return ObjectUtils.nullSafeEquals(this.value, parameterValue); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ProduceMediaTypeExpression.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ProduceMediaTypeExpression.java new file mode 100644 index 00000000..2e223bf9 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ProduceMediaTypeExpression.java @@ -0,0 +1,55 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.http.MediaType; + +import java.util.List; + +/** + * Parses and matches a single media type expression to a request's 'Accept' header. + *

+ * The source code is scratched from + * org.springframework.web.servlet.mvc.condition.ProducesRequestCondition.ProduceMediaTypeExpression + * + * @author Rossen Stoyanchev + * @author Arjen Poutsma + */ +class ProduceMediaTypeExpression extends AbstractMediaTypeExpression { + + ProduceMediaTypeExpression(String expression) { + super(expression); + } + + ProduceMediaTypeExpression(MediaType mediaType, boolean negated) { + super(mediaType, negated); + } + + public final boolean match(List acceptedMediaTypes) { + boolean match = matchMediaType(acceptedMediaTypes); + return (!isNegated() ? match : !match); + } + + private boolean matchMediaType(List acceptedMediaTypes) { + for (MediaType acceptedMediaType : acceptedMediaTypes) { + if (getMediaType().isCompatibleWith(acceptedMediaType)) { + return true; + } + } + return false; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/RequestMetadataMatcher.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/RequestMetadataMatcher.java new file mode 100644 index 00000000..6e3e9519 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/matcher/RequestMetadataMatcher.java @@ -0,0 +1,46 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.springframework.cloud.alibaba.dubbo.metadata.RequestMetadata; + +import static org.springframework.cloud.alibaba.dubbo.http.util.HttpUtils.toNameAndValues; + +/** + * {@link RequestMetadata} {@link HttpRequestMatcher} implementation + * + * @author Mercy + */ +public class RequestMetadataMatcher extends CompositeHttpRequestMatcher { + + public RequestMetadataMatcher(RequestMetadata metadata) { + super( + // method + new HttpRequestMethodsMatcher(metadata.getMethod()), + // url + new HttpRequestPathMatcher(metadata.getPath()), + // params + new HttpRequestParamsMatcher(toNameAndValues(metadata.getParams())), + // headers + new HttpRequestHeadersMatcher(toNameAndValues(metadata.getHeaders())), + // consumes + new HttpRequestConsumersMatcher(metadata.getConsumes().toArray(new String[0])), + // produces + new HttpRequestProducesMatcher(metadata.getProduces().toArray(new String[0])) + ); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/util/HttpMessageConverterResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/util/HttpMessageConverterResolver.java new file mode 100644 index 00000000..bf2fa95f --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/util/HttpMessageConverterResolver.java @@ -0,0 +1,228 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.util; + +import org.springframework.cloud.alibaba.dubbo.http.converter.HttpMessageConverterHolder; +import org.springframework.cloud.alibaba.dubbo.metadata.RequestMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; +import org.springframework.core.MethodParameter; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpRequest; +import org.springframework.http.MediaType; +import org.springframework.http.converter.GenericHttpMessageConverter; +import org.springframework.http.converter.HttpMessageConverter; +import org.springframework.http.server.ServletServerHttpRequest; +import org.springframework.http.server.ServletServerHttpResponse; +import org.springframework.util.ClassUtils; +import org.springframework.util.CollectionUtils; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Set; + +import static java.util.Collections.unmodifiableList; + +/** + * {@link HttpMessageConverter} Resolver + * + * @author Mercy + */ +public class HttpMessageConverterResolver { + + private static final MediaType MEDIA_TYPE_APPLICATION = new MediaType("application"); + + private final List> messageConverters; + + private final List allSupportedMediaTypes; + + private final ClassLoader classLoader; + + public HttpMessageConverterResolver(List> messageConverters, ClassLoader classLoader) { + this.messageConverters = messageConverters; + this.allSupportedMediaTypes = getAllSupportedMediaTypes(messageConverters); + this.classLoader = classLoader; + } + + public HttpMessageConverterHolder resolve(HttpRequest request, Class parameterType) { + + HttpMessageConverterHolder httpMessageConverterHolder = null; + + HttpHeaders httpHeaders = request.getHeaders(); + + MediaType contentType = httpHeaders.getContentType(); + + if (contentType == null) { + contentType = MediaType.APPLICATION_OCTET_STREAM; + } + + for (HttpMessageConverter converter : this.messageConverters) { + if (converter instanceof GenericHttpMessageConverter) { + GenericHttpMessageConverter genericConverter = (GenericHttpMessageConverter) converter; + if (genericConverter.canRead(parameterType, parameterType, contentType)) { + httpMessageConverterHolder = new HttpMessageConverterHolder(contentType, converter); + break; + } + } else { + if (converter.canRead(parameterType, contentType)) { + httpMessageConverterHolder = new HttpMessageConverterHolder(contentType, converter); + break; + } + } + + } + + return httpMessageConverterHolder; + } + + /** + * Resolve the most match {@link HttpMessageConverter} from {@link RequestMetadata} + * + * @param requestMetadata {@link RequestMetadata} + * @param restMethodMetadata {@link RestMethodMetadata} + * @return + */ + public HttpMessageConverterHolder resolve(RequestMetadata requestMetadata, RestMethodMetadata + restMethodMetadata) { + + HttpMessageConverterHolder httpMessageConverterHolder = null; + + Class returnValueClass = resolveReturnValueClass(restMethodMetadata); + + /** + * @see AbstractMessageConverterMethodProcessor#writeWithMessageConverters(Object, MethodParameter, ServletServerHttpRequest, ServletServerHttpResponse) + */ + List requestedMediaTypes = getAcceptableMediaTypes(requestMetadata); + List producibleMediaTypes = getProducibleMediaTypes(restMethodMetadata, returnValueClass); + + Set compatibleMediaTypes = new LinkedHashSet(); + for (MediaType requestedType : requestedMediaTypes) { + for (MediaType producibleType : producibleMediaTypes) { + if (requestedType.isCompatibleWith(producibleType)) { + compatibleMediaTypes.add(getMostSpecificMediaType(requestedType, producibleType)); + } + } + } + + if (compatibleMediaTypes.isEmpty()) { + return httpMessageConverterHolder; + } + + List mediaTypes = new ArrayList<>(compatibleMediaTypes); + + MediaType.sortBySpecificityAndQuality(mediaTypes); + + MediaType selectedMediaType = null; + for (MediaType mediaType : mediaTypes) { + if (mediaType.isConcrete()) { + selectedMediaType = mediaType; + break; + } else if (mediaType.equals(MediaType.ALL) || mediaType.equals(MEDIA_TYPE_APPLICATION)) { + selectedMediaType = MediaType.APPLICATION_OCTET_STREAM; + break; + } + } + + if (selectedMediaType != null) { + selectedMediaType = selectedMediaType.removeQualityValue(); + for (HttpMessageConverter messageConverter : this.messageConverters) { + if (messageConverter.canWrite(returnValueClass, selectedMediaType)) { + httpMessageConverterHolder = new HttpMessageConverterHolder(selectedMediaType, messageConverter); + break; + } + } + } + + return httpMessageConverterHolder; + } + + public List getAllSupportedMediaTypes() { + return unmodifiableList(allSupportedMediaTypes); + } + + private Class resolveReturnValueClass(RestMethodMetadata restMethodMetadata) { + String returnClassName = restMethodMetadata.getMethod().getReturnType(); + return ClassUtils.resolveClassName(returnClassName, classLoader); + } + + /** + * Resolve the {@link MediaType media-types} + * + * @param requestMetadata {@link RequestMetadata} from client side + * @return non-null {@link List} + */ + private List getAcceptableMediaTypes(RequestMetadata requestMetadata) { + return requestMetadata.getProduceMediaTypes(); + } + + /** + * Returns + * the media types that can be produced:

  • The producible media types specified in the request mappings, or + *
  • Media types of configured converters that can write the specific return value, or
  • {@link MediaType#ALL} + *
+ * + * @param restMethodMetadata {@link RestMethodMetadata} from server side + * @param returnValueClass the class of return value + * @return non-null {@link List} + */ + private List getProducibleMediaTypes(RestMethodMetadata restMethodMetadata, Class + returnValueClass) { + RequestMetadata serverRequestMetadata = restMethodMetadata.getRequest(); + List mediaTypes = serverRequestMetadata.getProduceMediaTypes(); + if (!CollectionUtils.isEmpty(mediaTypes)) { // Empty + return mediaTypes; + } else if (!this.allSupportedMediaTypes.isEmpty()) { + List result = new ArrayList<>(); + for (HttpMessageConverter converter : this.messageConverters) { + if (converter.canWrite(returnValueClass, null)) { + result.addAll(converter.getSupportedMediaTypes()); + } + } + return result; + } else { + return Collections.singletonList(MediaType.ALL); + } + } + + /** + * Return the media types + * supported by all provided message converters sorted by specificity via {@link + * MediaType#sortBySpecificity(List)}. + * + * @param messageConverters + * @return + */ + private List getAllSupportedMediaTypes(List> messageConverters) { + Set allSupportedMediaTypes = new LinkedHashSet(); + for (HttpMessageConverter messageConverter : messageConverters) { + allSupportedMediaTypes.addAll(messageConverter.getSupportedMediaTypes()); + } + List result = new ArrayList(allSupportedMediaTypes); + MediaType.sortBySpecificity(result); + return unmodifiableList(result); + } + + /** + * Return the more specific of the acceptable and the producible media types + * with the q-value of the former. + */ + private MediaType getMostSpecificMediaType(MediaType acceptType, MediaType produceType) { + MediaType produceTypeToUse = produceType.copyQualityValue(acceptType); + return (MediaType.SPECIFICITY_COMPARATOR.compare(acceptType, produceTypeToUse) <= 0 ? acceptType : produceTypeToUse); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/util/HttpUtils.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/util/HttpUtils.java new file mode 100644 index 00000000..9340e86f --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/http/util/HttpUtils.java @@ -0,0 +1,239 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.util; + +import org.springframework.http.HttpRequest; +import org.springframework.util.LinkedMultiValueMap; +import org.springframework.util.MultiValueMap; +import org.springframework.util.StringUtils; + +import java.io.UnsupportedEncodingException; +import java.net.URI; +import java.net.URLDecoder; +import java.net.URLEncoder; +import java.util.Arrays; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import static org.springframework.util.StringUtils.delimitedListToStringArray; +import static org.springframework.util.StringUtils.hasText; +import static org.springframework.util.StringUtils.trimAllWhitespace; + +/** + * Http Utilities class + * + * @author Mercy + */ +public abstract class HttpUtils { + + private static final String UTF_8 = "UTF-8"; + + private static final String EQUAL = "="; + + private static final String AND = "&"; + + private static final String SEMICOLON = ";"; + + private static final String QUESTION_MASK = "?"; + + /** + * The empty value + */ + private static final String EMPTY_VALUE = ""; + + /** + * Normalize path: + *
    + *
  1. To remove query string if presents
    2. + *
  2. To remove duplicated slash("/") if exists
    3. + *
+ * + * @param path path to be normalized + * @return a normalized path if required + */ + public static String normalizePath(String path) { + if (!hasText(path)) { + return path; + } + String normalizedPath = path; + int index = normalizedPath.indexOf(QUESTION_MASK); + if (index > -1) { + normalizedPath = normalizedPath.substring(0, index); + } + return StringUtils.replace(normalizedPath, "//", "/"); + } + + + /** + * Get Parameters from the specified {@link HttpRequest request} + * + * @param request the specified {@link HttpRequest request} + * @return + */ + public static MultiValueMap getParameters(HttpRequest request) { + URI uri = request.getURI(); + return getParameters(uri.getQuery()); + } + + /** + * Get Parameters from the specified query string. + *

+ * + * @param queryString The query string + * @return The query parameters + */ + public static MultiValueMap getParameters(String queryString) { + return getParameters(delimitedListToStringArray(queryString, AND)); + } + + /** + * Get Parameters from the specified pairs of name-value. + *

+ * + * @param pairs The pairs of name-value + * @return The query parameters + */ + public static MultiValueMap getParameters(Iterable pairs) { + MultiValueMap parameters = new LinkedMultiValueMap<>(); + if (pairs != null) { + for (String pair : pairs) { + String[] nameAndValue = delimitedListToStringArray(pair, EQUAL); + String name = decode(nameAndValue[0]); + String value = nameAndValue.length < 2 ? null : nameAndValue[1]; + value = decode(value); + addParam(parameters, name, value); + } + } + return parameters; + } + + /** + * Get Parameters from the specified pairs of name-value. + *

+ * + * @param pairs The pairs of name-value + * @return The query parameters + */ + public static MultiValueMap getParameters(String... pairs) { + return getParameters(Arrays.asList(pairs)); + } + +// /** +// * Parse a read-only {@link MultiValueMap} of {@link HttpCookie} from {@link HttpHeaders} +// * +// * @param httpHeaders {@link HttpHeaders} +// * @return non-null, the key is a cookie name , the value is {@link HttpCookie} +// */ +// public static MultiValueMap parseCookies(HttpHeaders httpHeaders) { +// +// String cookie = httpHeaders.getFirst(COOKIE); +// +// String[] cookieNameAndValues = StringUtils.delimitedListToStringArray(cookie, SEMICOLON); +// +// MultiValueMap cookies = new LinkedMultiValueMap<>(cookieNameAndValues.length); +// +// for (String cookeNameAndValue : cookieNameAndValues) { +// String[] nameAndValue = delimitedListToStringArray(trimWhitespace(cookeNameAndValue), EQUAL); +// String name = nameAndValue[0]; +// String value = nameAndValue.length < 2 ? null : nameAndValue[1]; +// HttpCookie httpCookie = new HttpCookie(name, value); +// cookies.add(name, httpCookie); +// } +// +// return cookies; +// } + + /** + * To the name and value line sets + * + * @param nameAndValuesMap {@link MultiValueMap} the map of name and values + * @return non-null + */ + public static Set toNameAndValuesSet(Map> nameAndValuesMap) { + Set nameAndValues = new LinkedHashSet<>(); + for (Map.Entry> entry : nameAndValuesMap.entrySet()) { + String name = entry.getKey(); + List values = entry.getValue(); + for (String value : values) { + String nameAndValue = name + EQUAL + value; + nameAndValues.add(nameAndValue); + } + } + return nameAndValues; + } + + public static String[] toNameAndValues(Map> nameAndValuesMap) { + return toNameAndValuesSet(nameAndValuesMap).toArray(new String[0]); + } + + /** + * Generate a string of query string from the specified request parameters {@link Map} + * + * @param params the specified request parameters {@link Map} + * @return non-null + */ + public static String toQueryString(Map> params) { + StringBuilder builder = new StringBuilder(); + for (String line : toNameAndValuesSet(params)) { + builder.append(line).append(AND); + } + return builder.toString(); + } + + /** + * Decode value + * + * @param value the value requires to decode + * @return the decoded value + */ + public static String decode(String value) { + if (value == null) { + return value; + } + String decodedValue = value; + try { + decodedValue = URLDecoder.decode(value, UTF_8); + } catch (UnsupportedEncodingException ex) { + } + return decodedValue; + } + + /** + * encode value + * + * @param value the value requires to encode + * @return the encoded value + */ + public static String encode(String value) { + String encodedValue = value; + try { + encodedValue = URLEncoder.encode(value, UTF_8); + } catch (UnsupportedEncodingException ex) { + } + return encodedValue; + } + + private static void addParam(MultiValueMap paramsMap, String name, String value) { + String paramValue = trimAllWhitespace(value); + if (!StringUtils.hasText(paramValue)) { + paramValue = EMPTY_VALUE; + } + paramsMap.add(trimAllWhitespace(name), paramValue); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/DubboServiceMetadata.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/DubboServiceMetadata.java new file mode 100644 index 00000000..f245df09 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/DubboServiceMetadata.java @@ -0,0 +1,58 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.metadata; + +import java.util.Objects; + +/** + * Dubbo Service Metadata + * + * @author Mercy + */ +public class DubboServiceMetadata { + + private final ServiceRestMetadata serviceRestMetadata; + + private final RestMethodMetadata restMethodMetadata; + + public DubboServiceMetadata(ServiceRestMetadata serviceRestMetadata, RestMethodMetadata restMethodMetadata) { + this.serviceRestMetadata = serviceRestMetadata; + this.restMethodMetadata = restMethodMetadata; + } + + public ServiceRestMetadata getServiceRestMetadata() { + return serviceRestMetadata; + } + + public RestMethodMetadata getRestMethodMetadata() { + return restMethodMetadata; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (!(o instanceof DubboServiceMetadata)) return false; + DubboServiceMetadata that = (DubboServiceMetadata) o; + return Objects.equals(serviceRestMetadata, that.serviceRestMetadata) && + Objects.equals(restMethodMetadata, that.restMethodMetadata); + } + + @Override + public int hashCode() { + return Objects.hash(serviceRestMetadata, restMethodMetadata); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/DubboTransportedMetadata.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/DubboTransportedMetadata.java new file mode 100644 index 00000000..2811bdaf --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/DubboTransportedMetadata.java @@ -0,0 +1,61 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.metadata; + +import org.springframework.cloud.alibaba.dubbo.annotation.DubboTransported; + +import java.util.Objects; + +/** + * {@link DubboTransported @DubboTransported} Metadata + */ +public class DubboTransportedMetadata { + + private String protocol; + + private String cluster; + + public String getProtocol() { + return protocol; + } + + public void setProtocol(String protocol) { + this.protocol = protocol; + } + + public String getCluster() { + return cluster; + } + + public void setCluster(String cluster) { + this.cluster = cluster; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (!(o instanceof DubboTransportedMetadata)) return false; + DubboTransportedMetadata that = (DubboTransportedMetadata) o; + return Objects.equals(protocol, that.protocol) && + Objects.equals(cluster, that.cluster); + } + + @Override + public int hashCode() { + return Objects.hash(protocol, cluster); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/DubboTransportedMethodMetadata.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/DubboTransportedMethodMetadata.java new file mode 100644 index 00000000..ade65aa9 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/DubboTransportedMethodMetadata.java @@ -0,0 +1,106 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.metadata; + +import org.springframework.cloud.alibaba.dubbo.annotation.DubboTransported; + +import java.lang.reflect.Method; +import java.util.List; +import java.util.Objects; + +/** + * {@link MethodMetadata} annotated {@link DubboTransported @DubboTransported} + * + * @author Mercy + */ +public class DubboTransportedMethodMetadata { + + private final DubboTransportedMetadata dubboTransportedMetadata; + + private final MethodMetadata methodMetadata; + + public DubboTransportedMethodMetadata(Method method) { + this.methodMetadata = new MethodMetadata(method); + this.dubboTransportedMetadata = new DubboTransportedMetadata(); + } + + public String getProtocol() { + return dubboTransportedMetadata.getProtocol(); + } + + public void setProtocol(String protocol) { + dubboTransportedMetadata.setProtocol(protocol); + } + + public String getCluster() { + return dubboTransportedMetadata.getCluster(); + } + + public void setCluster(String cluster) { + dubboTransportedMetadata.setCluster(cluster); + } + + public String getName() { + return methodMetadata.getName(); + } + + public void setName(String name) { + methodMetadata.setName(name); + } + + public String getReturnType() { + return methodMetadata.getReturnType(); + } + + public void setReturnType(String returnType) { + methodMetadata.setReturnType(returnType); + } + + public List getParams() { + return methodMetadata.getParams(); + } + + public void setParams(List params) { + methodMetadata.setParams(params); + } + + public Method getMethod() { + return methodMetadata.getMethod(); + } + + public DubboTransportedMetadata getDubboTransportedMetadata() { + return dubboTransportedMetadata; + } + + public MethodMetadata getMethodMetadata() { + return methodMetadata; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (!(o instanceof DubboTransportedMethodMetadata)) return false; + DubboTransportedMethodMetadata that = (DubboTransportedMethodMetadata) o; + return Objects.equals(dubboTransportedMetadata, that.dubboTransportedMetadata) && + Objects.equals(methodMetadata, that.methodMetadata); + } + + @Override + public int hashCode() { + return Objects.hash(dubboTransportedMetadata, methodMetadata); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/MethodMetadata.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/MethodMetadata.java index 18abf0e9..9dfe6ea4 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/MethodMetadata.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/MethodMetadata.java @@ -17,7 +17,8 @@ package org.springframework.cloud.alibaba.dubbo.metadata; import com.fasterxml.jackson.annotation.JsonIgnore; -import org.apache.commons.lang3.ClassUtils; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; import java.lang.reflect.Method; import java.lang.reflect.Parameter; @@ -32,10 +33,12 @@ import java.util.Objects; * * @author Mercy */ +@JsonInclude(JsonInclude.Include.NON_NULL) public class MethodMetadata { private String name; + @JsonProperty("return-type") private String returnType; private List params; @@ -49,7 +52,7 @@ public class MethodMetadata { public MethodMetadata(Method method) { this.name = method.getName(); - this.returnType = ClassUtils.getName(method.getReturnType()); + this.returnType = method.getReturnType().getName(); this.params = initParameters(method); this.method = method; } @@ -119,4 +122,14 @@ public class MethodMetadata { public int hashCode() { return Objects.hash(name, returnType, params); } + + @Override + public String toString() { + return "MethodMetadata{" + + "name='" + name + '\'' + + ", returnType='" + returnType + '\'' + + ", params=" + params + + ", method=" + method + + '}'; + } } diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/MethodParameterMetadata.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/MethodParameterMetadata.java index fbcaad00..0abf2b0e 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/MethodParameterMetadata.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/MethodParameterMetadata.java @@ -16,6 +16,8 @@ */ package org.springframework.cloud.alibaba.dubbo.metadata; +import com.fasterxml.jackson.annotation.JsonInclude; + import java.lang.reflect.Method; import java.util.Objects; @@ -24,6 +26,7 @@ import java.util.Objects; * * @author Mercy */ +@JsonInclude(JsonInclude.Include.NON_NULL) public class MethodParameterMetadata { private int index; @@ -70,4 +73,13 @@ public class MethodParameterMetadata { public int hashCode() { return Objects.hash(index, name, type); } + + @Override + public String toString() { + return "MethodParameterMetadata{" + + "index=" + index + + ", name='" + name + '\'' + + ", type='" + type + '\'' + + '}'; + } } diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/RequestMetadata.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/RequestMetadata.java index ae3d10dc..29361b93 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/RequestMetadata.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/RequestMetadata.java @@ -16,11 +16,29 @@ */ package org.springframework.cloud.alibaba.dubbo.metadata; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonProperty; import feign.RequestTemplate; +import org.springframework.http.HttpHeaders; +import org.springframework.http.MediaType; +import org.springframework.util.CollectionUtils; +import org.springframework.util.LinkedMultiValueMap; +import org.springframework.util.MultiValueMap; +import java.util.ArrayList; import java.util.Collection; +import java.util.Collections; +import java.util.LinkedHashSet; +import java.util.LinkedList; +import java.util.List; import java.util.Map; +import java.util.NavigableMap; import java.util.Objects; +import java.util.Set; +import java.util.SortedMap; + +import static org.springframework.cloud.alibaba.dubbo.http.util.HttpUtils.normalizePath; +import static org.springframework.http.MediaType.parseMediaTypes; /** * Request Metadata @@ -31,20 +49,26 @@ public class RequestMetadata { private String method; - private String url; + private String path; - private Map> queries; + @JsonProperty("params") + private MultiValueMap params = new LinkedMultiValueMap<>(); - private Map> headers; + @JsonProperty("headers") + private HttpHeaders headers = new HttpHeaders(); + + private Set consumes = new LinkedHashSet<>(); + + private Set produces = new LinkedHashSet<>(); public RequestMetadata() { } public RequestMetadata(RequestTemplate requestTemplate) { - this.method = requestTemplate.method(); - this.url = requestTemplate.url(); - this.queries = requestTemplate.queries(); - this.headers = requestTemplate.headers(); + setMethod(requestTemplate.method()); + setPath(requestTemplate.url()); + params(requestTemplate.queries()); + headers(requestTemplate.headers()); } public String getMethod() { @@ -52,46 +76,193 @@ public class RequestMetadata { } public void setMethod(String method) { - this.method = method; + this.method = method.toUpperCase(); } - public String getUrl() { - return url; + public String getPath() { + return path; } - public void setUrl(String url) { - this.url = url; + public void setPath(String path) { + this.path = normalizePath(path); } - public Map> getHeaders() { + public MultiValueMap getParams() { + return params; + } + + public void setParams(Map> params) { + params(params); + } + + public Map> getHeaders() { return headers; } - public void setHeaders(Map> headers) { - this.headers = headers; + public void setHeaders(Map> headers) { + headers(headers); } - public Map> getQueries() { - return queries; + public Set getConsumes() { + return consumes; } - public void setQueries(Map> queries) { - this.queries = queries; + public void setConsumes(Set consumes) { + this.consumes = consumes; + } + + public Set getProduces() { + return produces; + } + + public void setProduces(Set produces) { + this.produces = produces; + } + + // @JsonIgnore properties + @JsonIgnore + public Set getParamNames() { + return params.keySet(); + } + + @JsonIgnore + public Set getHeaderNames() { + return headers.keySet(); + } + + @JsonIgnore + public List getConsumeMediaTypes() { + return toMediaTypes(consumes); + } + + @JsonIgnore + public List getProduceMediaTypes() { + return toMediaTypes(produces); + } + + public String getParameter(String name) { + return this.params.getFirst(name); + } + + public String getHeader(String name) { + return this.headers.getFirst(name); + } + + public RequestMetadata addParam(String name, String value) { + add(name, value, this.params); + return this; + } + + public RequestMetadata addHeader(String name, String value) { + add(name, value, this.headers); + return this; + } + + private > RequestMetadata params(Map params) { + addAll(params, this.params); + return this; + } + + private > RequestMetadata headers(Map headers) { + if (!CollectionUtils.isEmpty(headers)) { + HttpHeaders httpHeaders = new HttpHeaders(); + // Add all headers + addAll(headers, httpHeaders); + // Handles "Content-Type" and "Accept" headers if present + mediaTypes(httpHeaders, HttpHeaders.CONTENT_TYPE, this.consumes); + mediaTypes(httpHeaders, HttpHeaders.ACCEPT, this.produces); + this.headers.putAll(httpHeaders); + } + return this; + } + + /** + * Get the best matched {@link RequestMetadata} via specified {@link RequestMetadata} + * + * @param requestMetadataMap the source of {@link NavigableMap} + * @param requestMetadata the match object + * @return if not matched, return null + */ + public static RequestMetadata getBestMatch(NavigableMap requestMetadataMap, + RequestMetadata requestMetadata) { + + RequestMetadata key = requestMetadata; + + RequestMetadata result = requestMetadataMap.get(key); + + if (result == null) { + SortedMap headMap = requestMetadataMap.headMap(key, true); + result = headMap.isEmpty() ? null : requestMetadataMap.get(headMap.lastKey()); + } + + return result; + } + + private static void add(String key, String value, MultiValueMap destination) { + destination.add(key, value); + } + + private static > void addAll(Map source, + MultiValueMap destination) { + for (Map.Entry entry : source.entrySet()) { + String key = entry.getKey(); + for (String value : entry.getValue()) { + add(key, value, destination); + } + } + } + + private static void mediaTypes(HttpHeaders httpHeaders, String headerName, Collection destination) { + List value = httpHeaders.get(headerName); + List mediaTypes = parseMediaTypes(value); + destination.addAll(toMediaTypeValues(mediaTypes)); + } + + private static List toMediaTypeValues(List mediaTypes) { + List list = new ArrayList<>(mediaTypes.size()); + for (MediaType mediaType : mediaTypes) { + list.add(mediaType.toString()); + } + return list; + } + + private static List toMediaTypes(Collection mediaTypeValues) { + if (mediaTypeValues.isEmpty()) { + return Collections.singletonList(MediaType.ALL); + } + return parseMediaTypes(new LinkedList<>(mediaTypeValues)); } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; + if (!(o instanceof RequestMetadata)) return false; RequestMetadata that = (RequestMetadata) o; return Objects.equals(method, that.method) && - Objects.equals(url, that.url) && - Objects.equals(queries, that.queries) && - Objects.equals(headers, that.headers); + Objects.equals(path, that.path) && + Objects.equals(consumes, that.consumes) && + Objects.equals(produces, that.produces) && + // Metadata should not compare the values + Objects.equals(getParamNames(), that.getParamNames()) && + Objects.equals(getHeaderNames(), that.getHeaderNames()); + } @Override public int hashCode() { - return Objects.hash(method, url, queries, headers); + // The values of metadata should not use for the hashCode() method + return Objects.hash(method, path, consumes, produces, getParamNames(), getHeaderNames()); + } + + @Override + public String toString() { + return "RequestMetadata{" + + "method='" + method + '\'' + + ", path='" + path + '\'' + + ", params=" + params + + ", headers=" + headers + + ", consumes=" + consumes + + ", produces=" + produces + + '}'; } } diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/RestMethodMetadata.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/RestMethodMetadata.java index 5024fefa..edbcf46a 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/RestMethodMetadata.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/RestMethodMetadata.java @@ -16,21 +16,75 @@ */ package org.springframework.cloud.alibaba.dubbo.metadata; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import org.springframework.core.ResolvableType; + +import java.lang.reflect.Type; import java.util.Collection; +import java.util.List; import java.util.Map; import java.util.Objects; /** * Method Request Metadata + * + * @author Mercy */ +@JsonInclude(JsonInclude.Include.NON_NULL) public class RestMethodMetadata { private MethodMetadata method; private RequestMetadata request; + @JsonProperty("url-index") + private Integer urlIndex; + + @JsonProperty("setBody-index") + private Integer bodyIndex; + + @JsonProperty("header-map-index") + private Integer headerMapIndex; + + @JsonProperty("query-map-index") + private Integer queryMapIndex; + + @JsonProperty("query-map-encoded") + private boolean queryMapEncoded; + + @JsonProperty("return-type") + private String returnType; + + @JsonProperty("setBody-type") + private String bodyType; + + @JsonProperty("index-to-name") private Map> indexToName; + @JsonProperty("form-params") + private List formParams; + + @JsonProperty("index-to-encoded") + private Map indexToEncoded; + + public RestMethodMetadata() { + } + + public RestMethodMetadata(feign.MethodMetadata methodMetadata) { + this.request = new RequestMetadata(methodMetadata.template()); + this.urlIndex = methodMetadata.urlIndex(); + this.bodyIndex = methodMetadata.bodyIndex(); + this.headerMapIndex = methodMetadata.headerMapIndex(); + this.queryMapEncoded = methodMetadata.queryMapEncoded(); + this.queryMapEncoded = methodMetadata.queryMapEncoded(); + this.returnType = getClassName(methodMetadata.returnType()); + this.bodyType = getClassName(methodMetadata.bodyType()); + this.indexToName = methodMetadata.indexToName(); + this.formParams = methodMetadata.formParams(); + this.indexToEncoded = methodMetadata.indexToEncoded(); + } + public MethodMetadata getMethod() { return method; } @@ -55,18 +109,126 @@ public class RestMethodMetadata { this.indexToName = indexToName; } + public Integer getUrlIndex() { + return urlIndex; + } + + public void setUrlIndex(Integer urlIndex) { + this.urlIndex = urlIndex; + } + + public Integer getBodyIndex() { + return bodyIndex; + } + + public void setBodyIndex(Integer bodyIndex) { + this.bodyIndex = bodyIndex; + } + + public Integer getHeaderMapIndex() { + return headerMapIndex; + } + + public void setHeaderMapIndex(Integer headerMapIndex) { + this.headerMapIndex = headerMapIndex; + } + + public Integer getQueryMapIndex() { + return queryMapIndex; + } + + public void setQueryMapIndex(Integer queryMapIndex) { + this.queryMapIndex = queryMapIndex; + } + + public boolean isQueryMapEncoded() { + return queryMapEncoded; + } + + public void setQueryMapEncoded(boolean queryMapEncoded) { + this.queryMapEncoded = queryMapEncoded; + } + + public String getReturnType() { + return returnType; + } + + public void setReturnType(String returnType) { + this.returnType = returnType; + } + + public String getBodyType() { + return bodyType; + } + + public void setBodyType(String bodyType) { + this.bodyType = bodyType; + } + + public List getFormParams() { + return formParams; + } + + public void setFormParams(List formParams) { + this.formParams = formParams; + } + + public Map getIndexToEncoded() { + return indexToEncoded; + } + + public void setIndexToEncoded(Map indexToEncoded) { + this.indexToEncoded = indexToEncoded; + } + @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; + if (!(o instanceof RestMethodMetadata)) return false; RestMethodMetadata that = (RestMethodMetadata) o; - return Objects.equals(method, that.method) && + return queryMapEncoded == that.queryMapEncoded && + Objects.equals(method, that.method) && Objects.equals(request, that.request) && - Objects.equals(indexToName, that.indexToName); + Objects.equals(urlIndex, that.urlIndex) && + Objects.equals(bodyIndex, that.bodyIndex) && + Objects.equals(headerMapIndex, that.headerMapIndex) && + Objects.equals(queryMapIndex, that.queryMapIndex) && + Objects.equals(returnType, that.returnType) && + Objects.equals(bodyType, that.bodyType) && + Objects.equals(indexToName, that.indexToName) && + Objects.equals(formParams, that.formParams) && + Objects.equals(indexToEncoded, that.indexToEncoded); } @Override public int hashCode() { - return Objects.hash(method, request, indexToName); + return Objects.hash(method, request, urlIndex, bodyIndex, headerMapIndex, queryMapIndex, queryMapEncoded, + returnType, bodyType, indexToName, formParams, indexToEncoded); + } + + private String getClassName(Type type) { + if (type == null) { + return null; + } + ResolvableType resolvableType = ResolvableType.forType(type); + return resolvableType.resolve().getName(); + } + + @Override + public String toString() { + return "RestMethodMetadata{" + + "method=" + method + + ", request=" + request + + ", urlIndex=" + urlIndex + + ", bodyIndex=" + bodyIndex + + ", headerMapIndex=" + headerMapIndex + + ", queryMapIndex=" + queryMapIndex + + ", queryMapEncoded=" + queryMapEncoded + + ", returnType='" + returnType + '\'' + + ", bodyType='" + bodyType + '\'' + + ", indexToName=" + indexToName + + ", formParams=" + formParams + + ", indexToEncoded=" + indexToEncoded + + '}'; } } diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/ServiceRestMetadata.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/ServiceRestMetadata.java index d5ba11f4..42efe71d 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/ServiceRestMetadata.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/ServiceRestMetadata.java @@ -16,6 +16,9 @@ */ package org.springframework.cloud.alibaba.dubbo.metadata; +import com.fasterxml.jackson.annotation.JsonInclude; + +import java.util.Objects; import java.util.Set; /** @@ -24,6 +27,7 @@ import java.util.Set; * @author Mercy * @see RestMethodMetadata */ +@JsonInclude(JsonInclude.Include.NON_NULL) public class ServiceRestMetadata { private String name; @@ -49,18 +53,14 @@ public class ServiceRestMetadata { @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - + if (!(o instanceof ServiceRestMetadata)) return false; ServiceRestMetadata that = (ServiceRestMetadata) o; - - if (name != null ? !name.equals(that.name) : that.name != null) return false; - return meta != null ? meta.equals(that.meta) : that.meta == null; + return Objects.equals(name, that.name) && + Objects.equals(meta, that.meta); } @Override public int hashCode() { - int result = name != null ? name.hashCode() : 0; - result = 31 * result + (meta != null ? meta.hashCode() : 0); - return result; + return Objects.hash(name, meta); } } diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/repository/DubboServiceMetadataRepository.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/repository/DubboServiceMetadataRepository.java index 57a0a133..e8d21a31 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/repository/DubboServiceMetadataRepository.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/repository/DubboServiceMetadataRepository.java @@ -16,25 +16,28 @@ */ package org.springframework.cloud.alibaba.dubbo.metadata.repository; -import com.alibaba.dubbo.config.spring.ReferenceBean; -import com.alibaba.dubbo.rpc.service.GenericService; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.type.TypeFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.cloud.alibaba.dubbo.metadata.MethodMetadata; +import org.springframework.cloud.alibaba.dubbo.http.matcher.RequestMetadataMatcher; +import org.springframework.cloud.alibaba.dubbo.metadata.DubboServiceMetadata; import org.springframework.cloud.alibaba.dubbo.metadata.RequestMetadata; import org.springframework.cloud.alibaba.dubbo.metadata.ServiceRestMetadata; -import org.springframework.cloud.alibaba.dubbo.metadata.service.MetadataConfigService; +import org.springframework.cloud.alibaba.dubbo.service.DubboMetadataConfigService; +import org.springframework.cloud.alibaba.dubbo.service.DubboMetadataConfigServiceProxy; +import org.springframework.http.HttpRequest; import org.springframework.stereotype.Repository; import java.util.Collections; -import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; import java.util.Map; import java.util.Set; -import static org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegistry.getServiceGroup; -import static org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegistry.getServiceInterface; -import static org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegistry.getServiceSegments; -import static org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegistry.getServiceVersion; +import static org.springframework.cloud.alibaba.dubbo.http.DefaultHttpRequest.builder; +import static org.springframework.util.CollectionUtils.isEmpty; /** * Dubbo Service Metadata {@link Repository} @@ -44,75 +47,143 @@ import static org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegist @Repository public class DubboServiceMetadataRepository { + private final Logger logger = LoggerFactory.getLogger(getClass()); + + private final ObjectMapper objectMapper = new ObjectMapper(); + /** * Key is application name - * Value is Map + * Value is Map */ - private Map> genericServicesRepository = new HashMap<>(); - - private Map> methodMetadataRepository = new HashMap<>(); + private Map> repository = newHashMap(); @Autowired - private MetadataConfigService metadataConfigService; + private DubboMetadataConfigServiceProxy dubboMetadataConfigServiceProxy; - @Value("${dubbo.target.protocol:dubbo}") - private String targetProtocol; + /** + * Initialize the specified service's Dubbo Service Metadata + * + * @param serviceName the service name + */ + public void initialize(String serviceName) { - @Value("${dubbo.target.cluster:failover}") - private String targetCluster; + if (repository.containsKey(serviceName)) { + return; + } - public void updateMetadata(String serviceName) { + Set serviceRestMetadataSet = getServiceRestMetadataSet(serviceName); - Map genericServicesMap = genericServicesRepository.computeIfAbsent(serviceName, k -> new HashMap<>()); + if (isEmpty(serviceRestMetadataSet)) { + if (logger.isWarnEnabled()) { + logger.warn("The Spring application[name : {}] does not expose The REST metadata in the Dubbo services." + , serviceName); + } + return; + } - Map methodMetadataMap = methodMetadataRepository.computeIfAbsent(serviceName, k -> new HashMap<>()); - - Set serviceRestMetadataSet = metadataConfigService.getServiceRestMetadata(serviceName); + Map metadataMap = getMetadataMap(serviceName); for (ServiceRestMetadata serviceRestMetadata : serviceRestMetadataSet) { - ReferenceBean referenceBean = adaptReferenceBean(serviceRestMetadata); - serviceRestMetadata.getMeta().forEach(restMethodMetadata -> { RequestMetadata requestMetadata = restMethodMetadata.getRequest(); - genericServicesMap.put(requestMetadata, referenceBean.get()); - methodMetadataMap.put(requestMetadata, restMethodMetadata.getMethod()); + RequestMetadataMatcher matcher = new RequestMetadataMatcher(requestMetadata); + DubboServiceMetadata metadata = new DubboServiceMetadata(serviceRestMetadata, restMethodMetadata); + metadataMap.put(matcher, metadata); }); } + + if (logger.isInfoEnabled()) { + logger.info("The REST metadata in the dubbo services has been loaded in the Spring application[name : {}]", serviceName); + } } - public GenericService getGenericService(String serviceName, RequestMetadata requestMetadata) { - return getGenericServicesMap(serviceName).get(requestMetadata); + /** + * Get a {@link DubboServiceMetadata} by the specified service name if {@link RequestMetadata} matched + * + * @param serviceName service name + * @param requestMetadata {@link RequestMetadata} to be matched + * @return {@link DubboServiceMetadata} if matched, or null + */ + public DubboServiceMetadata get(String serviceName, RequestMetadata requestMetadata) { + return match(repository, serviceName, requestMetadata); } - public MethodMetadata getMethodMetadata(String serviceName, RequestMetadata requestMetadata) { - return getMethodMetadataMap(serviceName).get(requestMetadata); + private T match(Map> repository, String serviceName, + RequestMetadata requestMetadata) { + + Map map = repository.get(serviceName); + + T object = null; + + if (!isEmpty(map)) { + RequestMetadataMatcher matcher = new RequestMetadataMatcher(requestMetadata); + object = map.get(matcher); + if (object == null) { // Can't match exactly + // Require to match one by one + HttpRequest request = builder() + .method(requestMetadata.getMethod()) + .path(requestMetadata.getPath()) + .params(requestMetadata.getParams()) + .headers(requestMetadata.getHeaders()) + .build(); + + for (Map.Entry entry : map.entrySet()) { + RequestMetadataMatcher possibleMatcher = entry.getKey(); + if (possibleMatcher.match(request)) { + object = entry.getValue(); + break; + } + } + } + } + + if (object == null) { + if (logger.isWarnEnabled()) { + logger.warn("DubboServiceMetadata can't be found in the Spring application [%s] and %s", + serviceName, requestMetadata); + } + } + + return object; } - private ReferenceBean adaptReferenceBean(ServiceRestMetadata serviceRestMetadata) { - String dubboServiceName = serviceRestMetadata.getName(); - String[] segments = getServiceSegments(dubboServiceName); - String interfaceName = getServiceInterface(segments); - String version = getServiceVersion(segments); - String group = getServiceGroup(segments); - - ReferenceBean referenceBean = new ReferenceBean(); - referenceBean.setGeneric(true); - referenceBean.setInterface(interfaceName); - referenceBean.setVersion(version); - referenceBean.setGroup(group); - referenceBean.setProtocol(targetProtocol); - referenceBean.setCluster(targetCluster); - - return referenceBean; + private Map getMetadataMap(String serviceName) { + return getMap(repository, serviceName); } - private Map getGenericServicesMap(String serviceName) { - return genericServicesRepository.getOrDefault(serviceName, Collections.emptyMap()); + private Set getServiceRestMetadataSet(String serviceName) { + DubboMetadataConfigService dubboMetadataConfigService = dubboMetadataConfigServiceProxy.newProxy(serviceName); + String serviceRestMetadataJsonConfig = dubboMetadataConfigService.getServiceRestMetadata(); + + Set metadata; + try { + metadata = objectMapper.readValue(serviceRestMetadataJsonConfig, + TypeFactory.defaultInstance().constructCollectionType(LinkedHashSet.class, ServiceRestMetadata.class)); + } catch (Exception e) { + if (logger.isErrorEnabled()) { + logger.error(e.getMessage(), e); + } + metadata = Collections.emptySet(); + } + return metadata; } - private Map getMethodMetadataMap(String serviceName) { - return methodMetadataRepository.getOrDefault(serviceName, Collections.emptyMap()); + private static Map getMap(Map> repository, String key) { + return getOrDefault(repository, key, newHashMap()); + } + + private static V getOrDefault(Map source, K key, V defaultValue) { + V value = source.get(key); + if (value == null) { + value = defaultValue; + source.put(key, value); + } + return value; + } + + private static Map newHashMap() { + return new LinkedHashMap<>(); } } diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/FeignMetadataResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/DubboServiceBeanMetadataResolver.java similarity index 84% rename from spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/FeignMetadataResolver.java rename to spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/DubboServiceBeanMetadataResolver.java index e7f80dd4..e3704dae 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/FeignMetadataResolver.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/DubboServiceBeanMetadataResolver.java @@ -18,6 +18,7 @@ package org.springframework.cloud.alibaba.dubbo.metadata.resolver; import com.alibaba.dubbo.common.URL; import com.alibaba.dubbo.config.spring.ServiceBean; + import feign.Contract; import feign.Feign; import feign.MethodMetadata; @@ -26,7 +27,6 @@ import org.springframework.beans.BeanUtils; import org.springframework.beans.factory.BeanClassLoaderAware; import org.springframework.beans.factory.ObjectProvider; import org.springframework.beans.factory.SmartInitializingSingleton; -import org.springframework.cloud.alibaba.dubbo.metadata.RequestMetadata; import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; import org.springframework.cloud.alibaba.dubbo.metadata.ServiceRestMetadata; import org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegistry; @@ -44,20 +44,19 @@ import java.util.stream.Collectors; import java.util.stream.Stream; /** - * The metadata resolver for {@link Feign} + * The metadata resolver for {@link Feign} for {@link ServiceBean Dubbo Service Bean} in the provider side. * * @author Mercy */ -public class FeignMetadataResolver implements BeanClassLoaderAware, SmartInitializingSingleton, MetadataResolver { +public class DubboServiceBeanMetadataResolver implements BeanClassLoaderAware, SmartInitializingSingleton, + MetadataResolver { private static final String[] CONTRACT_CLASS_NAMES = { "feign.jaxrs2.JAXRS2Contract", "org.springframework.cloud.openfeign.support.SpringMvcContract", }; - private final String currentApplicationName; - - private final ObjectProvider contract; + private final ObjectProvider contractObjectProvider; private ClassLoader classLoader; @@ -66,9 +65,8 @@ public class FeignMetadataResolver implements BeanClassLoaderAware, SmartInitial */ private Collection contracts; - public FeignMetadataResolver(String currentApplicationName, ObjectProvider contract) { - this.currentApplicationName = currentApplicationName; - this.contract = contract; + public DubboServiceBeanMetadataResolver(ObjectProvider contractObjectProvider) { + this.contractObjectProvider = contractObjectProvider; } @Override @@ -77,7 +75,11 @@ public class FeignMetadataResolver implements BeanClassLoaderAware, SmartInitial LinkedList contracts = new LinkedList<>(); // Add injected Contract if available, for example SpringMvcContract Bean under Spring Cloud Open Feign - contract.ifAvailable(contracts::add); + Contract contract = contractObjectProvider.getIfAvailable(); + + if (contract != null) { + contracts.add(contract); + } Stream.of(CONTRACT_CLASS_NAMES) .filter(this::isClassPresent) // filter the existed classes @@ -129,12 +131,22 @@ public class FeignMetadataResolver implements BeanClassLoaderAware, SmartInitial public Set resolveMethodRestMetadata(Class targetType) { List feignContractMethods = selectFeignContractMethods(targetType); return contracts.stream() - .map(contract -> contract.parseAndValidatateMetadata(targetType)) + .map(contract -> parseAndValidateMetadata(contract, targetType)) .flatMap(v -> v.stream()) .map(methodMetadata -> resolveMethodRestMetadata(methodMetadata, targetType, feignContractMethods)) .collect(Collectors.toSet()); } + private List parseAndValidateMetadata(Contract contract, Class targetType) { + List methodMetadataList = Collections.emptyList(); + try { + methodMetadataList = contract.parseAndValidatateMetadata(targetType); + } catch (Throwable ignored) { + // ignore + } + return methodMetadataList; + } + /** * Select feign contract methods *

@@ -160,13 +172,8 @@ public class FeignMetadataResolver implements BeanClassLoaderAware, SmartInitial List feignContractMethods) { String configKey = methodMetadata.configKey(); Method feignContractMethod = getMatchedFeignContractMethod(targetType, feignContractMethods, configKey); - - RestMethodMetadata metadata = new RestMethodMetadata(); - - metadata.setRequest(new RequestMetadata(methodMetadata.template())); + RestMethodMetadata metadata = new RestMethodMetadata(methodMetadata); metadata.setMethod(new org.springframework.cloud.alibaba.dubbo.metadata.MethodMetadata(feignContractMethod)); - metadata.setIndexToName(methodMetadata.indexToName()); - return metadata; } diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/DubboTransportedMethodMetadataResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/DubboTransportedMethodMetadataResolver.java new file mode 100644 index 00000000..d1aa6389 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/DubboTransportedMethodMetadataResolver.java @@ -0,0 +1,112 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.metadata.resolver; + +import feign.Contract; +import org.springframework.cloud.alibaba.dubbo.annotation.DubboTransported; +import org.springframework.cloud.alibaba.dubbo.metadata.DubboTransportedMethodMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.MethodMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; +import org.springframework.core.annotation.AnnotationUtils; +import org.springframework.core.env.PropertyResolver; + +import java.lang.reflect.Method; +import java.util.LinkedHashSet; +import java.util.Map; +import java.util.Set; +import java.util.stream.Collectors; + +import static feign.Feign.configKey; + +/** + * {@link MethodMetadata} Resolver for the {@link DubboTransported} annotated classes or methods in client side. + * + * @author Mercy + * @see DubboTransportedMethodMetadata + */ +public class DubboTransportedMethodMetadataResolver { + + private static final Class DUBBO_TRANSPORTED_CLASS = DubboTransported.class; + + private final PropertyResolver propertyResolver; + + private final Contract contract; + + public DubboTransportedMethodMetadataResolver(PropertyResolver propertyResolver, Contract contract) { + this.propertyResolver = propertyResolver; + this.contract = contract; + } + + public Map resolve(Class targetType) { + Set dubboTransportedMethodMetadataSet = + resolveDubboTransportedMethodMetadataSet(targetType); + Map restMethodMetadataMap = resolveRestRequestMetadataMap(targetType); + return dubboTransportedMethodMetadataSet + .stream() + .collect(Collectors.toMap(methodMetadata -> methodMetadata, methodMetadata -> { + RestMethodMetadata restMethodMetadata = restMethodMetadataMap.get(configKey(targetType, methodMetadata.getMethod())); + restMethodMetadata.setMethod(methodMetadata.getMethodMetadata()); + return restMethodMetadata; + } + )); + } + + protected Set resolveDubboTransportedMethodMetadataSet(Class targetType) { + // The public methods of target interface + Method[] methods = targetType.getMethods(); + + Set methodMetadataSet = new LinkedHashSet<>(); + + for (Method method : methods) { + DubboTransported dubboTransported = resolveDubboTransported(method); + if (dubboTransported != null) { + DubboTransportedMethodMetadata methodMetadata = createDubboTransportedMethodMetadata(method, dubboTransported); + methodMetadataSet.add(methodMetadata); + } + } + return methodMetadataSet; + } + + + private Map resolveRestRequestMetadataMap(Class targetType) { + return contract.parseAndValidatateMetadata(targetType) + .stream().collect(Collectors.toMap(feign.MethodMetadata::configKey, this::restMethodMetadata)); + } + + private RestMethodMetadata restMethodMetadata(feign.MethodMetadata methodMetadata) { + return new RestMethodMetadata(methodMetadata); + } + + private DubboTransportedMethodMetadata createDubboTransportedMethodMetadata(Method method, + DubboTransported dubboTransported) { + DubboTransportedMethodMetadata methodMetadata = new DubboTransportedMethodMetadata(method); + String protocol = propertyResolver.resolvePlaceholders(dubboTransported.protocol()); + String cluster = propertyResolver.resolvePlaceholders(dubboTransported.cluster()); + methodMetadata.setProtocol(protocol); + methodMetadata.setCluster(cluster); + return methodMetadata; + } + + private DubboTransported resolveDubboTransported(Method method) { + DubboTransported dubboTransported = AnnotationUtils.findAnnotation(method, DUBBO_TRANSPORTED_CLASS); + if (dubboTransported == null) { // Attempt to find @DubboTransported in the declaring class + Class declaringClass = method.getDeclaringClass(); + dubboTransported = AnnotationUtils.findAnnotation(declaringClass, DUBBO_TRANSPORTED_CLASS); + } + return dubboTransported; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/MetadataResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/MetadataResolver.java index 4956e387..922ce6d3 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/MetadataResolver.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/MetadataResolver.java @@ -17,6 +17,7 @@ package org.springframework.cloud.alibaba.dubbo.metadata.resolver; import com.alibaba.dubbo.config.spring.ServiceBean; + import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; import org.springframework.cloud.alibaba.dubbo.metadata.ServiceRestMetadata; diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/service/NacosMetadataConfigService.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/service/NacosMetadataConfigService.java deleted file mode 100644 index 93ce9281..00000000 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/service/NacosMetadataConfigService.java +++ /dev/null @@ -1,97 +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.springframework.cloud.alibaba.dubbo.metadata.service; - -import com.alibaba.nacos.api.config.ConfigService; -import com.alibaba.nacos.api.exception.NacosException; -import com.fasterxml.jackson.core.JsonProcessingException; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.SerializationFeature; -import com.fasterxml.jackson.databind.type.TypeFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.cloud.alibaba.dubbo.metadata.ServiceRestMetadata; -import org.springframework.cloud.alibaba.nacos.NacosConfigProperties; - -import javax.annotation.PostConstruct; -import java.util.Collections; -import java.util.LinkedHashSet; -import java.util.Set; - -import static com.alibaba.nacos.api.common.Constants.DEFAULT_GROUP; - -/** - * Nacos {@link MetadataConfigService} - * - * @author Mercy - */ -public class NacosMetadataConfigService implements MetadataConfigService { - - private final ObjectMapper objectMapper = new ObjectMapper(); - - @Autowired - private NacosConfigProperties nacosConfigProperties; - - private ConfigService configService; - - @PostConstruct - public void init() { - this.configService = nacosConfigProperties.configServiceInstance(); - this.objectMapper.enable(SerializationFeature.INDENT_OUTPUT); - } - - /** - * Get the data Id of service rest metadata - */ - private static String getServiceRestMetadataDataId(String serviceName) { - return "metadata:rest:" + serviceName + ".json"; - } - - @Override - public void publishServiceRestMetadata(String serviceName, Set serviceRestMetadata) { - String dataId = getServiceRestMetadataDataId(serviceName); - String json = writeValueAsString(serviceRestMetadata); - try { - configService.publishConfig(dataId, DEFAULT_GROUP, json); - } catch (NacosException e) { - throw new RuntimeException(e); - } - } - - @Override - public Set getServiceRestMetadata(String serviceName) { - Set metadata = Collections.emptySet(); - String dataId = getServiceRestMetadataDataId(serviceName); - try { - String json = configService.getConfig(dataId, DEFAULT_GROUP, 1000 * 3); - metadata = objectMapper.readValue(json, - TypeFactory.defaultInstance().constructCollectionType(LinkedHashSet.class, ServiceRestMetadata.class)); - } catch (Exception e) { - throw new RuntimeException(e); - } - return metadata; - } - - private String writeValueAsString(Object object) { - String content = null; - try { - content = objectMapper.writeValueAsString(object); - } catch (JsonProcessingException e) { - throw new IllegalArgumentException(e); - } - return content; - } -} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboFeignClientsConfiguration.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboFeignClientsConfiguration.java deleted file mode 100644 index 0c4d7400..00000000 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboFeignClientsConfiguration.java +++ /dev/null @@ -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.springframework.cloud.alibaba.dubbo.openfeign; - -import feign.Contract; -import feign.Feign; -import org.springframework.beans.BeansException; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.config.BeanPostProcessor; -import org.springframework.cloud.alibaba.dubbo.autoconfigure.DubboOpenFeignAutoConfiguration; -import org.springframework.cloud.alibaba.dubbo.metadata.repository.DubboServiceMetadataRepository; -import org.springframework.cloud.openfeign.FeignClient; -import org.springframework.cloud.openfeign.FeignClientsConfiguration; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; - -import java.util.List; - -/** - * Dubbo {@link Configuration} for {@link FeignClient FeignClients} - * - * @author Mercy - * @see DubboOpenFeignAutoConfiguration - * @see org.springframework.cloud.openfeign.FeignContext#setConfigurations(List) - * @see FeignClientsConfiguration - */ -@Configuration -public class DubboFeignClientsConfiguration { - - @Autowired - private Contract contract; - - @Autowired - private DubboServiceMetadataRepository dubboServiceRepository; - - @Bean - public BeanPostProcessor beanPostProcessor() { - return new BeanPostProcessor() { - @Override - public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { - if (bean instanceof Feign.Builder) { - Feign.Builder builder = (Feign.Builder) bean; - builder.invocationHandlerFactory(new DubboInvocationHandlerFactory(contract, dubboServiceRepository)); - } - return bean; - } - }; - } - - -} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboInvocationHandler.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboInvocationHandler.java index 622ae340..95dd73c0 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboInvocationHandler.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboInvocationHandler.java @@ -17,8 +17,10 @@ package org.springframework.cloud.alibaba.dubbo.openfeign; import com.alibaba.dubbo.rpc.service.GenericService; -import org.springframework.cloud.alibaba.dubbo.metadata.MethodMetadata; -import org.springframework.cloud.alibaba.dubbo.metadata.MethodParameterMetadata; + +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceExecutionContext; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceExecutionContextFactory; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; @@ -31,39 +33,39 @@ import java.util.Map; */ public class DubboInvocationHandler implements InvocationHandler { - private final Map genericServicesMap; - - private final Map methodMetadata; + private final Map feignMethodMetadataMap; private final InvocationHandler defaultInvocationHandler; - public DubboInvocationHandler(Map genericServicesMap, - Map methodMetadata, - InvocationHandler defaultInvocationHandler) { - this.genericServicesMap = genericServicesMap; - this.methodMetadata = methodMetadata; + private final DubboGenericServiceExecutionContextFactory contextFactory; + + public DubboInvocationHandler(Map feignMethodMetadataMap, + InvocationHandler defaultInvocationHandler, + DubboGenericServiceExecutionContextFactory contextFactory) { + this.feignMethodMetadataMap = feignMethodMetadataMap; this.defaultInvocationHandler = defaultInvocationHandler; + this.contextFactory = contextFactory; } @Override - public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { + public Object invoke(Object proxy, Method feignMethod, Object[] args) throws Throwable { - GenericService genericService = genericServicesMap.get(method); + FeignMethodMetadata feignMethodMetadata = feignMethodMetadataMap.get(feignMethod); - MethodMetadata methodMetadata = this.methodMetadata.get(method); - - if (genericService == null || methodMetadata == null) { - return defaultInvocationHandler.invoke(proxy, method, args); + if (feignMethodMetadata == null) { + return defaultInvocationHandler.invoke(proxy, feignMethod, args); } - String methodName = methodMetadata.getName(); + GenericService dubboGenericService = feignMethodMetadata.getDubboGenericService(); + RestMethodMetadata dubboRestMethodMetadata = feignMethodMetadata.getDubboRestMethodMetadata(); + RestMethodMetadata feignRestMethodMetadata = feignMethodMetadata.getFeignMethodMetadata(); - String[] parameterTypes = methodMetadata - .getParams() - .stream() - .map(MethodParameterMetadata::getType) - .toArray(String[]::new); + DubboGenericServiceExecutionContext context = contextFactory.create(dubboRestMethodMetadata, feignRestMethodMetadata, args); - return genericService.$invoke(methodName, parameterTypes, args); + String methodName = context.getMethodName(); + String[] parameterTypes = context.getParameterTypes(); + Object[] parameters = context.getParameters(); + + return dubboGenericService.$invoke(methodName, parameterTypes, parameters); } } diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboInvocationHandlerFactory.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboInvocationHandlerFactory.java deleted file mode 100644 index 4fd67f40..00000000 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboInvocationHandlerFactory.java +++ /dev/null @@ -1,101 +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.springframework.cloud.alibaba.dubbo.openfeign; - -import com.alibaba.dubbo.rpc.service.GenericService; -import feign.Contract; -import feign.InvocationHandlerFactory; -import feign.MethodMetadata; -import feign.Target; -import org.springframework.cloud.alibaba.dubbo.metadata.RequestMetadata; -import org.springframework.cloud.alibaba.dubbo.metadata.repository.DubboServiceMetadataRepository; - -import java.lang.reflect.InvocationHandler; -import java.lang.reflect.Method; -import java.util.HashMap; -import java.util.Map; -import java.util.Set; -import java.util.stream.Collectors; - -import static feign.Feign.configKey; - -/** - * Dubbo {@link InvocationHandlerFactory} - * - * @author Mercy - */ -public class DubboInvocationHandlerFactory implements InvocationHandlerFactory { - - private final static InvocationHandlerFactory DEFAULT_INVOCATION_HANDLER_FACTORY = - new InvocationHandlerFactory.Default(); - - private final Contract contract; - - private final DubboServiceMetadataRepository dubboServiceRepository; - - public DubboInvocationHandlerFactory(Contract contract, DubboServiceMetadataRepository dubboServiceRepository) { - this.contract = contract; - this.dubboServiceRepository = dubboServiceRepository; - } - - @Override - public InvocationHandler create(Target target, Map dispatch) { - // The target class annotated @FeignClient - Class targetType = target.type(); - // Resolve metadata from current @FeignClient type - Map methodRequestMetadataMap = resolveMethodRequestMetadataMap(targetType, dispatch.keySet()); - // @FeignClient specifies the service name - String serviceName = target.name(); - // Update specified metadata - dubboServiceRepository.updateMetadata(serviceName); - - Map genericServicesMap = new HashMap<>(); - - Map methodMetadataMap = new HashMap<>(); - - methodRequestMetadataMap.forEach((method, requestMetadata) -> { - GenericService genericService = dubboServiceRepository.getGenericService(serviceName, requestMetadata); - org.springframework.cloud.alibaba.dubbo.metadata.MethodMetadata methodMetadata = - dubboServiceRepository.getMethodMetadata(serviceName, requestMetadata); - genericServicesMap.put(method, genericService); - methodMetadataMap.put(method, methodMetadata); - }); - - InvocationHandler defaultInvocationHandler = DEFAULT_INVOCATION_HANDLER_FACTORY.create(target, dispatch); - - DubboInvocationHandler invocationHandler = new DubboInvocationHandler(genericServicesMap, methodMetadataMap, - defaultInvocationHandler); - - return invocationHandler; - } - - private Map resolveMethodRequestMetadataMap(Class targetType, Set methods) { - Map requestMetadataMap = resolveRequestMetadataMap(targetType); - return methods.stream().collect(Collectors.toMap(method -> method, method -> - requestMetadataMap.get(configKey(targetType, method)) - )); - } - - private Map resolveRequestMetadataMap(Class targetType) { - return contract.parseAndValidatateMetadata(targetType) - .stream().collect(Collectors.toMap(MethodMetadata::configKey, this::requestMetadata)); - } - - private RequestMetadata requestMetadata(MethodMetadata methodMetadata) { - return new RequestMetadata(methodMetadata.template()); - } -} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/FeignMethodMetadata.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/FeignMethodMetadata.java new file mode 100644 index 00000000..0eda4d1b --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/FeignMethodMetadata.java @@ -0,0 +1,57 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.openfeign; + +import com.alibaba.dubbo.rpc.service.GenericService; + +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; + +import java.lang.reflect.Method; + +/** + * Feign {@link Method} Metadata + * + * @author Mercy + */ +class FeignMethodMetadata { + + private final GenericService dubboGenericService; + + private final RestMethodMetadata dubboRestMethodMetadata; + + private final RestMethodMetadata feignMethodMetadata; + + + FeignMethodMetadata(GenericService dubboGenericService, RestMethodMetadata dubboRestMethodMetadata, + RestMethodMetadata feignMethodMetadata) { + this.dubboGenericService = dubboGenericService; + this.dubboRestMethodMetadata = dubboRestMethodMetadata; + this.feignMethodMetadata = feignMethodMetadata; + } + + GenericService getDubboGenericService() { + return dubboGenericService; + } + + RestMethodMetadata getDubboRestMethodMetadata() { + return dubboRestMethodMetadata; + } + + RestMethodMetadata getFeignMethodMetadata() { + return feignMethodMetadata; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/TargeterBeanPostProcessor.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/TargeterBeanPostProcessor.java new file mode 100644 index 00000000..d055709e --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/TargeterBeanPostProcessor.java @@ -0,0 +1,81 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.openfeign; + +import org.springframework.beans.BeansException; +import org.springframework.beans.factory.BeanClassLoaderAware; +import org.springframework.beans.factory.config.BeanPostProcessor; +import org.springframework.cloud.alibaba.dubbo.metadata.repository.DubboServiceMetadataRepository; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceExecutionContextFactory; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceFactory; +import org.springframework.core.env.Environment; + +import static java.lang.reflect.Proxy.newProxyInstance; +import static org.springframework.util.ClassUtils.getUserClass; +import static org.springframework.util.ClassUtils.resolveClassName; + +/** + * org.springframework.cloud.openfeign.Targeter {@link BeanPostProcessor} + * + * @author Mercy + */ +public class TargeterBeanPostProcessor implements BeanPostProcessor, BeanClassLoaderAware { + + private static final String TARGETER_CLASS_NAME = "org.springframework.cloud.openfeign.Targeter"; + + private final Environment environment; + + private final DubboServiceMetadataRepository dubboServiceMetadataRepository; + + private final DubboGenericServiceFactory dubboGenericServiceFactory; + + private final DubboGenericServiceExecutionContextFactory contextFactory; + + private ClassLoader classLoader; + + public TargeterBeanPostProcessor(Environment environment, + DubboServiceMetadataRepository dubboServiceMetadataRepository, + DubboGenericServiceFactory dubboGenericServiceFactory, + DubboGenericServiceExecutionContextFactory contextFactory) { + this.environment = environment; + this.dubboServiceMetadataRepository = dubboServiceMetadataRepository; + this.dubboGenericServiceFactory = dubboGenericServiceFactory; + this.contextFactory = contextFactory; + } + + @Override + public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { + return bean; + } + + @Override + public Object postProcessAfterInitialization(final Object bean, String beanName) throws BeansException { + Class beanClass = getUserClass(bean.getClass()); + Class targetClass = resolveClassName(TARGETER_CLASS_NAME, classLoader); + if (targetClass.isAssignableFrom(beanClass)) { + return newProxyInstance(classLoader, new Class[]{targetClass}, + new TargeterInvocationHandler(bean, environment, dubboServiceMetadataRepository, + dubboGenericServiceFactory,contextFactory)); + } + return bean; + } + + @Override + public void setBeanClassLoader(ClassLoader classLoader) { + this.classLoader = classLoader; + } +} \ No newline at end of file diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/TargeterInvocationHandler.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/TargeterInvocationHandler.java new file mode 100644 index 00000000..c665c245 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/TargeterInvocationHandler.java @@ -0,0 +1,171 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.openfeign; + + +import com.alibaba.dubbo.rpc.service.GenericService; + +import feign.Contract; +import feign.Target; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.cloud.alibaba.dubbo.annotation.DubboTransported; +import org.springframework.cloud.alibaba.dubbo.metadata.DubboServiceMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.DubboTransportedMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.DubboTransportedMethodMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.MethodMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.RequestMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.repository.DubboServiceMetadataRepository; +import org.springframework.cloud.alibaba.dubbo.metadata.resolver.DubboTransportedMethodMetadataResolver; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceExecutionContextFactory; +import org.springframework.cloud.alibaba.dubbo.service.DubboGenericServiceFactory; +import org.springframework.cloud.openfeign.FeignContext; +import org.springframework.core.env.Environment; + +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.Method; +import java.lang.reflect.Proxy; +import java.util.HashMap; +import java.util.Map; + +import static java.lang.reflect.Proxy.newProxyInstance; + +/** + * org.springframework.cloud.openfeign.Targeter {@link InvocationHandler} + * + * @author Mercy + */ +class TargeterInvocationHandler implements InvocationHandler { + + private final Logger logger = LoggerFactory.getLogger(getClass()); + + private final Object bean; + + private final Environment environment; + + private final DubboServiceMetadataRepository repository; + + private final DubboGenericServiceFactory dubboGenericServiceFactory; + + private final DubboGenericServiceExecutionContextFactory contextFactory; + + TargeterInvocationHandler(Object bean, Environment environment, DubboServiceMetadataRepository repository, + DubboGenericServiceFactory dubboGenericServiceFactory, + DubboGenericServiceExecutionContextFactory contextFactory) { + this.bean = bean; + this.environment = environment; + this.repository = repository; + this.dubboGenericServiceFactory = dubboGenericServiceFactory; + this.contextFactory = contextFactory; + } + + @Override + public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { + /** + * args[0]: FeignClientFactoryBean factory + * args[1]: Feign.Builder feign + * args[2]: FeignContext context + * args[3]: Target.HardCodedTarget target + */ + FeignContext feignContext = cast(args[2]); + Target.HardCodedTarget target = cast(args[3]); + + // Execute Targeter#target method first + method.setAccessible(true); + // Get the default proxy object + Object defaultProxy = method.invoke(bean, args); + // Create Dubbo Proxy if required + return createDubboProxyIfRequired(feignContext, target, defaultProxy); + } + + private Object createDubboProxyIfRequired(FeignContext feignContext, Target target, Object defaultProxy) { + + DubboInvocationHandler dubboInvocationHandler = createDubboInvocationHandler(feignContext, target, defaultProxy); + + if (dubboInvocationHandler == null) { + return defaultProxy; + } + + return newProxyInstance(target.type().getClassLoader(), new Class[]{target.type()}, dubboInvocationHandler); + } + + private DubboInvocationHandler createDubboInvocationHandler(FeignContext feignContext, Target target, + Object defaultFeignClientProxy) { + + // Service name equals @FeignClient.name() + String serviceName = target.name(); + Class targetType = target.type(); + + // Get Contract Bean from FeignContext + Contract contract = feignContext.getInstance(serviceName, Contract.class); + + DubboTransportedMethodMetadataResolver resolver = + new DubboTransportedMethodMetadataResolver(environment, contract); + + Map feignRestMethodMetadataMap = resolver.resolve(targetType); + + if (feignRestMethodMetadataMap.isEmpty()) { // @DubboTransported method was not found from the Client interface + if (logger.isDebugEnabled()) { + logger.debug("@{} method was not found in the Feign target type[{}]", + DubboTransported.class.getSimpleName(), targetType.getName()); + } + return null; + } + + // Update Metadata + repository.initialize(serviceName); + + Map feignMethodMetadataMap = getFeignMethodMetadataMap(serviceName, feignRestMethodMetadataMap); + + InvocationHandler defaultFeignClientInvocationHandler = Proxy.getInvocationHandler(defaultFeignClientProxy); + + DubboInvocationHandler dubboInvocationHandler = new DubboInvocationHandler(feignMethodMetadataMap, + defaultFeignClientInvocationHandler, contextFactory); + + return dubboInvocationHandler; + } + + private Map getFeignMethodMetadataMap(String serviceName, + Map + feignRestMethodMetadataMap) { + Map feignMethodMetadataMap = new HashMap<>(); + + for (Map.Entry entry : feignRestMethodMetadataMap.entrySet()) { + RestMethodMetadata feignRestMethodMetadata = entry.getValue(); + RequestMetadata feignRequestMetadata = feignRestMethodMetadata.getRequest(); + DubboServiceMetadata dubboServiceMetadata = repository.get(serviceName, feignRequestMetadata); + if (dubboServiceMetadata != null) { + DubboTransportedMethodMetadata dubboTransportedMethodMetadata = entry.getKey(); + DubboTransportedMetadata dubboTransportedMetadata = dubboTransportedMethodMetadata.getDubboTransportedMetadata(); + Method method = dubboTransportedMethodMetadata.getMethod(); + GenericService dubboGenericService = dubboGenericServiceFactory.create(dubboServiceMetadata, dubboTransportedMetadata); + RestMethodMetadata dubboRestMethodMetadata = dubboServiceMetadata.getRestMethodMetadata(); + MethodMetadata methodMetadata = dubboTransportedMethodMetadata.getMethodMetadata(); + FeignMethodMetadata feignMethodMetadata = new FeignMethodMetadata(dubboGenericService, + dubboRestMethodMetadata, feignRestMethodMetadata); + feignMethodMetadataMap.put(method, feignMethodMetadata); + } + } + + return feignMethodMetadataMap; + } + + private static T cast(Object object) { + return (T) object; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/registry/SpringCloudRegistry.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/registry/SpringCloudRegistry.java index 1904cbd5..8d05cbd0 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/registry/SpringCloudRegistry.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/registry/SpringCloudRegistry.java @@ -23,6 +23,7 @@ import com.alibaba.dubbo.common.utils.UrlUtils; import com.alibaba.dubbo.registry.NotifyListener; import com.alibaba.dubbo.registry.RegistryFactory; import com.alibaba.dubbo.registry.support.FailbackRegistry; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.cloud.client.DefaultServiceInstance; @@ -47,7 +48,6 @@ import java.util.concurrent.TimeUnit; import static com.alibaba.dubbo.common.Constants.CONFIGURATORS_CATEGORY; import static com.alibaba.dubbo.common.Constants.CONSUMERS_CATEGORY; -import static com.alibaba.dubbo.common.Constants.PROTOCOL_KEY; import static com.alibaba.dubbo.common.Constants.PROVIDERS_CATEGORY; import static com.alibaba.dubbo.common.Constants.ROUTERS_CATEGORY; @@ -70,9 +70,11 @@ public class SpringCloudRegistry extends FailbackRegistry { private static final int CATEGORY_INDEX = 0; - private static final int PROTOCOL_INDEX = CATEGORY_INDEX + 1; +// private static final int PROTOCOL_INDEX = CATEGORY_INDEX + 1; - private static final int SERVICE_INTERFACE_INDEX = PROTOCOL_INDEX + 1; +// private static final int SERVICE_INTERFACE_INDEX = PROTOCOL_INDEX + 1; + + private static final int SERVICE_INTERFACE_INDEX = CATEGORY_INDEX + 1; private static final int SERVICE_VERSION_INDEX = SERVICE_INTERFACE_INDEX + 1; @@ -169,7 +171,6 @@ public class SpringCloudRegistry extends FailbackRegistry { private static String getServiceName(URL url, String category) { StringBuilder serviceNameBuilder = new StringBuilder(category); - appendIfPresent(serviceNameBuilder, url.getParameter(PROTOCOL_KEY, url.getProtocol())); appendIfPresent(serviceNameBuilder, url, Constants.INTERFACE_KEY); appendIfPresent(serviceNameBuilder, url, Constants.VERSION_KEY); appendIfPresent(serviceNameBuilder, url, Constants.GROUP_KEY); @@ -203,12 +204,11 @@ public class SpringCloudRegistry extends FailbackRegistry { // split service name to segments // (required) segments[0] = category // (required) segments[1] = serviceInterface - // (required) segments[2] = protocol - // (required) segments[3] = version - // (optional) segments[4] = group + // (required) segments[2] = version + // (optional) segments[3] = group String[] segments = getServiceSegments(serviceName); int length = segments.length; - if (length < 4) { // must present 4 segments or more + if (length < SERVICE_GROUP_INDEX) { // must present 4 segments or more return false; } @@ -217,11 +217,6 @@ public class SpringCloudRegistry extends FailbackRegistry { return false; } - String protocol = getProtocol(segments); - if (StringUtils.hasText(protocol)) { - return false; - } - String serviceInterface = getServiceInterface(segments); if (!WILDCARD.equals(targetServiceInterface) && !Objects.equals(targetServiceInterface, serviceInterface)) { // no match service interface @@ -253,9 +248,9 @@ public class SpringCloudRegistry extends FailbackRegistry { return segments[CATEGORY_INDEX]; } - public static String getProtocol(String[] segments) { - return segments[PROTOCOL_INDEX]; - } +// public static String getProtocol(String[] segments) { +// return segments[PROTOCOL_INDEX]; +// } public static String getServiceInterface(String[] segments) { return segments[SERVICE_INTERFACE_INDEX]; @@ -266,7 +261,7 @@ public class SpringCloudRegistry extends FailbackRegistry { } public static String getServiceGroup(String[] segments) { - return segments.length > 4 ? segments[SERVICE_GROUP_INDEX] : null; + return segments.length > SERVICE_GROUP_INDEX ? segments[SERVICE_GROUP_INDEX] : null; } /** diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboGenericServiceExecutionContext.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboGenericServiceExecutionContext.java new file mode 100644 index 00000000..5bf8c691 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboGenericServiceExecutionContext.java @@ -0,0 +1,51 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service; + +import com.alibaba.dubbo.rpc.service.GenericService; + +/** + * Dubbo {@link GenericService} execution context + * + * @author Mercy + */ +public class DubboGenericServiceExecutionContext { + + private final String methodName; + + private final String[] parameterTypes; + + private final Object[] parameters; + + public DubboGenericServiceExecutionContext(String methodName, String[] parameterTypes, Object[] parameters) { + this.methodName = methodName; + this.parameterTypes = parameterTypes; + this.parameters = parameters; + } + + public String getMethodName() { + return methodName; + } + + public String[] getParameterTypes() { + return parameterTypes; + } + + public Object[] getParameters() { + return parameters; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboGenericServiceExecutionContextFactory.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboGenericServiceExecutionContextFactory.java new file mode 100644 index 00000000..625173d3 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboGenericServiceExecutionContextFactory.java @@ -0,0 +1,147 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.cloud.alibaba.dubbo.http.HttpServerRequest; +import org.springframework.cloud.alibaba.dubbo.metadata.MethodMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.MethodParameterMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; +import org.springframework.cloud.alibaba.dubbo.service.parameter.DubboGenericServiceParameterResolver; +import org.springframework.core.annotation.AnnotationAwareOrderComparator; + +import javax.annotation.PostConstruct; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +/** + * {@link DubboGenericServiceExecutionContext} Factory + * + * @author Mercy + * @see DubboGenericServiceParameterResolver + */ +public class DubboGenericServiceExecutionContextFactory { + + @Autowired(required = false) + private final List resolvers = Collections.emptyList(); + + @PostConstruct + public void init() { + AnnotationAwareOrderComparator.sort(resolvers); + } + + public DubboGenericServiceExecutionContext create(RestMethodMetadata dubboRestMethodMetadata, + RestMethodMetadata clientMethodMetadata, Object[] arguments) { + + MethodMetadata dubboMethodMetadata = dubboRestMethodMetadata.getMethod(); + + String methodName = dubboMethodMetadata.getName(); + + String[] parameterTypes = resolveParameterTypes(dubboMethodMetadata); + + Object[] parameters = resolveParameters(dubboRestMethodMetadata, clientMethodMetadata, arguments); + + return new DubboGenericServiceExecutionContext(methodName, parameterTypes, parameters); + } + + public DubboGenericServiceExecutionContext create(RestMethodMetadata dubboRestMethodMetadata, + HttpServerRequest request) { + MethodMetadata methodMetadata = dubboRestMethodMetadata.getMethod(); + + String methodName = methodMetadata.getName(); + + String[] parameterTypes = resolveParameterTypes(methodMetadata); + + Object[] parameters = resolveParameters(dubboRestMethodMetadata, request); + + return new DubboGenericServiceExecutionContext(methodName, parameterTypes, parameters); + } + + private Map buildParamNameToIndex(List params) { + Map paramNameToIndex = new LinkedHashMap<>(); + for (MethodParameterMetadata param : params) { + paramNameToIndex.put(param.getName(), param.getIndex()); + } + return paramNameToIndex; + } + + protected String[] resolveParameterTypes(MethodMetadata methodMetadata) { + + List params = methodMetadata.getParams(); + + String[] parameterTypes = new String[params.size()]; + + for (MethodParameterMetadata parameterMetadata : params) { + int index = parameterMetadata.getIndex(); + String parameterType = parameterMetadata.getType(); + parameterTypes[index] = parameterType; + } + + return parameterTypes; + } + + protected Object[] resolveParameters(RestMethodMetadata dubboRestMethodMetadata, HttpServerRequest request) { + + MethodMetadata dubboMethodMetadata = dubboRestMethodMetadata.getMethod(); + + List params = dubboMethodMetadata.getParams(); + + Object[] parameters = new Object[params.size()]; + + for (MethodParameterMetadata parameterMetadata : params) { + + int index = parameterMetadata.getIndex(); + + for (DubboGenericServiceParameterResolver resolver : resolvers) { + Object parameter = resolver.resolve(dubboRestMethodMetadata, parameterMetadata, request); + if (parameter != null) { + parameters[index] = parameter; + break; + } + } + } + + return parameters; + } + + protected Object[] resolveParameters(RestMethodMetadata dubboRestMethodMetadata, + RestMethodMetadata clientRestMethodMetadata, Object[] arguments) { + + MethodMetadata dubboMethodMetadata = dubboRestMethodMetadata.getMethod(); + + List params = dubboMethodMetadata.getParams(); + + Object[] parameters = new Object[params.size()]; + + for (MethodParameterMetadata parameterMetadata : params) { + + int index = parameterMetadata.getIndex(); + + for (DubboGenericServiceParameterResolver resolver : resolvers) { + Object parameter = resolver.resolve(dubboRestMethodMetadata, parameterMetadata, clientRestMethodMetadata, arguments); + if (parameter != null) { + parameters[index] = parameter; + break; + } + } + } + + return parameters; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboGenericServiceFactory.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboGenericServiceFactory.java new file mode 100644 index 00000000..f85fbac8 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboGenericServiceFactory.java @@ -0,0 +1,120 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service; + +import com.alibaba.dubbo.config.spring.ReferenceBean; +import com.alibaba.dubbo.rpc.service.GenericService; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.cloud.alibaba.dubbo.metadata.DubboServiceMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.DubboTransportedMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.ServiceRestMetadata; + +import javax.annotation.PreDestroy; +import java.util.Collection; +import java.util.Objects; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ConcurrentMap; + +import static com.alibaba.dubbo.common.Constants.DEFAULT_CLUSTER; +import static com.alibaba.dubbo.common.Constants.DEFAULT_PROTOCOL; +import static org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegistry.getServiceGroup; +import static org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegistry.getServiceInterface; +import static org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegistry.getServiceSegments; +import static org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegistry.getServiceVersion; + +/** + * Dubbo {@link GenericService} Factory + * + * @author Mercy + */ +public class DubboGenericServiceFactory { + + private final Logger logger = LoggerFactory.getLogger(getClass()); + + private final ConcurrentMap> cache = new ConcurrentHashMap<>(); + + public GenericService create(DubboServiceMetadata dubboServiceMetadata, + DubboTransportedMetadata dubboTransportedMetadata) { + + ReferenceBean referenceBean = build(dubboServiceMetadata.getServiceRestMetadata(), dubboTransportedMetadata); + + return referenceBean == null ? null : referenceBean.get(); + } + + public GenericService create(String serviceName, Class serviceClass) { + String interfaceName = serviceClass.getName(); + ReferenceBean referenceBean = build(interfaceName, serviceName, null, + DEFAULT_PROTOCOL, DEFAULT_CLUSTER); + return referenceBean.get(); + } + + + private ReferenceBean build(ServiceRestMetadata serviceRestMetadata, + DubboTransportedMetadata dubboTransportedMetadata) { + String dubboServiceName = serviceRestMetadata.getName(); + String[] segments = getServiceSegments(dubboServiceName); + String interfaceName = getServiceInterface(segments); + String version = getServiceVersion(segments); + String group = getServiceGroup(segments); + String protocol = dubboTransportedMetadata.getProtocol(); + String cluster = dubboTransportedMetadata.getCluster(); + + return build(interfaceName, version, group, protocol, cluster); + } + + private ReferenceBean build(String interfaceName, String version, String group, String protocol, + String cluster) { + + Integer key = Objects.hash(interfaceName, version, group, protocol, cluster); + + ReferenceBean referenceBean = cache.get(key); + + if (referenceBean == null) { + referenceBean = new ReferenceBean<>(); + referenceBean.setGeneric(true); + referenceBean.setInterface(interfaceName); + referenceBean.setVersion(version); + referenceBean.setGroup(group); + referenceBean.setProtocol(protocol); + referenceBean.setCluster(cluster); + } + + return referenceBean; + } + + @PreDestroy + public void destroy() { + destroyReferenceBeans(); + cache.values(); + } + + private void destroyReferenceBeans() { + Collection> referenceBeans = cache.values(); + if (logger.isInfoEnabled()) { + logger.info("The Dubbo GenericService ReferenceBeans are destroying..."); + } + for (ReferenceBean referenceBean : referenceBeans) { + referenceBean.destroy(); // destroy ReferenceBean + if (logger.isInfoEnabled()) { + logger.info("Destroyed the ReferenceBean : {} ", referenceBean); + } + } + } + +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/service/MetadataConfigService.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboMetadataConfigService.java similarity index 75% rename from spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/service/MetadataConfigService.java rename to spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboMetadataConfigService.java index 28b7a373..b8443fb0 100644 --- a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/service/MetadataConfigService.java +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboMetadataConfigService.java @@ -14,20 +14,23 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.springframework.cloud.alibaba.dubbo.metadata.service; +package org.springframework.cloud.alibaba.dubbo.service; import org.springframework.cloud.alibaba.dubbo.metadata.ServiceRestMetadata; import java.util.Set; /** - * Config Service for Metadata + * Dubbo Metadata Configuration Service * * @author Mercy */ -public interface MetadataConfigService { +public interface DubboMetadataConfigService { - void publishServiceRestMetadata(String serviceName, Set serviceRestMetadata); - - Set getServiceRestMetadata(String serviceName); + /** + * Get The json content of {@link ServiceRestMetadata} {@link Set} + * + * @return the non-null String + */ + String getServiceRestMetadata(); } diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboMetadataConfigServiceInvocationHandler.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboMetadataConfigServiceInvocationHandler.java new file mode 100644 index 00000000..94014d77 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboMetadataConfigServiceInvocationHandler.java @@ -0,0 +1,54 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service; + +import com.alibaba.dubbo.rpc.service.GenericService; + +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.Method; + +/** + * {@link DubboMetadataConfigService} {@link InvocationHandler} + * + * @author Mercy + */ +class DubboMetadataConfigServiceInvocationHandler implements InvocationHandler { + + /** + * The method name of {@link DubboMetadataConfigService#getServiceRestMetadata()} + */ + private static final String METHOD_NAME = "getServiceRestMetadata"; + + private static final String[] PARAMETER_TYPES = new String[0]; + + private static final String[] PARAMETER_VALUES = new String[0]; + + private final GenericService genericService; + + public DubboMetadataConfigServiceInvocationHandler(String serviceName, DubboGenericServiceFactory dubboGenericServiceFactory) { + this.genericService = dubboGenericServiceFactory.create(serviceName, DubboMetadataConfigService.class); + } + + @Override + public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { + String methodName = method.getName(); + if (METHOD_NAME.equals(methodName)) { + return genericService.$invoke(methodName, PARAMETER_TYPES, PARAMETER_VALUES); + } + return method.invoke(proxy, args); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboMetadataConfigServiceProxy.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboMetadataConfigServiceProxy.java new file mode 100644 index 00000000..8db49572 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/DubboMetadataConfigServiceProxy.java @@ -0,0 +1,51 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service; + +import org.springframework.beans.factory.BeanClassLoaderAware; + +import static java.lang.reflect.Proxy.newProxyInstance; + +/** + * The proxy of {@link DubboMetadataConfigService} + */ +public class DubboMetadataConfigServiceProxy implements BeanClassLoaderAware { + + private final DubboGenericServiceFactory dubboGenericServiceFactory; + + private ClassLoader classLoader; + + public DubboMetadataConfigServiceProxy(DubboGenericServiceFactory dubboGenericServiceFactory) { + this.dubboGenericServiceFactory = dubboGenericServiceFactory; + } + + /** + * New proxy instance of {@link DubboMetadataConfigService} via the specified service name + * + * @param serviceName the service name + * @return a {@link DubboMetadataConfigService} proxy + */ + public DubboMetadataConfigService newProxy(String serviceName) { + return (DubboMetadataConfigService) newProxyInstance(classLoader, new Class[]{DubboMetadataConfigService.class}, + new DubboMetadataConfigServiceInvocationHandler(serviceName, dubboGenericServiceFactory)); + } + + @Override + public void setBeanClassLoader(ClassLoader classLoader) { + this.classLoader = classLoader; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/PublishingDubboMetadataConfigService.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/PublishingDubboMetadataConfigService.java new file mode 100644 index 00000000..799e7caa --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/PublishingDubboMetadataConfigService.java @@ -0,0 +1,78 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service; + +import com.alibaba.dubbo.config.annotation.Service; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.SerializationFeature; +import org.springframework.cloud.alibaba.dubbo.metadata.ServiceRestMetadata; +import org.springframework.util.CollectionUtils; + +import javax.annotation.PostConstruct; +import java.util.LinkedHashSet; +import java.util.Set; + +import static org.springframework.cloud.alibaba.dubbo.autoconfigure.DubboMetadataAutoConfiguration.METADATA_PROTOCOL_BEAN_NAME; + +/** + * Publishing {@link DubboMetadataConfigService} implementation + * + * @author Mercy + */ +@Service(version = "${spring.application.name}", protocol = METADATA_PROTOCOL_BEAN_NAME) +// Use current Spring application name as the Dubbo Service version +public class PublishingDubboMetadataConfigService implements DubboMetadataConfigService { + + /** + * A Map to store REST metadata temporary, its' key is the special service name for a Dubbo service, + * the value is a JSON content of JAX-RS or Spring MVC REST metadata from the annotated methods. + */ + private final Set serviceRestMetadata = new LinkedHashSet<>(); + + private final ObjectMapper objectMapper = new ObjectMapper(); + + @PostConstruct + public void init() { + this.objectMapper.enable(SerializationFeature.INDENT_OUTPUT); + } + + /** + * Publish the {@link Set} of {@link ServiceRestMetadata} + * + * @param serviceRestMetadataSet the {@link Set} of {@link ServiceRestMetadata} + */ + public void publishServiceRestMetadata(Set serviceRestMetadataSet) { + for (ServiceRestMetadata serviceRestMetadata : serviceRestMetadataSet) { + if (!CollectionUtils.isEmpty(serviceRestMetadata.getMeta())) { + this.serviceRestMetadata.add(serviceRestMetadata); + } + } + } + + @Override + public String getServiceRestMetadata() { + String serviceRestMetadataJsonConfig = null; + try { + serviceRestMetadataJsonConfig = objectMapper.writeValueAsString(serviceRestMetadata); + } catch (JsonProcessingException e) { + throw new RuntimeException(e); + } + return serviceRestMetadataJsonConfig; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/AbstractDubboGenericServiceParameterResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/AbstractDubboGenericServiceParameterResolver.java new file mode 100644 index 00000000..5ad1be1b --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/AbstractDubboGenericServiceParameterResolver.java @@ -0,0 +1,82 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service.parameter; + +import org.springframework.beans.factory.BeanClassLoaderAware; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.core.convert.ConversionService; +import org.springframework.format.support.FormattingConversionService; + +import static org.springframework.context.ConfigurableApplicationContext.CONVERSION_SERVICE_BEAN_NAME; +import static org.springframework.util.ClassUtils.resolveClassName; + +/** + * Abstract {@link DubboGenericServiceParameterResolver} implementation + * + * @author Mercy + */ +public abstract class AbstractDubboGenericServiceParameterResolver implements DubboGenericServiceParameterResolver, + BeanClassLoaderAware { + + private int order; + + @Autowired(required = false) + @Qualifier(CONVERSION_SERVICE_BEAN_NAME) + private ConversionService conversionService = new FormattingConversionService(); + + private ClassLoader classLoader; + + public ConversionService getConversionService() { + return conversionService; + } + + public void setConversionService(ConversionService conversionService) { + this.conversionService = conversionService; + } + + public ClassLoader getClassLoader() { + return classLoader; + } + + @Override + public void setBeanClassLoader(ClassLoader classLoader) { + this.classLoader = classLoader; + } + + public void setOrder(int order) { + this.order = order; + } + + @Override + public int getOrder() { + return order; + } + + protected Class resolveClass(String className) { + return resolveClassName(className, classLoader); + } + + protected Object resolveValue(Object parameterValue, String parameterType) { + Class targetType = resolveClass(parameterType); + return resolveValue(parameterValue, targetType); + } + + protected Object resolveValue(Object parameterValue, Class parameterType) { + return conversionService.convert(parameterValue, parameterType); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/AbstractNamedValueServiceParameterResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/AbstractNamedValueServiceParameterResolver.java new file mode 100644 index 00000000..3654b1bd --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/AbstractNamedValueServiceParameterResolver.java @@ -0,0 +1,122 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service.parameter; + +import org.springframework.cloud.alibaba.dubbo.http.HttpServerRequest; +import org.springframework.cloud.alibaba.dubbo.metadata.MethodParameterMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; +import org.springframework.util.CollectionUtils; +import org.springframework.util.MultiValueMap; + +import java.util.Collection; +import java.util.Collections; +import java.util.Map; + +import static org.springframework.util.ObjectUtils.isEmpty; + +/** + * Abstract HTTP Names Value {@link DubboGenericServiceParameterResolver Dubbo GenericService Parameter Resolver} + * + * @author Mercy + */ +public abstract class AbstractNamedValueServiceParameterResolver extends AbstractDubboGenericServiceParameterResolver { + + /** + * Get the {@link MultiValueMap} of names and values + * + * @param request + * @return + */ + protected abstract MultiValueMap getNameAndValuesMap(HttpServerRequest request); + + @Override + public Object resolve(RestMethodMetadata restMethodMetadata, MethodParameterMetadata methodParameterMetadata, + HttpServerRequest request) { + + Collection names = getNames(restMethodMetadata, methodParameterMetadata); + + if (isEmpty(names)) { // index can't match + return null; + } + + MultiValueMap nameAndValues = getNameAndValuesMap(request); + + String targetName = null; + + for (String name : names) { + if (nameAndValues.containsKey(name)) { + targetName = name; + break; + } + } + + if (targetName == null) { // request parameter is abstract + return null; + } + + Class parameterType = resolveClass(methodParameterMetadata.getType()); + + Object paramValue = null; + + if (parameterType.isArray()) { // Array type + paramValue = nameAndValues.get(targetName); + } else { + paramValue = nameAndValues.getFirst(targetName); + } + + return resolveValue(paramValue, parameterType); + } + + @Override + public Object resolve(RestMethodMetadata restMethodMetadata, MethodParameterMetadata methodParameterMetadata, + RestMethodMetadata clientRestMethodMetadata, Object[] arguments) { + + Collection names = getNames(restMethodMetadata, methodParameterMetadata); + + if (isEmpty(names)) { // index can't match + return null; + } + + Integer index = null; + + Map> clientIndexToName = clientRestMethodMetadata.getIndexToName(); + + for (Map.Entry> entry : clientIndexToName.entrySet()) { + + Collection clientParamNames = entry.getValue(); + + if (CollectionUtils.containsAny(names, clientParamNames)) { + index = entry.getKey(); + break; + } + } + + return index > -1 ? arguments[index] : null; + } + + protected Collection getNames(RestMethodMetadata restMethodMetadata, MethodParameterMetadata methodParameterMetadata) { + + Map> indexToName = restMethodMetadata.getIndexToName(); + + int index = methodParameterMetadata.getIndex(); + + Collection paramNames = indexToName.get(index); + + return paramNames == null ? Collections.emptyList() : paramNames; + } + +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/DubboGenericServiceParameterResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/DubboGenericServiceParameterResolver.java new file mode 100644 index 00000000..58ed2263 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/DubboGenericServiceParameterResolver.java @@ -0,0 +1,43 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service.parameter; + +import com.alibaba.dubbo.rpc.service.GenericService; + +import org.springframework.cloud.alibaba.dubbo.http.HttpServerRequest; +import org.springframework.cloud.alibaba.dubbo.metadata.MethodParameterMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; +import org.springframework.core.Ordered; + +/** + * Dubbo {@link GenericService} Parameter Resolver + * + * @author Mercy + */ +public interface DubboGenericServiceParameterResolver extends Ordered { + + /** + * Resolves a method parameter into an argument value from a given request. + * + * @return + */ + Object resolve(RestMethodMetadata restMethodMetadata, MethodParameterMetadata methodParameterMetadata, + HttpServerRequest request); + + Object resolve(RestMethodMetadata restMethodMetadata, MethodParameterMetadata methodParameterMetadata, + RestMethodMetadata clientRestMethodMetadata, Object[] arguments); +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/PathVariableServiceParameterResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/PathVariableServiceParameterResolver.java new file mode 100644 index 00000000..81a40f3c --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/PathVariableServiceParameterResolver.java @@ -0,0 +1,40 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service.parameter; + +import org.springframework.cloud.alibaba.dubbo.http.HttpServerRequest; +import org.springframework.util.MultiValueMap; + +/** + * HTTP Request Path Variable {@link DubboGenericServiceParameterResolver Dubbo GenericService Parameter Resolver} + * + * @author Mercy + */ +public class PathVariableServiceParameterResolver extends AbstractNamedValueServiceParameterResolver { + + public static final int DEFAULT_ORDER = 3; + + public PathVariableServiceParameterResolver() { + super(); + setOrder(DEFAULT_ORDER); + } + + @Override + protected MultiValueMap getNameAndValuesMap(HttpServerRequest request) { + return request.getQueryParams(); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/RequestBodyServiceParameterResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/RequestBodyServiceParameterResolver.java new file mode 100644 index 00000000..e4f35cae --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/RequestBodyServiceParameterResolver.java @@ -0,0 +1,117 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service.parameter; + +import org.springframework.beans.factory.ObjectProvider; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.http.HttpMessageConverters; +import org.springframework.cloud.alibaba.dubbo.http.HttpServerRequest; +import org.springframework.cloud.alibaba.dubbo.http.converter.HttpMessageConverterHolder; +import org.springframework.cloud.alibaba.dubbo.http.util.HttpMessageConverterResolver; +import org.springframework.cloud.alibaba.dubbo.metadata.MethodParameterMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; +import org.springframework.http.converter.HttpMessageConverter; +import org.springframework.http.converter.HttpMessageNotReadableException; + +import javax.annotation.PostConstruct; +import java.io.IOException; +import java.util.Collections; +import java.util.Objects; + +/** + * HTTP Request Body {@link DubboGenericServiceParameterResolver} + * + * @author Mercy + */ +public class RequestBodyServiceParameterResolver extends AbstractDubboGenericServiceParameterResolver { + + public static final int DEFAULT_ORDER = 7; + + @Autowired + private ObjectProvider httpMessageConverters; + + private HttpMessageConverterResolver httpMessageConverterResolver; + + public RequestBodyServiceParameterResolver() { + super(); + setOrder(DEFAULT_ORDER); + } + + @PostConstruct + public void init() { + HttpMessageConverters httpMessageConverters = this.httpMessageConverters.getIfAvailable(); + + httpMessageConverterResolver = new HttpMessageConverterResolver(httpMessageConverters == null ? + Collections.emptyList() : httpMessageConverters.getConverters(), + getClassLoader()); + } + + private boolean supportParameter(RestMethodMetadata restMethodMetadata, MethodParameterMetadata methodParameterMetadata) { + + Integer index = methodParameterMetadata.getIndex(); + + Integer bodyIndex = restMethodMetadata.getBodyIndex(); + + if (!Objects.equals(index, bodyIndex)) { + return false; + } + + Class parameterType = resolveClass(methodParameterMetadata.getType()); + + Class bodyType = resolveClass(restMethodMetadata.getBodyType()); + + return Objects.equals(parameterType, bodyType); + } + + @Override + public Object resolve(RestMethodMetadata restMethodMetadata, MethodParameterMetadata methodParameterMetadata, + HttpServerRequest request) { + + if (!supportParameter(restMethodMetadata, methodParameterMetadata)) { + return null; + } + + Object result = null; + + Class parameterType = resolveClass(methodParameterMetadata.getType()); + + HttpMessageConverterHolder holder = httpMessageConverterResolver.resolve(request, parameterType); + + if (holder != null) { + HttpMessageConverter converter = holder.getConverter(); + try { + result = converter.read(parameterType, request); + } catch (IOException e) { + throw new HttpMessageNotReadableException("I/O error while reading input message", e); + } + } + + return result; + } + + @Override + public Object resolve(RestMethodMetadata restMethodMetadata, MethodParameterMetadata methodParameterMetadata, + RestMethodMetadata clientRestMethodMetadata, Object[] arguments) { + + if (!supportParameter(restMethodMetadata, methodParameterMetadata)) { + return null; + } + + Integer clientBodyIndex = clientRestMethodMetadata.getBodyIndex(); + return arguments[clientBodyIndex]; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/RequestHeaderServiceParameterResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/RequestHeaderServiceParameterResolver.java new file mode 100644 index 00000000..fc0e1c01 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/RequestHeaderServiceParameterResolver.java @@ -0,0 +1,40 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service.parameter; + +import org.springframework.cloud.alibaba.dubbo.http.HttpServerRequest; +import org.springframework.util.MultiValueMap; + +/** + * HTTP Request Header {@link DubboGenericServiceParameterResolver Dubbo GenericService Parameter Resolver} + * + * @author Mercy + */ +public class RequestHeaderServiceParameterResolver extends AbstractNamedValueServiceParameterResolver { + + public static final int DEFAULT_ORDER = 9; + + public RequestHeaderServiceParameterResolver() { + super(); + setOrder(DEFAULT_ORDER); + } + + @Override + protected MultiValueMap getNameAndValuesMap(HttpServerRequest request) { + return request.getHeaders(); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/RequestParamServiceParameterResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/RequestParamServiceParameterResolver.java new file mode 100644 index 00000000..4801d1ba --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/service/parameter/RequestParamServiceParameterResolver.java @@ -0,0 +1,40 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service.parameter; + +import org.springframework.cloud.alibaba.dubbo.http.HttpServerRequest; +import org.springframework.util.MultiValueMap; + +/** + * HTTP Request Parameter {@link DubboGenericServiceParameterResolver Dubbo GenericService Parameter Resolver} + * + * @author Mercy + */ +public class RequestParamServiceParameterResolver extends AbstractNamedValueServiceParameterResolver { + + public static final int DEFAULT_ORDER = 1; + + public RequestParamServiceParameterResolver() { + super(); + setOrder(DEFAULT_ORDER); + } + + @Override + protected MultiValueMap getNameAndValuesMap(HttpServerRequest request) { + return request.getQueryParams(); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/resources/META-INF/spring.factories b/spring-cloud-alibaba-dubbo/src/main/resources/META-INF/spring.factories index c2627f86..516f25f6 100644 --- a/spring-cloud-alibaba-dubbo/src/main/resources/META-INF/spring.factories +++ b/spring-cloud-alibaba-dubbo/src/main/resources/META-INF/spring.factories @@ -1,7 +1,9 @@ org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.cloud.alibaba.dubbo.autoconfigure.DubboMetadataAutoConfiguration,\ org.springframework.cloud.alibaba.dubbo.autoconfigure.DubboOpenFeignAutoConfiguration,\ - org.springframework.cloud.alibaba.dubbo.autoconfigure.DubboRestMetadataRegistrationAutoConfiguration + org.springframework.cloud.alibaba.dubbo.autoconfigure.DubboRestMetadataRegistrationAutoConfiguration,\ + org.springframework.cloud.alibaba.dubbo.autoconfigure.DubboLoadBalancedRestTemplateAutoConfiguration,\ + org.springframework.cloud.alibaba.dubbo.autoconfigure.DubboServiceAutoConfiguration org.springframework.context.ApplicationContextInitializer=\ - org.springframework.cloud.alibaba.dubbo.context.DubboServiceRegistrationApplicationContextInitializer + org.springframework.cloud.alibaba.dubbo.context.DubboServiceRegistrationApplicationContextInitializer \ No newline at end of file diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/bootstrap/DubboSpringCloudBootstrap.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/bootstrap/DubboSpringCloudBootstrap.java index d7b3d13d..48566585 100644 --- a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/bootstrap/DubboSpringCloudBootstrap.java +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/bootstrap/DubboSpringCloudBootstrap.java @@ -17,19 +17,35 @@ package org.springframework.cloud.alibaba.dubbo.bootstrap; import com.alibaba.dubbo.config.annotation.Reference; + import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.ApplicationRunner; import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.builder.SpringApplicationBuilder; -import org.springframework.cloud.alibaba.dubbo.service.EchoService; +import org.springframework.cloud.alibaba.dubbo.annotation.DubboTransported; +import org.springframework.cloud.alibaba.dubbo.service.RestService; +import org.springframework.cloud.alibaba.dubbo.service.User; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; +import org.springframework.cloud.client.loadbalancer.LoadBalanced; import org.springframework.cloud.openfeign.EnableFeignClients; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Lazy; import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestHeader; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.client.RestTemplate; + +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import java.util.HashMap; +import java.util.Map; + +import static org.springframework.http.MediaType.APPLICATION_JSON_UTF8_VALUE; /** * Dubbo Spring Cloud Bootstrap @@ -41,32 +57,159 @@ import org.springframework.web.bind.annotation.RestController; public class DubboSpringCloudBootstrap { @Reference(version = "1.0.0") - private EchoService echoService; + private RestService restService; @Autowired @Lazy - private FeignEchoService feignEchoService; + private FeignRestService feignRestService; - @GetMapping(value = "/call/echo") - public String echo(@RequestParam("message") String message) { - return feignEchoService.echo(message); + @Autowired + @Lazy + private DubboFeignRestService dubboFeignRestService; + + @Autowired + @LoadBalanced + private RestTemplate restTemplate; + + @FeignClient("spring-cloud-alibaba-dubbo") + public interface FeignRestService { + + @GetMapping(value = "/param") + String param(@RequestParam("param") String param); + + @PostMapping("/params") + public String params(@RequestParam("b") String b, @RequestParam("a") int a); + + @PostMapping(value = "/request/body/map", produces = APPLICATION_JSON_UTF8_VALUE) + User requestBody(@RequestParam("param") String param, @RequestBody Map data); + + @GetMapping("/headers") + @Path("/headers") + @GET + public String headers(@RequestHeader("h2") String header2, + @RequestHeader("h") String header, + @RequestParam("v") Integer value); + + @GetMapping("/path-variables/{p1}/{p2}") + public String pathVariables(@PathVariable("p2") String path2, + @PathVariable("p1") String path1, + @RequestParam("v") String param); } @FeignClient("spring-cloud-alibaba-dubbo") - public interface FeignEchoService { + @DubboTransported + public interface DubboFeignRestService { - @GetMapping(value = "/echo") - String echo(@RequestParam("message") String message); + @GetMapping(value = "/param") + String param(@RequestParam("param") String param); + + @PostMapping("/params") + String params(@RequestParam("b") String paramB, @RequestParam("a") int paramA); + + @PostMapping(value = "/request/body/map", produces = APPLICATION_JSON_UTF8_VALUE) + User requestBody(@RequestParam("param") String param, @RequestBody Map data); + + @GetMapping("/headers") + @Path("/headers") + @GET + public String headers(@RequestHeader("h2") String header2, + @RequestParam("v") Integer value, + @RequestHeader("h") String header); + + @GetMapping("/path-variables/{p1}/{p2}") + public String pathVariables(@RequestParam("v") String param, + @PathVariable("p2") String path2, + @PathVariable("p1") String path1); + } + + + @Bean + public ApplicationRunner paramRunner() { + return arguments -> { + + // To call /path-variables + callPathVariables(); + + // To call /headers + callHeaders(); + + // To call /param + callParam(); + + // To call /params + callParams(); + + // To call /request/body/map + callRequestBodyMap(); + + }; + } + + private void callPathVariables() { + // Dubbo Service call + System.out.println(restService.pathVariables("a", "b", "c")); + // Spring Cloud Open Feign REST Call (Dubbo Transported) + System.out.println(dubboFeignRestService.pathVariables("c", "b", "a")); + // Spring Cloud Open Feign REST Call + System.out.println(feignRestService.pathVariables("b", "a", "c")); + + // RestTemplate call + System.out.println(restTemplate.getForEntity("http://spring-cloud-alibaba-dubbo//path-variables/{p1}/{p2}?v=c", String.class, "a", "b")); + } + + private void callHeaders() { + // Dubbo Service call + System.out.println(restService.headers("a", "b", 10)); + // Spring Cloud Open Feign REST Call (Dubbo Transported) + System.out.println(dubboFeignRestService.headers("b", 10, "a")); + // Spring Cloud Open Feign REST Call + System.out.println(feignRestService.headers("b", "a", 10)); + } + + private void callParam() { + // Dubbo Service call + System.out.println(restService.param("mercyblitz")); + // Spring Cloud Open Feign REST Call (Dubbo Transported) + System.out.println(dubboFeignRestService.param("mercyblitz")); + // Spring Cloud Open Feign REST Call + System.out.println(feignRestService.param("mercyblitz")); + } + + private void callParams() { + // Dubbo Service call + System.out.println(restService.params(1, "1")); + // Spring Cloud Open Feign REST Call (Dubbo Transported) + System.out.println(dubboFeignRestService.params("1", 1)); + // Spring Cloud Open Feign REST Call + System.out.println(feignRestService.params("1", 1)); + + // RestTemplate call + System.out.println(restTemplate.getForEntity("http://spring-cloud-alibaba-dubbo/param?param=小马哥", String.class)); + } + + private void callRequestBodyMap() { + + Map data = new HashMap<>(); + data.put("id", 1); + data.put("name", "小马哥"); + data.put("age", 33); + + // Dubbo Service call + System.out.println(restService.requestBodyMap(data, "Hello,World")); + // Spring Cloud Open Feign REST Call (Dubbo Transported) +// System.out.println(dubboFeignRestService.requestBody("Hello,World", data)); +// Spring Cloud Open Feign REST Call + System.out.println(feignRestService.requestBody("Hello,World", data)); + + // RestTemplate call + System.out.println(restTemplate.postForObject("http://spring-cloud-alibaba-dubbo/request/body/map?param=小马哥", data, User.class)); } @Bean - public ApplicationRunner applicationRunner() { - return arguments -> { - // Dubbo Service call - System.out.println(echoService.echo("mercyblitz")); - // Spring Cloud Open Feign REST Call - System.out.println(feignEchoService.echo("mercyblitz")); - }; + @LoadBalanced + @DubboTransported + public RestTemplate restTemplate() { + return new RestTemplate(); } public static void main(String[] args) { diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractHttpRequestMatcherTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractHttpRequestMatcherTest.java new file mode 100644 index 00000000..6e792a53 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractHttpRequestMatcherTest.java @@ -0,0 +1,37 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.junit.Test; + +/** + * {@link AbstractHttpRequestMatcher} Test + * + * @author Mercy + */ +public abstract class AbstractHttpRequestMatcherTest { + + @Test + public abstract void testEqualsAndHashCode(); + + @Test + public abstract void testGetContent(); + + @Test + public abstract void testGetToStringInfix(); + +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractMediaTypeExpressionTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractMediaTypeExpressionTest.java new file mode 100644 index 00000000..48588c73 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractMediaTypeExpressionTest.java @@ -0,0 +1,71 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.junit.Assert; +import org.junit.Test; +import org.springframework.beans.BeanUtils; +import org.springframework.core.ResolvableType; +import org.springframework.http.MediaType; + +import java.lang.reflect.Constructor; + +/** + * {@link AbstractMediaTypeExpression} Test + * + * @author Mercy + */ +public abstract class AbstractMediaTypeExpressionTest { + + protected T createExpression(String expression) { + ResolvableType resolvableType = ResolvableType.forType(getClass().getGenericSuperclass()); + Class firstGenericType = (Class) resolvableType.resolveGeneric(0); + Constructor constructor = null; + try { + constructor = firstGenericType.getDeclaredConstructor(String.class); + } catch (NoSuchMethodException e) { + throw new RuntimeException(e); + } + return BeanUtils.instantiateClass(constructor, expression); + } + + @Test + public void testGetMediaTypeAndNegated() { + // Normal + AbstractMediaTypeExpression expression = createExpression(MediaType.APPLICATION_JSON_VALUE); + Assert.assertEquals(MediaType.APPLICATION_JSON, expression.getMediaType()); + Assert.assertFalse(expression.isNegated()); + + // Negated + expression = createExpression("!" + MediaType.APPLICATION_JSON_VALUE); + Assert.assertEquals(MediaType.APPLICATION_JSON, expression.getMediaType()); + Assert.assertTrue(expression.isNegated()); + } + + @Test + public void testEqualsAndHashCode() { + Assert.assertEquals(createExpression(MediaType.APPLICATION_JSON_VALUE), createExpression(MediaType.APPLICATION_JSON_VALUE)); + Assert.assertEquals(createExpression(MediaType.APPLICATION_JSON_VALUE).hashCode(), + createExpression(MediaType.APPLICATION_JSON_VALUE).hashCode()); + } + + @Test + public void testCompareTo() { + Assert.assertEquals(0, + createExpression(MediaType.APPLICATION_JSON_VALUE).compareTo(createExpression(MediaType.APPLICATION_JSON_VALUE))); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractNameValueExpressionTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractNameValueExpressionTest.java new file mode 100644 index 00000000..407b7127 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/AbstractNameValueExpressionTest.java @@ -0,0 +1,77 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.junit.Assert; +import org.junit.Test; +import org.springframework.beans.BeanUtils; +import org.springframework.core.ResolvableType; + +import java.lang.reflect.Constructor; + +/** + * {@link AbstractNameValueExpression} Test + * + * @author Mercy + */ +public abstract class AbstractNameValueExpressionTest { + + protected T createExpression(String expression) { + ResolvableType resolvableType = ResolvableType.forType(getClass().getGenericSuperclass()); + Class firstGenericType = (Class) resolvableType.resolveGeneric(0); + Constructor constructor = null; + try { + constructor = firstGenericType.getDeclaredConstructor(String.class); + } catch (NoSuchMethodException e) { + throw new RuntimeException(e); + } + return BeanUtils.instantiateClass(constructor, expression); + } + + @Test + public void testGetNameAndValue() { + // Normal Name and value + AbstractNameValueExpression expression = createExpression("a=1"); + Assert.assertEquals("a", expression.getName()); + Assert.assertFalse(expression.isNegated()); + + expression = createExpression("a=1"); + Assert.assertEquals("a", expression.getName()); + Assert.assertEquals("1", expression.getValue()); + Assert.assertFalse(expression.isNegated()); + + // Negated Name + expression = createExpression("!a"); + Assert.assertEquals("a", expression.getName()); + Assert.assertTrue(expression.isNegated()); + + expression = createExpression("a!=1"); + Assert.assertEquals("a", expression.getName()); + Assert.assertEquals("1", expression.getValue()); + Assert.assertTrue(expression.isNegated()); + } + + @Test + public void testEqualsAndHashCode() { + Assert.assertEquals(createExpression("a"), createExpression("a")); + Assert.assertEquals(createExpression("a").hashCode(), createExpression("a").hashCode()); + Assert.assertEquals(createExpression("a=1"), createExpression("a = 1 ")); + Assert.assertEquals(createExpression("a=1").hashCode(), createExpression("a = 1 ").hashCode()); + Assert.assertNotEquals(createExpression("a"), createExpression("b")); + Assert.assertNotEquals(createExpression("a").hashCode(), createExpression("b").hashCode()); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ConsumeMediaTypeExpressionTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ConsumeMediaTypeExpressionTest.java new file mode 100644 index 00000000..492a9f28 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ConsumeMediaTypeExpressionTest.java @@ -0,0 +1,45 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.MediaType; + +/** + * {@link ConsumeMediaTypeExpression} Test + * + * @author Mercy + */ +public class ConsumeMediaTypeExpressionTest extends AbstractMediaTypeExpressionTest { + + @Test + public void testMatch() { + ConsumeMediaTypeExpression expression = createExpression(MediaType.ALL_VALUE); + + Assert.assertTrue(expression.match(MediaType.APPLICATION_JSON_UTF8)); + + expression = createExpression(MediaType.APPLICATION_JSON_VALUE); + Assert.assertTrue(expression.match(MediaType.APPLICATION_JSON_UTF8)); + + expression = createExpression(MediaType.APPLICATION_JSON_VALUE + ";q=0.7"); + Assert.assertTrue(expression.match(MediaType.APPLICATION_JSON_UTF8)); + + expression = createExpression(MediaType.TEXT_HTML_VALUE); + Assert.assertFalse(expression.match(MediaType.APPLICATION_JSON_UTF8)); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HeaderExpressionTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HeaderExpressionTest.java new file mode 100644 index 00000000..1d2c7a76 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HeaderExpressionTest.java @@ -0,0 +1,60 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpRequest; + +import static org.springframework.cloud.alibaba.dubbo.http.DefaultHttpRequest.builder; + +/** + * {@link HeaderExpression} Test + * + * @author Mercy + */ +public class HeaderExpressionTest extends AbstractNameValueExpressionTest { + + @Test + public void testIsCaseSensitiveName() { + Assert.assertFalse(createExpression("a=1").isCaseSensitiveName()); + Assert.assertFalse(createExpression("a=!1").isCaseSensitiveName()); + Assert.assertFalse(createExpression("b=1").isCaseSensitiveName()); + } + + @Test + public void testMatch() { + + HeaderExpression expression = createExpression("a=1"); + HttpRequest request = builder().build(); + + Assert.assertFalse(expression.match(request)); + + request = builder().header("a", "").build(); + Assert.assertFalse(expression.match(request)); + + request = builder().header("a", "2").build(); + Assert.assertFalse(expression.match(request)); + + request = builder().header("", "1").build(); + Assert.assertFalse(expression.match(request)); + + request = builder().header("a", "1").build(); + Assert.assertTrue(expression.match(request)); + } + +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestMethodsMatcherTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestMethodsMatcherTest.java new file mode 100644 index 00000000..4d28fc57 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestMethodsMatcherTest.java @@ -0,0 +1,49 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.junit.Assert; +import org.springframework.http.HttpMethod; + +import java.util.Arrays; +import java.util.HashSet; + +/** + * {@link HttpRequestMethodsMatcher} Test + * + * @author Mercy + */ +public class HttpRequestMethodsMatcherTest extends AbstractHttpRequestMatcherTest { + + HttpRequestMethodsMatcher matcher = new HttpRequestMethodsMatcher("GET"); + + @Override + public void testEqualsAndHashCode() { + Assert.assertEquals(new HashSet<>(Arrays.asList(HttpMethod.GET)), matcher.getMethods()); + } + + @Override + public void testGetContent() { + Assert.assertEquals(new HashSet<>(Arrays.asList(HttpMethod.GET)), matcher.getContent()); + } + + @Override + public void testGetToStringInfix() { + Assert.assertEquals(" || ", matcher.getToStringInfix()); + } + +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestParamsMatcherTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestParamsMatcherTest.java new file mode 100644 index 00000000..36476fae --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/HttpRequestParamsMatcherTest.java @@ -0,0 +1,98 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.junit.Assert; +import org.junit.Test; +import org.springframework.mock.http.client.MockClientHttpRequest; + +import java.net.URI; +import java.util.List; +import java.util.Map; + +/** + * {@link HttpRequestParamsMatcher} Test + * + * @author Mercy + */ +public class HttpRequestParamsMatcherTest { + +// @Test +// public void testGetParams() { +// +// HttpRequestParamsMatcher matcher = new HttpRequestParamsMatcher( +// "a ", +// "a =1", +// "b = 2", +// "b = 3 ", +// " c = 4 ", +// " d" +// ); +// +// Map> params = matcher.getParams(); +// Assert.assertEquals(4, params.size()); +// Assert.assertTrue(params.containsKey("a")); +// Assert.assertTrue(params.containsKey("b")); +// Assert.assertTrue(params.containsKey("c")); +// Assert.assertTrue(params.containsKey("d")); +// Assert.assertFalse(params.containsKey("e")); +// +// List values = params.get("a"); +// Assert.assertEquals(2, values.size()); +// Assert.assertEquals("", values.get(0)); +// Assert.assertEquals("1", values.get(1)); +// +// values = params.get("b"); +// Assert.assertEquals(2, values.size()); +// Assert.assertEquals("2", values.get(0)); +// Assert.assertEquals("3", values.get(1)); +// +// values = params.get("c"); +// Assert.assertEquals(1, values.size()); +// Assert.assertEquals("4", values.get(0)); +// +// values = params.get("d"); +// Assert.assertEquals(1, values.size()); +// Assert.assertEquals("", values.get(0)); +// } + + @Test + public void testEquals() { + + HttpRequestParamsMatcher matcher = new HttpRequestParamsMatcher("a ", "a = 1"); + + MockClientHttpRequest request = new MockClientHttpRequest(); + + request.setURI(URI.create("http://dummy/?a")); + Assert.assertTrue(matcher.match(request)); + request.setURI(URI.create("http://dummy/?a&a=1")); + Assert.assertTrue(matcher.match(request)); + + matcher = new HttpRequestParamsMatcher("a ", "a =1", "b", "b=2"); + request.setURI(URI.create("http://dummy/?a&a=1&b")); + Assert.assertTrue(matcher.match(request)); + request.setURI(URI.create("http://dummy/?a&a=1&b&b=2")); + Assert.assertTrue(matcher.match(request)); + + matcher = new HttpRequestParamsMatcher("a ", "a =1", "b", "b=2", "b = 3 "); + request.setURI(URI.create("http://dummy/?a&a=1&b&b=2&b=3")); + Assert.assertTrue(matcher.match(request)); + + request.setURI(URI.create("http://dummy/?d=1")); + Assert.assertFalse(matcher.match(request)); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ParamExpressionTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ParamExpressionTest.java new file mode 100644 index 00000000..5cab37ab --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ParamExpressionTest.java @@ -0,0 +1,60 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.HttpRequest; + +import static org.springframework.cloud.alibaba.dubbo.http.DefaultHttpRequest.builder; + +/** + * {@link ParamExpression} Test + * + * @author Mercy + */ +public class ParamExpressionTest extends AbstractNameValueExpressionTest { + + @Test + public void testIsCaseSensitiveName() { + Assert.assertTrue(createExpression("a=1").isCaseSensitiveName()); + Assert.assertTrue(createExpression("a=!1").isCaseSensitiveName()); + Assert.assertTrue(createExpression("b=1").isCaseSensitiveName()); + } + + @Test + public void testMatch() { + + ParamExpression expression = createExpression("a=1"); + HttpRequest request = builder().build(); + + Assert.assertFalse(expression.match(request)); + + request = builder().param("a", "").build(); + Assert.assertFalse(expression.match(request)); + + request = builder().param("a", "2").build(); + Assert.assertFalse(expression.match(request)); + + request = builder().param("", "1").build(); + Assert.assertFalse(expression.match(request)); + + request = builder().param("a", "1").build(); + Assert.assertTrue(expression.match(request)); + } + +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ProduceMediaTypeExpressionTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ProduceMediaTypeExpressionTest.java new file mode 100644 index 00000000..a749e274 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/matcher/ProduceMediaTypeExpressionTest.java @@ -0,0 +1,40 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.matcher; + +import org.junit.Assert; +import org.junit.Test; +import org.springframework.http.MediaType; + +import java.util.Arrays; + +/** + * {@link ProduceMediaTypeExpression} Test + * + * @author Mercy + */ +public class ProduceMediaTypeExpressionTest extends AbstractMediaTypeExpressionTest { + + @Test + public void testMatch() { + ProduceMediaTypeExpression expression = createExpression(MediaType.APPLICATION_JSON_VALUE); + Assert.assertTrue(expression.match(Arrays.asList(MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON))); + + expression = createExpression(MediaType.APPLICATION_JSON_VALUE); + Assert.assertFalse(expression.match(Arrays.asList(MediaType.APPLICATION_XML))); + } +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/util/HttpUtilsTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/util/HttpUtilsTest.java new file mode 100644 index 00000000..789c18b8 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/http/util/HttpUtilsTest.java @@ -0,0 +1,41 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.http.util; + +import org.junit.Assert; +import org.junit.Test; + +/** + * {@link HttpUtils} Test + * + * @author Mercy + */ +public class HttpUtilsTest { + + @Test + public void testEncodeAndDecode() { + + String whitespace = " "; + + String encodedValue = HttpUtils.encode(" "); + + String decodedValue = HttpUtils.decode(encodedValue); + + Assert.assertEquals(whitespace, decodedValue); + } + +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/metadata/RequestMetadataTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/metadata/RequestMetadataTest.java new file mode 100644 index 00000000..bbd2d25e --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/metadata/RequestMetadataTest.java @@ -0,0 +1,136 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.metadata; + +import org.junit.Assert; +import org.junit.Test; + +import java.util.Arrays; +import java.util.LinkedHashSet; +import java.util.Set; + +/** + * {@link RequestMetadata} Test + * + * @author Mercy + */ +public class RequestMetadataTest { + + private String method = "GET"; + + private String url = "/param"; + + private Set paramNames = new LinkedHashSet<>(Arrays.asList("a", "b", "c")); + + private Set headerNames = new LinkedHashSet<>(Arrays.asList("d", "e", "f")); + + @Test + public void testEqualsAndHashCodeAndCompareTo() { + + RequestMetadata metadata = new RequestMetadata(); + RequestMetadata metadata2 = new RequestMetadata(); + + Assert.assertEquals(metadata, metadata2); + Assert.assertEquals(metadata.hashCode(), metadata2.hashCode()); + + metadata.setMethod(method); + metadata2.setMethod(method); + + Assert.assertEquals(metadata, metadata2); + Assert.assertEquals(metadata.hashCode(), metadata2.hashCode()); + + metadata.setPath(url); + metadata2.setPath(url); + + Assert.assertEquals(metadata, metadata2); + Assert.assertEquals(metadata.hashCode(), metadata2.hashCode()); + + metadata.addParam("a", "1").addParam("b", "2").addParam("c", "3"); + metadata2.addParam("a", "1a").addParam("b", "2b").addParam("c", "3c"); + + Assert.assertEquals(metadata, metadata2); + Assert.assertEquals(metadata.hashCode(), metadata2.hashCode()); + + metadata.addHeader("d", "1").addHeader("e", "2").addHeader("f", "3"); + metadata2.addHeader("d", "1").addHeader("e", "2"); + + Assert.assertNotEquals(metadata, metadata2); + Assert.assertNotEquals(metadata.hashCode(), metadata2.hashCode()); + } + +// @Test +// public void testBestMatch() { +// +// NavigableMap requestMetadataMap = new TreeMap<>(); +// +// RequestMetadata metadata = new RequestMetadata(); +// metadata.setMethod(method); +// +// RequestMetadata metadata1 = new RequestMetadata(); +// metadata1.setMethod(method); +// metadata1.setPath(url); +// +// RequestMetadata metadata2 = new RequestMetadata(); +// metadata2.setMethod(method); +// metadata2.setPath(url); +// metadata2.setParams(paramNames); +// +// RequestMetadata metadata3 = new RequestMetadata(); +// metadata3.setMethod(method); +// metadata3.setPath(url); +// metadata3.setParams(paramNames); +// metadata3.setHeaders(headerNames); +// +// requestMetadataMap.put(metadata, metadata); +// requestMetadataMap.put(metadata1, metadata1); +// requestMetadataMap.put(metadata2, metadata2); +// requestMetadataMap.put(metadata3, metadata3); +// +// RequestMetadata result = getBestMatch(requestMetadataMap, metadata); +// Assert.assertEquals(result, metadata); +// +// result = getBestMatch(requestMetadataMap, metadata1); +// Assert.assertEquals(result, metadata1); +// +// result = getBestMatch(requestMetadataMap, metadata2); +// Assert.assertEquals(result, metadata2); +// +// result = getBestMatch(requestMetadataMap, metadata3); +// Assert.assertEquals(result, metadata3); +// +// // REDO +// requestMetadataMap.clear(); +// +// requestMetadataMap.put(metadata1, metadata1); +// +// result = getBestMatch(requestMetadataMap, metadata2); +// Assert.assertEquals(metadata1, result); +// +// requestMetadataMap.put(metadata2, metadata2); +// +// result = getBestMatch(requestMetadataMap, metadata3); +// Assert.assertEquals(metadata2, result); +// +// result = getBestMatch(requestMetadataMap, new RequestMetadata()); +// Assert.assertNull(result); +// +// result = getBestMatch(requestMetadataMap, metadata); +// Assert.assertNull(result); +// +// } + +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/DubboTransportedMethodMetadataResolverTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/DubboTransportedMethodMetadataResolverTest.java new file mode 100644 index 00000000..6e263a06 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/DubboTransportedMethodMetadataResolverTest.java @@ -0,0 +1,59 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.metadata.resolver; + +import org.junit.Assert; +import org.junit.Before; +import org.junit.Test; +import org.springframework.cloud.alibaba.dubbo.annotation.DubboTransported; +import org.springframework.cloud.alibaba.dubbo.metadata.DubboTransportedMethodMetadata; +import org.springframework.cloud.openfeign.support.SpringMvcContract; +import org.springframework.mock.env.MockEnvironment; + +import java.util.Set; + +/** + * {@link DubboTransportedMethodMetadataResolver} Test + * + * @author Mercy + */ +public class DubboTransportedMethodMetadataResolverTest { + + private DubboTransportedMethodMetadataResolver resolver; + + private MockEnvironment environment; + + @Before + public void init() { + environment = new MockEnvironment(); + resolver = new DubboTransportedMethodMetadataResolver(environment, new SpringMvcContract()); + } + + @Test + public void testResolve() { + Set metadataSet = resolver.resolveDubboTransportedMethodMetadataSet(TestDefaultService.class); + Assert.assertEquals(1, metadataSet.size()); + } + + + @DubboTransported + interface TestDefaultService { + + String test(String message); + + } +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/DefaultEchoService.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/DefaultEchoService.java deleted file mode 100644 index e1ad9a9d..00000000 --- a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/DefaultEchoService.java +++ /dev/null @@ -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.springframework.cloud.alibaba.dubbo.service; - -import com.alibaba.dubbo.config.annotation.Service; -import com.alibaba.dubbo.rpc.RpcContext; - -import org.springframework.http.MediaType; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.PostMapping; -import org.springframework.web.bind.annotation.RequestParam; -import org.springframework.web.bind.annotation.RestController; - -import javax.ws.rs.Consumes; -import javax.ws.rs.GET; -import javax.ws.rs.POST; -import javax.ws.rs.Path; -import javax.ws.rs.Produces; -import javax.ws.rs.QueryParam; - -/** - * Default {@link EchoService} - * - * @author Mercy - */ -@Service(version = "1.0.0", protocol = {"dubbo", "rest"}) -@RestController -@Path("/") -public class DefaultEchoService implements EchoService { - - @Override - @GetMapping(value = "/echo" -// consumes = MediaType.APPLICATION_JSON_VALUE, -// produces = MediaType.APPLICATION_JSON_UTF8_VALUE - ) - @Path("/echo") - @GET -// @Consumes("application/json") -// @Produces("application/json;charset=UTF-8") - public String echo(@RequestParam @QueryParam("message") String message) { - return RpcContext.getContext().getUrl() + " [echo] : " + message; - } - - @Override - @PostMapping("/plus") - @Path("/plus") - @POST - public String plus(@RequestParam @QueryParam("a") int a, @RequestParam @QueryParam("b") int b) { - return null; - } -} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/EchoService.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/RestService.java similarity index 69% rename from spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/EchoService.java rename to spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/RestService.java index 10ace8ec..35d6755d 100644 --- a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/EchoService.java +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/RestService.java @@ -16,15 +16,27 @@ */ package org.springframework.cloud.alibaba.dubbo.service; +import java.util.Map; + /** * Echo Service * * @author Mercy */ -public interface EchoService { +public interface RestService { - String echo(String message); + String param(String param); - String plus(int a, int b); + String params(int a, String b); + + String headers(String header, String header2, Integer param); + + String pathVariables(String path1, String path2, String param); + + String form(String form); + + User requestBodyMap(Map data, String param); + + Map requestBodyUser(User user); } diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/StandardRestService.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/StandardRestService.java new file mode 100644 index 00000000..0c512f66 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/StandardRestService.java @@ -0,0 +1,149 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service; + +import com.alibaba.dubbo.rpc.RpcContext; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestHeader; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +import javax.ws.rs.Consumes; +import javax.ws.rs.FormParam; +import javax.ws.rs.GET; +import javax.ws.rs.HeaderParam; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import java.util.HashMap; +import java.util.Map; + +import static org.springframework.http.MediaType.APPLICATION_JSON_UTF8_VALUE; +import static org.springframework.util.MimeTypeUtils.APPLICATION_JSON_VALUE; + +/** + * Default {@link RestService} + * + * @author Mercy + */ +@com.alibaba.dubbo.config.annotation.Service(version = "1.0.0", protocol = {"dubbo", "rest"}) +@RestController +@Path("/") +public class StandardRestService implements RestService { + + private Logger logger = LoggerFactory.getLogger(getClass()); + + @Override + @GetMapping(value = "/param") + @Path("/param") + @GET + public String param(@RequestParam @QueryParam("param") String param) { + log("/param", param); + return param; + } + + @Override + @PostMapping("/params") + @Path("/params") + @POST + public String params(@RequestParam @QueryParam("a") int a, @RequestParam @QueryParam("b") String b) { + log("/params", a + b); + return a + b; + } + + @Override + @GetMapping("/headers") + @Path("/headers") + @GET + public String headers(@RequestHeader("h") @HeaderParam("h") String header, + @RequestHeader("h2") @HeaderParam("h2") String header2, + @RequestParam("v") @QueryParam("v") Integer param) { + String result = header + " , " + header2 + " , " + param; + log("/headers", result); + return result; + } + + @Override + @GetMapping("/path-variables/{p1}/{p2}") + @Path("/path-variables/{p1}/{p2}") + @GET + public String pathVariables(@PathVariable("p1") @PathParam("p1") String path1, + @PathVariable("p2") @PathParam("p2") String path2, + @RequestParam("v") @QueryParam("v") String param) { + String result = path1 + " , " + path2 + " , " + param; + log("/path-variables", result); + return result; + } + + // @CookieParam does not support : https://github.com/OpenFeign/feign/issues/913 + // @CookieValue also does not support + + @Override + @PostMapping("/form") + @Path("/form") + @POST + public String form(@RequestParam("f") @FormParam("f") String form) { + return String.valueOf(form); + } + + @Override + @PostMapping(value = "/request/body/map", produces = APPLICATION_JSON_UTF8_VALUE) + @Path("/request/body/map") + @POST + @Produces(APPLICATION_JSON_VALUE) + public User requestBodyMap(@RequestBody Map data, @RequestParam("param") @QueryParam("param") String param) { + User user = new User(); + user.setId(((Integer) data.get("id")).longValue()); + user.setName((String) data.get("name")); + user.setAge((Integer) data.get("age")); + log("/request/body/map", param); + return user; + } + + @PostMapping(value = "/request/body/user", consumes = APPLICATION_JSON_UTF8_VALUE) + @Path("/request/body/user") + @POST + @Override + @Consumes(APPLICATION_JSON_UTF8_VALUE) + public Map requestBodyUser(@RequestBody User user) { + Map map = new HashMap<>(); + map.put("id", user.getId()); + map.put("name", user.getName()); + map.put("age", user.getAge()); + return map; + } + + private void log(String url, Object result) { + String message = String.format("The client[%s] uses '%s' protocol to call %s : %s", + RpcContext.getContext().getRemoteHostName(), + RpcContext.getContext().getUrl() == null ? "N/A" : RpcContext.getContext().getUrl().getProtocol(), + url, + result + ); + if (logger.isInfoEnabled()) { + logger.info(message); + } + } +} diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/User.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/User.java new file mode 100644 index 00000000..79d54107 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/User.java @@ -0,0 +1,68 @@ +/* + * 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.springframework.cloud.alibaba.dubbo.service; + +import javax.ws.rs.FormParam; +import java.io.Serializable; + +/** + * User Entity + */ +public class User implements Serializable { + + @FormParam("id") + private Long id; + + @FormParam("name") + private String name; + + @FormParam("age") + private Integer age; + + public Long getId() { + return id; + } + + public void setId(Long id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public Integer getAge() { + return age; + } + + public void setAge(Integer age) { + this.age = age; + } + + @Override + public String toString() { + return "User{" + + "id=" + id + + ", name='" + name + '\'' + + ", age=" + age + + '}'; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/test/resources/application.yaml b/spring-cloud-alibaba-dubbo/src/test/resources/application.yaml index afdfbfa7..e3867ace 100644 --- a/spring-cloud-alibaba-dubbo/src/test/resources/application.yaml +++ b/spring-cloud-alibaba-dubbo/src/test/resources/application.yaml @@ -12,5 +12,9 @@ dubbo: registry: address: spring-cloud://nacos +feign: + hystrix: + enabled: true + server: port: 8080 \ No newline at end of file diff --git a/spring-cloud-alibaba-dubbo/src/test/resources/bootstrap.yaml b/spring-cloud-alibaba-dubbo/src/test/resources/bootstrap.yaml index c3799608..e21e07da 100644 --- a/spring-cloud-alibaba-dubbo/src/test/resources/bootstrap.yaml +++ b/spring-cloud-alibaba-dubbo/src/test/resources/bootstrap.yaml @@ -7,6 +7,8 @@ spring: server-addr: 127.0.0.1:8848 config: server-addr: 127.0.0.1:8848 + main: + allow-bean-definition-overriding: true eureka: client: diff --git a/spring-cloud-alibaba-examples/acm-example/acm-local-example/pom.xml b/spring-cloud-alibaba-examples/acm-example/acm-local-example/pom.xml index c7847d51..250a60fb 100644 --- a/spring-cloud-alibaba-examples/acm-example/acm-local-example/pom.xml +++ b/spring-cloud-alibaba-examples/acm-example/acm-local-example/pom.xml @@ -23,28 +23,11 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot spring-boot-maven-plugin - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/ans-example/ans-consumer-feign-example/pom.xml b/spring-cloud-alibaba-examples/ans-example/ans-consumer-feign-example/pom.xml index 2e6ddcb8..af0c708c 100644 --- a/spring-cloud-alibaba-examples/ans-example/ans-consumer-feign-example/pom.xml +++ b/spring-cloud-alibaba-examples/ans-example/ans-consumer-feign-example/pom.xml @@ -29,25 +29,4 @@ spring-boot-starter-actuator - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - - - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - - - \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/ans-example/ans-consumer-ribbon-example/pom.xml b/spring-cloud-alibaba-examples/ans-example/ans-consumer-ribbon-example/pom.xml index 6289c404..b66c22ff 100644 --- a/spring-cloud-alibaba-examples/ans-example/ans-consumer-ribbon-example/pom.xml +++ b/spring-cloud-alibaba-examples/ans-example/ans-consumer-ribbon-example/pom.xml @@ -25,25 +25,4 @@ spring-boot-starter-actuator - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - - - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - - - \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/ans-example/ans-provider-example/pom.xml b/spring-cloud-alibaba-examples/ans-example/ans-provider-example/pom.xml index 67ce3b6b..fc8f4b67 100644 --- a/spring-cloud-alibaba-examples/ans-example/ans-provider-example/pom.xml +++ b/spring-cloud-alibaba-examples/ans-example/ans-provider-example/pom.xml @@ -27,28 +27,11 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot spring-boot-maven-plugin - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/pom.xml b/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/pom.xml index 8d964fb7..565a732d 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/pom.xml +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/pom.xml @@ -34,14 +34,6 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot @@ -55,15 +47,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/src/main/resources/bootstrap.properties b/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/src/main/resources/bootstrap.properties index 6adb653c..831d8ff7 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/src/main/resources/bootstrap.properties +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/src/main/resources/bootstrap.properties @@ -1,2 +1,4 @@ -spring.application.name=nacos-config-example -spring.cloud.nacos.config.server-addr=127.0.0.1:8848 \ No newline at end of file +spring.application.name=sca-nacos-config +spring.cloud.nacos.config.server-addr=127.0.0.1:8848 +spring.cloud.nacos.config.shared-data-ids=base-common.properties,common.properties +spring.cloud.nacos.config.refreshable-dataids=common.properties \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-consumer-example/pom.xml b/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-consumer-example/pom.xml index aabf1ec1..6a3af32b 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-consumer-example/pom.xml +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-consumer-example/pom.xml @@ -48,14 +48,6 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot @@ -69,15 +61,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-provider-example/pom.xml b/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-provider-example/pom.xml index 52bac0cf..a81b13bc 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-provider-example/pom.xml +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-provider-example/pom.xml @@ -29,18 +29,9 @@ org.springframework.boot spring-boot-starter-actuator - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot @@ -54,15 +45,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/pom.xml b/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/pom.xml index bea5a0b0..843f6f4c 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/pom.xml +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/pom.xml @@ -20,26 +20,4 @@ nacos-discovery-consumer-example nacos-discovery-provider-example - - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - - - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - - - diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-discovery-example/pom.xml b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-discovery-example/pom.xml index bac2b278..6af752d7 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-discovery-example/pom.xml +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-discovery-example/pom.xml @@ -35,14 +35,6 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot @@ -56,15 +48,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-provider-example/pom.xml b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-provider-example/pom.xml index 8a121fa8..a4bf41d2 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-provider-example/pom.xml +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-provider-example/pom.xml @@ -33,14 +33,6 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot @@ -54,15 +46,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/pom.xml b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/pom.xml index 9b7f638e..c2aa58ed 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/pom.xml +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/pom.xml @@ -20,26 +20,4 @@ nacos-gateway-discovery-example nacos-gateway-provider-example - - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - - - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - - - diff --git a/spring-cloud-alibaba-examples/oss-example/pom.xml b/spring-cloud-alibaba-examples/oss-example/pom.xml index 75cbfd2f..624b3e66 100644 --- a/spring-cloud-alibaba-examples/oss-example/pom.xml +++ b/spring-cloud-alibaba-examples/oss-example/pom.xml @@ -33,14 +33,6 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot @@ -54,15 +46,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-examples/pom.xml b/spring-cloud-alibaba-examples/pom.xml index 6cd8e731..31e8ca5e 100644 --- a/spring-cloud-alibaba-examples/pom.xml +++ b/spring-cloud-alibaba-examples/pom.xml @@ -40,14 +40,6 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.apache.maven.plugins @@ -57,16 +49,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - - diff --git a/spring-cloud-alibaba-examples/rocketmq-example/pom.xml b/spring-cloud-alibaba-examples/rocketmq-example/pom.xml index 12bfbb4f..84ef5029 100644 --- a/spring-cloud-alibaba-examples/rocketmq-example/pom.xml +++ b/spring-cloud-alibaba-examples/rocketmq-example/pom.xml @@ -40,14 +40,6 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot @@ -61,15 +53,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-examples/schedulerx-example/schedulerx-simple-task-example/pom.xml b/spring-cloud-alibaba-examples/schedulerx-example/schedulerx-simple-task-example/pom.xml index 7cb076a9..57cb2df5 100644 --- a/spring-cloud-alibaba-examples/schedulerx-example/schedulerx-simple-task-example/pom.xml +++ b/spring-cloud-alibaba-examples/schedulerx-example/schedulerx-simple-task-example/pom.xml @@ -27,28 +27,11 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot spring-boot-maven-plugin - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/pom.xml b/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/pom.xml index 25e56597..507e8498 100644 --- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/pom.xml +++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-core-example/pom.xml @@ -51,14 +51,6 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot @@ -72,15 +64,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/readme-zh.md b/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/readme-zh.md index 0a26836b..2a936115 100644 --- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/readme-zh.md +++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/readme-zh.md @@ -112,7 +112,7 @@ Consumer端在服务调用之前，先定义限流规则。 根据Provider端中发布的定义，使用Dubbo的@Reference注解注入服务对应的Bean： @Reference(version = "${foo.service.version}", application = "${dubbo.application.id}", - url = "dubbo://localhost:12345", timeout = 30000) + path = "dubbo://localhost:12345", timeout = 30000) private FooService fooService; 由于设置的qps是10。调用15次查看是否被限流： diff --git a/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/readme.md b/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/readme.md index 2bfcaec9..a69ea0b1 100644 --- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/readme.md +++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/readme.md @@ -110,7 +110,7 @@ Configure rules: Using the `@Reference` annotation to inject service: @Reference(version = "${foo.service.version}", application = "${dubbo.application.id}", - url = "dubbo://localhost:12345", timeout = 30000) + path = "dubbo://localhost:12345", timeout = 30000) private FooService fooService; Because QPS is 10, we can see that flow control takes effect in this invocation: diff --git a/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-api/pom.xml b/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-api/pom.xml index d594344e..5e0b8f4a 100644 --- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-api/pom.xml +++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-api/pom.xml @@ -16,14 +16,6 @@ api for sentinel dubbo example - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.apache.maven.plugins @@ -33,15 +25,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-consumer-example/pom.xml b/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-consumer-example/pom.xml index f3bd3370..f10efec5 100644 --- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-consumer-example/pom.xml +++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-consumer-example/pom.xml @@ -40,14 +40,6 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot @@ -61,15 +53,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-provider-example/pom.xml b/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-provider-example/pom.xml index 6aff02b3..5fde98b0 100644 --- a/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-provider-example/pom.xml +++ b/spring-cloud-alibaba-examples/sentinel-example/sentinel-dubbo-example/sentinel-dubbo-provider-example/pom.xml @@ -39,14 +39,6 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot @@ -60,15 +52,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-examples/spring-cloud-bus-rocketmq-example/pom.xml b/spring-cloud-alibaba-examples/spring-cloud-bus-rocketmq-example/pom.xml index 6874be2d..060bb532 100644 --- a/spring-cloud-alibaba-examples/spring-cloud-bus-rocketmq-example/pom.xml +++ b/spring-cloud-alibaba-examples/spring-cloud-bus-rocketmq-example/pom.xml @@ -35,14 +35,6 @@ - - - - org.codehaus.mojo - cobertura-maven-plugin - - - org.springframework.boot @@ -56,15 +48,6 @@ true - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - diff --git a/spring-cloud-alibaba-nacos-config/pom.xml b/spring-cloud-alibaba-nacos-config/pom.xml index 05a7f5bd..8096c713 100644 --- a/spring-cloud-alibaba-nacos-config/pom.xml +++ b/spring-cloud-alibaba-nacos-config/pom.xml @@ -65,6 +65,11 @@ true + + org.springframework.boot + spring-boot-starter-web + test + org.springframework.boot spring-boot-starter-test @@ -75,6 +80,19 @@ spring-cloud-test-support test + + + org.powermock + powermock-module-junit4 + 2.0.0 + test + + + org.powermock + powermock-api-mockito2 + 2.0.0 + test + diff --git a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosConfigBootstrapConfiguration.java b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosConfigBootstrapConfiguration.java index 7fedcc16..94933a4d 100644 --- a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosConfigBootstrapConfiguration.java +++ b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosConfigBootstrapConfiguration.java @@ -17,6 +17,7 @@ package org.springframework.cloud.alibaba.nacos; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.cloud.alibaba.nacos.client.NacosPropertySourceLocator; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -34,6 +35,7 @@ public class NacosConfigBootstrapConfiguration { } @Bean + @ConditionalOnProperty(name = "spring.cloud.nacos.config.enabled", matchIfMissing = true) public NacosPropertySourceLocator nacosPropertySourceLocator( NacosConfigProperties nacosConfigProperties) { return new NacosPropertySourceLocator(nacosConfigProperties); diff --git a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosConfigProperties.java b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosConfigProperties.java index 4fefa863..5d13c01c 100644 --- a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosConfigProperties.java +++ b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosConfigProperties.java @@ -18,8 +18,9 @@ package org.springframework.cloud.alibaba.nacos; import com.alibaba.nacos.api.NacosFactory; import com.alibaba.nacos.api.config.ConfigService; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.core.env.Environment; @@ -49,9 +50,15 @@ import static com.alibaba.nacos.api.PropertyKeyConst.SERVER_ADDR; @ConfigurationProperties(NacosConfigProperties.PREFIX) public class NacosConfigProperties { - static final String PREFIX = "spring.cloud.nacos.config"; + public static final String PREFIX = "spring.cloud.nacos.config"; - private static final Log log = LogFactory.getLog(NacosConfigProperties.class); + private static final Logger log = LoggerFactory + .getLogger(NacosConfigProperties.class); + + /** + * whether to enable nacos config. + */ + private boolean enabled = true; /** * nacos config server address @@ -145,6 +152,14 @@ public class NacosConfigProperties { // todo sts support + public boolean isEnabled() { + return enabled; + } + + public void setEnabled(boolean enabled) { + this.enabled = enabled; + } + public String getServerAddr() { return serverAddr; } @@ -322,16 +337,17 @@ public class NacosConfigProperties { @Override public String toString() { - return "NacosConfigProperties{" + "serverAddr='" + serverAddr + '\'' - + ", encode='" + encode + '\'' + ", group='" + group + '\'' - + ", sharedDataids='" + this.sharedDataids + '\'' - + ", refreshableDataids='" + this.refreshableDataids + '\'' + ", prefix='" - + prefix + '\'' + ", fileExtension='" + fileExtension + '\'' - + ", timeout=" + timeout + ", endpoint='" + endpoint + '\'' - + ", namespace='" + namespace + '\'' + ", accessKey='" + accessKey + '\'' - + ", secretKey='" + secretKey + '\'' + ", contextPath='" + contextPath - + '\'' + ", clusterName='" + clusterName + '\'' + ", name='" + name + '\'' - + ", activeProfiles=" + Arrays.toString(activeProfiles) + '}'; + return "NacosConfigProperties{" + "enabled=" + enabled + ", serverAddr='" + + serverAddr + '\'' + ", encode='" + encode + '\'' + ", group='" + group + + '\'' + ", prefix='" + prefix + '\'' + ", fileExtension='" + + fileExtension + '\'' + ", timeout=" + timeout + ", endpoint='" + + endpoint + '\'' + ", namespace='" + namespace + '\'' + ", accessKey='" + + accessKey + '\'' + ", secretKey='" + secretKey + '\'' + + ", contextPath='" + contextPath + '\'' + ", clusterName='" + clusterName + + '\'' + ", name='" + name + '\'' + ", activeProfiles=" + + Arrays.toString(activeProfiles) + ", sharedDataids='" + sharedDataids + + '\'' + ", refreshableDataids='" + refreshableDataids + '\'' + + ", extConfig=" + extConfig + '}'; } public ConfigService configServiceInstance() { @@ -354,11 +370,8 @@ public class NacosConfigProperties { return configService; } catch (Exception e) { - log.error( - "create config service error!properties=" + this.toString() + ",e=,", - e); + log.error("create config service error!properties={},e=,", this, e); return null; } } - } diff --git a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosPropertySourceRepository.java b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosPropertySourceRepository.java index f29ab80a..0a0cc00c 100644 --- a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosPropertySourceRepository.java +++ b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/NacosPropertySourceRepository.java @@ -24,6 +24,7 @@ import java.util.concurrent.ConcurrentHashMap; /** * @author xiaojing + * @author pbting */ public class NacosPropertySourceRepository { @@ -45,6 +46,7 @@ public class NacosPropertySourceRepository { } public static NacosPropertySource getNacosPropertySource(String dataId) { + return nacosPropertySourceRepository.get(dataId); } } diff --git a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/client/NacosPropertySourceBuilder.java b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/client/NacosPropertySourceBuilder.java index c820d8b0..cf63f0db 100644 --- a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/client/NacosPropertySourceBuilder.java +++ b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/client/NacosPropertySourceBuilder.java @@ -18,8 +18,9 @@ package org.springframework.cloud.alibaba.nacos.client; import com.alibaba.nacos.api.config.ConfigService; import com.alibaba.nacos.api.exception.NacosException; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.beans.factory.config.YamlPropertiesFactoryBean; import org.springframework.cloud.alibaba.nacos.NacosPropertySourceRepository; import org.springframework.core.io.ByteArrayResource; @@ -37,7 +38,8 @@ import java.util.Properties; * @author pbting */ public class NacosPropertySourceBuilder { - private static final Log log = LogFactory.getLog(NacosPropertySourceBuilder.class); + private static final Logger log = LoggerFactory + .getLogger(NacosPropertySourceBuilder.class); private static final Properties EMPTY_PROPERTIES = new Properties(); private ConfigService configService; @@ -101,11 +103,10 @@ public class NacosPropertySourceBuilder { } } catch (NacosException e) { - log.error("get data from Nacos error,dataId:" + dataId + ", ", e); + log.error("get data from Nacos error,dataId:{}, ", dataId, e); } catch (Exception e) { - log.error("parse data from Nacos error,dataId:" + dataId + ",data:" + data - + ",", e); + log.error("parse data from Nacos error,dataId:{},data:{},", dataId, data, e); } return EMPTY_PROPERTIES; } diff --git a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/client/NacosPropertySourceLocator.java b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/client/NacosPropertySourceLocator.java index 5ffb7ac3..4c560658 100644 --- a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/client/NacosPropertySourceLocator.java +++ b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/client/NacosPropertySourceLocator.java @@ -17,8 +17,9 @@ package org.springframework.cloud.alibaba.nacos.client; import com.alibaba.nacos.api.config.ConfigService; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.cloud.alibaba.nacos.NacosConfigProperties; import org.springframework.cloud.alibaba.nacos.NacosPropertySourceRepository; import org.springframework.cloud.alibaba.nacos.refresh.NacosContextRefresher; @@ -39,7 +40,8 @@ import java.util.List; @Order(0) public class NacosPropertySourceLocator implements PropertySourceLocator { - private static final Log log = LogFactory.getLog(NacosPropertySourceLocator.class); + private static final Logger log = LoggerFactory + .getLogger(NacosPropertySourceLocator.class); private static final String NACOS_PROPERTY_SOURCE_NAME = "NACOS"; private static final String SEP1 = "-"; private static final String DOT = "."; @@ -182,19 +184,19 @@ public class NacosPropertySourceLocator implements PropertySourceLocator { } } - private static void checkDataIdFileExtension(String[] sharedDataIdArry) { + private static void checkDataIdFileExtension(String[] dataIdArray) { StringBuilder stringBuilder = new StringBuilder(); - for (int i = 0; i < sharedDataIdArry.length; i++) { + for (int i = 0; i < dataIdArray.length; i++) { boolean isLegal = false; for (String fileExtension : SUPPORT_FILE_EXTENSION) { - if (sharedDataIdArry[i].indexOf(fileExtension) > 0) { + if (dataIdArray[i].indexOf(fileExtension) > 0) { isLegal = true; break; } } // add tips if (!isLegal) { - stringBuilder.append(sharedDataIdArry[i] + ","); + stringBuilder.append(dataIdArray[i] + ","); } } diff --git a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/refresh/NacosContextRefresher.java b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/refresh/NacosContextRefresher.java index fcc6d9df..40341d41 100644 --- a/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/refresh/NacosContextRefresher.java +++ b/spring-cloud-alibaba-nacos-config/src/main/java/org/springframework/cloud/alibaba/nacos/refresh/NacosContextRefresher.java @@ -19,8 +19,9 @@ package org.springframework.cloud.alibaba.nacos.refresh; import com.alibaba.nacos.api.config.ConfigService; import com.alibaba.nacos.api.config.listener.Listener; import com.alibaba.nacos.api.exception.NacosException; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.boot.context.event.ApplicationReadyEvent; import org.springframework.cloud.alibaba.nacos.NacosPropertySourceRepository; import org.springframework.cloud.alibaba.nacos.client.NacosPropertySource; @@ -51,7 +52,8 @@ import java.util.concurrent.atomic.AtomicLong; public class NacosContextRefresher implements ApplicationListener, ApplicationContextAware { - private final static Log log = LogFactory.getLog(NacosContextRefresher.class); + private final static Logger log = LoggerFactory + .getLogger(NacosContextRefresher.class); private static final AtomicLong REFRESH_COUNT = new AtomicLong(0); diff --git a/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/EndpointTests.java b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/EndpointTests.java new file mode 100644 index 00000000..5ef53f03 --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/EndpointTests.java @@ -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 org.springframework.cloud.alibaba.nacos; + +import org.junit.Test; +import org.springframework.cloud.alibaba.nacos.endpoint.NacosConfigEndpoint; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * @author pbting + * @date 2019-01-17 2:25 PM + */ +public class EndpointTests extends NacosPowerMockitBaseTests { + + @Test + public void nacosConfigEndpoint() { + + NacosConfigEndpoint nacosConfigEndpoint = super.context + .getBean(NacosConfigEndpoint.class); + assertThat(nacosConfigEndpoint != null).isEqualTo(true); + } + + @Test + public void endpointInvoke() { + NacosConfigEndpoint nacosConfigEndpoint = this.context + .getBean(NacosConfigEndpoint.class); + assertThat(nacosConfigEndpoint.invoke() != null).isEqualTo(true); + } +} \ No newline at end of file diff --git a/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigAutoConfigurationTests.java b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigAutoConfigurationTests.java index 4ecb4ddf..f8c29c46 100644 --- a/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigAutoConfigurationTests.java +++ b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigAutoConfigurationTests.java @@ -16,59 +16,52 @@ package org.springframework.cloud.alibaba.nacos; -import org.junit.After; -import org.junit.Before; import org.junit.Test; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.WebApplicationType; -import org.springframework.boot.autoconfigure.AutoConfigureBefore; -import org.springframework.boot.builder.SpringApplicationBuilder; import org.springframework.cloud.alibaba.nacos.client.NacosPropertySourceLocator; import org.springframework.cloud.alibaba.nacos.refresh.NacosRefreshProperties; -import org.springframework.cloud.context.refresh.ContextRefresher; -import org.springframework.cloud.context.scope.refresh.RefreshScope; -import org.springframework.context.ConfigurableApplicationContext; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.core.env.Environment; +import org.springframework.core.env.CompositePropertySource; +import org.springframework.core.env.PropertySource; import static org.assertj.core.api.Assertions.assertThat; /** * @author xiaojing + * @author pbting */ -public class NacosConfigAutoConfigurationTests { - - private ConfigurableApplicationContext context; - - @Before - public void setUp() throws Exception { - this.context = new SpringApplicationBuilder( - NacosConfigBootstrapConfiguration.class, - NacosConfigAutoConfiguration.class, TestConfiguration.class) - .web(WebApplicationType.NONE) - .run("--spring.cloud.nacos.config.name=myapp", - "--spring.cloud.config.enabled=true", - "--spring.cloud.nacos.config.server-addr=127.0.0.1:8848", - "--spring.cloud.nacos.config.prefix=test"); - } - - @After - public void tearDown() throws Exception { - if (this.context != null) { - this.context.close(); - } - } - +public class NacosConfigAutoConfigurationTests extends NacosPowerMockitBaseTests { @Test public void testNacosConfigProperties() { - NacosConfigProperties nacosConfigProperties = this.context.getParent() + NacosConfigProperties nacosConfigProperties = context.getParent() .getBean(NacosConfigProperties.class); assertThat(nacosConfigProperties.getFileExtension()).isEqualTo("properties"); - assertThat(nacosConfigProperties.getPrefix()).isEqualTo("test"); - assertThat(nacosConfigProperties.getName()).isEqualTo("myapp"); + assertThat(nacosConfigProperties.getPrefix() == null).isEqualTo(true); + assertThat(nacosConfigProperties.getNamespace() == null).isEqualTo(true); + assertThat(nacosConfigProperties.getName()).isEqualTo("sca-nacos-config"); + assertThat(nacosConfigProperties.getServerAddr()).isEqualTo("127.0.0.1:8848"); + assertThat(nacosConfigProperties.getEncode()).isEqualTo("utf-8"); + assertThat(nacosConfigProperties.getActiveProfiles()) + .isEqualTo(new String[] { "develop" }); + assertThat(nacosConfigProperties.getSharedDataids()) + .isEqualTo("base-common.properties,common.properties"); + assertThat(nacosConfigProperties.getRefreshableDataids()) + .isEqualTo("common.properties"); + assertThat(nacosConfigProperties.getExtConfig().size()).isEqualTo(3); + assertThat(nacosConfigProperties.getExtConfig().get(0).getDataId()) + .isEqualTo("ext00.yaml"); + assertThat(nacosConfigProperties.getExtConfig().get(1).getGroup()) + .isEqualTo("EXT01_GROUP"); + assertThat(nacosConfigProperties.getExtConfig().get(1).isRefresh()) + .isEqualTo(true); + } + @Test + public void nacosPropertySourceLocator() { + NacosPropertySourceLocator nacosPropertySourceLocator = this.context + .getBean(NacosPropertySourceLocator.class); + PropertySource propertySource = nacosPropertySourceLocator + .locate(this.context.getEnvironment()); + assertThat(propertySource instanceof CompositePropertySource).isEqualTo(true); } @Test @@ -80,18 +73,4 @@ public class NacosConfigAutoConfigurationTests { } - @Configuration - @AutoConfigureBefore(NacosConfigAutoConfiguration.class) - static class TestConfiguration { - - @Autowired - ConfigurableApplicationContext context; - - @Bean - ContextRefresher contextRefresher() { - return new ContextRefresher(context, new RefreshScope()); - } - - } - } diff --git a/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigBootstrapConfigurationTests.java b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigBootstrapConfigurationTests.java deleted file mode 100644 index 3d273f2a..00000000 --- a/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigBootstrapConfigurationTests.java +++ /dev/null @@ -1,82 +0,0 @@ -/* - * Copyright (C) 2018 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 org.springframework.cloud.alibaba.nacos; - -import java.lang.reflect.Field; - -import com.alibaba.nacos.api.config.ConfigService; - -import org.junit.After; -import org.junit.Before; -import org.junit.Test; -import org.springframework.boot.WebApplicationType; -import org.springframework.boot.builder.SpringApplicationBuilder; -import org.springframework.cloud.alibaba.nacos.client.NacosPropertySourceLocator; -import org.springframework.context.ConfigurableApplicationContext; -import org.springframework.core.env.Environment; -import org.springframework.util.ReflectionUtils; - -import static org.assertj.core.api.Assertions.assertThat; - -/** - * @author xiaojing - */ -public class NacosConfigBootstrapConfigurationTests { - - private ConfigurableApplicationContext context; - - @Before - public void setUp() throws Exception { - this.context = new SpringApplicationBuilder( - NacosConfigBootstrapConfiguration.class).web(WebApplicationType.NONE).run( - "--spring.cloud.nacos.config.name=myapp", - "--spring.cloud.config.enabled=true", - "--spring.cloud.nacos.config.server-addr=127.0.0.1:8848", - "--spring.cloud.nacos.config.prefix=test"); - } - - @After - public void tearDown() throws Exception { - if (this.context != null) { - this.context.close(); - } - } - - @Test - public void testNacosPropertySourceLocator() { - - NacosPropertySourceLocator locator = this.context - .getBean(NacosPropertySourceLocator.class); - Environment environment = this.context.getEnvironment(); - try { - locator.locate(environment); - } - catch (Exception e) { - - } - - Field nacosConfigPropertiesField = ReflectionUtils - .findField(NacosPropertySourceLocator.class, "nacosConfigProperties"); - nacosConfigPropertiesField.setAccessible(true); - - NacosConfigProperties configService = (NacosConfigProperties) ReflectionUtils - .getField(nacosConfigPropertiesField, locator); - - assertThat(configService).isNotNull(); - } - -} diff --git a/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigHealthIndicatorTests.java b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigHealthIndicatorTests.java new file mode 100644 index 00000000..1fd434b5 --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigHealthIndicatorTests.java @@ -0,0 +1,67 @@ +/* + * 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 org.springframework.cloud.alibaba.nacos; + +import org.junit.Test; +import org.springframework.boot.actuate.health.Health; +import org.springframework.cloud.alibaba.nacos.endpoint.NacosConfigHealthIndicator; +import org.springframework.util.ReflectionUtils; + +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * @author pbting + * @date 2019-01-17 2:58 PM + */ +public class NacosConfigHealthIndicatorTests extends NacosPowerMockitBaseTests { + + @Test + public void nacosConfigHealthIndicatorInstance() { + NacosConfigHealthIndicator nacosConfigHealthIndicator = this.context + .getBean(NacosConfigHealthIndicator.class); + + assertThat(nacosConfigHealthIndicator != null).isEqualTo(true); + } + + @Test + public void testHealthCheck() { + + NacosConfigHealthIndicator nacosConfigHealthIndicator = this.context + .getBean(NacosConfigHealthIndicator.class); + + Health.Builder builder = Health.up(); + + Method method = ReflectionUtils.findMethod(NacosConfigHealthIndicator.class, + "doHealthCheck", Health.Builder.class); + ReflectionUtils.makeAccessible(method); + assertThat(method != null).isEqualTo(true); + + try { + method.invoke(nacosConfigHealthIndicator, builder); + assertThat(builder != null).isEqualTo(true); + } + catch (IllegalAccessException e) { + e.printStackTrace(); + } + catch (InvocationTargetException e) { + e.printStackTrace(); + } + + } +} \ No newline at end of file diff --git a/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosPowerMockitBaseTests.java b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosPowerMockitBaseTests.java new file mode 100644 index 00000000..ada71a9c --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosPowerMockitBaseTests.java @@ -0,0 +1,177 @@ +/* + * 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 org.springframework.cloud.alibaba.nacos; + +import com.alibaba.nacos.api.config.ConfigService; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.powermock.api.mockito.PowerMockito; +import org.powermock.api.support.MethodProxy; +import org.powermock.core.classloader.annotations.PowerMockIgnore; +import org.powermock.core.classloader.annotations.PrepareForTest; +import org.powermock.modules.junit4.PowerMockRunner; +import org.powermock.modules.junit4.PowerMockRunnerDelegate; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.config.YamlPropertiesFactoryBean; +import org.springframework.boot.autoconfigure.AutoConfigureBefore; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.cloud.alibaba.nacos.client.NacosPropertySource; +import org.springframework.cloud.alibaba.nacos.client.NacosPropertySourceBuilder; +import org.springframework.cloud.alibaba.nacos.endpoint.NacosConfigEndpointAutoConfiguration; +import org.springframework.cloud.context.refresh.ContextRefresher; +import org.springframework.cloud.context.scope.refresh.RefreshScope; +import org.springframework.context.ApplicationContext; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.io.ClassPathResource; +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.util.ReflectionUtils; + +import java.io.IOException; +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.Method; +import java.util.Arrays; +import java.util.Date; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Properties; + +/** + * @author pbting + * @date 2019-01-17 8:54 PM + */ +@RunWith(PowerMockRunner.class) +@PowerMockRunnerDelegate(SpringRunner.class) +@PowerMockIgnore({ "javax.management.*", "javax.net.ssl.*" }) +@PrepareForTest({ NacosPropertySourceBuilder.class }) +@SpringBootTest(classes = { NacosConfigBootstrapConfiguration.class, + NacosConfigEndpointAutoConfiguration.class, NacosConfigAutoConfiguration.class, + NacosPowerMockitBaseTests.TestConfiguration.class }, properties = { + "spring.application.name=sca-nacos-config", + "spring.cloud.nacos.config.server-addr=127.0.0.1:8848", + "spring.cloud.nacos.config.name=sca-nacos-config", + // "spring.cloud.nacos.config.refresh.enabled=false", + "spring.cloud.nacos.config.encode=utf-8", + "spring.cloud.nacos.config.shared-data-ids=base-common.properties,common.properties", + "spring.cloud.nacos.config.refreshable-dataids=common.properties", + "spring.cloud.nacos.config.ext-config[0].data-id=ext00.yaml", + "spring.cloud.nacos.config.ext-config[1].data-id=ext01.yml", + "spring.cloud.nacos.config.ext-config[1].group=EXT01_GROUP", + "spring.cloud.nacos.config.ext-config[1].refresh=true", + "spring.cloud.nacos.config.ext-config[2].data-id=ext02.yaml", + "spring.profiles.active=develop", "server.port=19090" }) +public class NacosPowerMockitBaseTests { + + private final static List DATAIDS = Arrays.asList("common.properties", + "base-common.properties", "ext00.yaml", "ext01.yml", "ext02.yaml", + "sca-nacos-config.properties", "sca-nacos-config-develop.properties"); + + private final static HashMap VALUES = new HashMap<>(); + + @Autowired + protected ApplicationContext context; + + static { + initDataIds(); + try { + final Constructor constructor = ReflectionUtils.accessibleConstructor( + NacosPropertySource.class, String.class, String.class, Map.class, + Date.class, boolean.class); + Method method = PowerMockito.method(NacosPropertySourceBuilder.class, "build", + String.class, String.class, String.class, boolean.class); + MethodProxy.proxy(method, new InvocationHandler() { + @Override + public Object invoke(Object proxy, Method method, Object[] args) + throws Throwable { + Properties properties = VALUES.get(args[0].toString()); + if (properties == null) { + properties = new Properties(); + properties.put("user.name", args[0].toString()); + } + Object instance = constructor.newInstance(args[1].toString(), + args[0].toString(), properties, new Date(), args[3]); + return instance; + } + }); + } + catch (NoSuchMethodException e) { + e.printStackTrace(); + } + } + + private static void initDataIds() { + DATAIDS.forEach(dataId -> { + String realpath = "/" + dataId; + ClassPathResource classPathResource = new ClassPathResource(realpath); + if (realpath.endsWith("properties")) { + Properties properties = new Properties(); + try { + properties.load(classPathResource.getInputStream()); + VALUES.put(dataId, properties); + } + catch (IOException e) { + e.printStackTrace(); + } + } + + if (realpath.endsWith("yaml") || realpath.endsWith("yml")) { + YamlPropertiesFactoryBean yamlFactory = new YamlPropertiesFactoryBean(); + yamlFactory.setResources(classPathResource); + try { + VALUES.put(dataId, yamlFactory.getObject()); + } + catch (Exception e) { + e.printStackTrace(); + } + } + }); + } + + public NacosPropertySourceBuilder nacosPropertySourceBuilderInstance() { + NacosConfigProperties nacosConfigProperties = this.context + .getBean(NacosConfigProperties.class); + + ConfigService configService = nacosConfigProperties.configServiceInstance(); + long timeout = nacosConfigProperties.getTimeout(); + NacosPropertySourceBuilder nacosPropertySourceBuilder = new NacosPropertySourceBuilder( + configService, timeout); + return nacosPropertySourceBuilder; + } + + @Configuration + @AutoConfigureBefore(NacosConfigAutoConfiguration.class) + static class TestConfiguration { + + @Autowired + ConfigurableApplicationContext context; + + @Bean + ContextRefresher contextRefresher() { + RefreshScope refreshScope = new RefreshScope(); + refreshScope.setApplicationContext(context); + return new ContextRefresher(context, refreshScope); + } + } + + @Test + public void testAppContext() { + System.err.println(this.context); + } +} \ No newline at end of file diff --git a/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosPropertySourceBuilderTests.java b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosPropertySourceBuilderTests.java new file mode 100644 index 00000000..40248d25 --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosPropertySourceBuilderTests.java @@ -0,0 +1,190 @@ +/* + * 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 org.springframework.cloud.alibaba.nacos; + +import org.junit.Test; +import org.powermock.api.support.MethodProxy; +import org.springframework.cloud.alibaba.nacos.client.NacosPropertySource; +import org.springframework.cloud.alibaba.nacos.client.NacosPropertySourceBuilder; +import org.springframework.util.ReflectionUtils; + +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.util.Date; +import java.util.HashMap; +import java.util.Map; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * @author pbting + * @date 2019-01-17 11:49 AM + */ +public class NacosPropertySourceBuilderTests extends NacosPowerMockitBaseTests { + + @Test + public void nacosPropertySourceBuilder() { + + assertThat(nacosPropertySourceBuilderInstance() != null).isEqualTo(true); + } + + @Test + public void getConfigByProperties() { + try { + final HashMap value = new HashMap<>(); + value.put("dev.mode", "local-mock"); + + final Constructor constructor = ReflectionUtils.accessibleConstructor( + NacosPropertySource.class, String.class, String.class, Map.class, + Date.class, boolean.class); + + NacosPropertySourceBuilder nacosPropertySourceBuilder = nacosPropertySourceBuilderInstance(); + + Method method = ReflectionUtils.findMethod(NacosPropertySourceBuilder.class, + "build", String.class, String.class, String.class, boolean.class); + ReflectionUtils.makeAccessible(method); + assertThat(method != null).isEqualTo(true); + MethodProxy.proxy(method, new InvocationHandler() { + @Override + public Object invoke(Object proxy, Method method, Object[] args) + throws Throwable { + Object instance = constructor.newInstance(args[1].toString(), + args[0].toString(), value, new Date(), args[3]); + return instance; + } + }); + + Object result = method.invoke(nacosPropertySourceBuilder, + "mock-nacos-config.properties", "DEFAULT_GROUP", "properties", true); + assertThat(result != null).isEqualTo(true); + assertThat(result instanceof NacosPropertySource).isEqualTo(true); + NacosPropertySource nacosPropertySource = (NacosPropertySource) result; + assertThat(nacosPropertySource.getProperty("dev.mode")) + .isEqualTo("local-mock"); + } + catch (Exception e) { + e.printStackTrace(); + } + } + + @Test + public void getConfigByYaml() { + + try { + // + final HashMap value = new HashMap<>(); + value.put("mock-ext-config", "mock-ext-config-value"); + + final Constructor constructor = ReflectionUtils.accessibleConstructor( + NacosPropertySource.class, String.class, String.class, Map.class, + Date.class, boolean.class); + + Method method = ReflectionUtils.findMethod(NacosPropertySourceBuilder.class, + "build", String.class, String.class, String.class, boolean.class); + ReflectionUtils.makeAccessible(method); + assertThat(method != null).isEqualTo(true); + + MethodProxy.proxy(method, new InvocationHandler() { + @Override + public Object invoke(Object proxy, Method method, Object[] args) + throws Throwable { + Object instance = constructor.newInstance(args[1].toString(), + args[0].toString(), value, new Date(), args[3]); + return instance; + } + }); + + NacosPropertySourceBuilder nacosPropertySourceBuilder = nacosPropertySourceBuilderInstance(); + Object result = method.invoke(nacosPropertySourceBuilder, "ext-config.yaml", + "DEFAULT_GROUP", "yaml", true); + assertThat(result != null).isEqualTo(true); + assertThat(result instanceof NacosPropertySource).isEqualTo(true); + NacosPropertySource nacosPropertySource = (NacosPropertySource) result; + assertThat(nacosPropertySource.getProperty("mock-ext-config")) + .isEqualTo("mock-ext-config-value"); + } + catch (Exception e) { + e.printStackTrace(); + } + } + + @Test + public void getConfigByYml() { + try { + // + final HashMap value = new HashMap<>(); + value.put("mock-ext-config-yml", "mock-ext-config-yml-value"); + + final Constructor constructor = ReflectionUtils.accessibleConstructor( + NacosPropertySource.class, String.class, String.class, Map.class, + Date.class, boolean.class); + + Method method = ReflectionUtils.findMethod(NacosPropertySourceBuilder.class, + "build", String.class, String.class, String.class, boolean.class); + ReflectionUtils.makeAccessible(method); + assertThat(method != null).isEqualTo(true); + + MethodProxy.proxy(method, new InvocationHandler() { + @Override + public Object invoke(Object proxy, Method method, Object[] args) + throws Throwable { + Object instance = constructor.newInstance(args[1].toString(), + args[0].toString(), value, new Date(), args[3]); + return instance; + } + }); + + NacosPropertySourceBuilder nacosPropertySourceBuilder = nacosPropertySourceBuilderInstance(); + Object result = method.invoke(nacosPropertySourceBuilder, "ext-config.yml", + "DEFAULT_GROUP", "yml", true); + assertThat(result != null).isEqualTo(true); + assertThat(result instanceof NacosPropertySource).isEqualTo(true); + NacosPropertySource nacosPropertySource = (NacosPropertySource) result; + assertThat(nacosPropertySource.getProperty("mock-ext-config-yml")) + .isEqualTo("mock-ext-config-yml-value"); + } + catch (Exception e) { + e.printStackTrace(); + } + } + + @Test + public void getEmpty() { + NacosPropertySourceBuilder nacosPropertySourceBuilder = nacosPropertySourceBuilderInstance(); + + Method method = ReflectionUtils.findMethod(NacosPropertySourceBuilder.class, + "build", String.class, String.class, String.class, boolean.class); + ReflectionUtils.makeAccessible(method); + assertThat(method != null).isEqualTo(true); + + try { + Object result = method.invoke(nacosPropertySourceBuilder, "nacos-empty.yml", + "DEFAULT_GROUP", "yml", true); + assertThat(result != null).isEqualTo(true); + assertThat(result instanceof NacosPropertySource).isEqualTo(true); + NacosPropertySource nacosPropertySource = (NacosPropertySource) result; + assertThat(nacosPropertySource.getProperty("address")).isEqualTo(null); + } + catch (IllegalAccessException e) { + e.printStackTrace(); + } + catch (InvocationTargetException e) { + e.printStackTrace(); + } + } +} \ No newline at end of file diff --git a/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosSharedAndExtConfigTests.java b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosSharedAndExtConfigTests.java new file mode 100644 index 00000000..90fe3ca4 --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/java/org/springframework/cloud/alibaba/nacos/NacosSharedAndExtConfigTests.java @@ -0,0 +1,91 @@ +/* + * 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 org.springframework.cloud.alibaba.nacos; + +import org.junit.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.concurrent.TimeUnit; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * @author pbting + * @date 2019-01-17 11:46 AM + */ +public class NacosSharedAndExtConfigTests extends NacosPowerMockitBaseTests { + private final static Logger log = LoggerFactory + .getLogger(NacosSharedAndExtConfigTests.class); + + @Test + public void testSharedConfigPriority() { + String userName = this.context.getEnvironment().getProperty("user.address"); + assertThat(userName).isEqualTo("zhejiang-ningbo"); + } + + @Test + public void testSharedConfigRefresh() { + + while (true) { + // ContextRefresher contextRefresher = this.context + // .getBean(ContextRefresher.class); + // contextRefresher.refresh(); + String userName = this.context.getEnvironment().getProperty("user.address"); + try { + assertThat(userName).isEqualTo("zhejiang-ningbo"); + TimeUnit.SECONDS.sleep(1); + log.info("user name is {}", userName); + } + catch (InterruptedException e) { + e.printStackTrace(); + } + // 真实测试时将这里 注释掉 + break; + } + } + + @Test + public void testExtConfigPriority() { + String extKey = this.context.getEnvironment().getProperty("ext.key"); + assertThat(extKey).isEqualTo("ext.value02"); + } + + @Test + public void testExtOtherGroup() { + String userExt = this.context.getEnvironment().getProperty("user.ext"); + assertThat(userExt).isEqualTo("EXT01_GROUP-value"); + } + + @Test + public void testExtRefresh() { + while (true) { + // ContextRefresher contextRefresher = this.context + // .getBean(ContextRefresher.class); + // contextRefresher.refresh(); + String userExt = this.context.getEnvironment().getProperty("user.ext"); + try { + assertThat(userExt).isEqualTo("EXT01_GROUP-value"); + TimeUnit.SECONDS.sleep(1); + log.info("user name is {}", userExt); + } + catch (InterruptedException e) { + e.printStackTrace(); + } + break; + } + } +} \ No newline at end of file diff --git a/spring-cloud-alibaba-nacos-config/src/test/resources/base-common.properties b/spring-cloud-alibaba-nacos-config/src/test/resources/base-common.properties new file mode 100644 index 00000000..71137acf --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/resources/base-common.properties @@ -0,0 +1,2 @@ +user.name=base-common-value +user.address=zhejiang-hangzhou \ No newline at end of file diff --git a/spring-cloud-alibaba-nacos-config/src/test/resources/common.properties b/spring-cloud-alibaba-nacos-config/src/test/resources/common.properties new file mode 100644 index 00000000..d8f61776 --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/resources/common.properties @@ -0,0 +1,2 @@ +user.name=common-value +user.address=zhejiang-ningbo \ No newline at end of file diff --git a/spring-cloud-alibaba-nacos-config/src/test/resources/ext00.yaml b/spring-cloud-alibaba-nacos-config/src/test/resources/ext00.yaml new file mode 100644 index 00000000..4d70f674 --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/resources/ext00.yaml @@ -0,0 +1,4 @@ +user: + name: ext-00-value +ext: + key: ext.value00 \ No newline at end of file diff --git a/spring-cloud-alibaba-nacos-config/src/test/resources/ext01.yml b/spring-cloud-alibaba-nacos-config/src/test/resources/ext01.yml new file mode 100644 index 00000000..c689c09e --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/resources/ext01.yml @@ -0,0 +1,5 @@ +user: + name: ext-01-value + ext: EXT01_GROUP-value +ext: + key: ext.value01 diff --git a/spring-cloud-alibaba-nacos-config/src/test/resources/ext02.yaml b/spring-cloud-alibaba-nacos-config/src/test/resources/ext02.yaml new file mode 100644 index 00000000..9cc47740 --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/resources/ext02.yaml @@ -0,0 +1,5 @@ +user: + name: ext-02-value +ext: + key: ext.value02 +app-local-common: update app local shared cguration for Nacos \ No newline at end of file diff --git a/spring-cloud-alibaba-nacos-config/src/test/resources/sca-nacos-config-develop.properties b/spring-cloud-alibaba-nacos-config/src/test/resources/sca-nacos-config-develop.properties new file mode 100644 index 00000000..21a6ef58 --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/resources/sca-nacos-config-develop.properties @@ -0,0 +1 @@ +user.name=sca-nacos-config-value-develop \ No newline at end of file diff --git a/spring-cloud-alibaba-nacos-config/src/test/resources/sca-nacos-config.properties b/spring-cloud-alibaba-nacos-config/src/test/resources/sca-nacos-config.properties new file mode 100644 index 00000000..db268f2c --- /dev/null +++ b/spring-cloud-alibaba-nacos-config/src/test/resources/sca-nacos-config.properties @@ -0,0 +1,2 @@ +user.name=sca-nacos-config-value +dev.mode=local \ No newline at end of file diff --git a/spring-cloud-alibaba-nacos-discovery/pom.xml b/spring-cloud-alibaba-nacos-discovery/pom.xml index 87df397d..fd2dbb80 100644 --- a/spring-cloud-alibaba-nacos-discovery/pom.xml +++ b/spring-cloud-alibaba-nacos-discovery/pom.xml @@ -82,28 +82,4 @@ - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - - org/springframework/cloud/alibaba/nacos/**.*class - - - - - - - diff --git a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryAutoConfiguration.java b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryAutoConfiguration.java index 7b018ae2..3bde6e42 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryAutoConfiguration.java +++ b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryAutoConfiguration.java @@ -24,10 +24,11 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean import org.springframework.boot.autoconfigure.condition.ConditionalOnNotWebApplication; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.cloud.alibaba.nacos.discovery.NacosDiscoveryClientAutoConfiguration; import org.springframework.cloud.alibaba.nacos.registry.NacosAutoServiceRegistration; import org.springframework.cloud.alibaba.nacos.registry.NacosRegistration; import org.springframework.cloud.alibaba.nacos.registry.NacosServiceRegistry; -import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationAutoConfiguration; +import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties; import org.springframework.context.ApplicationContext; import org.springframework.context.annotation.Bean; @@ -42,7 +43,7 @@ import org.springframework.context.annotation.Configuration; @ConditionalOnNacosDiscoveryEnabled @ConditionalOnProperty(value = "spring.cloud.service-registry.auto-registration.enabled", matchIfMissing = true) @AutoConfigureBefore(NacosDiscoveryClientAutoConfiguration.class) -@AutoConfigureAfter(AutoServiceRegistrationAutoConfiguration.class) +@AutoConfigureAfter(AutoServiceRegistrationConfiguration.class) public class NacosDiscoveryAutoConfiguration { @Bean diff --git a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryProperties.java b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryProperties.java index 775a502b..11ea3475 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryProperties.java +++ b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryProperties.java @@ -19,6 +19,7 @@ package org.springframework.cloud.alibaba.nacos; import com.alibaba.nacos.api.NacosFactory; import com.alibaba.nacos.api.naming.NamingService; import com.alibaba.nacos.client.naming.utils.UtilAndComs; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; @@ -27,14 +28,25 @@ import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.cloud.commons.util.InetUtils; import org.springframework.core.env.Environment; import org.springframework.util.StringUtils; + import javax.annotation.PostConstruct; import java.net.Inet4Address; import java.net.InetAddress; import java.net.NetworkInterface; import java.net.SocketException; -import java.util.*; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Properties; -import static com.alibaba.nacos.api.PropertyKeyConst.*; +import static com.alibaba.nacos.api.PropertyKeyConst.ACCESS_KEY; +import static com.alibaba.nacos.api.PropertyKeyConst.CLUSTER_NAME; +import static com.alibaba.nacos.api.PropertyKeyConst.ENDPOINT; +import static com.alibaba.nacos.api.PropertyKeyConst.NAMESPACE; +import static com.alibaba.nacos.api.PropertyKeyConst.NAMING_LOAD_CACHE_AT_START; +import static com.alibaba.nacos.api.PropertyKeyConst.SECRET_KEY; +import static com.alibaba.nacos.api.PropertyKeyConst.SERVER_ADDR; /** * @author dungu.zpf @@ -64,6 +76,11 @@ public class NacosDiscoveryProperties { */ private String namespace; + /** + * watch delay,duration to pull new service from nacos server. + */ + private long watchDelay = 5000; + /** * nacos naming log file name */ @@ -149,6 +166,9 @@ public class NacosDiscoveryProperties { } serverAddr = Objects.toString(serverAddr, ""); + if (serverAddr.lastIndexOf("/") != -1) { + serverAddr.substring(0, serverAddr.length() - 1); + } endpoint = Objects.toString(endpoint, ""); namespace = Objects.toString(namespace, ""); logName = Objects.toString(logName, ""); @@ -319,16 +339,25 @@ public class NacosDiscoveryProperties { this.namingLoadCacheAtStart = namingLoadCacheAtStart; } + public long getWatchDelay() { + return watchDelay; + } + + public void setWatchDelay(long watchDelay) { + this.watchDelay = watchDelay; + } + @Override public String toString() { return "NacosDiscoveryProperties{" + "serverAddr='" + serverAddr + '\'' + ", endpoint='" + endpoint + '\'' + ", namespace='" + namespace + '\'' - + ", logName='" + logName + '\'' + ", service='" + service + '\'' - + ", weight=" + weight + ", clusterName='" + clusterName + '\'' - + ", metadata=" + metadata + ", registerEnabled=" + registerEnabled - + ", ip='" + ip + '\'' + ", networkInterface='" + networkInterface + '\'' - + ", port=" + port + ", secure=" + secure + ", accessKey='" + accessKey - + ", namingLoadCacheAtStart=" + namingLoadCacheAtStart + '\'' + + ", watchDelay=" + watchDelay + ", logName='" + logName + '\'' + + ", service='" + service + '\'' + ", weight=" + weight + + ", clusterName='" + clusterName + '\'' + ", namingLoadCacheAtStart='" + + namingLoadCacheAtStart + '\'' + ", metadata=" + metadata + + ", registerEnabled=" + registerEnabled + ", ip='" + ip + '\'' + + ", networkInterface='" + networkInterface + '\'' + ", port=" + port + + ", secure=" + secure + ", accessKey='" + accessKey + '\'' + ", secretKey='" + secretKey + '\'' + '}'; } @@ -380,13 +409,14 @@ public class NacosDiscoveryProperties { properties.put(CLUSTER_NAME, clusterName); properties.put(NAMING_LOAD_CACHE_AT_START, namingLoadCacheAtStart); - try { - namingService = NacosFactory.createNamingService(properties); - } catch (Exception e) { + try { + namingService = NacosFactory.createNamingService(properties); + } + catch (Exception e) { LOGGER.error("create naming service error!properties={},e=,", this, e); return null; } - return namingService; + return namingService; } } diff --git a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryClient.java b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/discovery/NacosDiscoveryClient.java similarity index 93% rename from spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryClient.java rename to spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/discovery/NacosDiscoveryClient.java index 9333d8ae..a820144e 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryClient.java +++ b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/discovery/NacosDiscoveryClient.java @@ -14,20 +14,18 @@ * limitations under the License. */ -package org.springframework.cloud.alibaba.nacos; +package org.springframework.cloud.alibaba.nacos.discovery; import com.alibaba.nacos.api.naming.pojo.Instance; import com.alibaba.nacos.api.naming.pojo.ListView; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; +import org.springframework.cloud.alibaba.nacos.NacosServiceInstance; import org.springframework.cloud.client.ServiceInstance; import org.springframework.cloud.client.discovery.DiscoveryClient; -import java.util.ArrayList; -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Map; +import java.util.*; /** * @author xiaojing diff --git a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryClientAutoConfiguration.java b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/discovery/NacosDiscoveryClientAutoConfiguration.java similarity index 63% rename from spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryClientAutoConfiguration.java rename to spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/discovery/NacosDiscoveryClientAutoConfiguration.java index 60a76cf7..5fe818b3 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryClientAutoConfiguration.java +++ b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/discovery/NacosDiscoveryClientAutoConfiguration.java @@ -14,11 +14,16 @@ * limitations under the License. */ -package org.springframework.cloud.alibaba.nacos; +package org.springframework.cloud.alibaba.nacos.discovery; +import org.springframework.boot.autoconfigure.AutoConfigureBefore; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.cloud.alibaba.nacos.ConditionalOnNacosDiscoveryEnabled; +import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; +import org.springframework.cloud.client.CommonsClientAutoConfiguration; import org.springframework.cloud.client.discovery.DiscoveryClient; +import org.springframework.cloud.client.discovery.simple.SimpleDiscoveryClientAutoConfiguration; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -26,9 +31,10 @@ import org.springframework.context.annotation.Configuration; * @author xiaojing */ @Configuration -@ConditionalOnMissingBean(DiscoveryClient.class) @ConditionalOnNacosDiscoveryEnabled @EnableConfigurationProperties +@AutoConfigureBefore({ SimpleDiscoveryClientAutoConfiguration.class, + CommonsClientAutoConfiguration.class }) public class NacosDiscoveryClientAutoConfiguration { @Bean @@ -37,4 +43,9 @@ public class NacosDiscoveryClientAutoConfiguration { return new NacosDiscoveryClient(discoveryProperties); } + @Bean + @ConditionalOnMissingBean + public NacosWatch nacosWatch(NacosDiscoveryProperties nacosDiscoveryProperties) { + return new NacosWatch(nacosDiscoveryProperties); + } } diff --git a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/discovery/NacosWatch.java b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/discovery/NacosWatch.java new file mode 100644 index 00000000..0eefaf1a --- /dev/null +++ b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/discovery/NacosWatch.java @@ -0,0 +1,174 @@ +/* + * 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 org.springframework.cloud.alibaba.nacos.discovery; + +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Set; +import java.util.concurrent.ScheduledFuture; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicLong; + +import com.alibaba.nacos.api.naming.NamingService; +import com.alibaba.nacos.api.naming.listener.EventListener; +import com.alibaba.nacos.api.naming.pojo.ListView; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; +import org.springframework.cloud.client.discovery.event.HeartbeatEvent; +import org.springframework.context.ApplicationEventPublisher; +import org.springframework.context.ApplicationEventPublisherAware; +import org.springframework.context.SmartLifecycle; +import org.springframework.scheduling.TaskScheduler; +import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler; + +/** + * @author xiaojing + */ +public class NacosWatch implements ApplicationEventPublisherAware, SmartLifecycle { + + private static final Logger log = LoggerFactory.getLogger(NacosWatch.class); + + private final NacosDiscoveryProperties properties; + + private final TaskScheduler taskScheduler; + + private final AtomicLong nacosWatchIndex = new AtomicLong(0); + + private final AtomicBoolean running = new AtomicBoolean(false); + + private ApplicationEventPublisher publisher; + + private ScheduledFuture watchFuture; + + private Set cacheServices = new HashSet<>(); + + private HashMap subscribeListeners = new HashMap<>(); + + public NacosWatch(NacosDiscoveryProperties properties) { + this(properties, getTaskScheduler()); + } + + public NacosWatch(NacosDiscoveryProperties properties, TaskScheduler taskScheduler) { + this.properties = properties; + this.taskScheduler = taskScheduler; + } + + private static ThreadPoolTaskScheduler getTaskScheduler() { + ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler(); + taskScheduler.initialize(); + return taskScheduler; + } + + @Override + public void setApplicationEventPublisher(ApplicationEventPublisher publisher) { + this.publisher = publisher; + } + + @Override + public boolean isAutoStartup() { + return true; + } + + @Override + public void stop(Runnable callback) { + this.stop(); + callback.run(); + } + + @Override + public void start() { + if (this.running.compareAndSet(false, true)) { + this.watchFuture = this.taskScheduler.scheduleWithFixedDelay( + this::nacosServicesWatch, this.properties.getWatchDelay()); + } + } + + @Override + public void stop() { + if (this.running.compareAndSet(true, false) && this.watchFuture != null) { + this.watchFuture.cancel(true); + } + } + + @Override + public boolean isRunning() { + return false; + } + + @Override + public int getPhase() { + return 0; + } + + public void nacosServicesWatch() { + try { + + boolean changed = false; + NamingService namingService = properties.namingServiceInstance(); + + ListView listView = properties.namingServiceInstance() + .getServicesOfServer(1, Integer.MAX_VALUE); + + List serviceList = listView.getData(); + + // if there are new services found, publish event + Set currentServices = new HashSet<>(serviceList); + currentServices.removeAll(cacheServices); + if (currentServices.size() > 0) { + changed = true; + } + + // if some services disappear, publish event + if (cacheServices.removeAll(new HashSet<>(serviceList)) + && cacheServices.size() > 0) { + changed = true; + + for (String serviceName : cacheServices) { + namingService.unsubscribe(serviceName, + subscribeListeners.get(serviceName)); + subscribeListeners.remove(serviceName); + } + } + + cacheServices = new HashSet<>(serviceList); + + // subscribe services's node change, publish event if nodes changed + for (String serviceName : cacheServices) { + if (!subscribeListeners.containsKey(serviceName)) { + EventListener eventListener = event -> NacosWatch.this.publisher + .publishEvent(new HeartbeatEvent(NacosWatch.this, + nacosWatchIndex.getAndIncrement())); + subscribeListeners.put(serviceName, eventListener); + namingService.subscribe(serviceName, eventListener); + + } + } + + if (changed) { + this.publisher.publishEvent( + new HeartbeatEvent(this, nacosWatchIndex.getAndIncrement())); + } + + } + catch (Exception e) { + log.error("Error watching Nacos Service change", e); + } + } +} diff --git a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistration.java b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistration.java index 24b0a848..4f7094f0 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistration.java +++ b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistration.java @@ -30,75 +30,74 @@ import org.springframework.util.StringUtils; * @author Mercy */ public class NacosAutoServiceRegistration - extends AbstractAutoServiceRegistration { - private static final Logger LOGGER = LoggerFactory - .getLogger(NacosAutoServiceRegistration.class); + extends AbstractAutoServiceRegistration { + private static final Logger LOGGER = LoggerFactory + .getLogger(NacosAutoServiceRegistration.class); - private NacosRegistration registration; + private NacosRegistration registration; - public NacosAutoServiceRegistration( - ServiceRegistry serviceRegistry, - AutoServiceRegistrationProperties autoServiceRegistrationProperties, - NacosRegistration registration) { - super(serviceRegistry, autoServiceRegistrationProperties); - this.registration = registration; - } + public NacosAutoServiceRegistration(ServiceRegistry serviceRegistry, + AutoServiceRegistrationProperties autoServiceRegistrationProperties, + NacosRegistration registration) { + super(serviceRegistry, autoServiceRegistrationProperties); + this.registration = registration; + } - @Deprecated - public void setPort(int port) { - getPort().set(port); - } + @Deprecated + public void setPort(int port) { + getPort().set(port); + } - @Override - protected NacosRegistration getRegistration() { - if (this.registration.getPort() < 0 && this.getPort().get() > 0) { - this.registration.setPort(this.getPort().get()); - } - Assert.isTrue(this.registration.getPort() > 0, "service.port has not been set"); - return this.registration; - } + @Override + protected NacosRegistration getRegistration() { + if (this.registration.getPort() < 0 && this.getPort().get() > 0) { + this.registration.setPort(this.getPort().get()); + } + Assert.isTrue(this.registration.getPort() > 0, "service.port has not been set"); + return this.registration; + } - @Override - protected NacosRegistration getManagementRegistration() { - return null; - } + @Override + protected NacosRegistration getManagementRegistration() { + return null; + } - @Override - protected void register() { - if (!this.registration.getNacosDiscoveryProperties().isRegisterEnabled()) { - LOGGER.debug("Registration disabled."); - return; - } - if (this.registration.getPort() < 0) { - this.registration.setPort(getPort().get()); - } - super.register(); - } + @Override + protected void register() { + if (!this.registration.getNacosDiscoveryProperties().isRegisterEnabled()) { + LOGGER.debug("Registration disabled."); + return; + } + if (this.registration.getPort() < 0) { + this.registration.setPort(getPort().get()); + } + super.register(); + } - @Override - protected void registerManagement() { - if (!this.registration.getNacosDiscoveryProperties().isRegisterEnabled()) { - return; - } - super.registerManagement(); + @Override + protected void registerManagement() { + if (!this.registration.getNacosDiscoveryProperties().isRegisterEnabled()) { + return; + } + super.registerManagement(); - } + } - @Override - protected Object getConfiguration() { - return this.registration.getNacosDiscoveryProperties(); - } + @Override + protected Object getConfiguration() { + return this.registration.getNacosDiscoveryProperties(); + } - @Override - protected boolean isEnabled() { - return this.registration.getNacosDiscoveryProperties().isRegisterEnabled(); - } + @Override + protected boolean isEnabled() { + return this.registration.getNacosDiscoveryProperties().isRegisterEnabled(); + } - @Override - @SuppressWarnings("deprecation") - protected String getAppName() { - String appName = registration.getNacosDiscoveryProperties().getService(); - return StringUtils.isEmpty(appName) ? super.getAppName() : appName; - } + @Override + @SuppressWarnings("deprecation") + protected String getAppName() { + String appName = registration.getNacosDiscoveryProperties().getService(); + return StringUtils.isEmpty(appName) ? super.getAppName() : appName; + } } diff --git a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/registry/NacosServiceRegistry.java b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/registry/NacosServiceRegistry.java index 121d9f9e..8633c302 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/registry/NacosServiceRegistry.java +++ b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/registry/NacosServiceRegistry.java @@ -32,83 +32,84 @@ import org.springframework.util.StringUtils; */ public class NacosServiceRegistry implements ServiceRegistry { - private static Logger logger = LoggerFactory.getLogger(NacosServiceRegistry.class); + private static Logger logger = LoggerFactory.getLogger(NacosServiceRegistry.class); - private final NacosDiscoveryProperties nacosDiscoveryProperties; + private final NacosDiscoveryProperties nacosDiscoveryProperties; - private final NamingService namingService; + private final NamingService namingService; - public NacosServiceRegistry(NacosDiscoveryProperties nacosDiscoveryProperties) { - this.nacosDiscoveryProperties = nacosDiscoveryProperties; - this.namingService = nacosDiscoveryProperties.namingServiceInstance(); - } + public NacosServiceRegistry(NacosDiscoveryProperties nacosDiscoveryProperties) { + this.nacosDiscoveryProperties = nacosDiscoveryProperties; + this.namingService = nacosDiscoveryProperties.namingServiceInstance(); + } + @Override + public void register(Registration registration) { - @Override - public void register(Registration registration) { + if (StringUtils.isEmpty(registration.getServiceId())) { + logger.info("No service to register for nacos client..."); + return; + } - if (StringUtils.isEmpty(registration.getServiceId())) { - logger.info("No service to register for nacos client..."); - return; - } + String serviceId = registration.getServiceId(); - String serviceId = registration.getServiceId(); + Instance instance = new Instance(); + instance.setIp(registration.getHost()); + instance.setPort(registration.getPort()); + instance.setWeight(nacosDiscoveryProperties.getWeight()); + instance.setClusterName(nacosDiscoveryProperties.getClusterName()); + instance.setMetadata(registration.getMetadata()); - Instance instance = new Instance(); - instance.setIp(registration.getHost()); - instance.setPort(registration.getPort()); - instance.setWeight(nacosDiscoveryProperties.getWeight()); - instance.setClusterName(nacosDiscoveryProperties.getClusterName()); - instance.setMetadata(registration.getMetadata()); + try { + namingService.registerInstance(serviceId, instance); + logger.info("nacos registry, {} {}:{} register finished", serviceId, + instance.getIp(), instance.getPort()); + } + catch (Exception e) { + logger.error("nacos registry, {} register failed...{},", serviceId, + registration.toString(), e); + } + } - try { - namingService.registerInstance(serviceId, instance); - logger.info("nacos registry, {} {}:{} register finished", serviceId, - instance.getIp(), instance.getPort()); - } catch (Exception e) { - logger.error("nacos registry, {} register failed...{},", serviceId, - registration.toString(), e); - } - } + @Override + public void deregister(Registration registration) { - @Override - public void deregister(Registration registration) { + logger.info("De-registering from Nacos Server now..."); - logger.info("De-registering from Nacos Server now..."); + if (StringUtils.isEmpty(registration.getServiceId())) { + logger.info("No dom to de-register for nacos client..."); + return; + } - if (StringUtils.isEmpty(registration.getServiceId())) { - logger.info("No dom to de-register for nacos client..."); - return; - } + NamingService namingService = nacosDiscoveryProperties.namingServiceInstance(); + String serviceId = registration.getServiceId(); - NamingService namingService = nacosDiscoveryProperties.namingServiceInstance(); - String serviceId = registration.getServiceId(); + try { + namingService.deregisterInstance(serviceId, registration.getHost(), + registration.getPort(), nacosDiscoveryProperties.getClusterName()); + } + catch (Exception e) { + logger.error("ERR_NACOS_DEREGISTER, de-register failed...{},", + registration.toString(), e); + } - try { - namingService.deregisterInstance(serviceId, registration.getHost(), - registration.getPort(), nacosDiscoveryProperties.getClusterName()); - } catch (Exception e) { - logger.error("ERR_NACOS_DEREGISTER, de-register failed...{},", - registration.toString(), e); - } + logger.info("De-registration finished."); + } - logger.info("De-registration finished."); - } + @Override + public void close() { - @Override - public void close() { + } - } + @Override + public void setStatus(Registration registration, String status) { + // nacos doesn't support set status of a particular registration. + } - @Override - public void setStatus(Registration registration, String status) { - // nacos doesn't support set status of a particular registration. - } - - @Override - public T getStatus(Registration registration) { - // nacos doesn't support query status of a particular registration. - return null; - } + @Override + public T getStatus(Registration registration) { + // nacos doesn't support query status of a particular registration. + return null; + } } diff --git a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosServer.java b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosServer.java index ba64dbda..95debd87 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosServer.java +++ b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosServer.java @@ -17,12 +17,14 @@ package org.springframework.cloud.alibaba.nacos.ribbon; import com.alibaba.nacos.api.naming.pojo.Instance; + import com.netflix.loadbalancer.Server; import java.util.Map; /** * @author xiaojing + * @author pbting */ public class NacosServer extends Server { diff --git a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosServerList.java b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosServerList.java index 02195546..2bad9e41 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosServerList.java +++ b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosServerList.java @@ -17,6 +17,7 @@ package org.springframework.cloud.alibaba.nacos.ribbon; import com.alibaba.nacos.api.naming.pojo.Instance; + import com.netflix.client.config.IClientConfig; import com.netflix.loadbalancer.AbstractServerList; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; @@ -62,7 +63,10 @@ public class NacosServerList extends AbstractServerList { } private List instancesToServerList(List instances) { - List result = new ArrayList<>(instances.size()); + List result = new ArrayList<>(); + if (null == instances) { + return result; + } for (Instance instance : instances) { result.add(new NacosServer(instance)); } diff --git a/spring-cloud-alibaba-nacos-discovery/src/main/resources/META-INF/spring.factories b/spring-cloud-alibaba-nacos-discovery/src/main/resources/META-INF/spring.factories index 91d5ff59..2fe11df1 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/main/resources/META-INF/spring.factories +++ b/spring-cloud-alibaba-nacos-discovery/src/main/resources/META-INF/spring.factories @@ -2,4 +2,4 @@ org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.cloud.alibaba.nacos.NacosDiscoveryAutoConfiguration,\ org.springframework.cloud.alibaba.nacos.ribbon.RibbonNacosAutoConfiguration,\ org.springframework.cloud.alibaba.nacos.endpoint.NacosDiscoveryEndpointAutoConfiguration,\ - org.springframework.cloud.alibaba.nacos.NacosDiscoveryClientAutoConfiguration + org.springframework.cloud.alibaba.nacos.discovery.NacosDiscoveryClientAutoConfiguration diff --git a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryClientTests.java b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryClientTests.java index ad0e6dbf..12257f0a 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryClientTests.java +++ b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/NacosDiscoveryClientTests.java @@ -26,6 +26,7 @@ import com.alibaba.nacos.api.naming.pojo.Instance; import com.alibaba.nacos.api.naming.pojo.ListView; import org.junit.Test; +import org.springframework.cloud.alibaba.nacos.discovery.NacosDiscoveryClient; import org.springframework.cloud.client.ServiceInstance; import static org.assertj.core.api.Assertions.assertThat; diff --git a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationIpNetworkInterfaceTests.java b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationIpNetworkInterfaceTests.java index ea1f242b..8ec4c7b1 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationIpNetworkInterfaceTests.java +++ b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationIpNetworkInterfaceTests.java @@ -32,7 +32,7 @@ import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryAutoConfiguration; -import org.springframework.cloud.alibaba.nacos.NacosDiscoveryClientAutoConfiguration; +import org.springframework.cloud.alibaba.nacos.discovery.NacosDiscoveryClientAutoConfiguration; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; import org.springframework.cloud.commons.util.InetUtils; diff --git a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationIpTests.java b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationIpTests.java index aaf72093..88c656e1 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationIpTests.java +++ b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationIpTests.java @@ -16,11 +16,6 @@ package org.springframework.cloud.alibaba.nacos.registry; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertTrue; -import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; - import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; @@ -28,12 +23,16 @@ import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryAutoConfiguration; -import org.springframework.cloud.alibaba.nacos.NacosDiscoveryClientAutoConfiguration; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; +import org.springframework.cloud.alibaba.nacos.discovery.NacosDiscoveryClientAutoConfiguration; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; import org.springframework.context.annotation.Configuration; import org.springframework.test.context.junit4.SpringRunner; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; + /** * @author xiaojing */ @@ -42,7 +41,7 @@ import org.springframework.test.context.junit4.SpringRunner; @SpringBootTest(classes = NacosAutoServiceRegistrationIpTests.TestConfig.class, properties = { "spring.application.name=myTestService1", "spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848", - "spring.cloud.nacos.discovery.ip=123.123.123.123" }, webEnvironment = RANDOM_PORT) + "spring.cloud.nacos.discovery.ip=123.123.123.123" }, webEnvironment = RANDOM_PORT) public class NacosAutoServiceRegistrationIpTests { @Autowired diff --git a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationManagementPortTests.java b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationManagementPortTests.java index 645e1e4a..5a2ce084 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationManagementPortTests.java +++ b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationManagementPortTests.java @@ -29,7 +29,7 @@ import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryAutoConfiguration; -import org.springframework.cloud.alibaba.nacos.NacosDiscoveryClientAutoConfiguration; +import org.springframework.cloud.alibaba.nacos.discovery.NacosDiscoveryClientAutoConfiguration; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; import org.springframework.context.annotation.Configuration; diff --git a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationPortTests.java b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationPortTests.java index eb805085..ab76dc97 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationPortTests.java +++ b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationPortTests.java @@ -28,7 +28,7 @@ import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryAutoConfiguration; -import org.springframework.cloud.alibaba.nacos.NacosDiscoveryClientAutoConfiguration; +import org.springframework.cloud.alibaba.nacos.discovery.NacosDiscoveryClientAutoConfiguration; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; import org.springframework.context.annotation.Configuration; diff --git a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationTests.java b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationTests.java index 9432c97b..acd2cbb3 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationTests.java +++ b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/registry/NacosAutoServiceRegistrationTests.java @@ -26,7 +26,7 @@ import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.web.server.LocalServerPort; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryAutoConfiguration; -import org.springframework.cloud.alibaba.nacos.NacosDiscoveryClientAutoConfiguration; +import org.springframework.cloud.alibaba.nacos.discovery.NacosDiscoveryClientAutoConfiguration; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; import org.springframework.cloud.alibaba.nacos.endpoint.NacosDiscoveryEndpoint; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; @@ -185,8 +185,8 @@ public class NacosAutoServiceRegistrationTests { properties); Map map = nacosDiscoveryEndpoint.nacosDiscovery(); assertEquals(map.get("NacosDiscoveryProperties"), properties); - assertEquals(map.get("subscribe"), - properties.namingServiceInstance().getSubscribeServices()); + assertEquals(map.get("subscribe").toString(), + properties.namingServiceInstance().getSubscribeServices().toString()); } @Configuration diff --git a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosRibbonClientConfigurationTests.java b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosRibbonClientConfigurationTests.java index cc73df0e..5117ce53 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosRibbonClientConfigurationTests.java +++ b/spring-cloud-alibaba-nacos-discovery/src/test/java/org/springframework/cloud/alibaba/nacos/ribbon/NacosRibbonClientConfigurationTests.java @@ -6,7 +6,7 @@ import org.junit.Test; import org.springframework.boot.autoconfigure.AutoConfigurations; import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.test.context.runner.WebApplicationContextRunner; -import org.springframework.cloud.alibaba.nacos.NacosDiscoveryClientAutoConfiguration; +import org.springframework.cloud.alibaba.nacos.discovery.NacosDiscoveryClientAutoConfiguration; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; import org.springframework.cloud.client.loadbalancer.LoadBalanced; import org.springframework.context.annotation.Bean; diff --git a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/converter/SentinelConverter.java b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/converter/SentinelConverter.java index f499a16c..302bcd45 100644 --- a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/converter/SentinelConverter.java +++ b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/converter/SentinelConverter.java @@ -1,15 +1,5 @@ package org.springframework.cloud.alibaba.sentinel.datasource.converter; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Optional; - -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.cloud.alibaba.sentinel.datasource.RuleType; -import org.springframework.util.StringUtils; - import com.alibaba.csp.sentinel.datasource.Converter; import com.alibaba.csp.sentinel.slots.block.AbstractRule; import com.alibaba.csp.sentinel.slots.block.authority.AuthorityRule; @@ -23,6 +13,15 @@ import com.alibaba.csp.sentinel.slots.system.SystemRule; import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.databind.ObjectMapper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.cloud.alibaba.sentinel.datasource.RuleType; +import org.springframework.util.StringUtils; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Optional; /** * Convert sentinel rules for json or xml array Using strict mode to parse json or xml @@ -38,7 +37,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; public abstract class SentinelConverter implements Converter> { - private static final Logger logger = LoggerFactory.getLogger(SentinelConverter.class); + private static final Logger log = LoggerFactory.getLogger(SentinelConverter.class); private final ObjectMapper objectMapper; @@ -53,7 +52,7 @@ public abstract class SentinelConverter public List convert(String source) { List ruleList = new ArrayList<>(); if (StringUtils.isEmpty(source)) { - logger.warn("converter can not convert rules because source is empty"); + log.warn("converter can not convert rules because source is empty"); return ruleList; } try { diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/DataSourcePropertiesConfigurationTests.java b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/DataSourcePropertiesConfigurationTests.java index 4845d486..542622ec 100644 --- a/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/DataSourcePropertiesConfigurationTests.java +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/DataSourcePropertiesConfigurationTests.java @@ -1,230 +1,230 @@ -/* - * Copyright (C) 2018 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 org.springframework.cloud.alibaba.sentinel.datasource; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertNull; - -import org.junit.Test; -import org.springframework.cloud.alibaba.sentinel.datasource.config.ApolloDataSourceProperties; -import org.springframework.cloud.alibaba.sentinel.datasource.config.DataSourcePropertiesConfiguration; -import org.springframework.cloud.alibaba.sentinel.datasource.config.FileDataSourceProperties; -import org.springframework.cloud.alibaba.sentinel.datasource.config.NacosDataSourceProperties; -import org.springframework.cloud.alibaba.sentinel.datasource.config.ZookeeperDataSourceProperties; - -/** - * @author Jim - */ -public class DataSourcePropertiesConfigurationTests { - - @Test - public void testFileAttr() { - DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration(); - assertEquals("DataSourcePropertiesConfiguration valid field size was wrong", 0, - dataSourcePropertiesConfiguration.getValidField().size()); - assertNull("DataSourcePropertiesConfiguration valid properties was not null", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - - FileDataSourceProperties fileDataSourceProperties = buildFileProperties(); - - dataSourcePropertiesConfiguration.setFile(fileDataSourceProperties); - - assertEquals( - "DataSourcePropertiesConfiguration valid field size was wrong after set file attribute", - 1, dataSourcePropertiesConfiguration.getValidField().size()); - assertNotNull( - "DataSourcePropertiesConfiguration file properties was null after set file attribute", - dataSourcePropertiesConfiguration.getFile()); - assertNotNull( - "DataSourcePropertiesConfiguration valid properties was null after set file attribute", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - } - - @Test - public void testNacosAttr() { - DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration(); - assertEquals("DataSourcePropertiesConfiguration valid field size was wrong", 0, - dataSourcePropertiesConfiguration.getValidField().size()); - assertNull("DataSourcePropertiesConfiguration valid properties was not null", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - - NacosDataSourceProperties nacosDataSourceProperties = buildNacosProperties(); - - dataSourcePropertiesConfiguration.setNacos(nacosDataSourceProperties); - - assertEquals( - "DataSourcePropertiesConfiguration valid field size was wrong after set nacos attribute", - 1, dataSourcePropertiesConfiguration.getValidField().size()); - assertNotNull( - "DataSourcePropertiesConfiguration nacos properties was null after set nacos attribute", - dataSourcePropertiesConfiguration.getNacos()); - assertNotNull( - "DataSourcePropertiesConfiguration valid properties was null after set nacos attribute", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - } - - @Test - public void testZKAttr() { - DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration(); - assertEquals("DataSourcePropertiesConfiguration valid field size was wrong", 0, - dataSourcePropertiesConfiguration.getValidField().size()); - assertNull("DataSourcePropertiesConfiguration valid properties was not null", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - - ZookeeperDataSourceProperties zookeeperDataSourceProperties = buildZKProperties(); - - dataSourcePropertiesConfiguration.setZk(zookeeperDataSourceProperties); - - assertEquals( - "DataSourcePropertiesConfiguration valid field size was wrong after set zk attribute", - 1, dataSourcePropertiesConfiguration.getValidField().size()); - assertNotNull( - "DataSourcePropertiesConfiguration zk properties was null after set zk attribute", - dataSourcePropertiesConfiguration.getZk()); - assertNotNull( - "DataSourcePropertiesConfiguration valid properties was null after set zk attribute", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - } - - @Test - public void testApolloAttr() { - DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration(); - assertEquals("DataSourcePropertiesConfiguration valid field size was wrong", 0, - dataSourcePropertiesConfiguration.getValidField().size()); - assertNull("DataSourcePropertiesConfiguration valid properties was not null", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - - ApolloDataSourceProperties apolloDataSourceProperties = buildApolloProperties(); - - dataSourcePropertiesConfiguration.setApollo(apolloDataSourceProperties); - - assertEquals( - "DataSourcePropertiesConfiguration valid field size was wrong after set apollo attribute", - 1, dataSourcePropertiesConfiguration.getValidField().size()); - assertNotNull( - "DataSourcePropertiesConfiguration apollo properties was null after set apollo attribute", - dataSourcePropertiesConfiguration.getApollo()); - assertNotNull( - "DataSourcePropertiesConfiguration valid properties was null after set apollo attribute", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - } - - @Test - public void testMultiAttr() { - DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration(); - assertEquals("DataSourcePropertiesConfiguration valid field size was wrong", 0, - dataSourcePropertiesConfiguration.getValidField().size()); - assertNull("DataSourcePropertiesConfiguration valid properties was not null", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - - FileDataSourceProperties fileDataSourceProperties = buildFileProperties(); - NacosDataSourceProperties nacosDataSourceProperties = buildNacosProperties(); - - dataSourcePropertiesConfiguration.setFile(fileDataSourceProperties); - dataSourcePropertiesConfiguration.setNacos(nacosDataSourceProperties); - - assertEquals( - "DataSourcePropertiesConfiguration valid field size was wrong after set file and nacos attribute", - 2, dataSourcePropertiesConfiguration.getValidField().size()); - assertNull( - "DataSourcePropertiesConfiguration valid properties was not null after set file and nacos attribute", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - } - - @Test - public void testFileConstructor() { - DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration( - buildFileProperties()); - assertEquals( - "DataSourcePropertiesConfiguration file constructor valid field size was wrong", - 1, dataSourcePropertiesConfiguration.getValidField().size()); - assertNotNull( - "DataSourcePropertiesConfiguration file constructor valid properties was null", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - } - - @Test - public void testNacosConstructor() { - DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration( - buildNacosProperties()); - assertEquals( - "DataSourcePropertiesConfiguration nacos constructor valid field size was wrong", - 1, dataSourcePropertiesConfiguration.getValidField().size()); - assertNotNull( - "DataSourcePropertiesConfiguration nacos constructor valid properties was null", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - } - - @Test - public void testApolloConstructor() { - DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration( - buildApolloProperties()); - assertEquals( - "DataSourcePropertiesConfiguration apollo constructor valid field size was wrong", - 1, dataSourcePropertiesConfiguration.getValidField().size()); - assertNotNull( - "DataSourcePropertiesConfiguration apollo constructor valid properties was null", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - } - - @Test - public void testZKConstructor() { - DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration( - buildZKProperties()); - assertEquals( - "DataSourcePropertiesConfiguration zk constructor valid field size was wrong", - 1, dataSourcePropertiesConfiguration.getValidField().size()); - assertNotNull( - "DataSourcePropertiesConfiguration zk constructor valid properties was null", - dataSourcePropertiesConfiguration.getValidDataSourceProperties()); - } - - private FileDataSourceProperties buildFileProperties() { - FileDataSourceProperties fileDataSourceProperties = new FileDataSourceProperties(); - - fileDataSourceProperties.setFile("/tmp/test.json"); - fileDataSourceProperties.setBufSize(1024); - fileDataSourceProperties.setRecommendRefreshMs(2000); - return fileDataSourceProperties; - } - - private NacosDataSourceProperties buildNacosProperties() { - NacosDataSourceProperties nacosDataSourceProperties = new NacosDataSourceProperties(); - nacosDataSourceProperties.setServerAddr("127.0.0.1:8848"); - nacosDataSourceProperties.setDataId("sentinel"); - nacosDataSourceProperties.setGroupId("custom-group"); - return nacosDataSourceProperties; - } - - private ApolloDataSourceProperties buildApolloProperties() { - ApolloDataSourceProperties apolloDataSourceProperties = new ApolloDataSourceProperties(); - apolloDataSourceProperties.setFlowRulesKey("test-key"); - apolloDataSourceProperties.setDefaultFlowRuleValue("dft-val"); - apolloDataSourceProperties.setNamespaceName("namespace"); - return apolloDataSourceProperties; - } - - private ZookeeperDataSourceProperties buildZKProperties() { - ZookeeperDataSourceProperties zookeeperDataSourceProperties = new ZookeeperDataSourceProperties(); - - zookeeperDataSourceProperties.setServerAddr("localhost:2181"); - zookeeperDataSourceProperties.setPath("/path"); - return zookeeperDataSourceProperties; - } - -} +///* +// * Copyright (C) 2018 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 org.springframework.cloud.alibaba.sentinel.datasource; +// +//import static org.junit.Assert.assertEquals; +//import static org.junit.Assert.assertNotNull; +//import static org.junit.Assert.assertNull; +// +//import org.junit.Test; +//import org.springframework.cloud.alibaba.sentinel.datasource.config.ApolloDataSourceProperties; +//import org.springframework.cloud.alibaba.sentinel.datasource.config.DataSourcePropertiesConfiguration; +//import org.springframework.cloud.alibaba.sentinel.datasource.config.FileDataSourceProperties; +//import org.springframework.cloud.alibaba.sentinel.datasource.config.NacosDataSourceProperties; +//import org.springframework.cloud.alibaba.sentinel.datasource.config.ZookeeperDataSourceProperties; +// +///** +// * @author Jim +// */ +//public class DataSourcePropertiesConfigurationTests { +// +// @Test +// public void testFileAttr() { +// DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration(); +// assertEquals("DataSourcePropertiesConfiguration valid field size was wrong", 0, +// dataSourcePropertiesConfiguration.getValidField().size()); +// assertNull("DataSourcePropertiesConfiguration valid properties was not null", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// +// FileDataSourceProperties fileDataSourceProperties = buildFileProperties(); +// +// dataSourcePropertiesConfiguration.setFile(fileDataSourceProperties); +// +// assertEquals( +// "DataSourcePropertiesConfiguration valid field size was wrong after set file attribute", +// 1, dataSourcePropertiesConfiguration.getValidField().size()); +// assertNotNull( +// "DataSourcePropertiesConfiguration file properties was null after set file attribute", +// dataSourcePropertiesConfiguration.getFile()); +// assertNotNull( +// "DataSourcePropertiesConfiguration valid properties was null after set file attribute", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// } +// +// @Test +// public void testNacosAttr() { +// DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration(); +// assertEquals("DataSourcePropertiesConfiguration valid field size was wrong", 0, +// dataSourcePropertiesConfiguration.getValidField().size()); +// assertNull("DataSourcePropertiesConfiguration valid properties was not null", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// +// NacosDataSourceProperties nacosDataSourceProperties = buildNacosProperties(); +// +// dataSourcePropertiesConfiguration.setNacos(nacosDataSourceProperties); +// +// assertEquals( +// "DataSourcePropertiesConfiguration valid field size was wrong after set nacos attribute", +// 1, dataSourcePropertiesConfiguration.getValidField().size()); +// assertNotNull( +// "DataSourcePropertiesConfiguration nacos properties was null after set nacos attribute", +// dataSourcePropertiesConfiguration.getNacos()); +// assertNotNull( +// "DataSourcePropertiesConfiguration valid properties was null after set nacos attribute", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// } +// +// @Test +// public void testZKAttr() { +// DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration(); +// assertEquals("DataSourcePropertiesConfiguration valid field size was wrong", 0, +// dataSourcePropertiesConfiguration.getValidField().size()); +// assertNull("DataSourcePropertiesConfiguration valid properties was not null", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// +// ZookeeperDataSourceProperties zookeeperDataSourceProperties = buildZKProperties(); +// +// dataSourcePropertiesConfiguration.setZk(zookeeperDataSourceProperties); +// +// assertEquals( +// "DataSourcePropertiesConfiguration valid field size was wrong after set zk attribute", +// 1, dataSourcePropertiesConfiguration.getValidField().size()); +// assertNotNull( +// "DataSourcePropertiesConfiguration zk properties was null after set zk attribute", +// dataSourcePropertiesConfiguration.getZk()); +// assertNotNull( +// "DataSourcePropertiesConfiguration valid properties was null after set zk attribute", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// } +// +// @Test +// public void testApolloAttr() { +// DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration(); +// assertEquals("DataSourcePropertiesConfiguration valid field size was wrong", 0, +// dataSourcePropertiesConfiguration.getValidField().size()); +// assertNull("DataSourcePropertiesConfiguration valid properties was not null", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// +// ApolloDataSourceProperties apolloDataSourceProperties = buildApolloProperties(); +// +// dataSourcePropertiesConfiguration.setApollo(apolloDataSourceProperties); +// +// assertEquals( +// "DataSourcePropertiesConfiguration valid field size was wrong after set apollo attribute", +// 1, dataSourcePropertiesConfiguration.getValidField().size()); +// assertNotNull( +// "DataSourcePropertiesConfiguration apollo properties was null after set apollo attribute", +// dataSourcePropertiesConfiguration.getApollo()); +// assertNotNull( +// "DataSourcePropertiesConfiguration valid properties was null after set apollo attribute", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// } +// +// @Test +// public void testMultiAttr() { +// DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration(); +// assertEquals("DataSourcePropertiesConfiguration valid field size was wrong", 0, +// dataSourcePropertiesConfiguration.getValidField().size()); +// assertNull("DataSourcePropertiesConfiguration valid properties was not null", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// +// FileDataSourceProperties fileDataSourceProperties = buildFileProperties(); +// NacosDataSourceProperties nacosDataSourceProperties = buildNacosProperties(); +// +// dataSourcePropertiesConfiguration.setFile(fileDataSourceProperties); +// dataSourcePropertiesConfiguration.setNacos(nacosDataSourceProperties); +// +// assertEquals( +// "DataSourcePropertiesConfiguration valid field size was wrong after set file and nacos attribute", +// 2, dataSourcePropertiesConfiguration.getValidField().size()); +// assertNull( +// "DataSourcePropertiesConfiguration valid properties was not null after set file and nacos attribute", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// } +// +// @Test +// public void testFileConstructor() { +// DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration( +// buildFileProperties()); +// assertEquals( +// "DataSourcePropertiesConfiguration file constructor valid field size was wrong", +// 1, dataSourcePropertiesConfiguration.getValidField().size()); +// assertNotNull( +// "DataSourcePropertiesConfiguration file constructor valid properties was null", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// } +// +// @Test +// public void testNacosConstructor() { +// DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration( +// buildNacosProperties()); +// assertEquals( +// "DataSourcePropertiesConfiguration nacos constructor valid field size was wrong", +// 1, dataSourcePropertiesConfiguration.getValidField().size()); +// assertNotNull( +// "DataSourcePropertiesConfiguration nacos constructor valid properties was null", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// } +// +// @Test +// public void testApolloConstructor() { +// DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration( +// buildApolloProperties()); +// assertEquals( +// "DataSourcePropertiesConfiguration apollo constructor valid field size was wrong", +// 1, dataSourcePropertiesConfiguration.getValidField().size()); +// assertNotNull( +// "DataSourcePropertiesConfiguration apollo constructor valid properties was null", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// } +// +// @Test +// public void testZKConstructor() { +// DataSourcePropertiesConfiguration dataSourcePropertiesConfiguration = new DataSourcePropertiesConfiguration( +// buildZKProperties()); +// assertEquals( +// "DataSourcePropertiesConfiguration zk constructor valid field size was wrong", +// 1, dataSourcePropertiesConfiguration.getValidField().size()); +// assertNotNull( +// "DataSourcePropertiesConfiguration zk constructor valid properties was null", +// dataSourcePropertiesConfiguration.getValidDataSourceProperties()); +// } +// +// private FileDataSourceProperties buildFileProperties() { +// FileDataSourceProperties fileDataSourceProperties = new FileDataSourceProperties(); +// +// fileDataSourceProperties.setFile("/tmp/test.json"); +// fileDataSourceProperties.setBufSize(1024); +// fileDataSourceProperties.setRecommendRefreshMs(2000); +// return fileDataSourceProperties; +// } +// +// private NacosDataSourceProperties buildNacosProperties() { +// NacosDataSourceProperties nacosDataSourceProperties = new NacosDataSourceProperties(); +// nacosDataSourceProperties.setServerAddr("127.0.0.1:8848"); +// nacosDataSourceProperties.setDataId("sentinel"); +// nacosDataSourceProperties.setGroupId("custom-group"); +// return nacosDataSourceProperties; +// } +// +// private ApolloDataSourceProperties buildApolloProperties() { +// ApolloDataSourceProperties apolloDataSourceProperties = new ApolloDataSourceProperties(); +// apolloDataSourceProperties.setFlowRulesKey("test-key"); +// apolloDataSourceProperties.setDefaultFlowRuleValue("dft-val"); +// apolloDataSourceProperties.setNamespaceName("namespace"); +// return apolloDataSourceProperties; +// } +// +// private ZookeeperDataSourceProperties buildZKProperties() { +// ZookeeperDataSourceProperties zookeeperDataSourceProperties = new ZookeeperDataSourceProperties(); +// +// zookeeperDataSourceProperties.setServerAddr("localhost:2181"); +// zookeeperDataSourceProperties.setPath("/path"); +// return zookeeperDataSourceProperties; +// } +// +//} diff --git a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/SentinelWebAutoConfiguration.java b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/SentinelWebAutoConfiguration.java index c9699e66..1eea41e9 100644 --- a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/SentinelWebAutoConfiguration.java +++ b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/SentinelWebAutoConfiguration.java @@ -17,6 +17,7 @@ package org.springframework.cloud.alibaba.sentinel; import com.alibaba.csp.sentinel.adapter.servlet.CommonFilter; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; @@ -40,7 +41,7 @@ import java.util.List; @EnableConfigurationProperties(SentinelProperties.class) public class SentinelWebAutoConfiguration { - private static final Logger logger = LoggerFactory + private static final Logger log = LoggerFactory .getLogger(SentinelWebAutoConfiguration.class); @Autowired @@ -63,7 +64,7 @@ public class SentinelWebAutoConfiguration { Filter filter = new CommonFilter(); registration.setFilter(filter); registration.setOrder(filterConfig.getOrder()); - logger.info("[Sentinel Starter] register Sentinel with urlPatterns: {}.", + log.info("[Sentinel Starter] register Sentinel with urlPatterns: {}.", filterConfig.getUrlPatterns()); return registration; diff --git a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelBeanPostProcessor.java b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelBeanPostProcessor.java index 4b222d01..fe22c902 100644 --- a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelBeanPostProcessor.java +++ b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelBeanPostProcessor.java @@ -17,6 +17,7 @@ package org.springframework.cloud.alibaba.sentinel.custom; import com.alibaba.csp.sentinel.slots.block.BlockException; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.BeansException; @@ -50,7 +51,7 @@ import java.util.concurrent.ConcurrentHashMap; */ public class SentinelBeanPostProcessor implements MergedBeanDefinitionPostProcessor { - private static final Logger logger = LoggerFactory + private static final Logger log = LoggerFactory .getLogger(SentinelBeanPostProcessor.class); private final ApplicationContext applicationContext; @@ -97,14 +98,14 @@ public class SentinelBeanPostProcessor implements MergedBeanDefinitionPostProces return; } if (blockClass != void.class && StringUtils.isEmpty(blockMethod)) { - logger.error( + log.error( "{} class attribute exists but {} method attribute is not exists in bean[{}]", type, type, beanName); throw new IllegalArgumentException(type + " class attribute exists but " + type + " method attribute is not exists in bean[" + beanName + "]"); } else if (blockClass == void.class && !StringUtils.isEmpty(blockMethod)) { - logger.error( + log.error( "{} method attribute exists but {} class attribute is not exists in bean[{}]", type, type, beanName); throw new IllegalArgumentException(type + " method attribute exists but " @@ -116,7 +117,7 @@ public class SentinelBeanPostProcessor implements MergedBeanDefinitionPostProces Arrays.stream(args).map(clazz -> clazz.getSimpleName()).toArray()); Method foundMethod = ClassUtils.getStaticMethod(blockClass, blockMethod, args); if (foundMethod == null) { - logger.error( + log.error( "{} static method can not be found in bean[{}]. The right method signature is {}#{}{}, please check your class name, method name and arguments", type, beanName, blockClass.getName(), blockMethod, argsStr); throw new IllegalArgumentException(type @@ -127,7 +128,7 @@ public class SentinelBeanPostProcessor implements MergedBeanDefinitionPostProces } if (!ClientHttpResponse.class.isAssignableFrom(foundMethod.getReturnType())) { - logger.error( + log.error( "{} method return value in bean[{}] is not ClientHttpResponse: {}#{}{}", type, beanName, blockClass.getName(), blockMethod, argsStr); throw new IllegalArgumentException(type + " method return value in bean[" diff --git a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelDataSourceHandler.java b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelDataSourceHandler.java index f781a4ab..df57f919 100644 --- a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelDataSourceHandler.java +++ b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelDataSourceHandler.java @@ -1,11 +1,8 @@ package org.springframework.cloud.alibaba.sentinel.custom; -import java.lang.reflect.Field; -import java.util.Arrays; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Optional; +import com.alibaba.csp.sentinel.datasource.AbstractDataSource; +import com.alibaba.csp.sentinel.datasource.ReadableDataSource; +import com.alibaba.csp.sentinel.slots.block.AbstractRule; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -21,9 +18,12 @@ import org.springframework.util.CollectionUtils; import org.springframework.util.ReflectionUtils; import org.springframework.util.StringUtils; -import com.alibaba.csp.sentinel.datasource.AbstractDataSource; -import com.alibaba.csp.sentinel.datasource.ReadableDataSource; -import com.alibaba.csp.sentinel.slots.block.AbstractRule; +import java.lang.reflect.Field; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Optional; /** * Sentinel {@link ReadableDataSource} Handler Handle the configurations of @@ -36,7 +36,7 @@ import com.alibaba.csp.sentinel.slots.block.AbstractRule; */ public class SentinelDataSourceHandler implements SmartInitializingSingleton { - private static final Logger logger = LoggerFactory + private static final Logger log = LoggerFactory .getLogger(SentinelDataSourceHandler.class); private List dataTypeList = Arrays.asList("json", "xml"); @@ -61,7 +61,7 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton { try { List validFields = dataSourceProperties.getValidField(); if (validFields.size() != 1) { - logger.error("[Sentinel Starter] DataSource " + dataSourceName + log.error("[Sentinel Starter] DataSource " + dataSourceName + " multi datasource active and won't loaded: " + dataSourceProperties.getValidField()); return; @@ -73,7 +73,7 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton { + "-sentinel-" + validFields.get(0) + "-datasource"); } catch (Exception e) { - logger.error("[Sentinel Starter] DataSource " + dataSourceName + log.error("[Sentinel Starter] DataSource " + dataSourceName + " build error: " + e.getMessage(), e); } }); @@ -90,7 +90,7 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton { m.put(v.getName(), v.get(dataSourceProperties)); } catch (IllegalAccessException e) { - logger.error("[Sentinel Starter] DataSource " + dataSourceName + log.error("[Sentinel Starter] DataSource " + dataSourceName + " field: " + v.getName() + " invoke error"); throw new RuntimeException( "[Sentinel Starter] DataSource " + dataSourceName @@ -136,7 +136,7 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton { builder.addPropertyReference("converter", customConvertBeanName); } catch (ClassNotFoundException e) { - logger.error("[Sentinel Starter] DataSource " + dataSourceName + log.error("[Sentinel Starter] DataSource " + dataSourceName + " handle " + dataSourceProperties.getClass().getSimpleName() + " error, class name: " @@ -195,20 +195,20 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton { ruleConfig = dataSource.loadConfig(); } catch (Exception e) { - logger.error("[Sentinel Starter] DataSource " + dataSourceName + log.error("[Sentinel Starter] DataSource " + dataSourceName + " loadConfig error: " + e.getMessage(), e); return; } if (ruleConfig instanceof List) { List convertedRuleList = (List) ruleConfig; if (CollectionUtils.isEmpty(convertedRuleList)) { - logger.warn("[Sentinel Starter] DataSource {} rule list is empty.", + log.warn("[Sentinel Starter] DataSource {} rule list is empty.", dataSourceName); return; } if (convertedRuleList.stream() .noneMatch(rule -> rule.getClass() == ruleClass)) { - logger.error("[Sentinel Starter] DataSource {} none rules are {} type.", + log.error("[Sentinel Starter] DataSource {} none rules are {} type.", dataSourceName, ruleClass.getSimpleName()); throw new IllegalArgumentException("[Sentinel Starter] DataSource " + dataSourceName + " none rules are " + ruleClass.getSimpleName() @@ -216,16 +216,16 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton { } else if (!convertedRuleList.stream() .allMatch(rule -> rule.getClass() == ruleClass)) { - logger.warn("[Sentinel Starter] DataSource {} all rules are not {} type.", + log.warn("[Sentinel Starter] DataSource {} all rules are not {} type.", dataSourceName, ruleClass.getSimpleName()); } else { - logger.info("[Sentinel Starter] DataSource {} load {} {}", dataSourceName, + log.info("[Sentinel Starter] DataSource {} load {} {}", dataSourceName, convertedRuleList.size(), ruleClass.getSimpleName()); } } else { - logger.error("[Sentinel Starter] DataSource " + dataSourceName + log.error("[Sentinel Starter] DataSource " + dataSourceName + " rule class is not List<" + ruleClass.getSimpleName() + ">. Class: " + ruleConfig.getClass()); throw new IllegalArgumentException("[Sentinel Starter] DataSource " diff --git a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelProtectInterceptor.java b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelProtectInterceptor.java index a6dcb3c0..4d9c2eac 100644 --- a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelProtectInterceptor.java +++ b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelProtectInterceptor.java @@ -22,8 +22,7 @@ import com.alibaba.csp.sentinel.Tracer; import com.alibaba.csp.sentinel.context.ContextUtil; import com.alibaba.csp.sentinel.slots.block.BlockException; import com.alibaba.csp.sentinel.slots.block.degrade.DegradeException; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; + import org.springframework.cloud.alibaba.sentinel.annotation.SentinelRestTemplate; import org.springframework.cloud.alibaba.sentinel.rest.SentinelClientHttpResponse; import org.springframework.http.HttpRequest; @@ -43,9 +42,6 @@ import java.net.URI; */ public class SentinelProtectInterceptor implements ClientHttpRequestInterceptor { - private static final Logger logger = LoggerFactory - .getLogger(SentinelProtectInterceptor.class); - private final SentinelRestTemplate sentinelRestTemplate; public SentinelProtectInterceptor(SentinelRestTemplate sentinelRestTemplate) { diff --git a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/bootstrap/AcmPropertySource.java b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/bootstrap/AcmPropertySource.java index 3ebae277..fb7b58ad 100644 --- a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/bootstrap/AcmPropertySource.java +++ b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/bootstrap/AcmPropertySource.java @@ -27,29 +27,29 @@ import java.util.Map; */ public class AcmPropertySource extends MapPropertySource { - private final String dataId; + private final String dataId; - private final Date timestamp; + private final Date timestamp; - private final boolean groupLevel; + private final boolean groupLevel; - AcmPropertySource(String dataId, Map source, Date timestamp, - boolean groupLevel) { - super(dataId, source); - this.dataId = dataId; - this.timestamp = timestamp; - this.groupLevel = groupLevel; - } + AcmPropertySource(String dataId, Map source, Date timestamp, + boolean groupLevel) { + super(dataId, source); + this.dataId = dataId; + this.timestamp = timestamp; + this.groupLevel = groupLevel; + } - public String getDataId() { - return dataId; - } + public String getDataId() { + return dataId; + } - public Date getTimestamp() { - return timestamp; - } + public Date getTimestamp() { + return timestamp; + } - public boolean isGroupLevel() { - return groupLevel; - } + public boolean isGroupLevel() { + return groupLevel; + } } diff --git a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/bootstrap/AcmPropertySourceBuilder.java b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/bootstrap/AcmPropertySourceBuilder.java index 2bf9cbba..8a547b41 100644 --- a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/bootstrap/AcmPropertySourceBuilder.java +++ b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/bootstrap/AcmPropertySourceBuilder.java @@ -18,6 +18,7 @@ package org.springframework.cloud.alicloud.acm.bootstrap; import com.alibaba.edas.acm.ConfigService; import com.alibaba.edas.acm.exception.ConfigException; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.config.YamlPropertiesFactoryBean; @@ -25,7 +26,11 @@ import org.springframework.core.io.ByteArrayResource; import org.springframework.util.StringUtils; import java.io.StringReader; -import java.util.*; +import java.util.Date; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Map; +import java.util.Properties; /** * @author juven.xuxb @@ -33,64 +38,68 @@ import java.util.*; */ class AcmPropertySourceBuilder { - private Logger logger = LoggerFactory.getLogger(AcmPropertySourceBuilder.class); + private Logger log = LoggerFactory.getLogger(AcmPropertySourceBuilder.class); - /** - * 传入 ACM 的 DataId 和 groupID，获取到解析后的 AcmProperty 对象 - * - * @param dataId - * @param diamondGroup - * @param groupLevel - * @return - */ - AcmPropertySource build(String dataId, String diamondGroup, boolean groupLevel) { - Properties properties = loadDiamondData(dataId, diamondGroup); - if (properties == null) { - return null; - } - return new AcmPropertySource(dataId, toMap(properties), new Date(), groupLevel); - } + /** + * 传入 ACM 的 DataId 和 groupID，获取到解析后的 AcmProperty 对象 + * + * @param dataId + * @param diamondGroup + * @param groupLevel + * @return + */ + AcmPropertySource build(String dataId, String diamondGroup, boolean groupLevel) { + Properties properties = loadDiamondData(dataId, diamondGroup); + if (properties == null) { + return null; + } + return new AcmPropertySource(dataId, toMap(properties), new Date(), groupLevel); + } - private Properties loadDiamondData(String dataId, String diamondGroup) { - try { - String data = ConfigService.getConfig(dataId, diamondGroup, 3000L); - if (StringUtils.isEmpty(data)) { - return null; - } - if (dataId.endsWith(".properties")) { - Properties properties = new Properties(); - logger.info(String.format("Loading acm data, dataId: '%s', group: '%s'", - dataId, diamondGroup)); - properties.load(new StringReader(data)); - return properties; - } else if (dataId.endsWith(".yaml") || dataId.endsWith(".yml")) { - YamlPropertiesFactoryBean yamlFactory = new YamlPropertiesFactoryBean(); - yamlFactory.setResources(new ByteArrayResource(data.getBytes())); - return yamlFactory.getObject(); - } - } catch (Exception e) { - if (e instanceof ConfigException) { - logger.error("DIAMOND-100500:" + dataId + ", " + e.toString(), e); - } else { - logger.error("DIAMOND-100500:" + dataId, e); - } - } - return null; - } + private Properties loadDiamondData(String dataId, String diamondGroup) { + try { + String data = ConfigService.getConfig(dataId, diamondGroup, 3000L); + if (StringUtils.isEmpty(data)) { + return null; + } + if (dataId.endsWith(".properties")) { + Properties properties = new Properties(); + log.info(String.format("Loading acm data, dataId: '%s', group: '%s'", + dataId, diamondGroup)); + properties.load(new StringReader(data)); + return properties; + } + else if (dataId.endsWith(".yaml") || dataId.endsWith(".yml")) { + YamlPropertiesFactoryBean yamlFactory = new YamlPropertiesFactoryBean(); + yamlFactory.setResources(new ByteArrayResource(data.getBytes())); + return yamlFactory.getObject(); + } + } + catch (Exception e) { + if (e instanceof ConfigException) { + log.error("DIAMOND-100500:" + dataId + ", " + e.toString(), e); + } + else { + log.error("DIAMOND-100500:" + dataId, e); + } + } + return null; + } - @SuppressWarnings("unchecked") - private Map toMap(Properties properties) { - Map result = new HashMap<>(); - Enumeration keys = (Enumeration)properties.propertyNames(); - while (keys.hasMoreElements()) { - String key = keys.nextElement(); - Object value = properties.getProperty(key); - if (value != null) { - result.put(key, ((String)value).trim()); - } else { - result.put(key, null); - } - } - return result; - } + @SuppressWarnings("unchecked") + private Map toMap(Properties properties) { + Map result = new HashMap<>(); + Enumeration keys = (Enumeration) properties.propertyNames(); + while (keys.hasMoreElements()) { + String key = keys.nextElement(); + Object value = properties.getProperty(key); + if (value != null) { + result.put(key, ((String) value).trim()); + } + else { + result.put(key, null); + } + } + return result; + } } diff --git a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmEndpoint.java b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmEndpoint.java index 6c5518d7..0133fe24 100644 --- a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmEndpoint.java +++ b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmEndpoint.java @@ -38,40 +38,40 @@ import java.util.Map; @Endpoint(id = "acm") public class AcmEndpoint { - private final AcmProperties properties; + private final AcmProperties properties; - private final AcmRefreshHistory refreshHistory; + private final AcmRefreshHistory refreshHistory; - private final AcmPropertySourceRepository propertySourceRepository; + private final AcmPropertySourceRepository propertySourceRepository; - private DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); + private DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); - public AcmEndpoint(AcmProperties properties, AcmRefreshHistory refreshHistory, - AcmPropertySourceRepository propertySourceRepository) { - this.properties = properties; - this.refreshHistory = refreshHistory; - this.propertySourceRepository = propertySourceRepository; - } + public AcmEndpoint(AcmProperties properties, AcmRefreshHistory refreshHistory, + AcmPropertySourceRepository propertySourceRepository) { + this.properties = properties; + this.refreshHistory = refreshHistory; + this.propertySourceRepository = propertySourceRepository; + } - @ReadOperation - public Map invoke() { - Map result = new HashMap<>(); - result.put("config", properties); + @ReadOperation + public Map invoke() { + Map result = new HashMap<>(); + result.put("config", properties); - Map runtime = new HashMap<>(); - List all = propertySourceRepository.getAll(); + Map runtime = new HashMap<>(); + List all = propertySourceRepository.getAll(); - List> sources = new ArrayList<>(); - for (AcmPropertySource ps : all) { - Map source = new HashMap<>(); - source.put("dataId", ps.getDataId()); - source.put("lastSynced", dateFormat.format(ps.getTimestamp())); - sources.add(source); - } - runtime.put("sources", sources); - runtime.put("refreshHistory", refreshHistory.getRecords()); + List> sources = new ArrayList<>(); + for (AcmPropertySource ps : all) { + Map source = new HashMap<>(); + source.put("dataId", ps.getDataId()); + source.put("lastSynced", dateFormat.format(ps.getTimestamp())); + sources.add(source); + } + runtime.put("sources", sources); + runtime.put("refreshHistory", refreshHistory.getRecords()); - result.put("runtime", runtime); - return result; - } + result.put("runtime", runtime); + return result; + } } diff --git a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmHealthIndicator.java b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmHealthIndicator.java index 27569ec1..3ae68d70 100644 --- a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmHealthIndicator.java +++ b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmHealthIndicator.java @@ -17,6 +17,7 @@ package org.springframework.cloud.alicloud.acm.endpoint; import com.alibaba.edas.acm.ConfigService; + import org.springframework.boot.actuate.health.AbstractHealthIndicator; import org.springframework.boot.actuate.health.Health; import org.springframework.cloud.alicloud.acm.AcmPropertySourceRepository; @@ -33,39 +34,40 @@ import java.util.List; */ public class AcmHealthIndicator extends AbstractHealthIndicator { - private final AcmProperties acmProperties; + private final AcmProperties acmProperties; - private final AcmPropertySourceRepository acmPropertySourceRepository; + private final AcmPropertySourceRepository acmPropertySourceRepository; - private final List dataIds; + private final List dataIds; - public AcmHealthIndicator(AcmProperties acmProperties, - AcmPropertySourceRepository acmPropertySourceRepository) { - this.acmProperties = acmProperties; - this.acmPropertySourceRepository = acmPropertySourceRepository; + public AcmHealthIndicator(AcmProperties acmProperties, + AcmPropertySourceRepository acmPropertySourceRepository) { + this.acmProperties = acmProperties; + this.acmPropertySourceRepository = acmPropertySourceRepository; - this.dataIds = new ArrayList<>(); - for (AcmPropertySource acmPropertySource : this.acmPropertySourceRepository - .getAll()) { - this.dataIds.add(acmPropertySource.getDataId()); - } - } + this.dataIds = new ArrayList<>(); + for (AcmPropertySource acmPropertySource : this.acmPropertySourceRepository + .getAll()) { + this.dataIds.add(acmPropertySource.getDataId()); + } + } - @Override - protected void doHealthCheck(Health.Builder builder) throws Exception { - for (String dataId : dataIds) { - try { - String config = ConfigService.getConfig(dataId, acmProperties.getGroup(), - acmProperties.getTimeout()); - if (StringUtils.isEmpty(config)) { - builder.down().withDetail(String.format("dataId: '%s', group: '%s'", - dataId, acmProperties.getGroup()), "config is empty"); - } - } catch (Exception e) { - builder.down().withDetail(String.format("dataId: '%s', group: '%s'", - dataId, acmProperties.getGroup()), e.getMessage()); - } - } - builder.up().withDetail("dataIds", dataIds); - } + @Override + protected void doHealthCheck(Health.Builder builder) throws Exception { + for (String dataId : dataIds) { + try { + String config = ConfigService.getConfig(dataId, acmProperties.getGroup(), + acmProperties.getTimeout()); + if (StringUtils.isEmpty(config)) { + builder.down().withDetail(String.format("dataId: '%s', group: '%s'", + dataId, acmProperties.getGroup()), "config is empty"); + } + } + catch (Exception e) { + builder.down().withDetail(String.format("dataId: '%s', group: '%s'", + dataId, acmProperties.getGroup()), e.getMessage()); + } + } + builder.up().withDetail("dataIds", dataIds); + } } diff --git a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/refresh/AcmContextRefresher.java b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/refresh/AcmContextRefresher.java index 617c8806..59883bb8 100644 --- a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/refresh/AcmContextRefresher.java +++ b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/refresh/AcmContextRefresher.java @@ -16,12 +16,8 @@ package org.springframework.cloud.alicloud.acm.refresh; -import java.io.UnsupportedEncodingException; -import java.math.BigInteger; -import java.security.MessageDigest; -import java.security.NoSuchAlgorithmException; -import java.util.Map; -import java.util.concurrent.ConcurrentHashMap; +import com.alibaba.edas.acm.ConfigService; +import com.alibaba.edas.acm.listener.ConfigChangeListener; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -36,8 +32,12 @@ import org.springframework.context.ApplicationContextAware; import org.springframework.context.ApplicationListener; import org.springframework.util.StringUtils; -import com.alibaba.edas.acm.ConfigService; -import com.alibaba.edas.acm.listener.ConfigChangeListener; +import java.io.UnsupportedEncodingException; +import java.math.BigInteger; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; /** * On application start up, AcmContextRefresher add diamond listeners to all application @@ -49,7 +49,7 @@ import com.alibaba.edas.acm.listener.ConfigChangeListener; public class AcmContextRefresher implements ApplicationListener, ApplicationContextAware { - private Logger logger = LoggerFactory.getLogger(AcmContextRefresher.class); + private Logger log = LoggerFactory.getLogger(AcmContextRefresher.class); private final ContextRefresher contextRefresher; @@ -103,7 +103,7 @@ public class AcmContextRefresher } catch (NoSuchAlgorithmException | UnsupportedEncodingException e) { - logger.warn("unable to get md5 for dataId: " + dataId, e); + log.warn("unable to get md5 for dataId: " + dataId, e); } } refreshHistory.add(dataId, md5); diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsAutoConfiguration.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsAutoConfiguration.java index d5ab0935..fb96cfc1 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsAutoConfiguration.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsAutoConfiguration.java @@ -26,7 +26,7 @@ import org.springframework.cloud.alicloud.ans.registry.AnsAutoServiceRegistratio import org.springframework.cloud.alicloud.ans.registry.AnsRegistration; import org.springframework.cloud.alicloud.ans.registry.AnsServiceRegistry; import org.springframework.cloud.alicloud.context.ans.AnsProperties; -import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationAutoConfiguration; +import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties; import org.springframework.context.ApplicationContext; import org.springframework.context.annotation.Bean; @@ -42,7 +42,7 @@ import org.springframework.context.annotation.Configuration; @ConditionalOnClass(name = "org.springframework.boot.web.context.WebServerInitializedEvent") @ConditionalOnProperty(value = "spring.cloud.service-registry.auto-registration.enabled", matchIfMissing = true) @ConditionalOnAnsEnabled -@AutoConfigureAfter(AutoServiceRegistrationAutoConfiguration.class) +@AutoConfigureAfter(AutoServiceRegistrationConfiguration.class) public class AnsAutoConfiguration { @Bean diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsDiscoveryClient.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsDiscoveryClient.java index 36c28c9f..6f93a979 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsDiscoveryClient.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsDiscoveryClient.java @@ -18,6 +18,7 @@ package org.springframework.cloud.alicloud.ans; import com.alibaba.ans.core.NamingService; import com.alibaba.ans.shaded.com.taobao.vipserver.client.core.Host; + import org.springframework.cloud.client.ServiceInstance; import org.springframework.cloud.client.discovery.DiscoveryClient; @@ -30,6 +31,7 @@ import java.util.Set; /** * @author xiaolongzuo + * @author pbting */ public class AnsDiscoveryClient implements DiscoveryClient { diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsDiscoveryClientAutoConfiguration.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsDiscoveryClientAutoConfiguration.java index c19296f4..06508b07 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsDiscoveryClientAutoConfiguration.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/AnsDiscoveryClientAutoConfiguration.java @@ -28,6 +28,7 @@ import org.springframework.context.annotation.Configuration; /** * @author xiaolongzuo + * @author pbting */ @Configuration @Conditional(MigrateOnConditionMissingClass.class) diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/endpoint/AnsEndpoint.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/endpoint/AnsEndpoint.java index 87cdcd59..baefdb56 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/endpoint/AnsEndpoint.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/endpoint/AnsEndpoint.java @@ -18,6 +18,7 @@ package org.springframework.cloud.alicloud.ans.endpoint; import com.alibaba.ans.core.NamingService; import com.alibaba.ans.shaded.com.taobao.vipserver.client.core.Host; + import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.boot.actuate.endpoint.annotation.Endpoint; @@ -31,6 +32,7 @@ import java.util.Set; /** * @author xiaolongzuo + * @author pbting */ @Endpoint(id = "ans") public class AnsEndpoint { diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateEndpoint.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateEndpoint.java index 16b99d7b..59b2146a 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateEndpoint.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateEndpoint.java @@ -1,7 +1,7 @@ package org.springframework.cloud.alicloud.ans.migrate; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.boot.actuate.endpoint.annotation.Endpoint; import org.springframework.boot.actuate.endpoint.annotation.ReadOperation; @@ -11,7 +11,7 @@ import java.util.concurrent.ConcurrentMap; @Endpoint(id = "migrate") public class MigrateEndpoint { - private static final Log log = LogFactory.getLog(MigrateEndpoint.class); + private static final Logger log = LoggerFactory.getLogger(MigrateEndpoint.class); public MigrateEndpoint() { } diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateEndpointAutoConfiguration.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateEndpointAutoConfiguration.java index 385d5a5d..af572837 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateEndpointAutoConfiguration.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateEndpointAutoConfiguration.java @@ -6,6 +6,9 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplicat import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Conditional; +/** + * @author pbting + */ @ConditionalOnWebApplication @ConditionalOnClass(value = Endpoint.class) @Conditional(MigrateOnConditionClass.class) diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnCondition.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnCondition.java index 96050181..86816587 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnCondition.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnCondition.java @@ -35,7 +35,7 @@ public abstract class MigrateOnCondition implements Condition, BeanClassLoaderAw forName(className, classLoader); return true; } - catch (Throwable var3) { + catch (Throwable throwable) { return false; } } @@ -45,5 +45,4 @@ public abstract class MigrateOnCondition implements Condition, BeanClassLoaderAw return classLoader != null ? classLoader.loadClass(className) : Class.forName(className); } - } \ No newline at end of file diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnConditionClass.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnConditionClass.java index 23c58036..9e99c9f8 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnConditionClass.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnConditionClass.java @@ -1,7 +1,7 @@ package org.springframework.cloud.alicloud.ans.migrate; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.context.annotation.ConditionContext; import org.springframework.core.type.AnnotatedTypeMetadata; @@ -10,13 +10,14 @@ import org.springframework.core.type.AnnotatedTypeMetadata; */ public class MigrateOnConditionClass extends MigrateOnCondition { - protected static final Log log = LogFactory.getLog(MigrateOnConditionClass.class); + private static final Logger log = LoggerFactory + .getLogger(MigrateOnConditionClass.class); @Override public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) { boolean result = isPresent(conditionOnClass[0], classLoader) || isPresent(conditionOnClass[1], classLoader); - log.info("the result of match is :" + result); + log.info("the result of matcher is " + result); return result; } } \ No newline at end of file diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnConditionMissingClass.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnConditionMissingClass.java index 8501ed12..b5653bb7 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnConditionMissingClass.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateOnConditionMissingClass.java @@ -1,7 +1,7 @@ package org.springframework.cloud.alicloud.ans.migrate; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.context.annotation.ConditionContext; import org.springframework.core.type.AnnotatedTypeMetadata; @@ -9,14 +9,13 @@ import org.springframework.core.type.AnnotatedTypeMetadata; * @author pbting */ public class MigrateOnConditionMissingClass extends MigrateOnConditionClass { - - protected static final Log log = LogFactory - .getLog(MigrateOnConditionMissingClass.class); + private static final Logger log = LoggerFactory + .getLogger(MigrateOnConditionMissingClass.class); @Override public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) { boolean result = !super.matches(context, metadata); - log.info("the result of match is :" + result); + log.info(" the result of matcher is " + result); return result; } diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateProxyManager.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateProxyManager.java index 23427941..f44f1af9 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateProxyManager.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateProxyManager.java @@ -5,8 +5,8 @@ import com.netflix.loadbalancer.ILoadBalancer; import com.netflix.loadbalancer.Server; import com.netflix.loadbalancer.ServerList; import org.aopalliance.aop.Advice; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.aop.AfterReturningAdvice; import org.springframework.aop.framework.ProxyFactory; @@ -23,7 +23,7 @@ import java.util.concurrent.atomic.AtomicBoolean; */ final class MigrateProxyManager { - private final static Log log = LogFactory.getLog(MigrateProxyManager.class); + private static final Logger log = LoggerFactory.getLogger(MigrateProxyManager.class); private final static AtomicBoolean IS_PROXY = new AtomicBoolean(true); private final static Set SERVICES_ID = new ConcurrentSkipListSet<>(); diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateRibbonBeanPostProcessor.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateRibbonBeanPostProcessor.java index 98fe851e..b03a1890 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateRibbonBeanPostProcessor.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateRibbonBeanPostProcessor.java @@ -3,8 +3,8 @@ package org.springframework.cloud.alicloud.ans.migrate; import com.netflix.client.config.IClientConfig; import com.netflix.loadbalancer.ILoadBalancer; import com.netflix.loadbalancer.ServerList; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.beans.BeansException; import org.springframework.beans.factory.BeanClassLoaderAware; import org.springframework.beans.factory.config.BeanPostProcessor; @@ -12,7 +12,7 @@ import org.springframework.beans.factory.config.BeanPostProcessor; public class MigrateRibbonBeanPostProcessor implements BeanPostProcessor, BeanClassLoaderAware { - protected static final Log log = LogFactory.getLog(MigrateOnCondition.class); + private static final Logger log = LoggerFactory.getLogger(MigrateOnCondition.class); private ClassLoader classLoader; private IClientConfig clientConfig; diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateServiceRegistry.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateServiceRegistry.java index 5491e98d..11ca9e9c 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateServiceRegistry.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateServiceRegistry.java @@ -1,7 +1,7 @@ package org.springframework.cloud.alicloud.ans.migrate; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.boot.web.context.WebServerInitializedEvent; import org.springframework.cloud.alicloud.ans.registry.AnsRegistration; import org.springframework.cloud.alicloud.ans.registry.AnsServiceRegistry; @@ -19,7 +19,8 @@ import java.util.concurrent.atomic.AtomicBoolean; @Component public class MigrateServiceRegistry { - private static final Log log = LogFactory.getLog(MigrateServiceRegistry.class); + private static final Logger log = LoggerFactory + .getLogger(MigrateServiceRegistry.class); private AtomicBoolean running = new AtomicBoolean(false); diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrationAutoconfiguration.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrationAutoconfiguration.java index 7564b4d7..8f632bf1 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrationAutoconfiguration.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrationAutoconfiguration.java @@ -12,6 +12,9 @@ import org.springframework.context.annotation.Conditional; import org.springframework.context.annotation.Configuration; import org.springframework.core.env.Environment; +/** + * @author pbting + */ @Configuration @EnableConfigurationProperties @Conditional(MigrateOnConditionClass.class) diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/ServerListInvocationHandler.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/ServerListInvocationHandler.java index 16a31147..16d533c1 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/ServerListInvocationHandler.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/ServerListInvocationHandler.java @@ -4,8 +4,8 @@ import com.netflix.client.config.IClientConfig; import com.netflix.loadbalancer.Server; import org.aopalliance.intercept.MethodInterceptor; import org.aopalliance.intercept.MethodInvocation; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.cloud.alicloud.ans.ribbon.AnsServer; import org.springframework.cloud.alicloud.ans.ribbon.AnsServerList; @@ -22,11 +22,12 @@ import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; /** - * + * @author pbting */ class ServerListInvocationHandler implements MethodInterceptor { - private final static Log log = LogFactory.getLog(ServerListInvocationHandler.class); + private static final Logger log = LoggerFactory + .getLogger(ServerListInvocationHandler.class); private final static ConcurrentMap SERVER_LIST_CONCURRENT_MAP = new ConcurrentHashMap<>(); diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/ServerWrapper.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/ServerWrapper.java index aeaa5a60..4fbccfdf 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/ServerWrapper.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/ServerWrapper.java @@ -4,6 +4,9 @@ import com.netflix.loadbalancer.Server; import java.util.concurrent.atomic.AtomicLong; +/** + * @author pbting + */ public class ServerWrapper { private Server server; diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistration.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistration.java index 82d0d8eb..4158dedb 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistration.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistration.java @@ -16,8 +16,8 @@ package org.springframework.cloud.alicloud.ans.registry; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.cloud.client.serviceregistry.AbstractAutoServiceRegistration; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties; @@ -27,10 +27,12 @@ import org.springframework.util.StringUtils; /** * @author xiaolongzuo + * @author pbting */ public class AnsAutoServiceRegistration extends AbstractAutoServiceRegistration { - private static final Log log = LogFactory.getLog(AnsAutoServiceRegistration.class); + private static final Logger log = LoggerFactory + .getLogger(AnsAutoServiceRegistration.class); @Autowired private AnsRegistration registration; diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsServiceRegistry.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsServiceRegistry.java index 1ff187a3..6c4f6e03 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsServiceRegistry.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsServiceRegistry.java @@ -18,9 +18,10 @@ package org.springframework.cloud.alicloud.ans.registry; import com.alibaba.ans.core.NamingService; import com.alibaba.ans.shaded.com.taobao.vipserver.client.ipms.NodeReactor; + import org.apache.commons.lang.StringUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.cloud.client.serviceregistry.ServiceRegistry; import java.util.ArrayList; @@ -32,7 +33,7 @@ import java.util.Map; */ public class AnsServiceRegistry implements ServiceRegistry { - private static Log log = LogFactory.getLog(AnsServiceRegistry.class); + private static final Logger log = LoggerFactory.getLogger(AnsServiceRegistry.class); private static final String SEPARATOR = ","; diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/AnsRibbonClientConfiguration.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/AnsRibbonClientConfiguration.java index 3f1f1516..c67c6c38 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/AnsRibbonClientConfiguration.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/AnsRibbonClientConfiguration.java @@ -26,6 +26,7 @@ import org.springframework.context.annotation.Configuration; /** * @author xiaolongzuo + * @author pbting */ @Configuration @Conditional(MigrateOnConditionMissingClass.class) diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/AnsServerList.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/AnsServerList.java index 74472369..c3b308be 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/AnsServerList.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/AnsServerList.java @@ -18,6 +18,7 @@ package org.springframework.cloud.alicloud.ans.ribbon; import com.alibaba.ans.core.NamingService; import com.alibaba.ans.shaded.com.taobao.vipserver.client.core.Host; + import com.netflix.client.config.IClientConfig; import com.netflix.loadbalancer.AbstractServerList; @@ -26,6 +27,7 @@ import java.util.List; /** * @author xiaolongzuo + * @author pbting */ public class AnsServerList extends AbstractServerList { diff --git a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/nacos/NacosParameterInitListener.java b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/nacos/NacosConfigParameterInitListener.java similarity index 87% rename from spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/nacos/NacosParameterInitListener.java rename to spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/nacos/NacosConfigParameterInitListener.java index 91e9dd20..2a7920f3 100644 --- a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/nacos/NacosParameterInitListener.java +++ b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/nacos/NacosConfigParameterInitListener.java @@ -1,20 +1,20 @@ package org.springframework.cloud.alicloud.context.nacos; +import com.alibaba.cloud.context.edas.EdasChangeOrderConfiguration; +import com.alibaba.cloud.context.edas.EdasChangeOrderConfigurationFactory; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent; import org.springframework.cloud.alicloud.context.listener.AbstractOnceApplicationListener; -import com.alibaba.cloud.context.edas.EdasChangeOrderConfiguration; -import com.alibaba.cloud.context.edas.EdasChangeOrderConfigurationFactory; - /** * @author pbting */ -public class NacosParameterInitListener +public class NacosConfigParameterInitListener extends AbstractOnceApplicationListener { private static final Logger log = LoggerFactory - .getLogger(NacosParameterInitListener.class); + .getLogger(NacosConfigParameterInitListener.class); @Override protected String conditionalOnClass() { @@ -30,12 +30,15 @@ public class NacosParameterInitListener EdasChangeOrderConfiguration edasChangeOrderConfiguration = EdasChangeOrderConfigurationFactory .getEdasChangeOrderConfiguration(); + if (log.isDebugEnabled()) { + log.debug("Initialize Nacos Config Parameter ,is managed {}.", + edasChangeOrderConfiguration.isEdasManaged()); + } + if (!edasChangeOrderConfiguration.isEdasManaged()) { return; } - log.info("Initialize Nacos Parameter from edas change order,is edas managed {}.", - edasChangeOrderConfiguration.isEdasManaged()); System.getProperties().setProperty("spring.cloud.nacos.config.server-mode", "EDAS"); // initialize nacos configuration diff --git a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/nacos/NacosDiscoveryParameterInitListener.java b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/nacos/NacosDiscoveryParameterInitListener.java new file mode 100644 index 00000000..cd68551c --- /dev/null +++ b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/nacos/NacosDiscoveryParameterInitListener.java @@ -0,0 +1,73 @@ +/* + * 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 org.springframework.cloud.alicloud.context.nacos; + +import com.alibaba.cloud.context.edas.EdasChangeOrderConfiguration; +import com.alibaba.cloud.context.edas.EdasChangeOrderConfigurationFactory; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent; +import org.springframework.cloud.alicloud.context.listener.AbstractOnceApplicationListener; + +import java.util.Properties; + +/** + * @author pbting + * @date 2019-02-14 11:12 AM + */ +public class NacosDiscoveryParameterInitListener + extends AbstractOnceApplicationListener { + private static final Logger log = LoggerFactory + .getLogger(NacosDiscoveryParameterInitListener.class); + + @Override + protected String conditionalOnClass() { + return "org.springframework.cloud.alibaba.nacos.NacosDiscoveryAutoConfiguration"; + } + + @Override + protected void handleEvent(ApplicationEnvironmentPreparedEvent event) { + EdasChangeOrderConfiguration edasChangeOrderConfiguration = EdasChangeOrderConfigurationFactory + .getEdasChangeOrderConfiguration(); + + if (log.isDebugEnabled()) { + log.debug("Initialize Nacos Discovery Parameter ,is managed {}.", + edasChangeOrderConfiguration.isEdasManaged()); + } + + if (!edasChangeOrderConfiguration.isEdasManaged()) { + return; + } + // initialize nacos configuration + Properties properties = System.getProperties(); + + // step 1: set some properties for spring cloud alibaba nacos discovery + properties.setProperty("spring.cloud.nacos.discovery.server-addr", ""); + properties.setProperty("spring.cloud.nacos.discovery.endpoint", + edasChangeOrderConfiguration.getAddressServerDomain()); + properties.setProperty("spring.cloud.nacos.discovery.namespace", + edasChangeOrderConfiguration.getTenantId()); + properties.setProperty("spring.cloud.nacos.discovery.access-key", + edasChangeOrderConfiguration.getDauthAccessKey()); + properties.setProperty("spring.cloud.nacos.discovery.secret-key", + edasChangeOrderConfiguration.getDauthSecretKey()); + + // step 2: set these properties for nacos client + properties.setProperty("nacos.naming.web.context", "/vipserver"); + properties.setProperty("nacos.naming.exposed.port", "80"); + } +} \ No newline at end of file diff --git a/spring-cloud-alicloud-context/src/main/resources/META-INF/spring.factories b/spring-cloud-alicloud-context/src/main/resources/META-INF/spring.factories index f99f0502..b39c6499 100644 --- a/spring-cloud-alicloud-context/src/main/resources/META-INF/spring.factories +++ b/spring-cloud-alicloud-context/src/main/resources/META-INF/spring.factories @@ -10,5 +10,6 @@ org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.cloud.alicloud.context.sms.SmsContextAutoConfiguration org.springframework.context.ApplicationListener=\ org.springframework.cloud.alicloud.context.ans.AnsContextApplicationListener,\ - org.springframework.cloud.alicloud.context.nacos.NacosParameterInitListener,\ + org.springframework.cloud.alicloud.context.nacos.NacosConfigParameterInitListener,\ + org.springframework.cloud.alicloud.context.nacos.NacosDiscoveryParameterInitListener,\ org.springframework.cloud.alicloud.context.sentinel.SentinelAliCloudListener \ No newline at end of file diff --git a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/nacos/NacosParameterInitListenerTests.java b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/nacos/NacosConfigParameterInitListenerTests.java similarity index 92% rename from spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/nacos/NacosParameterInitListenerTests.java rename to spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/nacos/NacosConfigParameterInitListenerTests.java index fe0451fd..355bc08b 100644 --- a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/nacos/NacosParameterInitListenerTests.java +++ b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/nacos/NacosConfigParameterInitListenerTests.java @@ -16,7 +16,8 @@ package org.springframework.cloud.alicloud.context.nacos; -import static org.assertj.core.api.AssertionsForClassTypes.assertThat; +import com.alibaba.cloud.context.ans.AliCloudAnsInitializer; +import com.alibaba.cloud.context.edas.EdasChangeOrderConfigurationFactory; import org.junit.BeforeClass; import org.junit.Test; @@ -24,15 +25,14 @@ import org.powermock.core.classloader.annotations.PrepareForTest; import org.springframework.cloud.alicloud.context.BaseAliCloudSpringApplication; import org.springframework.cloud.alicloud.utils.ChangeOrderUtils; -import com.alibaba.cloud.context.ans.AliCloudAnsInitializer; -import com.alibaba.cloud.context.edas.EdasChangeOrderConfigurationFactory; +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; /** * @author xiaolongzuo */ @PrepareForTest({ EdasChangeOrderConfigurationFactory.class, - NacosParameterInitListener.class, AliCloudAnsInitializer.class }) -public class NacosParameterInitListenerTests extends BaseAliCloudSpringApplication { + NacosConfigParameterInitListener.class, AliCloudAnsInitializer.class }) +public class NacosConfigParameterInitListenerTests extends BaseAliCloudSpringApplication { @BeforeClass public static void setUp() { diff --git a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/nacos/NacosDiscoveryParameterInitListenerTests.java b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/nacos/NacosDiscoveryParameterInitListenerTests.java new file mode 100644 index 00000000..b9e0ec2b --- /dev/null +++ b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/nacos/NacosDiscoveryParameterInitListenerTests.java @@ -0,0 +1,59 @@ +/* + * Copyright (C) 2018 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 org.springframework.cloud.alicloud.context.nacos; + +import com.alibaba.cloud.context.ans.AliCloudAnsInitializer; +import com.alibaba.cloud.context.edas.EdasChangeOrderConfigurationFactory; + +import org.junit.BeforeClass; +import org.junit.Test; +import org.powermock.core.classloader.annotations.PrepareForTest; +import org.springframework.cloud.alicloud.context.BaseAliCloudSpringApplication; +import org.springframework.cloud.alicloud.utils.ChangeOrderUtils; + +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; + +/** + * @author xiaolongzuo + */ +@PrepareForTest({EdasChangeOrderConfigurationFactory.class, + NacosConfigParameterInitListener.class, AliCloudAnsInitializer.class}) +public class NacosDiscoveryParameterInitListenerTests extends BaseAliCloudSpringApplication { + + @BeforeClass + public static void setUp() { + ChangeOrderUtils.mockChangeOrder(); + System.getProperties().setProperty("webContext", "/vipserver"); + System.getProperties().setProperty("serverPort", "80"); + } + + @Test + public void testNacosParameterInitListener() { + assertThat(System.getProperty("spring.cloud.nacos.config.server-addr")) + .isEqualTo(""); + assertThat(System.getProperty("spring.cloud.nacos.config.endpoint")) + .isEqualTo("testDomain"); + assertThat(System.getProperty("spring.cloud.nacos.config.namespace")) + .isEqualTo("testTenantId"); + assertThat(System.getProperty("spring.cloud.nacos.config.access-key")) + .isEqualTo("testAK"); + assertThat(System.getProperty("spring.cloud.nacos.config.secret-key")) + .isEqualTo("testSK"); + assertThat(System.getProperties().getProperty("webContext")).isEqualTo("/vipserver"); + assertThat(System.getProperties().getProperty("serverPort")).isEqualTo("80"); + } +} diff --git a/spring-cloud-starter-alibaba/pom.xml b/spring-cloud-starter-alibaba/pom.xml index c0de3644..70e8dc18 100644 --- a/spring-cloud-starter-alibaba/pom.xml +++ b/spring-cloud-starter-alibaba/pom.xml @@ -19,27 +19,6 @@ spring-cloud-starter-alibaba-fescar spring-cloud-starter-stream-rocketmq spring-cloud-starter-bus-rocketmq + spring-cloud-starter-dubbo - - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - - - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - - - \ No newline at end of file diff --git a/spring-cloud-starter-alibaba/spring-cloud-starter-dubbo/pom.xml b/spring-cloud-starter-alibaba/spring-cloud-starter-dubbo/pom.xml new file mode 100644 index 00000000..2eb028ff --- /dev/null +++ b/spring-cloud-starter-alibaba/spring-cloud-starter-dubbo/pom.xml @@ -0,0 +1,25 @@ + + + + org.springframework.cloud + spring-cloud-starter-alibaba + 0.2.2.BUILD-SNAPSHOT + ../pom.xml + + 4.0.0 + + org.springframework.cloud + spring-cloud-starter-dubbo + Spring Cloud Starter Dubbo + + + + ${project.groupId} + spring-cloud-alibaba-dubbo + ${project.version} + + + + \ No newline at end of file diff --git a/spring-cloud-starter-alicloud/pom.xml b/spring-cloud-starter-alicloud/pom.xml index 3684464e..df47cfbb 100644 --- a/spring-cloud-starter-alicloud/pom.xml +++ b/spring-cloud-starter-alicloud/pom.xml @@ -17,26 +17,4 @@ spring-cloud-starter-alicloud-schedulerx spring-cloud-starter-alicloud-sms - - - - - - org.codehaus.mojo - cobertura-maven-plugin - - - - - - org.codehaus.mojo - cobertura-maven-plugin - false - - true - - - - - \ No newline at end of file diff --git a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/RocketMQMessageChannelBinder.java b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/RocketMQMessageChannelBinder.java index 9effe0f7..4cd4a5fe 100644 --- a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/RocketMQMessageChannelBinder.java +++ b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/RocketMQMessageChannelBinder.java @@ -23,7 +23,10 @@ import java.util.Set; import org.apache.rocketmq.client.producer.DefaultMQProducer; import org.apache.rocketmq.spring.core.RocketMQTemplate; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.cloud.stream.binder.AbstractMessageChannelBinder; +import org.springframework.cloud.stream.binder.BinderSpecificPropertiesProvider; import org.springframework.cloud.stream.binder.ExtendedConsumerProperties; import org.springframework.cloud.stream.binder.ExtendedProducerProperties; import org.springframework.cloud.stream.binder.ExtendedPropertiesBinder; @@ -52,16 +55,19 @@ public class RocketMQMessageChannelBinder extends implements ExtendedPropertiesBinder { - private final RocketMQExtendedBindingProperties extendedBindingProperties; + private static final Logger logger = LoggerFactory + .getLogger(RocketMQMessageChannelBinder.class); + + private RocketMQExtendedBindingProperties extendedBindingProperties = new RocketMQExtendedBindingProperties(); + private final RocketMQBinderConfigurationProperties rocketBinderConfigurationProperties; private final InstrumentationManager instrumentationManager; private Set clientConfigId = new HashSet<>(); private Map topicInUse = new HashMap<>(); - public RocketMQMessageChannelBinder( + public RocketMQMessageChannelBinder(RocketMQTopicProvisioner provisioningProvider, RocketMQExtendedBindingProperties extendedBindingProperties, - RocketMQTopicProvisioner provisioningProvider, RocketMQBinderConfigurationProperties rocketBinderConfigurationProperties, InstrumentationManager instrumentationManager) { super(null, provisioningProvider); @@ -145,7 +151,7 @@ public class RocketMQMessageChannelBinder extends } RocketMQListenerBindingContainer listenerContainer = new RocketMQListenerBindingContainer( - consumerProperties, this); + consumerProperties, rocketBinderConfigurationProperties, this); listenerContainer.setConsumerGroup(group); listenerContainer.setTopic(destination.getName()); listenerContainer.setConsumeThreadMax(consumerProperties.getConcurrency()); @@ -194,4 +200,20 @@ public class RocketMQMessageChannelBinder extends public Map getTopicInUse() { return topicInUse; } + + @Override + public String getDefaultsPrefix() { + return extendedBindingProperties.getDefaultsPrefix(); + } + + @Override + public Class getExtendedPropertiesEntryClass() { + return extendedBindingProperties.getExtendedPropertiesEntryClass(); + } + + public void setExtendedBindingProperties( + RocketMQExtendedBindingProperties extendedBindingProperties) { + this.extendedBindingProperties = extendedBindingProperties; + } + } diff --git a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/config/RocketMQBinderAutoConfiguration.java b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/config/RocketMQBinderAutoConfiguration.java index c0fbe77a..74f19d96 100644 --- a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/config/RocketMQBinderAutoConfiguration.java +++ b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/config/RocketMQBinderAutoConfiguration.java @@ -66,8 +66,9 @@ public class RocketMQBinderAutoConfiguration { RocketMQTopicProvisioner provisioningProvider, InstrumentationManager instrumentationManager) { RocketMQMessageChannelBinder binder = new RocketMQMessageChannelBinder( - extendedBindingProperties, provisioningProvider, + provisioningProvider, extendedBindingProperties, rocketBinderConfigurationProperties, instrumentationManager); + binder.setExtendedBindingProperties(extendedBindingProperties); return binder; } diff --git a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/properties/RocketMQBindingProperties.java b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/properties/RocketMQBindingProperties.java index 094dafd1..6d1146e9 100644 --- a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/properties/RocketMQBindingProperties.java +++ b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/properties/RocketMQBindingProperties.java @@ -16,16 +16,19 @@ package org.springframework.cloud.stream.binder.rocketmq.properties; +import org.springframework.cloud.stream.binder.BinderSpecificPropertiesProvider; + /** * @author Timur Valiev * @author Jim */ -public class RocketMQBindingProperties { +public class RocketMQBindingProperties implements BinderSpecificPropertiesProvider { private RocketMQConsumerProperties consumer = new RocketMQConsumerProperties(); private RocketMQProducerProperties producer = new RocketMQProducerProperties(); + @Override public RocketMQConsumerProperties getConsumer() { return consumer; } @@ -34,6 +37,7 @@ public class RocketMQBindingProperties { this.consumer = consumer; } + @Override public RocketMQProducerProperties getProducer() { return producer; } diff --git a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/properties/RocketMQExtendedBindingProperties.java b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/properties/RocketMQExtendedBindingProperties.java index b016f693..659a350e 100644 --- a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/properties/RocketMQExtendedBindingProperties.java +++ b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/properties/RocketMQExtendedBindingProperties.java @@ -16,71 +16,27 @@ package org.springframework.cloud.stream.binder.rocketmq.properties; -import java.util.HashMap; -import java.util.Map; - import org.springframework.boot.context.properties.ConfigurationProperties; -import org.springframework.cloud.stream.binder.ExtendedBindingProperties; +import org.springframework.cloud.stream.binder.AbstractExtendedBindingProperties; +import org.springframework.cloud.stream.binder.BinderSpecificPropertiesProvider; /** * @author Timur Valiev * @author Jim */ @ConfigurationProperties("spring.cloud.stream.rocketmq") -public class RocketMQExtendedBindingProperties implements - ExtendedBindingProperties { +public class RocketMQExtendedBindingProperties extends + AbstractExtendedBindingProperties { - private Map bindings = new HashMap<>(); + private static final String DEFAULTS_PREFIX = "spring.cloud.stream.rocketmq.default"; - public Map getBindings() { - return this.bindings; - } - - public void setBindings(Map bindings) { - this.bindings = bindings; + @Override + public String getDefaultsPrefix() { + return DEFAULTS_PREFIX; } @Override - public synchronized RocketMQConsumerProperties getExtendedConsumerProperties( - String channelName) { - if (bindings.containsKey(channelName)) { - if (bindings.get(channelName).getConsumer() != null) { - return bindings.get(channelName).getConsumer(); - } - else { - RocketMQConsumerProperties properties = new RocketMQConsumerProperties(); - this.bindings.get(channelName).setConsumer(properties); - return properties; - } - } - else { - RocketMQConsumerProperties properties = new RocketMQConsumerProperties(); - RocketMQBindingProperties rbp = new RocketMQBindingProperties(); - rbp.setConsumer(properties); - bindings.put(channelName, rbp); - return properties; - } - } - - @Override - public synchronized RocketMQProducerProperties getExtendedProducerProperties( - String channelName) { - if (bindings.containsKey(channelName)) { - if (bindings.get(channelName).getProducer() != null) { - return bindings.get(channelName).getProducer(); - } - else { - RocketMQProducerProperties properties = new RocketMQProducerProperties(); - this.bindings.get(channelName).setProducer(properties); - return properties; - } - } - else { - RocketMQProducerProperties properties = new RocketMQProducerProperties(); - RocketMQBindingProperties rbp = new RocketMQBindingProperties(); - rbp.setProducer(properties); - bindings.put(channelName, rbp); - return properties; - } + public Class getExtendedPropertiesEntryClass() { + return RocketMQBindingProperties.class; } }