diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..5c2cb13c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +我们鼓励使用英文,如果不能直接使用,可以使用翻译软件,您仍旧可以保留中文原文。 +We recommend using English. If you are non-native English speaker, you can use the translation software. + +**Which Component** +eg. Nacos Discovery, Sentinel + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. +e.g. MacOS 、Java8 、 Version 0.2.1.RELEASE diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..f4117418 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +我们鼓励使用英文,如果不能直接使用,可以使用翻译软件,您仍旧可以保留中文原文。 +We recommend using English. If you are non-native English speaker, you can use the translation software. + + +**Which Component** +eg. Nacos Discovery, Sentinel + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..6ef2bf0a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,21 @@ +--- +name: Question +about: how to ask an valid question +title: '' +labels: '' +assignees: '' + +--- + +我们鼓励使用英文,如果不能直接使用,可以使用翻译软件,您仍旧可以保留中文原文。 +We recommend using English. If you are non-native English speaker, you can use the translation software. + + +**Which Component** +eg. Nacos Discovery, Sentinel + +**Describe what problem you have encountered** +A clear and concise description of what you want to do. + +**Describe what information you have read** +eg. I have read the reference doc of Sentinel diff --git a/CODE_OF_CONDUCT.adoc b/CODE_OF_CONDUCT.adoc new file mode 100644 index 00000000..77a7e0ac --- /dev/null +++ b/CODE_OF_CONDUCT.adoc @@ -0,0 +1,45 @@ + += Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of fostering an open +and welcoming community, we pledge to respect all people who contribute through reporting +issues, posting feature requests, updating documentation, submitting pull requests or +patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for +everyone, regardless of level of experience, gender, gender identity and expression, +sexual orientation, disability, personal appearance, body size, race, ethnicity, age, +religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic addresses, + without explicit permission +* Other unethical or unprofessional conduct + +Project maintainers have the right and responsibility to remove, edit, or reject comments, +commits, code, wiki edits, issues, and other contributions that are not aligned to this +Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors +that they deem inappropriate, threatening, offensive, or harmful. + +By adopting this Code of Conduct, project maintainers commit themselves to fairly and +consistently applying these principles to every aspect of managing this project. Project +maintainers who do not follow or enforce the Code of Conduct may be permanently removed +from the project team. + +This Code of Conduct applies both within project spaces and in public spaces when an +individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by +contacting a project maintainer at spring-code-of-conduct@pivotal.io . All complaints will +be reviewed and investigated and will result in a response that is deemed necessary and +appropriate to the circumstances. Maintainers are obligated to maintain confidentiality +with regard to the reporter of an incident. + +This Code of Conduct is adapted from the +http://contributor-covenant.org[Contributor Covenant], version 1.3.0, available at +http://contributor-covenant.org/version/1/3/0/[contributor-covenant.org/version/1/3/0/] diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..7146573a --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,29 @@ +## Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery + +- Personal attacks + +- Trolling or insulting/derogatory comments + +- Public or private harassment + +- Publishing other’s private information, such as physical or electronic addresses, without explicit permission + +- Other unethical or unprofessional conduct + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer at spring-code-of-conduct@pivotal.io . All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident. + +This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org/), version 1.3.0, available at [contributor-covenant.org/version/1/3/0/](http://contributor-covenant.org/version/1/3/0/) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..7261357c --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ + +### Describe what this PR does / why we need it + + +### Does this pull request fix one issue? + + + +### Describe how you did it + + +### Describe how to verify it + + +### Special notes for reviews diff --git a/README-zh.md b/README-zh.md index c76e149e..bfe834aa 100644 --- a/README-zh.md +++ b/README-zh.md @@ -19,8 +19,10 @@ Spring Cloud Alibaba 致力于提供微服务开发的一站式解决方案。 * **服务注册与发现**:适配 Spring Cloud 服务注册与发现标准,默认集成了 Ribbon 的支持。 * **分布式配置管理**:支持分布式系统中的外部化配置,配置更改时自动刷新。 * **消息驱动能力**:基于 Spring Cloud Stream 为微服务应用构建消息驱动能力。 +* **分布式事务**:使用 @GlobalTransactional 注解, 高效并且对业务零侵入地解决分布式事务问题。。 * **阿里云对象存储**:阿里云提供的海量、安全、低成本、高可靠的云存储服务。支持在任何应用、任何时间、任何地点存储和访问任意类型的数据。 * **分布式任务调度**:提供秒级、精准、高可靠、高可用的定时(基于 Cron 表达式)任务调度服务。同时提供分布式的任务执行模型,如网格任务。网格任务支持海量子任务均匀分配到所有 Worker(schedulerx-client)上执行。 +* **阿里云短信服务**:覆盖全球的短信服务,友好、高效、智能的互联化通讯能力,帮助企业迅速搭建客户触达通道。 更多功能请参考 [Roadmap](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/Roadmap-zh.md)。 @@ -33,11 +35,17 @@ Spring Cloud Alibaba 致力于提供微服务开发的一站式解决方案。 **[RocketMQ](https://rocketmq.apache.org/)**:一款开源的分布式消息系统,基于高可用分布式集群技术,提供低延时的、高可靠的消息发布与订阅服务。 +**[Dubbo](https://github.com/apache/incubator-dubbo)**:Apache Dubbo™ (incubating) 是一款高性能 Java RPC 框架。 + +**[Fescar](https://github.com/alibaba/fescar)**:阿里巴巴开源产品,一个易于使用的高性能微服务分布式事务解决方案。 + **[Alibaba Cloud ACM](https://www.aliyun.com/product/acm)**:一款在分布式架构环境中对应用配置进行集中管理和推送的应用配置中心产品。 **[Alibaba Cloud OSS](https://www.aliyun.com/product/oss)**: 阿里云对象存储服务(Object Storage Service,简称 OSS),是阿里云提供的海量、安全、低成本、高可靠的云存储服务。您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。 -**[Alibaba Cloud SchedulerX](https://help.aliyun.com/document_detail/43136.html?spm=a2c4g.11186623.6.709.baef7da9QVICiD)**: 阿里中间件团队开发的一款分布式任务调度产品,提供秒级、精准、高可靠、高可用的定时(基于 Cron 表达式)任务调度服务。 +**[Alibaba Cloud SchedulerX](https://help.aliyun.com/document_detail/43136.html)**: 阿里中间件团队开发的一款分布式任务调度产品,提供秒级、精准、高可靠、高可用的定时(基于 Cron 表达式)任务调度服务。 + +**[Alibaba Cloud SMS](https://www.aliyun.com/product/sms)**: 覆盖全球的短信服务,友好、高效、智能的互联化通讯能力,帮助企业迅速搭建客户触达通道。 更多组件请参考 [Roadmap](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/Roadmap-zh.md)。 @@ -100,6 +108,8 @@ Example 列表: [RocketMQ Example](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-examples/rocketmq-example/readme-zh.md) +[Fescar Example](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-examples/fescar-example/readme-zh.md) + [Alibaba Cloud OSS Example](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-examples/oss-example/readme-zh.md) [Alibaba Cloud ANS Example](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-examples/ans-example/ans-provider-example/readme-zh.md) diff --git a/README.md b/README.md index 8b073b61..ad4672cd 100644 --- a/README.md +++ b/README.md @@ -20,21 +20,33 @@ With Spring Cloud Alibaba, you only need to add some annotations and a small amo * **Service registration and discovery**:Service can be registered and clients can discover the instances using Spring-managed beans, auto integration Ribbon. * **Distributed configuration**:support for externalized configuration in a distributed system, auto refresh when configuration changes. * **Event-driven**:support for building highly scalable event-driven microservices connected with shared messaging systems. +* **Distributed Transaction**:support for distributed transaction solution with high performance and ease of use. * **Alibaba Cloud Object Storage**:massive, secure, low-cost, and highly reliable cloud storage services. Support for storing and accessing any type of data in any application, anytime, anywhere. +* **Alibaba Cloud SchedulerX**:accurate, highly reliable, and highly available scheduled job scheduling services with response time within seconds. +* **Alibaba Cloud SMS**: A messaging service that covers the globe, Alibaba SMS provides convenient, efficient, and intelligent communication capabilities that help businesses quickly contact their customers. + For more features, please refer to [Roadmap](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/Roadmap.md). ## Components **[Sentinel](https://github.com/alibaba/Sentinel)**: Sentinel takes "traffic flow" as the breakthrough point, and provides solutions in areas such as flow control, concurrency, circuit breaking, and load protection to protect service stability. -**[Nacos](https://github.com/alibaba/Nacos)**: an easy-to-use dynamic service discovery, configuration and service management platform for building cloud native applications. +**[Nacos](https://github.com/alibaba/Nacos)**: An easy-to-use dynamic service discovery, configuration and service management platform for building cloud native applications. -**[RocketMQ](https://rocketmq.apache.org/)**:a distributed messaging and streaming platform with low latency, high performance and reliability, trillion-level capacity and flexible scalability. +**[RocketMQ](https://rocketmq.apache.org/)**:A distributed messaging and streaming platform with low latency, high performance and reliability, trillion-level capacity and flexible scalability. -**[Alibaba Cloud ACM](https://www.aliyun.com/product/acm)**:an application configuration center that enables you to centralize the management of application configurations, and accomplish real-time configuration push in a distributed environment. +**[Dubbo](https://github.com/apache/incubator-dubbo)**:A high-performance, Java based open source RPC framework. + +**[Fescar](https://github.com/alibaba/fescar)**:A distributed transaction solution with high performance and ease of use for microservices architecture. + +**[Alibaba Cloud ACM](https://www.aliyun.com/product/acm)**:An application configuration center that enables you to centralize the management of application configurations, and accomplish real-time configuration push in a distributed environment. **[Alibaba Cloud OSS](https://www.aliyun.com/product/oss)**: An encrypted and secure cloud storage service which stores, processes and accesses massive amounts of data from anywhere in the world. +**[Alibaba Cloud SMS](https://www.aliyun.com/product/sms)**: A messaging service that covers the globe, Alibaba SMS provides convenient, efficient, and intelligent communication capabilities that help businesses quickly contact their customers. + +**[Alibaba Cloud SchedulerX](https://www.aliyun.com/product/SchedulerX)**:accurate, highly reliable, and highly available scheduled job scheduling services with response time within seconds.. + For more features please refer to [Roadmap](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/Roadmap.md). ## How to build @@ -120,6 +132,28 @@ During the incubation period, the version management of the project will follow * Functional updates will be reflected in the 3rd number of the version, for example, the next version of 0.1.0 will be 0.1.1. +## Code of Conduct +This project is a sub-project of Spring Cloud, it adheres to the Contributor Covenant [code of conduct](https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc). By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. + +## Code Conventions and Housekeeping +None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge. + +Use the Spring Framework code format conventions. If you use Eclipse you can import formatter settings using the eclipse-code-formatter.xml file from the Spring Cloud Build project. If using IntelliJ, you can use the Eclipse Code Formatter Plugin to import the same file. + +Make sure all new .java files to have a simple Javadoc class comment with at least an @author tag identifying you, and preferably at least a paragraph on what the class is for. + +Add the ASF license header comment to all new .java files (copy from existing files in the project) + +Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes). + +Add some Javadocs and, if you change the namespace, some XSD doc elements. + +A few unit tests would help a lot as well — someone has to do it. + +If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project). + +When writing a commit message please follow these conventions, if you are fixing an existing issue please add Fixes gh-XXXX at the end of the commit message (where XXXX is the issue number). + ## Contact Us Mailing list is recommended for discussing almost anything related to spring-cloud-alibaba. diff --git a/Roadmap-zh.md b/Roadmap-zh.md index 78e09e0e..8bf69a79 100644 --- a/Roadmap-zh.md +++ b/Roadmap-zh.md @@ -17,21 +17,10 @@ Spring Cloud Alibaba 致力于提供分布式应用服务开发的一站式解 阿里巴巴开源产品,一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。 -**Alibaba Cloud OSS** - -阿里云对象存储服务(Object Storage Service,简称 OSS),是阿里云提供的海量、安全、低成本、高可靠的云存储服务。您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。 - **RocketMQ** Apache RocketMQ™ 基于 Java 的高性能、高吞吐量的分布式消息和流计算平台。 -**Alibaba Cloud SchedulerX** - -阿里中间件团队开发的一款分布式任务调度产品,支持周期性的任务与固定时间点触发任务。 - - -## 即将加入的组件 - **Dubbo** Apache Dubbo™ (incubating) 是一款高性能 Java RPC 框架。 @@ -40,6 +29,14 @@ Apache Dubbo™ (incubating) 是一款高性能 Java RPC 框架。 阿里巴巴开源产品,一个易于使用的高性能微服务分布式事务解决方案。 -**Alibaba Cloud SLS** +**Alibaba Cloud OSS** -针对日志类数据的一站式服务,在阿里巴巴集团经历大量大数据场景锤炼而成。您无需开发就能快捷完成日志数据采集、消费、投递以及查询分析等功能,提升运维、运营效率,建立 DT 时代海量日志处理能力。 \ No newline at end of file +阿里云对象存储服务(Object Storage Service,简称 OSS),是阿里云提供的海量、安全、低成本、高可靠的云存储服务。您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。 + +**Alibaba Cloud SchedulerX** + +阿里中间件团队开发的一款分布式任务调度产品,支持周期性的任务与固定时间点触发任务。 + +**Alibaba Cloud SMS** + +覆盖全球的短信服务,友好、高效、智能的互联化通讯能力,帮助企业迅速搭建客户触达通道。 diff --git a/Roadmap.md b/Roadmap.md index 66cb84f6..e7b99498 100644 --- a/Roadmap.md +++ b/Roadmap.md @@ -24,16 +24,6 @@ An opensource project of Alibaba, an easy-to-use dynamic service discovery, conf Apache RocketMQ™ is an open source distributed messaging and streaming data platform. -**Alibaba Cloud OSS** - -Alibaba Cloud Object Storage Service, An encrypted and secure cloud storage service which stores, processes and accesses massive amounts of data from anywhere in the world. - -**Alibaba Cloud Schedulerx** - -A distributed task scheduling product developed by Alibaba Middleware team. It supports both periodical tasks and tasks to be triggered at specified time points. - -More components will be supported by Spring Cloud Alibaba in the future, which may include but are not limited to the following: - **Dubbo** Apache Dubbo™ (incubating) is a high-performance, Java based open source RPC framework. @@ -42,6 +32,15 @@ Apache Dubbo™ (incubating) is a high-performance, Java based open source RPC f A distributed transaction solution with high performance and ease of use for microservices architecture. -**Alibaba Cloud SLS** +**Alibaba Cloud OSS** + +Alibaba Cloud Object Storage Service, An encrypted and secure cloud storage service which stores, processes and accesses massive amounts of data from anywhere in the world. + +**Alibaba Cloud Schedulerx** + +A distributed task scheduling product developed by Alibaba Middleware team. It supports both periodical tasks and tasks to be triggered at specified time points. + +**Alibaba Cloud SMS** + +A messaging service that covers the globe, Alibaba SMS provides convenient, efficient, and intelligent communication capabilities that help businesses quickly contact their customers. -Aliyun Log Service is an all-in-one service for log-type data. It helps increase Operations & Management and operational efficiency, as well as build the processing capability to deal with massive logs. diff --git a/pom.xml b/pom.xml index 92bd96cb..57652f34 100644 --- a/pom.xml +++ b/pom.xml @@ -91,8 +91,10 @@ spring-cloud-alibaba-sentinel-datasource spring-cloud-alibaba-nacos-config spring-cloud-alibaba-nacos-discovery + spring-cloud-alibaba-fescar spring-cloud-stream-binder-rocketmq spring-cloud-alibaba-nacos-config-server + spring-cloud-alibaba-dubbo spring-cloud-alicloud-context spring-cloud-alibaba-examples spring-cloud-alibaba-test @@ -109,6 +111,15 @@ + + + org.springframework.boot + spring-boot-dependencies + ${spring-boot.version} + pom + import + + org.springframework.cloud spring-cloud-alibaba-dependencies @@ -200,7 +211,15 @@ org.codehaus.mojo cobertura-maven-plugin ${cobertura-maven-plugin.version} + + + org.ow2.asm + asm + 5.0.3 + + + true html xml diff --git a/spring-cloud-alibaba-dependencies/pom.xml b/spring-cloud-alibaba-dependencies/pom.xml index ef203d31..9034205a 100644 --- a/spring-cloud-alibaba-dependencies/pom.xml +++ b/spring-cloud-alibaba-dependencies/pom.xml @@ -17,17 +17,21 @@ Spring Cloud Alibaba Dependencies - 1.4.0 + 1.4.1 3.1.0 - 0.6.2 - 0.6.1 + 0.1.3 + 0.8.0 + 0.8.0 1.0.8 1.0.1 4.0.1 - 1.0.4 + 1.0.5 2.16.0 4.3.1 2.1.6 + 2.6.5 + 0.2.1.RELEASE + 0.0.2 1.1.0 1.1.8 1.1.0 @@ -176,6 +180,29 @@ + + + + com.alibaba.fescar + fescar-core + ${fescar.version} + + + com.alibaba.fescar + fescar-common + ${fescar.version} + + + com.alibaba.fescar + fescar-spring + ${fescar.version} + + + com.alibaba.fescar + fescar-rm-datasource + ${fescar.version} + + com.aliyun.oss @@ -183,6 +210,49 @@ ${oss.version} + + + com.alibaba + dubbo-dependencies-bom + ${dubbo.version} + pom + import + + + + + com.alibaba + dubbo + ${dubbo.version} + + + org.springframework + spring-context + + + javax.servlet + servlet-api + + + log4j + log4j + + + + + + + com.alibaba.boot + dubbo-spring-boot-starter + ${dubbo-spring-boot.version} + + + + + com.alibaba + dubbo-registry-nacos + ${dubbo-registry-nacos.version} + @@ -215,6 +285,11 @@ spring-cloud-alibaba-nacos-config-server ${project.version} + + org.springframework.cloud + spring-cloud-alibaba-fescar + ${project.version} + org.springframework.cloud spring-cloud-alicloud-acm @@ -258,6 +333,12 @@ ${project.version} + + org.springframework.cloud + spring-cloud-starter-alibaba-fescar + ${project.version} + + org.springframework.cloud spring-cloud-starter-alibaba-nacos-discovery diff --git a/spring-cloud-alibaba-dubbo/pom.xml b/spring-cloud-alibaba-dubbo/pom.xml new file mode 100644 index 00000000..94467a24 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/pom.xml @@ -0,0 +1,179 @@ + + + + spring-cloud-alibaba + org.springframework.cloud + 0.2.2.BUILD-SNAPSHOT + ../pom.xml + + 4.0.0 + + spring-cloud-alibaba-dubbo + Spring Cloud Alibaba Dubbo + + + + + + org.springframework.boot + spring-boot-actuator + true + + + + org.springframework.boot + spring-boot-actuator-autoconfigure + true + + + + org.springframework.boot + spring-boot-configuration-processor + true + + + + org.springframework.boot + spring-boot + true + + + + org.springframework.boot + spring-boot-autoconfigure + true + + + + + org.springframework.cloud + spring-cloud-commons + true + + + + org.springframework.cloud + spring-cloud-context + true + + + + org.springframework.cloud + spring-cloud-alibaba-nacos-config + + + + org.springframework.cloud + spring-cloud-starter-openfeign + true + + + + + com.alibaba.boot + dubbo-spring-boot-starter + + + + com.alibaba + dubbo + + + + + io.netty + netty-all + + + + + org.jboss.resteasy + resteasy-jaxrs + + + + org.jboss.resteasy + resteasy-client + + + + org.jboss.resteasy + resteasy-netty4 + + + + javax.validation + validation-api + + + + org.jboss.resteasy + resteasy-jackson-provider + + + + org.jboss.resteasy + resteasy-jaxb-provider + + + + javax.servlet + javax.servlet-api + provided + + + + + io.github.openfeign + feign-jaxrs2 + 9.7.0 + + + + org.apache.commons + commons-lang3 + + + + + junit + junit + test + + + + org.springframework + spring-test + test + + + + org.springframework.boot + spring-boot-starter-web + test + + + + org.springframework.boot + spring-boot-test + test + + + + + org.springframework.cloud + spring-cloud-starter-alibaba-nacos-discovery + test + + + + + + + + + + + \ No newline at end of file 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 new file mode 100644 index 00000000..cd4422c7 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboMetadataAutoConfiguration.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.autoconfigure; + +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; +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.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Import; + +/** + * Spring Boot Auto-Configuration class for Dubbo Metadata + * + * @author Mercy + */ +@Configuration +@Import(DubboServiceMetadataRepository.class) +public class DubboMetadataAutoConfiguration { + + @Bean + @ConditionalOnBean(NacosConfigProperties.class) + public MetadataConfigService metadataConfigService() { + return new NacosMetadataConfigService(); + } + +} \ 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 new file mode 100644 index 00000000..d37d8dc0 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboOpenFeignAutoConfiguration.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 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.resolver.MetadataResolver; +import org.springframework.cloud.alibaba.dubbo.openfeign.DubboFeignClientsConfiguration; +import org.springframework.cloud.openfeign.EnableFeignClients; +import org.springframework.cloud.openfeign.FeignAutoConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + + +/** + * Dubbo Feign Auto-{@link Configuration Configuration} + * + * @author Mercy + */ +@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); + } +} \ 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 new file mode 100644 index 00000000..7c7aa9fd --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboRestMetadataRegistrationAutoConfiguration.java @@ -0,0 +1,86 @@ +/* + * 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 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.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +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.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} + * will be registered Spring Cloud registry. + * + * @author Mercy + */ +@ConditionalOnProperty(value = "spring.cloud.service-registry.auto-registration.enabled", matchIfMissing = true) +@ConditionalOnMissingBean(value = { + MetadataResolver.class, + MetadataConfigService.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; + + @EventListener(ServiceBeanExportedEvent.class) + public void recordRestMetadata(ServiceBeanExportedEvent event) throws JsonProcessingException { + ServiceBean serviceBean = event.getServiceBean(); + serviceRestMetadata.addAll(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/context/DubboServiceRegistrationApplicationContextInitializer.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/context/DubboServiceRegistrationApplicationContextInitializer.java new file mode 100644 index 00000000..f1283e91 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/context/DubboServiceRegistrationApplicationContextInitializer.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.context; + +import org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegistryFactory; +import org.springframework.context.ApplicationContextInitializer; +import org.springframework.context.ConfigurableApplicationContext; + +/** + * The Dubbo services will be registered as the specified Spring cloud applications that will not be considered + * normal ones, but only are used to Dubbo's service discovery even if it is based on Spring Cloud Commons abstraction. + * However, current application will be registered by other DiscoveryClientAutoConfiguration. + * + * @author Mercy + */ +public class DubboServiceRegistrationApplicationContextInitializer implements + ApplicationContextInitializer { + + @Override + public void initialize(ConfigurableApplicationContext applicationContext) { + // Set ApplicationContext into SpringCloudRegistryFactory before Dubbo Service Register + SpringCloudRegistryFactory.setApplicationContext(applicationContext); + } +} 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 new file mode 100644 index 00000000..18abf0e9 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/MethodMetadata.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.metadata; + +import com.fasterxml.jackson.annotation.JsonIgnore; +import org.apache.commons.lang3.ClassUtils; + +import java.lang.reflect.Method; +import java.lang.reflect.Parameter; +import java.util.ArrayList; +import java.util.Collections; +import java.util.LinkedList; +import java.util.List; +import java.util.Objects; + +/** + * {@link Method} Metadata + * + * @author Mercy + */ +public class MethodMetadata { + + private String name; + + private String returnType; + + private List params; + + @JsonIgnore + private Method method; + + public MethodMetadata() { + this.params = new LinkedList<>(); + } + + public MethodMetadata(Method method) { + this.name = method.getName(); + this.returnType = ClassUtils.getName(method.getReturnType()); + this.params = initParameters(method); + this.method = method; + } + + private List initParameters(Method method) { + int parameterCount = method.getParameterCount(); + if (parameterCount < 1) { + return Collections.emptyList(); + } + List params = new ArrayList<>(parameterCount); + Parameter[] parameters = method.getParameters(); + for (int i = 0; i < parameterCount; i++) { + Parameter parameter = parameters[i]; + MethodParameterMetadata param = toMethodParameterMetadata(i, parameter); + params.add(param); + } + return params; + } + + private MethodParameterMetadata toMethodParameterMetadata(int index, Parameter parameter) { + MethodParameterMetadata metadata = new MethodParameterMetadata(); + metadata.setIndex(index); + metadata.setName(parameter.getName()); + metadata.setType(parameter.getType().getTypeName()); + return metadata; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public String getReturnType() { + return returnType; + } + + public void setReturnType(String returnType) { + this.returnType = returnType; + } + + public List getParams() { + return params; + } + + public void setParams(List params) { + this.params = params; + } + + public Method getMethod() { + return method; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + MethodMetadata that = (MethodMetadata) o; + return Objects.equals(name, that.name) && + Objects.equals(returnType, that.returnType) && + Objects.equals(params, that.params); + } + + @Override + public int hashCode() { + return Objects.hash(name, returnType, params); + } +} 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 new file mode 100644 index 00000000..fbcaad00 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/MethodParameterMetadata.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.metadata; + +import java.lang.reflect.Method; +import java.util.Objects; + +/** + * {@link Method} Parameter Metadata + * + * @author Mercy + */ +public class MethodParameterMetadata { + + private int index; + + private String name; + + private String type; + + public int getIndex() { + return index; + } + + public void setIndex(int index) { + this.index = index; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + MethodParameterMetadata that = (MethodParameterMetadata) o; + return index == that.index && + Objects.equals(name, that.name) && + Objects.equals(type, that.type); + } + + @Override + public int hashCode() { + return Objects.hash(index, name, 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 new file mode 100644 index 00000000..ae3d10dc --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/RequestMetadata.java @@ -0,0 +1,97 @@ +/* + * 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 feign.RequestTemplate; + +import java.util.Collection; +import java.util.Map; +import java.util.Objects; + +/** + * Request Metadata + * + * @author Mercy + */ +public class RequestMetadata { + + private String method; + + private String url; + + private Map> queries; + + private Map> headers; + + public RequestMetadata() { + } + + public RequestMetadata(RequestTemplate requestTemplate) { + this.method = requestTemplate.method(); + this.url = requestTemplate.url(); + this.queries = requestTemplate.queries(); + this.headers = requestTemplate.headers(); + } + + public String getMethod() { + return method; + } + + public void setMethod(String method) { + this.method = method; + } + + public String getUrl() { + return url; + } + + public void setUrl(String url) { + this.url = url; + } + + public Map> getHeaders() { + return headers; + } + + public void setHeaders(Map> headers) { + this.headers = headers; + } + + public Map> getQueries() { + return queries; + } + + public void setQueries(Map> queries) { + this.queries = queries; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) 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); + } + + @Override + public int hashCode() { + return Objects.hash(method, url, queries, headers); + } +} 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 new file mode 100644 index 00000000..5024fefa --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/RestMethodMetadata.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.metadata; + +import java.util.Collection; +import java.util.Map; +import java.util.Objects; + +/** + * Method Request Metadata + */ +public class RestMethodMetadata { + + private MethodMetadata method; + + private RequestMetadata request; + + private Map> indexToName; + + public MethodMetadata getMethod() { + return method; + } + + public void setMethod(MethodMetadata method) { + this.method = method; + } + + public RequestMetadata getRequest() { + return request; + } + + public void setRequest(RequestMetadata request) { + this.request = request; + } + + public Map> getIndexToName() { + return indexToName; + } + + public void setIndexToName(Map> indexToName) { + this.indexToName = indexToName; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + RestMethodMetadata that = (RestMethodMetadata) o; + return Objects.equals(method, that.method) && + Objects.equals(request, that.request) && + Objects.equals(indexToName, that.indexToName); + } + + @Override + public int hashCode() { + return Objects.hash(method, request, indexToName); + } +} 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 new file mode 100644 index 00000000..d5ba11f4 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/ServiceRestMetadata.java @@ -0,0 +1,66 @@ +/* + * 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.Set; + +/** + * Service Rest Metadata + * + * @author Mercy + * @see RestMethodMetadata + */ +public class ServiceRestMetadata { + + private String name; + + private Set meta; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public Set getMeta() { + return meta; + } + + public void setMeta(Set meta) { + this.meta = meta; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) 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; + } + + @Override + public int hashCode() { + int result = name != null ? name.hashCode() : 0; + result = 31 * result + (meta != null ? meta.hashCode() : 0); + return result; + } +} 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 new file mode 100644 index 00000000..57a0a133 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/repository/DubboServiceMetadataRepository.java @@ -0,0 +1,118 @@ +/* + * 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.repository; + +import com.alibaba.dubbo.config.spring.ReferenceBean; +import com.alibaba.dubbo.rpc.service.GenericService; +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.metadata.RequestMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.ServiceRestMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.service.MetadataConfigService; +import org.springframework.stereotype.Repository; + +import java.util.Collections; +import java.util.HashMap; +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; + +/** + * Dubbo Service Metadata {@link Repository} + * + * @author Mercy + */ +@Repository +public class DubboServiceMetadataRepository { + + /** + * Key is application name + * Value is Map + */ + private Map> genericServicesRepository = new HashMap<>(); + + private Map> methodMetadataRepository = new HashMap<>(); + + @Autowired + private MetadataConfigService metadataConfigService; + + @Value("${dubbo.target.protocol:dubbo}") + private String targetProtocol; + + @Value("${dubbo.target.cluster:failover}") + private String targetCluster; + + public void updateMetadata(String serviceName) { + + Map genericServicesMap = genericServicesRepository.computeIfAbsent(serviceName, k -> new HashMap<>()); + + Map methodMetadataMap = methodMetadataRepository.computeIfAbsent(serviceName, k -> new HashMap<>()); + + Set serviceRestMetadataSet = metadataConfigService.getServiceRestMetadata(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()); + }); + } + } + + public GenericService getGenericService(String serviceName, RequestMetadata requestMetadata) { + return getGenericServicesMap(serviceName).get(requestMetadata); + } + + public MethodMetadata getMethodMetadata(String serviceName, RequestMetadata requestMetadata) { + return getMethodMetadataMap(serviceName).get(requestMetadata); + } + + 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 getGenericServicesMap(String serviceName) { + return genericServicesRepository.getOrDefault(serviceName, Collections.emptyMap()); + } + + private Map getMethodMetadataMap(String serviceName) { + return methodMetadataRepository.getOrDefault(serviceName, Collections.emptyMap()); + } + +} 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/FeignMetadataResolver.java new file mode 100644 index 00000000..e7f80dd4 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/FeignMetadataResolver.java @@ -0,0 +1,190 @@ +/* + * 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 com.alibaba.dubbo.common.URL; +import com.alibaba.dubbo.config.spring.ServiceBean; +import feign.Contract; +import feign.Feign; +import feign.MethodMetadata; +import feign.Util; +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; +import org.springframework.util.ClassUtils; + +import java.lang.reflect.Method; +import java.lang.reflect.Modifier; +import java.util.Collection; +import java.util.Collections; +import java.util.LinkedHashSet; +import java.util.LinkedList; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +/** + * The metadata resolver for {@link Feign} + * + * @author Mercy + */ +public class FeignMetadataResolver 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 ClassLoader classLoader; + + /** + * Feign Contracts + */ + private Collection contracts; + + public FeignMetadataResolver(String currentApplicationName, ObjectProvider contract) { + this.currentApplicationName = currentApplicationName; + this.contract = contract; + } + + @Override + public void afterSingletonsInstantiated() { + + LinkedList contracts = new LinkedList<>(); + + // Add injected Contract if available, for example SpringMvcContract Bean under Spring Cloud Open Feign + contract.ifAvailable(contracts::add); + + Stream.of(CONTRACT_CLASS_NAMES) + .filter(this::isClassPresent) // filter the existed classes + .map(this::loadContractClass) // load Contract Class + .map(this::createContract) // create instance by the specified class + .forEach(contracts::add); // add the Contract instance into contracts + + this.contracts = Collections.unmodifiableCollection(contracts); + } + + private Contract createContract(Class contractClassName) { + return (Contract) BeanUtils.instantiateClass(contractClassName); + } + + private Class loadContractClass(String contractClassName) { + return ClassUtils.resolveClassName(contractClassName, classLoader); + } + + private boolean isClassPresent(String className) { + return ClassUtils.isPresent(className, classLoader); + } + + @Override + public Set resolveServiceRestMetadata(ServiceBean serviceBean) { + + Object bean = serviceBean.getRef(); + + Class beanType = bean.getClass(); + + Set serviceRestMetadata = new LinkedHashSet<>(); + + Set methodRestMetadata = resolveMethodRestMetadata(beanType); + + List urls = serviceBean.getExportedUrls(); + + urls.stream() + .map(SpringCloudRegistry::getServiceName) + .forEach(serviceName -> { + ServiceRestMetadata metadata = new ServiceRestMetadata(); + metadata.setName(serviceName); + metadata.setMeta(methodRestMetadata); + serviceRestMetadata.add(metadata); + }); + + return serviceRestMetadata; + } + + @Override + public Set resolveMethodRestMetadata(Class targetType) { + List feignContractMethods = selectFeignContractMethods(targetType); + return contracts.stream() + .map(contract -> contract.parseAndValidatateMetadata(targetType)) + .flatMap(v -> v.stream()) + .map(methodMetadata -> resolveMethodRestMetadata(methodMetadata, targetType, feignContractMethods)) + .collect(Collectors.toSet()); + } + + /** + * Select feign contract methods + *

+ * extract some code from {@link Contract.BaseContract#parseAndValidatateMetadata(java.lang.Class)} + * + * @param targetType + * @return non-null + */ + private List selectFeignContractMethods(Class targetType) { + List methods = new LinkedList<>(); + for (Method method : targetType.getMethods()) { + if (method.getDeclaringClass() == Object.class || + (method.getModifiers() & Modifier.STATIC) != 0 || + Util.isDefault(method)) { + continue; + } + methods.add(method); + } + return methods; + } + + protected RestMethodMetadata resolveMethodRestMetadata(MethodMetadata methodMetadata, Class targetType, + List feignContractMethods) { + String configKey = methodMetadata.configKey(); + Method feignContractMethod = getMatchedFeignContractMethod(targetType, feignContractMethods, configKey); + + RestMethodMetadata metadata = new RestMethodMetadata(); + + metadata.setRequest(new RequestMetadata(methodMetadata.template())); + metadata.setMethod(new org.springframework.cloud.alibaba.dubbo.metadata.MethodMetadata(feignContractMethod)); + metadata.setIndexToName(methodMetadata.indexToName()); + + return metadata; + } + + private Method getMatchedFeignContractMethod(Class targetType, List methods, String expectedConfigKey) { + Method matchedMethod = null; + for (Method method : methods) { + String configKey = Feign.configKey(targetType, method); + if (expectedConfigKey.equals(configKey)) { + matchedMethod = method; + break; + } + } + return matchedMethod; + } + + @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/metadata/resolver/MetadataResolver.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/MetadataResolver.java new file mode 100644 index 00000000..4956e387 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/resolver/MetadataResolver.java @@ -0,0 +1,47 @@ +/* + * 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 com.alibaba.dubbo.config.spring.ServiceBean; +import org.springframework.cloud.alibaba.dubbo.metadata.RestMethodMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.ServiceRestMetadata; + +import java.util.Set; + +/** + * The REST metadata resolver + * + * @author Mercy + */ +public interface MetadataResolver { + + /** + * Resolve the {@link ServiceRestMetadata} {@link Set set} from {@link ServiceBean} + * + * @param serviceBean {@link ServiceBean} + * @return non-null {@link Set} + */ + Set resolveServiceRestMetadata(ServiceBean serviceBean); + + /** + * Resolve {@link RestMethodMetadata} {@link Set set} from {@link Class target type} + * + * @param targetType {@link Class target type} + * @return non-null {@link Set} + */ + Set resolveMethodRestMetadata(Class targetType); +} 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/metadata/service/MetadataConfigService.java new file mode 100644 index 00000000..28b7a373 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/service/MetadataConfigService.java @@ -0,0 +1,33 @@ +/* + * 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 org.springframework.cloud.alibaba.dubbo.metadata.ServiceRestMetadata; + +import java.util.Set; + +/** + * Config Service for Metadata + * + * @author Mercy + */ +public interface MetadataConfigService { + + void publishServiceRestMetadata(String serviceName, Set serviceRestMetadata); + + Set getServiceRestMetadata(String serviceName); +} 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 new file mode 100644 index 00000000..93ce9281 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/metadata/service/NacosMetadataConfigService.java @@ -0,0 +1,97 @@ +/* + * 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 new file mode 100644 index 00000000..0c4d7400 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboFeignClientsConfiguration.java @@ -0,0 +1,65 @@ +/* + * 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 new file mode 100644 index 00000000..622ae340 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboInvocationHandler.java @@ -0,0 +1,69 @@ +/* + * 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.MethodMetadata; +import org.springframework.cloud.alibaba.dubbo.metadata.MethodParameterMetadata; + +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.Method; +import java.util.Map; + +/** + * Dubbo {@link GenericService} for {@link InvocationHandler} + * + * @author Mercy + */ +public class DubboInvocationHandler implements InvocationHandler { + + private final Map genericServicesMap; + + private final Map methodMetadata; + + private final InvocationHandler defaultInvocationHandler; + + public DubboInvocationHandler(Map genericServicesMap, + Map methodMetadata, + InvocationHandler defaultInvocationHandler) { + this.genericServicesMap = genericServicesMap; + this.methodMetadata = methodMetadata; + this.defaultInvocationHandler = defaultInvocationHandler; + } + + @Override + public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { + + GenericService genericService = genericServicesMap.get(method); + + MethodMetadata methodMetadata = this.methodMetadata.get(method); + + if (genericService == null || methodMetadata == null) { + return defaultInvocationHandler.invoke(proxy, method, args); + } + + String methodName = methodMetadata.getName(); + + String[] parameterTypes = methodMetadata + .getParams() + .stream() + .map(MethodParameterMetadata::getType) + .toArray(String[]::new); + + return genericService.$invoke(methodName, parameterTypes, args); + } +} 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 new file mode 100644 index 00000000..4fd67f40 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/openfeign/DubboInvocationHandlerFactory.java @@ -0,0 +1,101 @@ +/* + * 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/registry/DubboRegistration.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/registry/DubboRegistration.java new file mode 100644 index 00000000..9a435ff2 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/registry/DubboRegistration.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.registry; + +import org.springframework.cloud.client.ServiceInstance; +import org.springframework.cloud.client.serviceregistry.Registration; + +import java.net.URI; +import java.util.Map; + +/** + * The {@link Registration} of Dubbo uses an external of {@link ServiceInstance} instance as the delegate. + * + * @author Mercy + */ +class DubboRegistration implements Registration { + + private final ServiceInstance delegate; + + public DubboRegistration(ServiceInstance delegate) { + this.delegate = delegate; + } + + @Override + public String getServiceId() { + return delegate.getServiceId(); + } + + @Override + public String getHost() { + return delegate.getHost(); + } + + @Override + public int getPort() { + return delegate.getPort(); + } + + @Override + public boolean isSecure() { + return delegate.isSecure(); + } + + @Override + public URI getUri() { + return delegate.getUri(); + } + + @Override + public Map getMetadata() { + return delegate.getMetadata(); + } + + @Override + public String getScheme() { + return delegate.getScheme(); + } +} 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 new file mode 100644 index 00000000..1904cbd5 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/registry/SpringCloudRegistry.java @@ -0,0 +1,443 @@ +/* + * 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.registry; + +import com.alibaba.dubbo.common.Constants; +import com.alibaba.dubbo.common.URL; +import com.alibaba.dubbo.common.utils.NetUtils; +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; +import org.springframework.cloud.client.ServiceInstance; +import org.springframework.cloud.client.discovery.DiscoveryClient; +import org.springframework.cloud.client.serviceregistry.Registration; +import org.springframework.cloud.client.serviceregistry.ServiceRegistry; +import org.springframework.util.StringUtils; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.LinkedList; +import java.util.List; +import java.util.Objects; +import java.util.concurrent.Executors; +import java.util.concurrent.ScheduledExecutorService; +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; + +/** + * Dubbo {@link RegistryFactory} uses Spring Cloud Service Registration abstraction, whose protocol is "spring-cloud" + * + * @author Mercy + */ +public class SpringCloudRegistry extends FailbackRegistry { + + /** + * All supported categories + */ + private static final String[] ALL_SUPPORTED_CATEGORIES = of( + PROVIDERS_CATEGORY, + CONSUMERS_CATEGORY, + ROUTERS_CATEGORY, + CONFIGURATORS_CATEGORY + ); + + private static final int CATEGORY_INDEX = 0; + + private static final int PROTOCOL_INDEX = CATEGORY_INDEX + 1; + + private static final int SERVICE_INTERFACE_INDEX = PROTOCOL_INDEX + 1; + + private static final int SERVICE_VERSION_INDEX = SERVICE_INTERFACE_INDEX + 1; + + private static final int SERVICE_GROUP_INDEX = SERVICE_VERSION_INDEX + 1; + + private static final String WILDCARD = "*"; + + /** + * The separator for service name + */ + private static final String SERVICE_NAME_SEPARATOR = ":"; + + private final ServiceRegistry serviceRegistry; + + private final DiscoveryClient discoveryClient; + + private final Logger logger = LoggerFactory.getLogger(getClass()); + + /** + * {@link ScheduledExecutorService} lookup service names(only for Dubbo-OPS) + */ + private volatile ScheduledExecutorService scheduledExecutorService; + + /** + * The interval in second of lookup service names(only for Dubbo-OPS) + */ + private static final long LOOKUP_INTERVAL = Long.getLong("dubbo.service.names.lookup.interval", 30); + + public SpringCloudRegistry(URL url, ServiceRegistry serviceRegistry, + DiscoveryClient discoveryClient) { + super(url); + this.serviceRegistry = serviceRegistry; + this.discoveryClient = discoveryClient; + } + + @Override + protected void doRegister(URL url) { + final String serviceName = getServiceName(url); + final Registration registration = createRegistration(serviceName, url); + serviceRegistry.register(registration); + } + + @Override + protected void doUnregister(URL url) { + final String serviceName = getServiceName(url); + final Registration registration = createRegistration(serviceName, url); + this.serviceRegistry.deregister(registration); + } + + @Override + protected void doSubscribe(URL url, NotifyListener listener) { + List serviceNames = getServiceNames(url, listener); + doSubscribe(url, listener, serviceNames); + } + + @Override + protected void doUnsubscribe(URL url, NotifyListener listener) { + if (isAdminProtocol(url)) { + shutdownServiceNamesLookup(); + } + } + + @Override + public boolean isAvailable() { + return false; + } + + private void shutdownServiceNamesLookup() { + if (scheduledExecutorService != null) { + scheduledExecutorService.shutdown(); + } + } + + private Registration createRegistration(String serviceName, URL url) { + return new DubboRegistration(createServiceInstance(serviceName, url)); + } + + private ServiceInstance createServiceInstance(String serviceName, URL url) { + // Append default category if absent + String category = url.getParameter(Constants.CATEGORY_KEY, Constants.DEFAULT_CATEGORY); + URL newURL = url.addParameter(Constants.CATEGORY_KEY, category); + newURL = newURL.addParameter(Constants.PROTOCOL_KEY, url.getProtocol()); + String ip = NetUtils.getLocalHost(); + int port = newURL.getParameter(Constants.BIND_PORT_KEY, url.getPort()); + DefaultServiceInstance serviceInstance = new DefaultServiceInstance(serviceName, ip, port, false); + serviceInstance.getMetadata().putAll(new LinkedHashMap<>(newURL.getParameters())); + return serviceInstance; + } + + public static String getServiceName(URL url) { + String category = url.getParameter(Constants.CATEGORY_KEY, Constants.DEFAULT_CATEGORY); + return getServiceName(url, category); + } + + 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); + return serviceNameBuilder.toString(); + } + + private static void appendIfPresent(StringBuilder target, URL url, String parameterName) { + String parameterValue = url.getParameter(parameterName); + appendIfPresent(target, parameterValue); + } + + private static void appendIfPresent(StringBuilder target, String parameterValue) { + if (StringUtils.hasText(parameterValue)) { + target.append(SERVICE_NAME_SEPARATOR).append(parameterValue); + } + } + + private void filterServiceNames(List serviceNames, URL url) { + + final String[] categories = getCategories(url); + + final String targetServiceInterface = url.getServiceInterface(); + + final String targetVersion = url.getParameter(Constants.VERSION_KEY); + + final String targetGroup = url.getParameter(Constants.GROUP_KEY); + + filter(serviceNames, new Filter() { + @Override + public boolean accept(String serviceName) { + // 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 + String[] segments = getServiceSegments(serviceName); + int length = segments.length; + if (length < 4) { // must present 4 segments or more + return false; + } + + String category = getCategory(segments); + if (Arrays.binarySearch(categories, category) > -1) { // no match category + 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 + return false; + } + + String version = getServiceVersion(segments); + if (!WILDCARD.equals(targetVersion) && + !Objects.equals(targetVersion, version)) { // no match service version + return false; + } + + String group = getServiceGroup(segments); + if (group != null && !WILDCARD.equals(targetGroup) + && !Objects.equals(targetGroup, group)) { // no match service group + return false; + } + + return true; + } + }); + } + + public static String[] getServiceSegments(String serviceName) { + return StringUtils.delimitedListToStringArray(serviceName, SERVICE_NAME_SEPARATOR); + } + + public static String getCategory(String[] segments) { + return segments[CATEGORY_INDEX]; + } + + public static String getProtocol(String[] segments) { + return segments[PROTOCOL_INDEX]; + } + + public static String getServiceInterface(String[] segments) { + return segments[SERVICE_INTERFACE_INDEX]; + } + + public static String getServiceVersion(String[] segments) { + return segments[SERVICE_VERSION_INDEX]; + } + + public static String getServiceGroup(String[] segments) { + return segments.length > 4 ? segments[SERVICE_GROUP_INDEX] : null; + } + + /** + * Get the categories from {@link URL} + * + * @param url {@link URL} + * @return non-null array + */ + private String[] getCategories(URL url) { + return Constants.ANY_VALUE.equals(url.getServiceInterface()) ? + ALL_SUPPORTED_CATEGORIES : of(Constants.DEFAULT_CATEGORY); + } + + private List getAllServiceNames() { + return discoveryClient.getServices(); + } + + /** + * Get the service names from the specified {@link URL url} + * + * @param url {@link URL} + * @param listener {@link NotifyListener} + * @return non-null + */ + private List getServiceNames(URL url, NotifyListener listener) { + if (isAdminProtocol(url)) { + scheduleServiceNamesLookup(url, listener); + return getServiceNamesForOps(url); + } else { + return doGetServiceNames(url); + } + } + + + private boolean isAdminProtocol(URL url) { + return Constants.ADMIN_PROTOCOL.equals(url.getProtocol()); + } + + private void scheduleServiceNamesLookup(final URL url, final NotifyListener listener) { + if (scheduledExecutorService == null) { + scheduledExecutorService = Executors.newSingleThreadScheduledExecutor(); + scheduledExecutorService.scheduleAtFixedRate(new Runnable() { + @Override + public void run() { + List serviceNames = getAllServiceNames(); + filter(serviceNames, new Filter() { + @Override + public boolean accept(String serviceName) { + boolean accepted = false; + for (String category : ALL_SUPPORTED_CATEGORIES) { + String prefix = category + SERVICE_NAME_SEPARATOR; + if (StringUtils.startsWithIgnoreCase(serviceName, prefix)) { + accepted = true; + break; + } + } + return accepted; + } + }); + doSubscribe(url, listener, serviceNames); + } + }, LOOKUP_INTERVAL, LOOKUP_INTERVAL, TimeUnit.SECONDS); + } + } + + private void doSubscribe(final URL url, final NotifyListener listener, final List serviceNames) { + for (String serviceName : serviceNames) { + List serviceInstances = discoveryClient.getInstances(serviceName); + notifySubscriber(url, listener, serviceInstances); + // TODO Support Update notification event + } + } + + private List doGetServiceNames(URL url) { + String[] categories = getCategories(url); + List serviceNames = new ArrayList(categories.length); + for (String category : categories) { + final String serviceName = getServiceName(url, category); + serviceNames.add(serviceName); + } + return serviceNames; + } + + /** + * Notify the Healthy {@link ServiceInstance service instance} to subscriber. + * + * @param url {@link URL} + * @param listener {@link NotifyListener} + * @param serviceInstances all {@link ServiceInstance instances} + */ + private void notifySubscriber(URL url, NotifyListener listener, List serviceInstances) { + List healthyInstances = new LinkedList(serviceInstances); + // Healthy Instances + filterHealthyInstances(healthyInstances); + List urls = buildURLs(url, healthyInstances); + this.notify(url, listener, urls); + } + + private void filterHealthyInstances(Collection instances) { + filter(instances, new Filter() { + @Override + public boolean accept(ServiceInstance data) { + // TODO check the details of status +// return serviceRegistry.getStatus(new DubboRegistration(data)) != null; + return true; + } + }); + } + + private List buildURLs(URL consumerURL, Collection serviceInstances) { + if (serviceInstances.isEmpty()) { + return Collections.emptyList(); + } + List urls = new LinkedList(); + for (ServiceInstance serviceInstance : serviceInstances) { + URL url = buildURL(serviceInstance); + if (UrlUtils.isMatch(consumerURL, url)) { + urls.add(url); + } + } + return urls; + } + + private URL buildURL(ServiceInstance serviceInstance) { + URL url = new URL(serviceInstance.getMetadata().get(Constants.PROTOCOL_KEY), + serviceInstance.getHost(), + serviceInstance.getPort(), + serviceInstance.getMetadata()); + return url; + } + + /** + * Get the service names for Dubbo OPS + * + * @param url {@link URL} + * @return non-null + */ + private List getServiceNamesForOps(URL url) { + List serviceNames = getAllServiceNames(); + filterServiceNames(serviceNames, url); + return serviceNames; + } + + private void filter(Collection collection, Filter filter) { + Iterator iterator = collection.iterator(); + while (iterator.hasNext()) { + T data = iterator.next(); + if (!filter.accept(data)) { // remove if not accept + iterator.remove(); + } + } + } + + private static T[] of(T... values) { + return values; + } + + /** + * A filter + */ + private interface Filter { + + /** + * Tests whether or not the specified data should be accepted. + * + * @param data The data to be tested + * @return true if and only if data + * should be accepted + */ + boolean accept(T data); + + } + +} diff --git a/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/registry/SpringCloudRegistryFactory.java b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/registry/SpringCloudRegistryFactory.java new file mode 100644 index 00000000..7402ff97 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/java/org/springframework/cloud/alibaba/dubbo/registry/SpringCloudRegistryFactory.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.registry; + +import com.alibaba.dubbo.common.URL; +import com.alibaba.dubbo.registry.Registry; +import com.alibaba.dubbo.registry.RegistryFactory; + +import org.springframework.cloud.client.discovery.DiscoveryClient; +import org.springframework.cloud.client.serviceregistry.Registration; +import org.springframework.cloud.client.serviceregistry.ServiceRegistry; +import org.springframework.context.ApplicationContext; + +/** + * Dubbo {@link RegistryFactory} uses Spring Cloud Service Registration abstraction, whose protocol is "spring-cloud" + * + * @author Mercy + * @see RegistryFactory + * @see SpringCloudRegistry + */ +public class SpringCloudRegistryFactory implements RegistryFactory { + + private static ApplicationContext applicationContext; + + @Override + public Registry getRegistry(URL url) { + ServiceRegistry serviceRegistry = applicationContext.getBean(ServiceRegistry.class); + DiscoveryClient discoveryClient = applicationContext.getBean(DiscoveryClient.class); + return new SpringCloudRegistry(url, serviceRegistry, discoveryClient); + } + + public static void setApplicationContext(ApplicationContext applicationContext) { + SpringCloudRegistryFactory.applicationContext = applicationContext; + } +} diff --git a/spring-cloud-alibaba-dubbo/src/main/resources/META-INF/dubbo/com.alibaba.dubbo.registry.RegistryFactory b/spring-cloud-alibaba-dubbo/src/main/resources/META-INF/dubbo/com.alibaba.dubbo.registry.RegistryFactory new file mode 100644 index 00000000..77ac945a --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/resources/META-INF/dubbo/com.alibaba.dubbo.registry.RegistryFactory @@ -0,0 +1 @@ +spring-cloud=org.springframework.cloud.alibaba.dubbo.registry.SpringCloudRegistryFactory \ No newline at end of file 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 new file mode 100644 index 00000000..c2627f86 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/main/resources/META-INF/spring.factories @@ -0,0 +1,7 @@ +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.context.ApplicationContextInitializer=\ + org.springframework.cloud.alibaba.dubbo.context.DubboServiceRegistrationApplicationContextInitializer diff --git a/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboServiceRegistrationAutoConfigurationTest.java b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboServiceRegistrationAutoConfigurationTest.java new file mode 100644 index 00000000..ce32e641 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/autoconfigure/DubboServiceRegistrationAutoConfigurationTest.java @@ -0,0 +1,28 @@ +/* + * 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.test.context.SpringBootTest; + +/** + * {@link DubboServiceRegistrationAutoConfiguration} Test + * + * @author Mercy + */ +@SpringBootTest +public class DubboServiceRegistrationAutoConfigurationTest { +} 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 new file mode 100644 index 00000000..d7b3d13d --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/bootstrap/DubboSpringCloudBootstrap.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.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.client.discovery.EnableDiscoveryClient; +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.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +/** + * Dubbo Spring Cloud Bootstrap + */ +@EnableDiscoveryClient +@EnableAutoConfiguration +@EnableFeignClients +@RestController +public class DubboSpringCloudBootstrap { + + @Reference(version = "1.0.0") + private EchoService echoService; + + @Autowired + @Lazy + private FeignEchoService feignEchoService; + + @GetMapping(value = "/call/echo") + public String echo(@RequestParam("message") String message) { + return feignEchoService.echo(message); + } + + @FeignClient("spring-cloud-alibaba-dubbo") + public interface FeignEchoService { + + @GetMapping(value = "/echo") + String echo(@RequestParam("message") String message); + } + + @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")); + }; + } + + public static void main(String[] args) { + new SpringApplicationBuilder(DubboSpringCloudBootstrap.class) + .run(args); + } +} + + + 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 new file mode 100644 index 00000000..e1ad9a9d --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/DefaultEchoService.java @@ -0,0 +1,65 @@ +/* + * 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/EchoService.java new file mode 100644 index 00000000..10ace8ec --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/java/org/springframework/cloud/alibaba/dubbo/service/EchoService.java @@ -0,0 +1,30 @@ +/* + * 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; + +/** + * Echo Service + * + * @author Mercy + */ +public interface EchoService { + + String echo(String message); + + String plus(int a, int b); + +} diff --git a/spring-cloud-alibaba-dubbo/src/test/resources/application.yaml b/spring-cloud-alibaba-dubbo/src/test/resources/application.yaml new file mode 100644 index 00000000..afdfbfa7 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/resources/application.yaml @@ -0,0 +1,16 @@ +dubbo: + scan: + base-packages: org.springframework.cloud.alibaba.dubbo.service + protocols: + dubbo: + name: dubbo + port: 12345 + rest: + name: rest + port: 9090 + server: netty + registry: + address: spring-cloud://nacos + +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 new file mode 100644 index 00000000..c3799608 --- /dev/null +++ b/spring-cloud-alibaba-dubbo/src/test/resources/bootstrap.yaml @@ -0,0 +1,28 @@ +spring: + application: + name: spring-cloud-alibaba-dubbo + cloud: + nacos: + discovery: + server-addr: 127.0.0.1:8848 + config: + server-addr: 127.0.0.1:8848 + +eureka: + client: + enabled: false + +--- +spring: + profiles: eureka + cloud: + nacos: + discovery: + enabled: false + register-enabled: false + +eureka: + client: + enabled: true + service-url: + defaultZone: http://127.0.0.1:8761/eureka/ \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/env-extension/src/main/java/org/springframework/alicloud/env/extension/ImportExtraConfig.java b/spring-cloud-alibaba-examples/env-extension/src/main/java/org/springframework/alicloud/env/extension/ImportExtraConfig.java index cfea09fa..1585c4a9 100644 --- a/spring-cloud-alibaba-examples/env-extension/src/main/java/org/springframework/alicloud/env/extension/ImportExtraConfig.java +++ b/spring-cloud-alibaba-examples/env-extension/src/main/java/org/springframework/alicloud/env/extension/ImportExtraConfig.java @@ -1,7 +1,11 @@ package org.springframework.alicloud.env.extension; -import java.lang.annotation.*; +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; @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) diff --git a/spring-cloud-alibaba-examples/fescar-example/account-service/pom.xml b/spring-cloud-alibaba-examples/fescar-example/account-service/pom.xml new file mode 100644 index 00000000..219187bc --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/account-service/pom.xml @@ -0,0 +1,63 @@ + + + + spring-cloud-alibaba-examples + org.springframework.cloud + 0.2.2.BUILD-SNAPSHOT + ../../pom.xml + + 4.0.0 + account-service + + + + org.springframework.cloud + spring-cloud-starter-alibaba-fescar + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-actuator + + + org.springframework.boot + spring-boot-starter-jdbc + + + + mysql + mysql-connector-java + + + + + + + + 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/fescar-example/account-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/AccountApplication.java b/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/AccountApplication.java new file mode 100644 index 00000000..893d3464 --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/AccountApplication.java @@ -0,0 +1,32 @@ +/* + * 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.cloud.examples; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +/** + * @author xiaojing + */ +@SpringBootApplication +public class AccountApplication { + + public static void main(String[] args) { + SpringApplication.run(AccountApplication.class, args); + } + +} diff --git a/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/AccountController.java b/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/AccountController.java new file mode 100644 index 00000000..3738fb87 --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/AccountController.java @@ -0,0 +1,66 @@ +/* + * 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.cloud.examples; + +import java.util.Random; + +import com.alibaba.fescar.core.context.RootContext; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.jdbc.core.JdbcTemplate; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RestController; + +/** + * @author xiaojing + */ +@RestController +public class AccountController { + + private static final Logger LOGGER = LoggerFactory.getLogger(AccountController.class); + + private static final String SUCCESS = "SUCCESS"; + private static final String FAIL = "FAIL"; + + private final JdbcTemplate jdbcTemplate; + private Random random; + + public AccountController(JdbcTemplate jdbcTemplate) { + this.jdbcTemplate = jdbcTemplate; + this.random = new Random(); + } + + @RequestMapping(value = "/account", method = RequestMethod.POST, produces = "application/json") + public String account(String userId, int money) { + LOGGER.info("Account Service ... xid: " + RootContext.getXID()); + + if (random.nextBoolean()) { + throw new RuntimeException("this is a mock Exception"); + } + + int result = jdbcTemplate.update( + "update account_tbl set money = money - ? where user_id = ?", + new Object[] { money, userId }); + LOGGER.info("Account Service End ... "); + if (result == 1) { + return SUCCESS; + } + return FAIL; + } + +} diff --git a/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/DatabaseConfiguration.java b/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/DatabaseConfiguration.java new file mode 100644 index 00000000..62e11cd6 --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/DatabaseConfiguration.java @@ -0,0 +1,92 @@ +/* + * 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.cloud.examples; + +import java.sql.SQLException; +import java.util.Random; + +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.env.Environment; +import org.springframework.jdbc.core.JdbcTemplate; + +import com.alibaba.druid.pool.DruidDataSource; +import com.alibaba.fescar.rm.datasource.DataSourceProxy; + +/** + * @author xiaojing + */ +@Configuration +public class DatabaseConfiguration { + + private final ApplicationContext applicationContext; + + public DatabaseConfiguration(ApplicationContext applicationContext) { + this.applicationContext = applicationContext; + } + + @Bean(initMethod = "init", destroyMethod = "close") + public DruidDataSource storageDataSource() throws SQLException { + + Environment environment = applicationContext.getEnvironment(); + + String ip = environment.getProperty("mysql.server.ip"); + String port = environment.getProperty("mysql.server.port"); + String dbName = environment.getProperty("mysql.db.name"); + + String userName = environment.getProperty("mysql.user.name"); + String password = environment.getProperty("mysql.user.password"); + + DruidDataSource druidDataSource = new DruidDataSource(); + druidDataSource.setUrl("jdbc:mysql://" + ip + ":" + port + "/" + dbName); + druidDataSource.setUsername(userName); + druidDataSource.setPassword(password); + druidDataSource.setDriverClassName("com.mysql.jdbc.Driver"); + druidDataSource.setInitialSize(0); + druidDataSource.setMaxActive(180); + druidDataSource.setMaxWait(60000); + druidDataSource.setMinIdle(0); + druidDataSource.setValidationQuery("Select 'x' from DUAL"); + druidDataSource.setTestOnBorrow(false); + druidDataSource.setTestOnReturn(false); + druidDataSource.setTestWhileIdle(true); + druidDataSource.setTimeBetweenEvictionRunsMillis(60000); + druidDataSource.setMinEvictableIdleTimeMillis(25200000); + druidDataSource.setRemoveAbandoned(true); + druidDataSource.setRemoveAbandonedTimeout(1800); + druidDataSource.setLogAbandoned(true); + druidDataSource.setFilters("mergeStat"); + return druidDataSource; + } + + @Bean + public DataSourceProxy dataSourceProxy(DruidDataSource druidDataSource) { + return new DataSourceProxy(druidDataSource); + } + + @Bean + public JdbcTemplate jdbcTemplate(DataSourceProxy dataSourceProxy) { + JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSourceProxy); + + jdbcTemplate.update("delete from account_tbl where user_id = 'U100001'"); + jdbcTemplate.update( + "insert into account_tbl(user_id, money) values ('U100001', 10000)"); + + return jdbcTemplate; + } + +} diff --git a/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/resources/application.conf b/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/resources/application.conf new file mode 100644 index 00000000..b264dd9d --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/resources/application.conf @@ -0,0 +1,30 @@ +transport { + # tcp udt unix-domain-socket + type = "TCP" + #NIO NATIVE + server = "NIO" + #thread factory for netty + thread-factory { + boss-thread-prefix = "NettyBoss" + worker-thread-prefix = "NettyServerNIOWorker" + server-executor-thread-prefix = "NettyServerBizHandler" + share-boss-worker = false + client-selector-thread-prefix = "NettyClientSelector" + client-selector-thread-size = 1 + client-worker-thread-prefix = "NettyClientWorkerThread" + # netty boss thread size,will not be used for UDT + boss-thread-size = 1 + #auto default pin or 8 + worker-thread-size = 8 + } +} +service { + #vgroup->rgroup + vgroup_mapping.account-service-fescar-service-group = "localRgroup" + #only support single node + localRgroup.grouplist = "127.0.0.1:8091" + #degrade current not support + enableDegrade = false + #disable + disable = false +} diff --git a/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/resources/application.properties b/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/resources/application.properties new file mode 100644 index 00000000..10f45c59 --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/account-service/src/main/resources/application.properties @@ -0,0 +1,9 @@ +spring.application.name=account-service +server.port=18084 + +mysql.server.ip=127.0.0.1 +mysql.server.port=3306 +mysql.db.name=demo + +mysql.user.name=xxxxx +mysql.user.password=xxxxx \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/fescar-example/business-service/pom.xml b/spring-cloud-alibaba-examples/fescar-example/business-service/pom.xml new file mode 100644 index 00000000..6d77872a --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/business-service/pom.xml @@ -0,0 +1,62 @@ + + + + spring-cloud-alibaba-examples + org.springframework.cloud + 0.2.2.BUILD-SNAPSHOT + ../../pom.xml + + 4.0.0 + business-service + + + + org.springframework.cloud + spring-cloud-starter-alibaba-fescar + + + org.springframework.cloud + spring-cloud-starter-openfeign + + + org.springframework.cloud + spring-cloud-starter-netflix-hystrix + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-actuator + + + org.springframework.cloud + spring-cloud-starter-alibaba-sentinel + + + + + + + + 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/fescar-example/business-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/BusinessApplication.java b/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/BusinessApplication.java new file mode 100644 index 00000000..c0ed45fc --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/BusinessApplication.java @@ -0,0 +1,63 @@ +/* + * 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.cloud.examples; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.cloud.openfeign.EnableFeignClients; +import org.springframework.cloud.openfeign.FeignClient; +import org.springframework.context.annotation.Bean; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.client.RestTemplate; + +/** + * @author xiaojing + */ +@SpringBootApplication +@EnableFeignClients +public class BusinessApplication { + + public static void main(String[] args) { + SpringApplication.run(BusinessApplication.class, args); + } + + @Bean + public RestTemplate restTemplate() { + return new RestTemplate(); + } + + @FeignClient(value = "storage", url = "http://127.0.0.1:18082") + public interface StorageService { + + @RequestMapping(path = "/storage/{commodityCode}/{count}") + String storage(@RequestParam("commodityCode") String commodityCode, + @RequestParam("count") int count); + + } + + @FeignClient(value = "order", url = "http://127.0.0.1:18083") + public interface OrderService { + + @RequestMapping(path = "/order", method = RequestMethod.POST) + String order(@RequestParam("userId") String userId, + @RequestParam("commodityCode") String commodityCode, + @RequestParam("orderCount") int orderCount); + + } +} diff --git a/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/HomeController.java b/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/HomeController.java new file mode 100644 index 00000000..039074ec --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/HomeController.java @@ -0,0 +1,117 @@ +/* + * 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.cloud.examples; + +import com.alibaba.fescar.spring.annotation.GlobalTransactional; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.cloud.alibaba.cloud.examples.BusinessApplication.OrderService; +import org.springframework.cloud.alibaba.cloud.examples.BusinessApplication.StorageService; +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.util.LinkedMultiValueMap; +import org.springframework.util.MultiValueMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.client.RestTemplate; + +/** + * @author xiaojing + */ +@RestController +public class HomeController { + + private static final Logger LOGGER = LoggerFactory.getLogger(HomeController.class); + + private static final String SUCCESS = "SUCCESS"; + private static final String FAIL = "FAIL"; + private static final String USER_ID = "U100001"; + private static final String COMMODITY_CODE = "C00321"; + private static final int ORDER_COUNT = 2; + + private final RestTemplate restTemplate; + private final OrderService orderService; + private final StorageService storageService; + + public HomeController(RestTemplate restTemplate, OrderService orderService, + StorageService storageService) { + this.restTemplate = restTemplate; + this.orderService = orderService; + this.storageService = storageService; + } + + @GlobalTransactional(timeoutMills = 300000, name = "spring-cloud-demo-tx") + @RequestMapping(value = "/fescar/rest", method = RequestMethod.GET, produces = "application/json") + public String rest() { + + String result = restTemplate.getForObject( + "http://127.0.0.1:18082/storage/" + COMMODITY_CODE + "/" + ORDER_COUNT, + String.class); + + if (!SUCCESS.equals(result)) { + throw new RuntimeException(); + } + + String url = "http://127.0.0.1:18083/order"; + HttpHeaders headers = new HttpHeaders(); + headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED); + + MultiValueMap map = new LinkedMultiValueMap(); + map.add("userId", USER_ID); + map.add("commodityCode", COMMODITY_CODE); + map.add("orderCount", ORDER_COUNT + ""); + + HttpEntity> request = new HttpEntity>( + map, headers); + + ResponseEntity response = restTemplate.postForEntity(url, request, + String.class); + + result = response.getBody(); + + if (!SUCCESS.equals(result)) { + throw new RuntimeException(); + } + + return SUCCESS; + } + + @GlobalTransactional(timeoutMills = 300000, name = "spring-cloud-demo-tx") + @RequestMapping(value = "/fescar/feign", method = RequestMethod.GET, produces = "application/json") + public String feign() { + + String result = storageService.storage(COMMODITY_CODE, ORDER_COUNT); + + if (!SUCCESS.equals(result)) { + throw new RuntimeException(); + } + + result = orderService.order(USER_ID, COMMODITY_CODE, ORDER_COUNT); + + if (!SUCCESS.equals(result)) { + throw new RuntimeException(); + } + + return SUCCESS; + + } + +} diff --git a/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/Order.java b/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/Order.java new file mode 100644 index 00000000..6594793a --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/Order.java @@ -0,0 +1,33 @@ +/* + * 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.cloud.examples; + +import java.io.Serializable; + +public class Order implements Serializable { + public long id; + public String userId; + public String commodityCode; + public int count; + public int money; + + @Override + public String toString() { + return "Order{" + "id=" + id + ", userId='" + userId + '\'' + ", commodityCode='" + + commodityCode + '\'' + ", count=" + count + ", money=" + money + '}'; + } +} diff --git a/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/resources/application.conf b/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/resources/application.conf new file mode 100644 index 00000000..65b69508 --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/resources/application.conf @@ -0,0 +1,30 @@ +transport { + # tcp udt unix-domain-socket + type = "TCP" + #NIO NATIVE + server = "NIO" + #thread factory for netty + thread-factory { + boss-thread-prefix = "NettyBoss" + worker-thread-prefix = "NettyServerNIOWorker" + server-executor-thread-prefix = "NettyServerBizHandler" + share-boss-worker = false + client-selector-thread-prefix = "NettyClientSelector" + client-selector-thread-size = 1 + client-worker-thread-prefix = "NettyClientWorkerThread" + # netty boss thread size,will not be used for UDT + boss-thread-size = 1 + #auto default pin or 8 + worker-thread-size = 8 + } +} +service { + #vgroup->rgroup + vgroup_mapping.business-service-fescar-service-group = "localRgroup" + #only support single node + localRgroup.grouplist = "127.0.0.1:8091" + #degrade current not support + enableDegrade = false + #disable + disable = false +} diff --git a/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/resources/application.properties b/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/resources/application.properties new file mode 100644 index 00000000..1832ce6f --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/business-service/src/main/resources/application.properties @@ -0,0 +1,8 @@ +server.port=18081 +spring.application.name=business-service +# The following configuration can be omitted. + +#feign.hystrix.enabled=true +#feign.sentinel.enabled=true + +logging.level.com.alibaba.fescar=debug \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/fescar-example/order-service/pom.xml b/spring-cloud-alibaba-examples/fescar-example/order-service/pom.xml new file mode 100644 index 00000000..7840c546 --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/order-service/pom.xml @@ -0,0 +1,63 @@ + + + + spring-cloud-alibaba-examples + org.springframework.cloud + 0.2.2.BUILD-SNAPSHOT + ../../pom.xml + + 4.0.0 + order-service + + + + org.springframework.cloud + spring-cloud-starter-alibaba-fescar + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-actuator + + + org.springframework.boot + spring-boot-starter-jdbc + + + + mysql + mysql-connector-java + + + + + + + + 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/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/DatabaseConfiguration.java b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/DatabaseConfiguration.java new file mode 100644 index 00000000..8e5c7d87 --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/DatabaseConfiguration.java @@ -0,0 +1,89 @@ +/* + * 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.cloud.examples; + +import java.sql.SQLException; + +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.env.Environment; +import org.springframework.jdbc.core.JdbcTemplate; + +import com.alibaba.druid.pool.DruidDataSource; +import com.alibaba.fescar.rm.datasource.DataSourceProxy; + +/** + * @author xiaojing + */ +@Configuration +public class DatabaseConfiguration { + + private final ApplicationContext applicationContext; + + public DatabaseConfiguration(ApplicationContext applicationContext) { + this.applicationContext = applicationContext; + } + + @Bean(initMethod = "init", destroyMethod = "close") + public DruidDataSource storageDataSource() throws SQLException { + + Environment env = applicationContext.getEnvironment(); + + String ip = env.getProperty("mysql.server.ip"); + String port = env.getProperty("mysql.server.port"); + String dbName = env.getProperty("mysql.db.name"); + + String userName = env.getProperty("mysql.user.name"); + String password = env.getProperty("mysql.user.password"); + + DruidDataSource druidDataSource = new DruidDataSource(); + druidDataSource.setUrl("jdbc:mysql://" + ip + ":" + port + "/" + dbName); + druidDataSource.setUsername(userName); + druidDataSource.setPassword(password); + druidDataSource.setDriverClassName("com.mysql.jdbc.Driver"); + druidDataSource.setInitialSize(0); + druidDataSource.setMaxActive(180); + druidDataSource.setMaxWait(60000); + druidDataSource.setMinIdle(0); + druidDataSource.setValidationQuery("Select 'x' from DUAL"); + druidDataSource.setTestOnBorrow(false); + druidDataSource.setTestOnReturn(false); + druidDataSource.setTestWhileIdle(true); + druidDataSource.setTimeBetweenEvictionRunsMillis(60000); + druidDataSource.setMinEvictableIdleTimeMillis(25200000); + druidDataSource.setRemoveAbandoned(true); + druidDataSource.setRemoveAbandonedTimeout(1800); + druidDataSource.setLogAbandoned(true); + druidDataSource.setFilters("mergeStat"); + return druidDataSource; + } + + @Bean + public DataSourceProxy dataSourceProxy(DruidDataSource druidDataSource) { + return new DataSourceProxy(druidDataSource); + } + + @Bean + public JdbcTemplate jdbcTemplate(DataSourceProxy dataSourceProxy) { + JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSourceProxy); + + jdbcTemplate.execute("TRUNCATE TABLE order_tbl"); + + return jdbcTemplate; + } + +} diff --git a/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/OderApplication.java b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/OderApplication.java new file mode 100644 index 00000000..1ab0dab1 --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/OderApplication.java @@ -0,0 +1,39 @@ +/* + * 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.cloud.examples; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.annotation.Bean; +import org.springframework.web.client.RestTemplate; + +/** + * @author xiaojing + */ +@SpringBootApplication +public class OderApplication { + + public static void main(String[] args) { + SpringApplication.run(OderApplication.class, args); + } + + @Bean + public RestTemplate restTemplate() { + return new RestTemplate(); + } + +} diff --git a/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/Order.java b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/Order.java new file mode 100644 index 00000000..6594793a --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/Order.java @@ -0,0 +1,33 @@ +/* + * 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.cloud.examples; + +import java.io.Serializable; + +public class Order implements Serializable { + public long id; + public String userId; + public String commodityCode; + public int count; + public int money; + + @Override + public String toString() { + return "Order{" + "id=" + id + ", userId='" + userId + '\'' + ", commodityCode='" + + commodityCode + '\'' + ", count=" + count + ", money=" + money + '}'; + } +} diff --git a/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/OrderController.java b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/OrderController.java new file mode 100644 index 00000000..2e0e0f81 --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/OrderController.java @@ -0,0 +1,131 @@ +/* + * 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.cloud.examples; + +import java.sql.Connection; +import java.sql.PreparedStatement; +import java.sql.SQLException; +import java.util.Random; + +import com.alibaba.fescar.core.context.RootContext; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.jdbc.core.JdbcTemplate; +import org.springframework.jdbc.core.PreparedStatementCreator; +import org.springframework.jdbc.support.GeneratedKeyHolder; +import org.springframework.jdbc.support.KeyHolder; +import org.springframework.util.LinkedMultiValueMap; +import org.springframework.util.MultiValueMap; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.client.RestTemplate; + +/** + * @author xiaojing + */ +@RestController +public class OrderController { + + private static final Logger LOGGER = LoggerFactory.getLogger(OrderController.class); + private static final String SUCCESS = "SUCCESS"; + private static final String FAIL = "FAIL"; + private static final String USER_ID = "U100001"; + private static final String COMMODITY_CODE = "C00321"; + + private final JdbcTemplate jdbcTemplate; + private final RestTemplate restTemplate; + private Random random; + + public OrderController(JdbcTemplate jdbcTemplate, RestTemplate restTemplate) { + this.jdbcTemplate = jdbcTemplate; + this.restTemplate = restTemplate; + this.random = new Random(); + } + + @RequestMapping(value = "/order", method = RequestMethod.POST, produces = "application/json") + public String order(String userId, String commodityCode, int orderCount) { + LOGGER.info("Order Service Begin ... xid: " + RootContext.getXID()); + + int orderMoney = calculate(commodityCode, orderCount); + + invokerAccountService(orderMoney); + + final Order order = new Order(); + order.userId = userId; + order.commodityCode = commodityCode; + order.count = orderCount; + order.money = orderMoney; + + KeyHolder keyHolder = new GeneratedKeyHolder(); + + int result = jdbcTemplate.update(new PreparedStatementCreator() { + + @Override + public PreparedStatement createPreparedStatement(Connection con) + throws SQLException { + PreparedStatement pst = con.prepareStatement( + "insert into order_tbl (user_id, commodity_code, count, money) values (?, ?, ?, ?)", + PreparedStatement.RETURN_GENERATED_KEYS); + pst.setObject(1, order.userId); + pst.setObject(2, order.commodityCode); + pst.setObject(3, order.count); + pst.setObject(4, order.money); + return pst; + } + }, keyHolder); + + order.id = (long) keyHolder.getKey(); + + if (random.nextBoolean()) { + throw new RuntimeException("this is a mock Exception"); + } + + LOGGER.info("Order Service End ... Created " + order); + + if (result == 1) { + return SUCCESS; + } + return FAIL; + } + + private int calculate(String commodityId, int orderCount) { + return 2 * orderCount; + } + + private void invokerAccountService(int orderMoney) { + String url = "http://127.0.0.1:18084/account"; + HttpHeaders headers = new HttpHeaders(); + headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED); + + MultiValueMap map = new LinkedMultiValueMap(); + + map.add("userId", USER_ID); + map.add("money", orderMoney + ""); + + HttpEntity> request = new HttpEntity>( + map, headers); + + ResponseEntity response = restTemplate.postForEntity(url, request, + String.class); + } +} diff --git a/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/resources/application.conf b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/resources/application.conf new file mode 100644 index 00000000..c298ca0c --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/resources/application.conf @@ -0,0 +1,30 @@ +transport { + # tcp udt unix-domain-socket + type = "TCP" + #NIO NATIVE + server = "NIO" + #thread factory for netty + thread-factory { + boss-thread-prefix = "NettyBoss" + worker-thread-prefix = "NettyServerNIOWorker" + server-executor-thread-prefix = "NettyServerBizHandler" + share-boss-worker = false + client-selector-thread-prefix = "NettyClientSelector" + client-selector-thread-size = 1 + client-worker-thread-prefix = "NettyClientWorkerThread" + # netty boss thread size,will not be used for UDT + boss-thread-size = 1 + #auto default pin or 8 + worker-thread-size = 8 + } +} +service { + #vgroup->rgroup + vgroup_mapping.order-service-fescar-service-group = "localRgroup" + #only support single node + localRgroup.grouplist = "127.0.0.1:8091" + #degrade current not support + enableDegrade = false + #disable + disable = false +} diff --git a/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/resources/application.properties b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/resources/application.properties new file mode 100644 index 00000000..f3e417d8 --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/order-service/src/main/resources/application.properties @@ -0,0 +1,9 @@ +spring.application.name=order-service +server.port=18083 + +mysql.server.ip=127.0.0.1 +mysql.server.port=3306 +mysql.db.name=demo + +mysql.user.name=xxxxx +mysql.user.password=xxxxx \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/fescar-example/readme-zh.md b/spring-cloud-alibaba-examples/fescar-example/readme-zh.md new file mode 100644 index 00000000..e93f6866 --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/readme-zh.md @@ -0,0 +1,156 @@ +# Fescar Example + +## 项目说明 + + +本项目演示如何使用 Fescar Starter 完成 Spring Cloud 应用的分布式事务接入。 + +[Fescar](https://github.com/alibaba/fescar) 是 阿里巴巴 开源的 分布式事务中间件,以 高效 并且对业务 0 侵入 的方式,解决 微服务 场景下面临的分布式事务问题。 + + + +## 准备工作 + +在运行此示例之前,你需要先完成如下几步准备工作: + +1. 配置数据库 + +1. 创建 UNDO_LOG 表 + +1. 创建 示例中 业务所需要的数据库表 + +1. 启动 Fescar Server + + +### 配置数据库 + +首先,你需要有一个支持 InnoDB 引擎的 MySQL 数据库。 + +**注意**: 实际上,Fescar 支持不同的应用使用完全不相干的数据库,但是这里为了简单地演示一个原理,所以我们选择了只使用一个数据库。 + +将 `account-server`、`order-service`、`storage-service` 这三个应用中的 resources 目录下的 `application.properties` 文件中的如下配置修改成你运行环境中的实际配置。 + +``` +mysql.server.ip=your mysql server ip address +mysql.server.port=your mysql server listening port +mysql.db.name=your database name for test + +mysql.user.name=your mysql server username +mysql.user.password=your mysql server password + +``` + +### 创建 UNDO_LOG 表 + +[Fescar AT 模式]() 需要使用到 UNDO_LOG 表。 + +``` $sql +CREATE TABLE `undo_log` ( + `id` bigint(20) NOT NULL AUTO_INCREMENT, + `branch_id` bigint(20) NOT NULL, + `xid` varchar(100) NOT NULL, + `rollback_info` longblob NOT NULL, + `log_status` int(11) NOT NULL, + `log_created` datetime NOT NULL, + `log_modified` datetime NOT NULL, + `ext` varchar(100) DEFAULT NULL, + PRIMARY KEY (`id`), + KEY `idx_unionkey` (`xid`,`branch_id`) +) ENGINE=InnoDB AUTO_INCREMENT=159 DEFAULT CHARSET=utf8 +``` + +### 创建 示例中 业务所需要的数据库表 + +```$sql +DROP TABLE IF EXISTS `storage_tbl`; +CREATE TABLE `storage_tbl` ( + `id` int(11) NOT NULL AUTO_INCREMENT, + `commodity_code` varchar(255) DEFAULT NULL, + `count` int(11) DEFAULT 0, + PRIMARY KEY (`id`), + UNIQUE KEY (`commodity_code`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8; + + +DROP TABLE IF EXISTS `order_tbl`; +CREATE TABLE `order_tbl` ( + `id` int(11) NOT NULL AUTO_INCREMENT, + `user_id` varchar(255) DEFAULT NULL, + `commodity_code` varchar(255) DEFAULT NULL, + `count` int(11) DEFAULT 0, + `money` int(11) DEFAULT 0, + PRIMARY KEY (`id`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8; + + +DROP TABLE IF EXISTS `account_tbl`; +CREATE TABLE `account_tbl` ( + `id` int(11) NOT NULL AUTO_INCREMENT, + `user_id` varchar(255) DEFAULT NULL, + `money` int(11) DEFAULT 0, + PRIMARY KEY (`id`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8; +``` + +### 启动 Fescar Server + +点击这个页面 [https://github.com/alibaba/fescar/releases](https://github.com/alibaba/fescar/releases),下载最新版本的 Fescar Server 端. + + +进入解压之后的 bin 目录,执行如下命令来启动 + +```$shell +sh fescar-server.sh $LISTEN_PORT $PATH_FOR_PERSISTENT_DATA +``` + +在这个示例中,采用如下命令来启动 Fescar Server + +```$shell +sh fescar-server.sh 8091 ~/fescar/data/ +``` + +**注意** 如果你修改了端口号,那么记得需要在各个示例工程中的 `application.conf` 文件中,修改 grouplist 的值。 + + +## 运行示例 + +分别运行 `account-server`、`order-service`、`storage-service` 和 `business-service` 这三个应用的 Main 函数,启动示例。 + +启动示例后,通过 HTTP 的 GET 方法访问如下两个 URL,可以分别验证在 `business-service` 中 通过 RestTemplate 和 FeignClient 调用其他服务的场景。 + +```$xslt +http://127.0.0.1:18081/fescar/feign + +http://127.0.0.1:18081/fescar/rest +``` + +## 如何验证分布式事务成功? + +### Xid 信息是否成功传递 + +在 `account-server`、`order-service` 和 `storage-service` 三个 服务的 Controller 中,第一个执行的逻辑都是输出 RootContext 中的 Xid 信息,如果看到都输出了正确的 Xid 信息,即每次都发生变化,且同一次调用中所有服务的 Xid 都一致。则表明 Fescar 的 Xid 的传递和还原是正常的。 + +### 数据库中数据是否一致 + +在本示例中,我们模拟了一个用户购买货物的场景,StorageService 负责扣减库存数量,OrderService 负责保存订单,AccountService 负责扣减用户账户余额。 + +为了演示样例,我们在 OrderService 和 AccountService 中 使用 Random.nextBoolean() 的方式来随机抛出异常,模拟了在服务调用时随机发生异常的场景。 + +如果分布式事务生效的话, 那么以下等式应该成立 + + +- 用户原始金额(1000) = 用户现存的金额 + 货物单价 (2) * 订单数量 * 每单的货物数量(2) + +- 货物的初始数量(100) = 货物的现存数量 + 订单数量 * 每单的货物数量(2) + +## 对 Spring Cloud 支持点 + +- 通过 Spring MVC 提供服务的服务提供者,在收到 header 中含有 Fescar 信息的 HTTP 请求时,可以自动还原 Fescar 上下文。 + +- 支持服务调用者通过 RestTemplate 调用时,自动传递 Fescar 上下文。 + +- 支持服务调用者通过 FeignClient 调用时,自动传递 Fescar 上下文。 + +- 支持 FeignClient 和 Hystrix 同时使用的场景。 + +- 支持 FeignClient 和 Sentinel 同时使用的场景。 diff --git a/spring-cloud-alibaba-examples/fescar-example/storage-service/pom.xml b/spring-cloud-alibaba-examples/fescar-example/storage-service/pom.xml new file mode 100644 index 00000000..bcdca22c --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/storage-service/pom.xml @@ -0,0 +1,68 @@ + + + + spring-cloud-alibaba-examples + org.springframework.cloud + 0.2.2.BUILD-SNAPSHOT + ../../pom.xml + + 4.0.0 + storage-service + + + + org.springframework.cloud + spring-cloud-starter-alibaba-fescar + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-actuator + + + com.alibaba + druid + 1.1.10 + + + org.springframework.boot + spring-boot-starter-jdbc + + + + mysql + mysql-connector-java + + + + + + + + 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/fescar-example/storage-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/DatabaseConfiguration.java b/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/DatabaseConfiguration.java new file mode 100644 index 00000000..2973f21a --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/DatabaseConfiguration.java @@ -0,0 +1,94 @@ +/* + * 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.cloud.examples; + +import java.sql.SQLException; + +import com.alibaba.druid.pool.DruidDataSource; +import com.alibaba.fescar.rm.datasource.DataSourceProxy; + +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.env.Environment; +import org.springframework.jdbc.core.JdbcTemplate; + +/** + * @author xiaojing + */ +@Configuration +public class DatabaseConfiguration { + + private final ApplicationContext applicationContext; + + public DatabaseConfiguration(ApplicationContext applicationContext) { + this.applicationContext = applicationContext; + } + + @Bean(initMethod = "init", destroyMethod = "close") + public DruidDataSource storageDataSource() throws SQLException { + + Environment environment = applicationContext.getEnvironment(); + + String ip = environment.getProperty("mysql.server.ip"); + String port = environment.getProperty("mysql.server.port"); + String dbName = environment.getProperty("mysql.db.name"); + + String userName = environment.getProperty("mysql.user.name"); + String password = environment.getProperty("mysql.user.password"); + + DruidDataSource druidDataSource = new DruidDataSource(); + druidDataSource.setUrl("jdbc:mysql://" + ip + ":" + port + "/" + dbName); + druidDataSource.setUsername(userName); + druidDataSource.setPassword(password); + druidDataSource.setDriverClassName("com.mysql.jdbc.Driver"); + druidDataSource.setInitialSize(0); + druidDataSource.setMaxActive(180); + druidDataSource.setMaxWait(60000); + druidDataSource.setMinIdle(0); + druidDataSource.setValidationQuery("Select 'x' from DUAL"); + druidDataSource.setTestOnBorrow(false); + druidDataSource.setTestOnReturn(false); + druidDataSource.setTestWhileIdle(true); + druidDataSource.setTimeBetweenEvictionRunsMillis(60000); + druidDataSource.setMinEvictableIdleTimeMillis(25200000); + druidDataSource.setRemoveAbandoned(true); + druidDataSource.setRemoveAbandonedTimeout(1800); + druidDataSource.setLogAbandoned(true); + druidDataSource.setFilters("mergeStat"); + return druidDataSource; + } + + @Bean + public DataSourceProxy dataSourceProxy(DruidDataSource druidDataSource) { + return new DataSourceProxy(druidDataSource); + } + + @Bean + public JdbcTemplate jdbcTemplate(DataSourceProxy dataSourceProxy) { + + JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSourceProxy); + + jdbcTemplate.update("delete from storage_tbl where commodity_code = 'C00321'"); + jdbcTemplate.update( + "insert into storage_tbl(commodity_code, count) values ('C00321', 100)"); + + return jdbcTemplate; + + } + +} diff --git a/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/StorageApplication.java b/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/StorageApplication.java new file mode 100644 index 00000000..94bbac7f --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/StorageApplication.java @@ -0,0 +1,32 @@ +/* + * 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.cloud.examples; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +/** + * @author xiaojing + */ +@SpringBootApplication +public class StorageApplication { + + public static void main(String[] args) { + SpringApplication.run(StorageApplication.class, args); + } + +} diff --git a/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/StorageController.java b/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/StorageController.java new file mode 100644 index 00000000..fd97ab2c --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/java/org/springframework/cloud/alibaba/cloud/examples/StorageController.java @@ -0,0 +1,58 @@ +/* + * 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.cloud.examples; + +import com.alibaba.fescar.core.context.RootContext; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.jdbc.core.JdbcTemplate; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RestController; + +/** + * @author xiaojing + */ +@RestController +public class StorageController { + + private static final Logger LOGGER = LoggerFactory.getLogger(StorageController.class); + + private static final String SUCCESS = "SUCCESS"; + private static final String FAIL = "FAIL"; + + private final JdbcTemplate jdbcTemplate; + + public StorageController(JdbcTemplate jdbcTemplate) { + this.jdbcTemplate = jdbcTemplate; + } + + @RequestMapping(value = "/storage/{commodityCode}/{count}", method = RequestMethod.GET, produces = "application/json") + public String echo(@PathVariable String commodityCode, @PathVariable int count) { + LOGGER.info("Storage Service Begin ... xid: " + RootContext.getXID()); + int result = jdbcTemplate.update( + "update storage_tbl set count = count - ? where commodity_code = ?", + new Object[] { count, commodityCode }); + LOGGER.info("Storage Service End ... "); + if (result == 1) { + return SUCCESS; + } + return FAIL; + } +} diff --git a/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/resources/application.conf b/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/resources/application.conf new file mode 100644 index 00000000..4bc5989e --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/resources/application.conf @@ -0,0 +1,30 @@ +transport { + # tcp udt unix-domain-socket + type = "TCP" + #NIO NATIVE + server = "NIO" + #thread factory for netty + thread-factory { + boss-thread-prefix = "NettyBoss" + worker-thread-prefix = "NettyServerNIOWorker" + server-executor-thread-prefix = "NettyServerBizHandler" + share-boss-worker = false + client-selector-thread-prefix = "NettyClientSelector" + client-selector-thread-size = 1 + client-worker-thread-prefix = "NettyClientWorkerThread" + # netty boss thread size,will not be used for UDT + boss-thread-size = 1 + #auto default pin or 8 + worker-thread-size = 8 + } +} +service { + #vgroup->rgroup + vgroup_mapping.storage-service-fescar-service-group = "localRgroup" + #only support single node + localRgroup.grouplist = "127.0.0.1:8091" + #degrade current not support + enableDegrade = false + #disable + disable = false +} diff --git a/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/resources/application.properties b/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/resources/application.properties new file mode 100644 index 00000000..832eaecd --- /dev/null +++ b/spring-cloud-alibaba-examples/fescar-example/storage-service/src/main/resources/application.properties @@ -0,0 +1,9 @@ +spring.application.name=storage-service +server.port=18082 + +mysql.server.ip=127.0.0.1 +mysql.server.port=3306 +mysql.db.name=demo + +mysql.user.name=xxxxx +mysql.user.password=xxxxx \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/readme-zh.md b/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/readme-zh.md index e7339058..390b567e 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/readme-zh.md +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/readme-zh.md @@ -113,11 +113,11 @@ Nacos Client 从 Nacos Server 端获取数据时,调用的是此接口 `Config 在 Nacos Config Starter 中,dataId 的拼接格式如下 - ${prefix} - ${spring.active.profile} . ${file-extension} + ${prefix} - ${spring.profiles.active} . ${file-extension} * `prefix` 默认为 `spring.application.name` 的值,也可以通过配置项 `spring.cloud.nacos.config.prefix`来配置。 -* `spring.active.profile` 即为当前环境对应的 profile,详情可以参考 [Spring Boot文档](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-profiles.html#boot-features-profiles) +* `spring.profiles.active` 即为当前环境对应的 profile,详情可以参考 [Spring Boot文档](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-profiles.html#boot-features-profiles) **注意,当 activeprofile 为空时,对应的连接符 `-` 也将不存在,dataId 的拼接格式变成 `${prefix}`.`${file-extension}`** diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/readme.md b/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/readme.md index 58b499ae..702a5107 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/readme.md +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-config-example/readme.md @@ -114,11 +114,11 @@ Nacos Client gets data from Nacos Server through this method. `ConfigService.get In Nacos Config Starter, the splicing format of dataId is as follows - ${prefix} - ${spring.active.profile} . ${file-extension} + ${prefix} - ${spring.profiles.active} . ${file-extension} * `prefix` default value is `spring.application.name` value, which can also be configured via the configuration item `spring.cloud.nacos.config.prefix`. -* `spring.active.profile` is the profile corresponding to the current environment. For details, please refer to [Spring Boot Doc](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-profiles.html#boot-features-profiles) +* `spring.profiles.active` is the profile corresponding to the current environment. For details, please refer to [Spring Boot Doc](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-profiles.html#boot-features-profiles) **Note: when the activeprofile is empty, the corresponding connector `-` will also not exist, and the splicing format of the dataId becomes `${prefix}`.`${file-extension}`** diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-consumer-example/src/main/resources/application.properties b/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-consumer-example/src/main/resources/application.properties index fbc9736e..02b7ce32 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-consumer-example/src/main/resources/application.properties +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-consumer-example/src/main/resources/application.properties @@ -9,4 +9,5 @@ spring.cloud.sentinel.transport.dashboard=localhost:8080 spring.cloud.sentinel.eager=true spring.cloud.sentinel.datasource.ds1.file.file=classpath: flowrule.json -spring.cloud.sentinel.datasource.ds1.file.data-type=json \ No newline at end of file +spring.cloud.sentinel.datasource.ds1.file.data-type=json +spring.cloud.sentinel.datasource.ds1.file.rule-type=flow \ No newline at end of file diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-provider-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/ProviderApplication.java b/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-provider-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/ProviderApplication.java index 843f5cbe..c8b4a1c2 100644 --- a/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-provider-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/ProviderApplication.java +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example/nacos-discovery-provider-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/ProviderApplication.java @@ -13,7 +13,6 @@ import org.springframework.web.bind.annotation.RestController; * @author xiaojing */ @SpringBootApplication -@EnableDiscoveryClient public class ProviderApplication { public static void main(String[] args) { 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 new file mode 100644 index 00000000..bac2b278 --- /dev/null +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-discovery-example/pom.xml @@ -0,0 +1,71 @@ + + + + + org.springframework.cloud + nacos-gateway-example + 0.2.2.BUILD-SNAPSHOT + + 4.0.0 + + + nacos-gateway-discovery-example + jar + Example demonstrating how to use gateway with nacos + + + + + org.springframework.cloud + spring-cloud-starter-gateway + 2.0.2.RELEASE + + + + org.springframework.cloud + spring-cloud-starter-alibaba-nacos-discovery + + + + org.springframework.boot + spring-boot-starter-actuator + + + + + + + + + org.codehaus.mojo + cobertura-maven-plugin + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + org.apache.maven.plugins + maven-deploy-plugin + ${maven-deploy-plugin.version} + + true + + + + org.codehaus.mojo + cobertura-maven-plugin + false + + true + + + + + + + diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-discovery-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/GatewayApplication.java b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-discovery-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/GatewayApplication.java new file mode 100644 index 00000000..c581d1ff --- /dev/null +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-discovery-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/GatewayApplication.java @@ -0,0 +1,18 @@ +package org.springframework.cloud.alibaba.cloud.examples; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.cloud.client.discovery.EnableDiscoveryClient; + +/** + * @author lengleng + */ +@SpringBootApplication +@EnableDiscoveryClient +public class GatewayApplication { + + public static void main(String[] args) { + SpringApplication.run(GatewayApplication.class, args); + } + +} diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-discovery-example/src/main/resources/application.properties b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-discovery-example/src/main/resources/application.properties new file mode 100644 index 00000000..61394891 --- /dev/null +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-discovery-example/src/main/resources/application.properties @@ -0,0 +1,11 @@ +server.port=18085 +spring.application.name=service-gateway +spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848 +management.endpoints.web.exposure.include=* + +# spring cloud route config +spring.cloud.gateway.routes[0].id=nacos-route +spring.cloud.gateway.routes[0].uri=lb://service-gateway-provider +spring.cloud.gateway.routes[0].predicates[0].name=Path +spring.cloud.gateway.routes[0].predicates[0].args[pattern]=/nacos/** +spring.cloud.gateway.routes[0].filters[0]=StripPrefix=1 \ No newline at end of file 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 new file mode 100644 index 00000000..8a121fa8 --- /dev/null +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-provider-example/pom.xml @@ -0,0 +1,69 @@ + + + + + org.springframework.cloud + nacos-gateway-example + 0.2.2.BUILD-SNAPSHOT + + 4.0.0 + + + nacos-gateway-provider-example + jar + Example demonstrating how to use gateway with nacos + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.cloud + spring-cloud-starter-alibaba-nacos-discovery + + + + org.springframework.boot + spring-boot-starter-actuator + + + + + + + + + org.codehaus.mojo + cobertura-maven-plugin + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + org.apache.maven.plugins + maven-deploy-plugin + ${maven-deploy-plugin.version} + + 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/src/main/java/org/springframework/cloud/alibaba/cloud/examples/ProviderApplication.java b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-provider-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/ProviderApplication.java new file mode 100644 index 00000000..843f5cbe --- /dev/null +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-provider-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/ProviderApplication.java @@ -0,0 +1,35 @@ +package org.springframework.cloud.alibaba.cloud.examples; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.cloud.client.discovery.EnableDiscoveryClient; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +/** + * @author xiaojing + */ +@SpringBootApplication +@EnableDiscoveryClient +public class ProviderApplication { + + public static void main(String[] args) { + SpringApplication.run(ProviderApplication.class, args); + } + + @RestController + class EchoController { + @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET) + public String echo(@PathVariable String string) { + return "hello Nacos Discovery " + string; + } + + @RequestMapping(value = "/divide", method = RequestMethod.GET) + public String divide(@RequestParam Integer a, @RequestParam Integer b) { + return String.valueOf(a / b); + } + } +} diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-provider-example/src/main/resources/application.properties b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-provider-example/src/main/resources/application.properties new file mode 100644 index 00000000..9a061092 --- /dev/null +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/nacos-gateway-provider-example/src/main/resources/application.properties @@ -0,0 +1,4 @@ +server.port=18086 +spring.application.name=service-gateway-provider +spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848 +management.endpoints.web.exposure.include=* \ No newline at end of file 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 new file mode 100644 index 00000000..9b7f638e --- /dev/null +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/pom.xml @@ -0,0 +1,45 @@ + + + + + org.springframework.cloud + spring-cloud-alibaba-examples + 0.2.2.BUILD-SNAPSHOT + ../../pom.xml + + 4.0.0 + + + nacos-gateway-example + pom + Example demonstrating how to use gateway with nacos + + + + 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/nacos-example/nacos-gateway-example/readme-zh.md b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/readme-zh.md new file mode 100644 index 00000000..6fc875fe --- /dev/null +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/readme-zh.md @@ -0,0 +1,97 @@ +# Spring Cloud Gateway、 Nacos Discovery Example + +## 项目说明 + +本项目演示如何使用 Nacos Discovery Starter 、 Spring Cloud Gateway Starter 完成 Spring Cloud 服务路由。 + +[Nacos](https://github.com/alibaba/Nacos) 是阿里巴巴开源的一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。 +[Spring Cloud Gateway](https://spring.io/projects/spring-cloud-gateway) 是spring cloud 官方开源的一个在SpringMVC 上可以构建API网关的库。 + +## 示例 + +### 如何接入 +在启动示例进行演示之前,我们先了解一下 Spring Cloud 应用如何接入 Spring Cloud 如何接入Nacos Discovery、Spring Cloud Gateway。 +**注意 本章节只是为了便于您理解接入方式,本示例代码中已经完成接入工作,您无需再进行修改。** + +1. 首先,修改 pom.xml 文件,引入 Nacos Discovery Starter、Spring Cloud Gateway Starter。 + +```xml + + org.springframework.cloud + spring-cloud-starter-alibaba-nacos-discovery + + + org.springframework.cloud + spring-cloud-starter-gateway + +``` + +2. 在应用的 /src/main/resources/application.properties 配置文件中配置 Nacos Server 地址 + + spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848 + +3. 在应用的 /src/main/resources/application.properties 配置文件中配置 Spring Cloud Gateway 路由 + +```properties +spring.cloud.gateway.routes[0].id=nacos-route +spring.cloud.gateway.routes[0].uri=lb://service-gateway-provider +spring.cloud.gateway.routes[0].predicates[0].name=Path +spring.cloud.gateway.routes[0].predicates[0].args[pattern]=/nacos/** +spring.cloud.gateway.routes[0].filters[0]=StripPrefix=1 +``` + +4. 使用 @EnableDiscoveryClient 注解开启服务注册与发现功能 + +```java + @SpringBootApplication + @EnableDiscoveryClient + public class GatewayApplication { + + public static void main(String[] args) { + SpringApplication.run(GatewayApplication.class, args); + } + + } +``` + +### 启动 Nacos Server + +1. 首先需要获取 Nacos Server,支持直接下载和源码构建两种方式。 + + 1. 直接下载:[Nacos Server 下载页](https://github.com/alibaba/nacos/releases) + 2. 源码构建:进入 Nacos [Github 项目页面](https://github.com/alibaba/nacos),将代码 git clone 到本地自行编译打包,[参考此文档](https://nacos.io/zh-cn/docs/quick-start.html)。**推荐使用源码构建方式以获取最新版本** + +2. 启动 Server,进入解压后文件夹或编译打包好的文件夹,找到如下相对文件夹 nacos/bin,并对照操作系统实际情况之下如下命令。 + + 1. Linux/Unix/Mac 操作系统,执行命令 `sh startup.sh -m standalone` + 1. Windows 操作系统,执行命令 `cmd startup.cmd` + +### Spring Cloud Gateway应用启动 +启动应用,支持 IDE 直接启动和编译打包后启动。 + +1. IDE直接启动:找到 nacos-gateway-discovery-example 项目的主类 `GatewayApplication`,执行 main 方法启动应用。 +2. 打包编译后启动:在 nacos-gateway-discovery-example 项目中执行 `mvn clean package` 将工程编译打包,然后执行 `java -jar nacos-gateway-discovery-example.jar`启动应用。 + +### 服务提供方应用启动 +启动应用,支持 IDE 直接启动和编译打包后启动。 +1. IDE直接启动:找到 nacos-gateway-provider-example 项目的主类 `ProviderApplication`,执行 main 方法启动应用。 +2. 打包编译后启动:在 nacos-gateway-provider-example 项目中执行 `mvn clean package` 将工程编译打包,然后执行 `java -jar nacos-gateway-provider-example.jar`启动应用。 + +### 验证 +1. +```bash + curl 'http://127.0.0.1:18085/nacos/echo/hello-world' + + hello Nacos Discovery hello-world⏎ +``` +1. +```bash + curl 'http://127.0.0.1:18085/nacos/divide?a=6&b=2' + + 3⏎ +``` +#### 更多介绍 +Nacos为用户提供包括动态服务发现,配置管理,服务管理等服务基础设施,帮助用户更灵活,更轻松地构建,交付和管理他们的微服务平台,基于Nacos, 用户可以更快速的构建以“服务”为中心的现代云原生应用。Nacos可以和Spring Cloud、Kubernetes/CNCF、Dubbo 等微服务生态无缝融合,为用户提供更卓越的体验。更多 Nacos 相关的信息,请参考 [Nacos 项目](https://github.com/alibaba/Nacos)。 + +如果您对 Spring Cloud Nacos Discovery 有任何建议或想法,欢迎在 issue 中或者通过其他社区渠道向我们提出。 + diff --git a/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/readme.md b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/readme.md new file mode 100644 index 00000000..07e717b4 --- /dev/null +++ b/spring-cloud-alibaba-examples/nacos-example/nacos-gateway-example/readme.md @@ -0,0 +1,105 @@ +# Spring Cloud Gateway、 Nacos Discovery Example + +## Project Instruction + +This example illustrates how to use Nacos Discovery Starter、 Spring Cloud Gateway Starter implement Service route for Spring Cloud applications. + +[Nacos](https://github.com/alibaba/Nacos) an easy-to-use dynamic service discovery, configuration and service management platform for building cloud native applications. +[Spring Cloud Gateway](https://spring.io/projects/spring-cloud-gateway) provides a library for building an API Gateway on top of Spring MVC. + + +## Demo + +### Connect to Nacos Discovery +Before we start the demo, let's learn how to connect Nacos Config to a Spring Cloud application. **Note: This section is to show you how to connect to Nacos Discovery、Nacos Discovery、Spring Cloud Gateway. The configurations have been completed in the following example, so you don't need modify the code any more.** + +1. Add Nacos Discovery Starter、Spring Cloud Gateway Starter in the pom.xml file in your Spring Cloud project. + +```xml + + org.springframework.cloud + spring-cloud-starter-alibaba-nacos-discovery + + + org.springframework.cloud + spring-cloud-starter-gateway + +``` +2. Add Nacos server address configurations to file /src/main/resources/application.properties. + + spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848 + +3. Add Spring Cloud Gateway configurations to file /src/main/resources/application.properties. + +```properties +spring.cloud.gateway.routes[0].id=nacos-route +spring.cloud.gateway.routes[0].uri=lb://service-gateway-provider +spring.cloud.gateway.routes[0].predicates[0].name=Path +spring.cloud.gateway.routes[0].predicates[0].args[pattern]=/nacos/** +spring.cloud.gateway.routes[0].filters[0]=StripPrefix=1 +``` +4. Use the @EnableDiscoveryClient annotation to turn on service registration and discovery. + +```java + @SpringBootApplication + @EnableDiscoveryClient + public class GatewayApplication { + + public static void main(String[] args) { + SpringApplication.run(GatewayApplication.class, args); + } + + } +``` + +### Start Nacos Server + +1. Install Nacos Server by downloading or build from source code.**Recommended latest version Nacos Server** + + 1. Download: Download Nacos Server [download page](https://github.com/alibaba/nacos/releases) + 2. Build from source code: Get source code by git clone git@github.com:alibaba/Nacos.git from Github Nacos and build your code. See [build reference](https://nacos.io/en-us/docs/quick-start.html) for details. + + + +2. Unzip the downloaded file and go to the nacos/bin folder(), And according to the actual situation of the operating system, execute the following command。[see reference for more detail](https://nacos.io/en-us/docs/quick-start.html)。 + + 1. Linux/Unix/Mac , execute `sh startup.sh -m standalone` + 1. Windows , execute `cmd startup.cmd` + +### Start Spring Cloud Gateway Application +Start the application in IDE or by building a fatjar. + +1. Start in IDE: Find main class `GatewayApplication ` in project `nacos-gateway-discovery-example`, and execute the main method. +2. Build a fatjar:Execute command `mvn clean package` in project `nacos-gateway-discovery-example` to build a fatjar,and run command `java -jar nacos-gateway-discovery-example.jar` to start the application. + + +### Start Service provider Application + +Start the application in IDE or by building a fatjar. + +1. Start in IDE: Find main class `ProviderApplication ` in project `nacos-gateway-provider-example`, and execute the main method. +2. Build a fatjar:Execute command `mvn clean package` in project `nacos-gateway-provider-example` to build a fatjar,and run command `java -jar nacos-gateway-provider-example.jar` to start the application. + + +### Verification +1. +```bash + curl 'http://127.0.0.1:18085/nacos/echo/hello-world' + + hello Nacos Discovery hello-world⏎ +``` +1. +```bash + curl 'http://127.0.0.1:18085/nacos/divide?a=6&b=2' + + 3⏎ +``` + +#### More introduction + +[Nacos ](https://github.com/alibaba/Nacos) is committed to help you discover, configure, and manage your microservices. It provides a set of simple and useful features enabling you to realize dynamic service discovery, service configuration, service metadata and traffic management. + +Nacos makes it easier and faster to construct, deliver and manage your microservices platform. It is the infrastructure that supports a service-centered modern application architecture with a microservices or cloud-native approach. + +If you have any ideas or suggestions for Nacos Discovery starter, please don't hesitate to tell us by submitting github issues. + diff --git a/spring-cloud-alibaba-examples/pom.xml b/spring-cloud-alibaba-examples/pom.xml index dd03c65a..6cd8e731 100644 --- a/spring-cloud-alibaba-examples/pom.xml +++ b/spring-cloud-alibaba-examples/pom.xml @@ -23,11 +23,16 @@ sentinel-example/sentinel-dubbo-example/sentinel-dubbo-api nacos-example/nacos-discovery-example nacos-example/nacos-config-example + nacos-example/nacos-gateway-example env-extension oss-example ans-example/ans-consumer-feign-example ans-example/ans-consumer-ribbon-example ans-example/ans-provider-example + fescar-example/business-service + fescar-example/order-service + fescar-example/storage-service + fescar-example/account-service acm-example/acm-local-example rocketmq-example spring-cloud-bus-rocketmq-example diff --git a/spring-cloud-alibaba-examples/schedulerx-example/schedulerx-simple-task-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/SimpleTask.java b/spring-cloud-alibaba-examples/schedulerx-example/schedulerx-simple-task-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/SimpleTask.java index e49c0a05..09055da1 100644 --- a/spring-cloud-alibaba-examples/schedulerx-example/schedulerx-simple-task-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/SimpleTask.java +++ b/spring-cloud-alibaba-examples/schedulerx-example/schedulerx-simple-task-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/SimpleTask.java @@ -19,17 +19,22 @@ package org.springframework.cloud.alibaba.cloud.examples; import com.alibaba.edas.schedulerx.ProcessResult; import com.alibaba.edas.schedulerx.ScxSimpleJobContext; import com.alibaba.edas.schedulerx.ScxSimpleJobProcessor; +import org.springframework.beans.factory.annotation.Autowired; /** * @author xiaolongzuo */ public class SimpleTask implements ScxSimpleJobProcessor { - @Override - public ProcessResult process(ScxSimpleJobContext context) { - System.out.println("-----------Hello world---------------"); - ProcessResult processResult = new ProcessResult(true); - return processResult; - } + @Autowired + private TestService testService; + + @Override + public ProcessResult process(ScxSimpleJobContext context) { + System.out.println("-----------Hello world---------------"); + testService.test(); + ProcessResult processResult = new ProcessResult(true); + return processResult; + } } diff --git a/spring-cloud-alibaba-examples/schedulerx-example/schedulerx-simple-task-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/TestService.java b/spring-cloud-alibaba-examples/schedulerx-example/schedulerx-simple-task-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/TestService.java new file mode 100644 index 00000000..1786d197 --- /dev/null +++ b/spring-cloud-alibaba-examples/schedulerx-example/schedulerx-simple-task-example/src/main/java/org/springframework/cloud/alibaba/cloud/examples/TestService.java @@ -0,0 +1,30 @@ +/* + * 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.cloud.examples; + +import org.springframework.stereotype.Service; + +/** + * @author xiaolongzuo + */ +@Service +public class TestService { + + public void test() { + System.out.println("---------IOC Success--------"); + } +} 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 868bc10c..f3bd3370 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 @@ -30,7 +30,11 @@ com.alibaba.boot dubbo-spring-boot-starter - 0.2.0 + + + + com.alibaba + dubbo 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 684a589b..6aff02b3 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 @@ -29,8 +29,13 @@ com.alibaba.boot dubbo-spring-boot-starter - 0.2.0 + + + com.alibaba + dubbo + + diff --git a/spring-cloud-alibaba-fescar/pom.xml b/spring-cloud-alibaba-fescar/pom.xml new file mode 100644 index 00000000..15613f57 --- /dev/null +++ b/spring-cloud-alibaba-fescar/pom.xml @@ -0,0 +1,117 @@ + + + + + org.springframework.cloud + spring-cloud-alibaba + 0.2.2.BUILD-SNAPSHOT + + 4.0.0 + + org.springframework.cloud + spring-cloud-alibaba-fescar + Spring Cloud Alibaba Fescar + + + + + com.alibaba.fescar + fescar-core + + + com.alibaba.fescar + fescar-common + + + com.alibaba.fescar + fescar-spring + + + com.alibaba.fescar + fescar-rm-datasource + + + + org.springframework.cloud + spring-cloud-starter-openfeign + provided + true + + + org.springframework.cloud + spring-cloud-starter-alibaba-sentinel + provided + true + + + + org.springframework.cloud + spring-cloud-commons + true + + + + org.springframework.cloud + spring-cloud-starter-netflix-ribbon + provided + true + + + + + + org.springframework.boot + spring-boot-starter-aop + + + + org.springframework.boot + spring-boot-actuator + provided + true + + + + org.springframework.boot + spring-boot-actuator-autoconfigure + provided + true + + + + org.springframework.boot + spring-boot-configuration-processor + provided + true + + + + org.springframework.boot + spring-boot + provided + true + + + + org.springframework.boot + spring-boot-autoconfigure + provided + true + + + org.springframework.boot + spring-boot-starter-web + provided + true + + + + org.springframework.boot + spring-boot-starter-test + test + + + + + diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/FescarProperties.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/FescarProperties.java new file mode 100644 index 00000000..f7847d96 --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/FescarProperties.java @@ -0,0 +1,42 @@ +/* + * 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.fescar; + +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * @author xiaojing + */ +@ConfigurationProperties("spring.cloud.alibaba.fescar") +public class FescarProperties { + + // todo support config Fescar server information + + /** + * Fescar tx service group.default is ${spring.application.name}-fescar-service-group. + */ + private String txServiceGroup; + + public String getTxServiceGroup() { + return txServiceGroup; + } + + public void setTxServiceGroup(String txServiceGroup) { + this.txServiceGroup = txServiceGroup; + } + +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/GlobalTransactionAutoConfiguration.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/GlobalTransactionAutoConfiguration.java new file mode 100644 index 00000000..d876ad3b --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/GlobalTransactionAutoConfiguration.java @@ -0,0 +1,60 @@ +/* + * 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.fescar; + +import com.alibaba.fescar.spring.annotation.GlobalTransactionScanner; + +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.util.StringUtils; + +/** + * @author xiaojing + */ + +@Configuration +@EnableConfigurationProperties(FescarProperties.class) +public class GlobalTransactionAutoConfiguration { + + private final ApplicationContext applicationContext; + + private final FescarProperties fescarProperties; + + public GlobalTransactionAutoConfiguration(ApplicationContext applicationContext, + FescarProperties fescarProperties) { + this.applicationContext = applicationContext; + this.fescarProperties = fescarProperties; + } + + @Bean + public GlobalTransactionScanner globalTransactionScanner() { + + String applicationName = applicationContext.getEnvironment() + .getProperty("spring.application.name"); + + String txServiceGroup = fescarProperties.getTxServiceGroup(); + + if (StringUtils.isEmpty(txServiceGroup)) { + txServiceGroup = applicationName + "-fescar-service-group"; + fescarProperties.setTxServiceGroup(txServiceGroup); + } + + return new GlobalTransactionScanner(applicationName, txServiceGroup); + } +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarBeanPostProcessor.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarBeanPostProcessor.java new file mode 100644 index 00000000..02bd6c32 --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarBeanPostProcessor.java @@ -0,0 +1,44 @@ +/* + * 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.fescar.feign; + +import org.springframework.beans.BeansException; +import org.springframework.beans.factory.config.BeanPostProcessor; + +/** + * @author xiaojing + */ +final class FescarBeanPostProcessor implements BeanPostProcessor { + + private final FescarFeignObjectWrapper fescarFeignObjectWrapper; + + FescarBeanPostProcessor(FescarFeignObjectWrapper fescarFeignObjectWrapper) { + this.fescarFeignObjectWrapper = fescarFeignObjectWrapper; + } + + @Override + public Object postProcessBeforeInitialization(Object bean, String beanName) + throws BeansException { + return this.fescarFeignObjectWrapper.wrap(bean); + } + + @Override + public Object postProcessAfterInitialization(Object bean, String beanName) + throws BeansException { + return bean; + } +} \ No newline at end of file diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarContextBeanPostProcessor.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarContextBeanPostProcessor.java new file mode 100644 index 00000000..ffd8e88e --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarContextBeanPostProcessor.java @@ -0,0 +1,59 @@ +/* + * 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.fescar.feign; + +import org.springframework.beans.BeansException; +import org.springframework.beans.factory.BeanFactory; +import org.springframework.beans.factory.config.BeanPostProcessor; +import org.springframework.cloud.openfeign.FeignContext; + +/** + * @author xiaojing + */ +public class FescarContextBeanPostProcessor implements BeanPostProcessor { + + private final BeanFactory beanFactory; + private FescarFeignObjectWrapper fescarFeignObjectWrapper; + + FescarContextBeanPostProcessor(BeanFactory beanFactory) { + this.beanFactory = beanFactory; + } + + @Override + public Object postProcessBeforeInitialization(Object bean, String beanName) + throws BeansException { + if (bean instanceof FeignContext && !(bean instanceof FescarFeignContext)) { + return new FescarFeignContext(getFescarFeignObjectWrapper(), + (FeignContext) bean); + } + return bean; + } + + @Override + public Object postProcessAfterInitialization(Object bean, String beanName) + throws BeansException { + return bean; + } + + private FescarFeignObjectWrapper getFescarFeignObjectWrapper() { + if (this.fescarFeignObjectWrapper == null) { + this.fescarFeignObjectWrapper = this.beanFactory + .getBean(FescarFeignObjectWrapper.class); + } + return this.fescarFeignObjectWrapper; + } +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignBuilder.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignBuilder.java new file mode 100644 index 00000000..acab33ff --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignBuilder.java @@ -0,0 +1,34 @@ +/* + * 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.fescar.feign; + +import org.springframework.beans.factory.BeanFactory; + +import feign.Feign; + +/** + * @author xiaojing + */ +final class FescarFeignBuilder { + + private FescarFeignBuilder() { + } + + static Feign.Builder builder(BeanFactory beanFactory) { + return Feign.builder().client(new FescarFeignClient(beanFactory)); + } +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignClient.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignClient.java new file mode 100644 index 00000000..9fc9d527 --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignClient.java @@ -0,0 +1,85 @@ +/* + * 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.fescar.feign; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import com.alibaba.fescar.core.context.RootContext; + +import org.springframework.beans.factory.BeanFactory; + +import feign.Client; +import feign.Request; +import feign.Response; +import org.springframework.util.StringUtils; + +/** + * @author xiaojing + */ +public class FescarFeignClient implements Client { + + private final Client delegate; + private final BeanFactory beanFactory; + + FescarFeignClient(BeanFactory beanFactory) { + this.beanFactory = beanFactory; + this.delegate = new Client.Default(null, null); + } + + FescarFeignClient(BeanFactory beanFactory, Client delegate) { + this.delegate = delegate; + this.beanFactory = beanFactory; + } + + @Override + public Response execute(Request request, Request.Options options) throws IOException { + + Request modifiedRequest = getModifyRequest(request); + + try { + return this.delegate.execute(modifiedRequest, options); + } + finally { + + } + } + + private Request getModifyRequest(Request request) { + + String xid = RootContext.getXID(); + + if (StringUtils.isEmpty(xid)) { + return request; + } + + Map> headers = new HashMap<>(); + headers.putAll(request.headers()); + + List fescarXid = new ArrayList<>(); + fescarXid.add(xid); + headers.put(RootContext.KEY_XID, fescarXid); + + return Request.create(request.method(), request.url(), headers, request.body(), + request.charset()); + } + +} \ No newline at end of file diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignClientAutoConfiguration.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignClientAutoConfiguration.java new file mode 100644 index 00000000..1cb2c0cb --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignClientAutoConfiguration.java @@ -0,0 +1,85 @@ +/* + * 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.fescar.feign; + +import org.springframework.beans.factory.BeanFactory; +import org.springframework.boot.autoconfigure.AutoConfigureBefore; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.cloud.openfeign.FeignAutoConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Scope; + +import feign.Client; +import feign.Feign; + +/** + * @author xiaojing + */ + +@Configuration +@ConditionalOnClass(Client.class) +@AutoConfigureBefore(FeignAutoConfiguration.class) +public class FescarFeignClientAutoConfiguration { + + @Bean + @Scope("prototype") + @ConditionalOnClass(name = "com.netflix.hystrix.HystrixCommand") + @ConditionalOnProperty(name = "feign.hystrix.enabled", havingValue = "true") + Feign.Builder feignHystrixBuilder(BeanFactory beanFactory) { + return FescarHystrixFeignBuilder.builder(beanFactory); + } + + @Bean + @Scope("prototype") + @ConditionalOnClass(name = "com.alibaba.csp.sentinel.SphU") + @ConditionalOnProperty(name = "feign.sentinel.enabled", havingValue = "true") + Feign.Builder feignSentinelBuilder(BeanFactory beanFactory) { + return FescarSentinelFeignBuilder.builder(beanFactory); + } + + @Bean + @ConditionalOnMissingBean + @Scope("prototype") + Feign.Builder feignBuilder(BeanFactory beanFactory) { + return FescarFeignBuilder.builder(beanFactory); + } + + @Configuration + protected static class FeignBeanPostProcessorConfiguration { + + @Bean + FescarBeanPostProcessor fescarBeanPostProcessor( + FescarFeignObjectWrapper fescarFeignObjectWrapper) { + return new FescarBeanPostProcessor(fescarFeignObjectWrapper); + } + + @Bean + FescarContextBeanPostProcessor fescarContextBeanPostProcessor( + BeanFactory beanFactory) { + return new FescarContextBeanPostProcessor(beanFactory); + } + + @Bean + FescarFeignObjectWrapper fescarFeignObjectWrapper(BeanFactory beanFactory) { + return new FescarFeignObjectWrapper(beanFactory); + } + } + +} \ No newline at end of file diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignContext.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignContext.java new file mode 100644 index 00000000..bd8d2251 --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignContext.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.fescar.feign; + +import java.util.HashMap; +import java.util.Map; + +import feign.Client; +import org.springframework.cloud.openfeign.FeignContext; + +/** + * + * @author xiaojing + */ +public class FescarFeignContext extends FeignContext { + + private final FescarFeignObjectWrapper fescarFeignObjectWrapper; + private final FeignContext delegate; + + FescarFeignContext(FescarFeignObjectWrapper fescarFeignObjectWrapper, + FeignContext delegate) { + this.fescarFeignObjectWrapper = fescarFeignObjectWrapper; + this.delegate = delegate; + } + + @Override + public T getInstance(String name, Class type) { + T object = this.delegate.getInstance(name, type); + if (object instanceof Client) { + return object; + } + return (T) this.fescarFeignObjectWrapper.wrap(object); + } + + @Override + public Map getInstances(String name, Class type) { + Map instances = this.delegate.getInstances(name, type); + if (instances == null) { + return null; + } + Map convertedInstances = new HashMap<>(); + for (Map.Entry entry : instances.entrySet()) { + if (entry.getValue() instanceof Client) { + convertedInstances.put(entry.getKey(), entry.getValue()); + } + else { + convertedInstances.put(entry.getKey(), + (T) this.fescarFeignObjectWrapper.wrap(entry.getValue())); + } + } + return convertedInstances; + } +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignObjectWrapper.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignObjectWrapper.java new file mode 100644 index 00000000..9b42b2f9 --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarFeignObjectWrapper.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.fescar.feign; + +import org.springframework.beans.factory.BeanFactory; +import org.springframework.cloud.netflix.ribbon.SpringClientFactory; + +import feign.Client; +import org.springframework.cloud.openfeign.ribbon.CachingSpringLoadBalancerFactory; +import org.springframework.cloud.openfeign.ribbon.LoadBalancerFeignClient; + +/** + * @author xiaojing + */ +public class FescarFeignObjectWrapper { + + private final BeanFactory beanFactory; + + private CachingSpringLoadBalancerFactory cachingSpringLoadBalancerFactory; + private SpringClientFactory springClientFactory; + + FescarFeignObjectWrapper(BeanFactory beanFactory) { + this.beanFactory = beanFactory; + } + + Object wrap(Object bean) { + if (bean instanceof Client && !(bean instanceof FescarFeignClient)) { + if (bean instanceof LoadBalancerFeignClient) { + LoadBalancerFeignClient client = ((LoadBalancerFeignClient) bean); + return new FescarLoadBalancerFeignClient(client.getDelegate(), factory(), + clientFactory(), this.beanFactory); + } + return new FescarFeignClient(this.beanFactory, (Client) bean); + } + return bean; + } + + CachingSpringLoadBalancerFactory factory() { + if (this.cachingSpringLoadBalancerFactory == null) { + this.cachingSpringLoadBalancerFactory = this.beanFactory + .getBean(CachingSpringLoadBalancerFactory.class); + } + return this.cachingSpringLoadBalancerFactory; + } + + SpringClientFactory clientFactory() { + if (this.springClientFactory == null) { + this.springClientFactory = this.beanFactory + .getBean(SpringClientFactory.class); + } + return this.springClientFactory; + } +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarHystrixFeignBuilder.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarHystrixFeignBuilder.java new file mode 100644 index 00000000..b67a9d84 --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarHystrixFeignBuilder.java @@ -0,0 +1,37 @@ +/* + * 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.fescar.feign; + +import feign.Retryer; +import feign.hystrix.HystrixFeign; +import org.springframework.beans.factory.BeanFactory; + +import feign.Feign; + +/** + * @author xiaojing + */ +final class FescarHystrixFeignBuilder { + + private FescarHystrixFeignBuilder() { + } + + static Feign.Builder builder(BeanFactory beanFactory) { + return HystrixFeign.builder().retryer(Retryer.NEVER_RETRY) + .client(new FescarFeignClient(beanFactory)); + } +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarLoadBalancerFeignClient.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarLoadBalancerFeignClient.java new file mode 100644 index 00000000..7f00d058 --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarLoadBalancerFeignClient.java @@ -0,0 +1,53 @@ +/* + * 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.fescar.feign; + +import java.io.IOException; + +import org.springframework.beans.factory.BeanFactory; +import org.springframework.cloud.netflix.ribbon.SpringClientFactory; + +import feign.Client; +import feign.Request; +import feign.Response; +import org.springframework.cloud.openfeign.ribbon.CachingSpringLoadBalancerFactory; +import org.springframework.cloud.openfeign.ribbon.LoadBalancerFeignClient; + +/** + * @author xiaojing + */ +public class FescarLoadBalancerFeignClient extends LoadBalancerFeignClient { + + private final BeanFactory beanFactory; + + FescarLoadBalancerFeignClient(Client delegate, + CachingSpringLoadBalancerFactory lbClientFactory, + SpringClientFactory clientFactory, BeanFactory beanFactory) { + super(wrap(delegate, beanFactory), lbClientFactory, clientFactory); + this.beanFactory = beanFactory; + } + + @Override + public Response execute(Request request, Request.Options options) throws IOException { + return super.execute(request, options); + } + + private static Client wrap(Client delegate, BeanFactory beanFactory) { + return (Client) new FescarFeignObjectWrapper(beanFactory).wrap(delegate); + } + +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarSentinelFeignBuilder.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarSentinelFeignBuilder.java new file mode 100644 index 00000000..42f63214 --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/FescarSentinelFeignBuilder.java @@ -0,0 +1,39 @@ +/* + * 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.fescar.feign; + +import org.springframework.beans.factory.BeanFactory; + +import feign.Feign; +import feign.Retryer; +import feign.hystrix.HystrixFeign; +import org.springframework.boot.autoconfigure.data.redis.RedisProperties.Sentinel; +import org.springframework.cloud.alibaba.sentinel.feign.SentinelFeign; + +/** + * @author xiaojing + */ +final class FescarSentinelFeignBuilder { + + private FescarSentinelFeignBuilder() { + } + + static Feign.Builder builder(BeanFactory beanFactory) { + return SentinelFeign.builder().retryer(Retryer.NEVER_RETRY) + .client(new FescarFeignClient(beanFactory)); + } +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/hystrix/FescarHystrixAutoConfiguration.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/hystrix/FescarHystrixAutoConfiguration.java new file mode 100644 index 00000000..f7db4b0d --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/hystrix/FescarHystrixAutoConfiguration.java @@ -0,0 +1,37 @@ +/* + * 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.fescar.feign.hystrix; + +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import com.netflix.hystrix.HystrixCommand; + +/** + * @author xiaojing + */ + +@Configuration +@ConditionalOnClass(HystrixCommand.class) +public class FescarHystrixAutoConfiguration { + + @Bean + FescarHystrixConcurrencyStrategy fescarHystrixConcurrencyStrategy() { + return new FescarHystrixConcurrencyStrategy(); + } + +} \ No newline at end of file diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/hystrix/FescarHystrixConcurrencyStrategy.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/hystrix/FescarHystrixConcurrencyStrategy.java new file mode 100644 index 00000000..e21ff168 --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/feign/hystrix/FescarHystrixConcurrencyStrategy.java @@ -0,0 +1,80 @@ +/* + * 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.fescar.feign.hystrix; + +import java.util.concurrent.Callable; + +import com.alibaba.fescar.core.context.RootContext; + +import com.netflix.hystrix.strategy.HystrixPlugins; +import com.netflix.hystrix.strategy.concurrency.HystrixConcurrencyStrategy; + +/** + * @author xiaojing + */ +public class FescarHystrixConcurrencyStrategy extends HystrixConcurrencyStrategy { + + private HystrixConcurrencyStrategy delegate; + + public FescarHystrixConcurrencyStrategy() { + this.delegate = HystrixPlugins.getInstance().getConcurrencyStrategy(); + HystrixPlugins.reset(); + HystrixPlugins.getInstance().registerConcurrencyStrategy(this); + } + + @Override + public Callable wrapCallable(Callable c) { + if (c instanceof FescarContextCallable) { + return c; + } + + Callable wrappedCallable; + if (this.delegate != null) { + wrappedCallable = this.delegate.wrapCallable(c); + } + else { + wrappedCallable = c; + } + if (wrappedCallable instanceof FescarContextCallable) { + return wrappedCallable; + } + + return new FescarContextCallable<>(wrappedCallable); + } + + private static class FescarContextCallable implements Callable { + + private final Callable actual; + private final String xid; + + FescarContextCallable(Callable actual) { + this.actual = actual; + this.xid = RootContext.getXID(); + } + + @Override + public K call() throws Exception { + try { + RootContext.bind(xid); + return actual.call(); + } + finally { + RootContext.unbind(); + } + } + + } +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/rest/FescarRestTemplateAutoConfiguration.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/rest/FescarRestTemplateAutoConfiguration.java new file mode 100644 index 00000000..91191ed0 --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/rest/FescarRestTemplateAutoConfiguration.java @@ -0,0 +1,76 @@ +/* + * 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. + */ +/* + * 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.fescar.rest; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; + +import javax.annotation.PostConstruct; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.http.client.ClientHttpRequestInterceptor; +import org.springframework.web.client.RestTemplate; + +/** + * @author xiaojing + */ + +@Configuration +public class FescarRestTemplateAutoConfiguration { + + @Bean + public FescarRestTemplateInterceptor fescarRestTemplateInterceptor() { + return new FescarRestTemplateInterceptor(); + } + + @Autowired(required = false) + private Collection restTemplates; + + @Autowired + private FescarRestTemplateInterceptor fescarRestTemplateInterceptor; + + @PostConstruct + public void init() { + if (this.restTemplates != null) { + for (RestTemplate restTemplate : restTemplates) { + List interceptors = new ArrayList( + restTemplate.getInterceptors()); + interceptors.add(this.fescarRestTemplateInterceptor); + restTemplate.setInterceptors(interceptors); + } + } + } + +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/rest/FescarRestTemplateInterceptor.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/rest/FescarRestTemplateInterceptor.java new file mode 100644 index 00000000..5a5b2a10 --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/rest/FescarRestTemplateInterceptor.java @@ -0,0 +1,46 @@ +/* + * 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.fescar.rest; + +import java.io.IOException; + +import com.alibaba.fescar.core.context.RootContext; + +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.client.support.HttpRequestWrapper; +import org.springframework.util.StringUtils; + +/** + * @author xiaojing + */ +public class FescarRestTemplateInterceptor implements ClientHttpRequestInterceptor { + @Override + public ClientHttpResponse intercept(HttpRequest httpRequest, byte[] bytes, + ClientHttpRequestExecution clientHttpRequestExecution) throws IOException { + HttpRequestWrapper requestWrapper = new HttpRequestWrapper(httpRequest); + + String xid = RootContext.getXID(); + + if (!StringUtils.isEmpty(xid)) { + requestWrapper.getHeaders().add(RootContext.KEY_XID, xid); + } + return clientHttpRequestExecution.execute(requestWrapper, bytes); + } +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/web/FescarHandlerInterceptor.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/web/FescarHandlerInterceptor.java new file mode 100644 index 00000000..84ffee8e --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/web/FescarHandlerInterceptor.java @@ -0,0 +1,85 @@ +/* + * 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.fescar.web; + +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +import com.alibaba.fescar.core.context.RootContext; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.util.StringUtils; +import org.springframework.web.servlet.HandlerInterceptor; + +/** + * @author xiaojing + * + * Fescar HandlerInterceptor, Convert Fescar information into + * @see com.alibaba.fescar.core.context.RootContext from http request's header in + * {@link org.springframework.web.servlet.HandlerInterceptor#preHandle(HttpServletRequest , HttpServletResponse , Object )}, + * And clean up Fescar information after servlet method invocation in + * {@link org.springframework.web.servlet.HandlerInterceptor#afterCompletion(HttpServletRequest, HttpServletResponse, Object, Exception)} + */ +public class FescarHandlerInterceptor implements HandlerInterceptor { + + private static final Logger log = LoggerFactory + .getLogger(FescarHandlerInterceptor.class); + + @Override + public boolean preHandle(HttpServletRequest request, HttpServletResponse response, + Object handler) throws Exception { + + String xid = RootContext.getXID(); + String rpcXid = request.getHeader(RootContext.KEY_XID); + if (log.isDebugEnabled()) { + log.debug("xid in RootContext {} xid in RpcContext {}", xid, rpcXid); + } + + if (xid == null && rpcXid != null) { + RootContext.bind(rpcXid); + if (log.isDebugEnabled()) { + log.debug("bind {} to RootContext", rpcXid); + } + } + return true; + } + + @Override + public void afterCompletion(HttpServletRequest request, HttpServletResponse response, + Object handler, Exception e) throws Exception { + + String rpcXid = request.getHeader(RootContext.KEY_XID); + + if (StringUtils.isEmpty(rpcXid)) { + return; + } + + String unbindXid = RootContext.unbind(); + if (log.isDebugEnabled()) { + log.debug("unbind {} from RootContext", unbindXid); + } + if (!rpcXid.equalsIgnoreCase(unbindXid)) { + log.warn("xid in change during RPC from {} to {}", rpcXid, unbindXid); + if (unbindXid != null) { + RootContext.bind(unbindXid); + log.warn("bind {} back to RootContext", unbindXid); + } + } + } + +} diff --git a/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/web/FescarHandlerInterceptorConfiguration.java b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/web/FescarHandlerInterceptorConfiguration.java new file mode 100644 index 00000000..c510b1ac --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/java/org/springframework/cloud/alibaba/fescar/web/FescarHandlerInterceptorConfiguration.java @@ -0,0 +1,31 @@ +/* + * 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.fescar.web; + +import org.springframework.web.servlet.config.annotation.InterceptorRegistry; +import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; + +/** + * @author xiaojing + */ +public class FescarHandlerInterceptorConfiguration implements WebMvcConfigurer { + + @Override + public void addInterceptors(InterceptorRegistry registry) { + registry.addInterceptor(new FescarHandlerInterceptor()).addPathPatterns("/**"); + } +} diff --git a/spring-cloud-alibaba-fescar/src/main/resources/META-INF/spring.factories b/spring-cloud-alibaba-fescar/src/main/resources/META-INF/spring.factories new file mode 100644 index 00000000..3560bcee --- /dev/null +++ b/spring-cloud-alibaba-fescar/src/main/resources/META-INF/spring.factories @@ -0,0 +1,7 @@ +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.springframework.cloud.alibaba.fescar.rest.FescarRestTemplateAutoConfiguration,\ +org.springframework.cloud.alibaba.fescar.web.FescarHandlerInterceptorConfiguration,\ +org.springframework.cloud.alibaba.fescar.GlobalTransactionAutoConfiguration,\ +org.springframework.cloud.alibaba.fescar.feign.FescarFeignClientAutoConfiguration,\ +org.springframework.cloud.alibaba.fescar.feign.hystrix.FescarHystrixAutoConfiguration + 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 8a7be505..4fefa863 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 @@ -30,7 +30,14 @@ import java.util.List; 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.CONTEXT_PATH; +import static com.alibaba.nacos.api.PropertyKeyConst.ENCODE; +import static com.alibaba.nacos.api.PropertyKeyConst.ENDPOINT; +import static com.alibaba.nacos.api.PropertyKeyConst.NAMESPACE; +import static com.alibaba.nacos.api.PropertyKeyConst.SECRET_KEY; +import static com.alibaba.nacos.api.PropertyKeyConst.SERVER_ADDR; /** * nacos properties 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 1b853704..c820d8b0 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 @@ -26,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 xiaojing 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 ac287280..27456512 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 @@ -16,10 +16,11 @@ package org.springframework.cloud.alibaba.nacos; +import org.springframework.boot.ApplicationRunner; import org.springframework.boot.autoconfigure.AutoConfigureAfter; import org.springframework.boot.autoconfigure.AutoConfigureBefore; import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; -import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +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.registry.NacosAutoServiceRegistration; @@ -34,21 +35,20 @@ import org.springframework.context.annotation.Configuration; /** * @author xiaojing + * @author Mercy */ - @Configuration @EnableConfigurationProperties @ConditionalOnNacosDiscoveryEnabled -@ConditionalOnClass(name = "org.springframework.boot.web.servlet.context.ServletWebServerInitializedEvent") @ConditionalOnProperty(value = "spring.cloud.service-registry.auto-registration.enabled", matchIfMissing = true) -@AutoConfigureBefore({ AutoServiceRegistrationAutoConfiguration.class, - NacosDiscoveryClientAutoConfiguration.class }) -@AutoConfigureAfter(AutoServiceRegistrationConfiguration.class) +@AutoConfigureBefore(NacosDiscoveryClientAutoConfiguration.class) +@AutoConfigureAfter(AutoServiceRegistrationAutoConfiguration.class) public class NacosDiscoveryAutoConfiguration { @Bean - public NacosServiceRegistry nacosServiceRegistry() { - return new NacosServiceRegistry(); + public NacosServiceRegistry nacosServiceRegistry( + NacosDiscoveryProperties nacosDiscoveryProperties) { + return new NacosServiceRegistry(nacosDiscoveryProperties); } @Bean @@ -68,4 +68,26 @@ public class NacosDiscoveryAutoConfiguration { return new NacosAutoServiceRegistration(registry, autoServiceRegistrationProperties, registration); } + + @Bean + @ConditionalOnBean(NacosAutoServiceRegistration.class) // NacosAutoServiceRegistration + // should be present + @ConditionalOnNotWebApplication // Not Web Application + public ApplicationRunner applicationRunner( + NacosAutoServiceRegistration nacosAutoServiceRegistration) { + return args -> { + // WebServerInitializedEvent should not be multicast in Non-Web environment. + // Whatever, NacosAutoServiceRegistration must be checked it's running or not. + if (!nacosAutoServiceRegistration.isRunning()) { // If it's not running, let + // it start. + // FIXME: Please make sure "spring.cloud.nacos.discovery.port" must be + // configured on an available port, + // or the startup or Nacos health check will be failed. + nacosAutoServiceRegistration.start(); + // NacosAutoServiceRegistration will be stopped after its destroy() method + // is invoked. + // @PreDestroy destroy() -> stop() + } + }; + } } \ No newline at end of file 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/NacosDiscoveryClient.java index 67e6b441..9333d8ae 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/NacosDiscoveryClient.java @@ -23,7 +23,11 @@ import org.slf4j.LoggerFactory; import org.springframework.cloud.client.ServiceInstance; import org.springframework.cloud.client.discovery.DiscoveryClient; -import java.util.*; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; /** * @author xiaojing 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 86b73bf3..775a502b 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 @@ -39,6 +39,7 @@ import static com.alibaba.nacos.api.PropertyKeyConst.*; /** * @author dungu.zpf * @author xiaojing + * @author Mercy */ @ConfigurationProperties("spring.cloud.nacos.discovery") @@ -160,7 +161,7 @@ public class NacosDiscoveryProperties { else { NetworkInterface netInterface = NetworkInterface .getByName(networkInterface); - if (null == networkInterface) { + if (null == netInterface) { throw new IllegalArgumentException( "no such interface " + networkInterface); } @@ -379,14 +380,13 @@ public class NacosDiscoveryProperties { properties.put(CLUSTER_NAME, clusterName); properties.put(NAMING_LOAD_CACHE_AT_START, namingLoadCacheAtStart); - try { - namingService = NacosFactory.createNamingService(properties); - return namingService; - } - 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; } } diff --git a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/endpoint/NacosDiscoveryEndpointAutoConfiguration.java b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/endpoint/NacosDiscoveryEndpointAutoConfiguration.java index 2356ad0a..0bbee4c2 100644 --- a/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/endpoint/NacosDiscoveryEndpointAutoConfiguration.java +++ b/spring-cloud-alibaba-nacos-discovery/src/main/java/org/springframework/cloud/alibaba/nacos/endpoint/NacosDiscoveryEndpointAutoConfiguration.java @@ -20,6 +20,7 @@ import org.springframework.boot.actuate.autoconfigure.endpoint.condition.Conditi import org.springframework.boot.actuate.endpoint.annotation.Endpoint; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.cloud.alibaba.nacos.ConditionalOnNacosDiscoveryEnabled; import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -29,6 +30,7 @@ import org.springframework.context.annotation.Configuration; */ @Configuration @ConditionalOnClass(Endpoint.class) +@ConditionalOnNacosDiscoveryEnabled public class NacosDiscoveryEndpointAutoConfiguration { @Bean 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 ec60041c..24b0a848 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 @@ -20,83 +20,85 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.cloud.client.serviceregistry.AbstractAutoServiceRegistration; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationProperties; +import org.springframework.cloud.client.serviceregistry.Registration; import org.springframework.cloud.client.serviceregistry.ServiceRegistry; import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** * @author xiaojing + * @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 f3850a18..121d9f9e 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 @@ -18,90 +18,97 @@ package org.springframework.cloud.alibaba.nacos.registry; import com.alibaba.nacos.api.naming.NamingService; import com.alibaba.nacos.api.naming.pojo.Instance; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; +import org.springframework.cloud.client.serviceregistry.Registration; import org.springframework.cloud.client.serviceregistry.ServiceRegistry; import org.springframework.util.StringUtils; /** * @author xiaojing + * @author Mercy */ -public class NacosServiceRegistry implements ServiceRegistry { +public class NacosServiceRegistry implements ServiceRegistry { - private static Logger logger = LoggerFactory.getLogger(NacosServiceRegistry.class); + private static Logger logger = LoggerFactory.getLogger(NacosServiceRegistry.class); - @Override - public void register(NacosRegistration registration) { + private final NacosDiscoveryProperties nacosDiscoveryProperties; - if (!registration.isRegisterEnabled()) { - logger.info("Nacos Registration is disabled..."); - return; - } - if (StringUtils.isEmpty(registration.getServiceId())) { - logger.info("No service to register for nacos client..."); - return; - } + private final NamingService namingService; - NamingService namingService = registration.getNacosNamingService(); - String serviceId = registration.getServiceId(); + public NacosServiceRegistry(NacosDiscoveryProperties nacosDiscoveryProperties) { + this.nacosDiscoveryProperties = nacosDiscoveryProperties; + this.namingService = nacosDiscoveryProperties.namingServiceInstance(); + } - Instance instance = new Instance(); - instance.setIp(registration.getHost()); - instance.setPort(registration.getPort()); - instance.setWeight(registration.getRegisterWeight()); - instance.setClusterName(registration.getCluster()); - 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); - } - } + @Override + public void register(Registration registration) { - @Override - public void deregister(NacosRegistration registration) { + if (StringUtils.isEmpty(registration.getServiceId())) { + logger.info("No service to register for nacos client..."); + return; + } - logger.info("De-registering from Nacos Server now..."); + String serviceId = registration.getServiceId(); - if (StringUtils.isEmpty(registration.getServiceId())) { - logger.info("No dom to de-register for nacos client..."); - return; - } + Instance instance = new Instance(); + instance.setIp(registration.getHost()); + instance.setPort(registration.getPort()); + instance.setWeight(nacosDiscoveryProperties.getWeight()); + instance.setClusterName(nacosDiscoveryProperties.getClusterName()); + instance.setMetadata(registration.getMetadata()); - NamingService namingService = registration.getNacosNamingService(); - String serviceId = registration.getServiceId(); + 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.deregisterInstance(serviceId, registration.getHost(), - registration.getPort(), registration.getCluster()); - } - catch (Exception e) { - logger.error("ERR_NACOS_DEREGISTER, de-register failed...{},", - registration.toString(), e); - } + @Override + public void deregister(Registration registration) { - logger.info("De-registration finished."); - } + logger.info("De-registering from Nacos Server now..."); - @Override - public void close() { + if (StringUtils.isEmpty(registration.getServiceId())) { + logger.info("No dom to de-register for nacos client..."); + return; + } - } + NamingService namingService = nacosDiscoveryProperties.namingServiceInstance(); + String serviceId = registration.getServiceId(); - @Override - public void setStatus(NacosRegistration registration, String status) { - // nacos doesn't support set status of a particular registration. - } + try { + namingService.deregisterInstance(serviceId, registration.getHost(), + registration.getPort(), nacosDiscoveryProperties.getClusterName()); + } catch (Exception e) { + logger.error("ERR_NACOS_DEREGISTER, de-register failed...{},", + registration.toString(), e); + } - @Override - public T getStatus(NacosRegistration registration) { - // nacos doesn't support query status of a particular registration. - return null; - } + logger.info("De-registration finished."); + } + + @Override + public void close() { + + } + + @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; + } } 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 6b83e83c..02195546 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 @@ -16,6 +16,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; @@ -23,8 +24,6 @@ import org.springframework.cloud.alibaba.nacos.NacosDiscoveryProperties; import java.util.ArrayList; import java.util.List; -import com.alibaba.nacos.api.naming.pojo.Instance; - /** * @author xiaojing * @author renhaojun 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 723407fe..91d5ff59 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 @@ -1,6 +1,5 @@ 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.client.discovery.EnableDiscoveryClient=\ -org.springframework.cloud.alibaba.nacos.NacosDiscoveryClientAutoConfiguration + org.springframework.cloud.alibaba.nacos.endpoint.NacosDiscoveryEndpointAutoConfiguration,\ + org.springframework.cloud.alibaba.nacos.NacosDiscoveryClientAutoConfiguration diff --git a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/NacosDataSourceWithAuthorization.java b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/NacosDataSourceWithAuthorization.java deleted file mode 100644 index 6d63c401..00000000 --- a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/NacosDataSourceWithAuthorization.java +++ /dev/null @@ -1,135 +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.sentinel.datasource; - -import java.util.Properties; -import java.util.concurrent.ArrayBlockingQueue; -import java.util.concurrent.Executor; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.ThreadPoolExecutor; -import java.util.concurrent.TimeUnit; - -import com.alibaba.csp.sentinel.concurrent.NamedThreadFactory; -import com.alibaba.csp.sentinel.datasource.AbstractDataSource; -import com.alibaba.csp.sentinel.datasource.Converter; -import com.alibaba.csp.sentinel.datasource.nacos.NacosDataSource; -import com.alibaba.csp.sentinel.log.RecordLog; -import com.alibaba.csp.sentinel.util.StringUtil; -import com.alibaba.nacos.api.NacosFactory; -import com.alibaba.nacos.api.config.ConfigService; -import com.alibaba.nacos.api.config.listener.Listener; - -/** - * {@link NacosDataSource} now is not support ak、sk,namespace and endpoint. This class may - * be delete when {@link NacosDataSource} support commercialized - * - * @author Jim - */ -public class NacosDataSourceWithAuthorization extends AbstractDataSource { - - private static final int DEFAULT_TIMEOUT = 3000; - - private final ExecutorService pool = new ThreadPoolExecutor(1, 1, 0, - TimeUnit.MILLISECONDS, new ArrayBlockingQueue(1), - new NamedThreadFactory("sentinel-nacos-auth-ds-update"), - new ThreadPoolExecutor.DiscardOldestPolicy()); - - private final Listener configListener; - private final Properties properties; - private final String dataId; - private final String groupId; - - private ConfigService configService = null; - - public NacosDataSourceWithAuthorization(final Properties properties, - final String groupId, final String dataId, Converter parser) { - super(parser); - if (StringUtil.isBlank(groupId) || StringUtil.isBlank(dataId)) { - throw new IllegalArgumentException(String - .format("Bad argument: groupId=[%s], dataId=[%s]", groupId, dataId)); - } - this.groupId = groupId; - this.dataId = dataId; - this.properties = properties; - this.configListener = new Listener() { - @Override - public Executor getExecutor() { - return pool; - } - - @Override - public void receiveConfigInfo(final String configInfo) { - RecordLog.info(String.format( - "[NacosDataSourceWithAuthorization] New property value received for %s", - properties.toString())); - T newValue = NacosDataSourceWithAuthorization.this.parser - .convert(configInfo); - // Update the new value to the property. - getProperty().updateValue(newValue); - } - }; - initNacosListener(); - loadInitialConfig(); - } - - private void loadInitialConfig() { - try { - T newValue = loadConfig(); - if (newValue == null) { - RecordLog.warn( - "[NacosDataSourceWithAuthorization] WARN: initial config is null, you may have to check your data source"); - } - getProperty().updateValue(newValue); - } - catch (Exception ex) { - RecordLog.warn( - "[NacosDataSourceWithAuthorization] Error when loading initial config", - ex); - } - } - - private void initNacosListener() { - try { - this.configService = NacosFactory.createConfigService(properties); - // Add config listener. - configService.addListener(dataId, groupId, configListener); - } - catch (Exception e) { - RecordLog.warn( - "[NacosDataSourceWithAuthorization] Error occurred when initializing Nacos data source", - e); - e.printStackTrace(); - } - } - - @Override - public String readSource() throws Exception { - if (configService == null) { - throw new IllegalStateException( - "Nacos config service has not been initialized or error occurred"); - } - return configService.getConfig(dataId, groupId, DEFAULT_TIMEOUT); - } - - @Override - public void close() { - if (configService != null) { - configService.removeListener(dataId, groupId, configListener); - } - pool.shutdownNow(); - } -} diff --git a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/SentinelDataSourceConstants.java b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/SentinelDataSourceConstants.java index 8903b700..345b443d 100644 --- a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/SentinelDataSourceConstants.java +++ b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/SentinelDataSourceConstants.java @@ -23,14 +23,4 @@ public interface SentinelDataSourceConstants { String PROPERTY_PREFIX = "spring.cloud.sentinel"; - String NACOS_DATASOURCE_AK = PROPERTY_PREFIX + ".nacos.config.access-key"; - - String NACOS_DATASOURCE_SK = PROPERTY_PREFIX + ".nacos.config.secret-key"; - - String NACOS_DATASOURCE_NAMESPACE = PROPERTY_PREFIX + ".nacos.config.namespace"; - - String NACOS_DATASOURCE_ENDPOINT = PROPERTY_PREFIX + ".nacos.config.endpoint"; - - String PROJECT_NAME = PROPERTY_PREFIX + ".nacos.config.project-name"; - } diff --git a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/config/AbstractDataSourceProperties.java b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/config/AbstractDataSourceProperties.java index ba6500bb..272252c2 100644 --- a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/config/AbstractDataSourceProperties.java +++ b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/config/AbstractDataSourceProperties.java @@ -27,7 +27,7 @@ public class AbstractDataSourceProperties { private RuleType ruleType; private String converterClass; @JsonIgnore - protected String factoryBeanName; + private final String factoryBeanName; public AbstractDataSourceProperties(String factoryBeanName) { this.factoryBeanName = factoryBeanName; @@ -61,10 +61,6 @@ public class AbstractDataSourceProperties { return factoryBeanName; } - public void setFactoryBeanName(String factoryBeanName) { - this.factoryBeanName = factoryBeanName; - } - public void preCheck(String dataSourceName) { } diff --git a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/config/NacosDataSourceProperties.java b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/config/NacosDataSourceProperties.java index 5be00c78..9df4d473 100644 --- a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/config/NacosDataSourceProperties.java +++ b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/config/NacosDataSourceProperties.java @@ -5,7 +5,6 @@ import javax.validation.constraints.NotEmpty; import org.springframework.cloud.alibaba.sentinel.datasource.RuleType; import org.springframework.cloud.alibaba.sentinel.datasource.SentinelDataSourceConstants; import org.springframework.cloud.alibaba.sentinel.datasource.factorybean.NacosDataSourceFactoryBean; -import org.springframework.cloud.alibaba.sentinel.datasource.factorybean.NacosDataSourceWithAuthorizationFactoryBean; import org.springframework.util.StringUtils; /** @@ -19,13 +18,11 @@ public class NacosDataSourceProperties extends AbstractDataSourceProperties { private String serverAddr; @NotEmpty - private String groupId; + private String groupId = "DEFAULT_GROUP"; @NotEmpty private String dataId; - // commercialized usage - private String endpoint; private String namespace; private String accessKey; @@ -37,19 +34,9 @@ public class NacosDataSourceProperties extends AbstractDataSourceProperties { @Override public void preCheck(String dataSourceName) { - if (!StringUtils.isEmpty(System.getProperties() - .getProperty(SentinelDataSourceConstants.NACOS_DATASOURCE_ENDPOINT))) { - this.setServerAddr(null); - this.setFactoryBeanName( - NacosDataSourceWithAuthorizationFactoryBean.class.getName()); - this.setEndpoint(System.getProperties() - .getProperty(SentinelDataSourceConstants.NACOS_DATASOURCE_ENDPOINT)); - this.setNamespace(System.getProperties() - .getProperty(SentinelDataSourceConstants.NACOS_DATASOURCE_NAMESPACE)); - this.setAccessKey(System.getProperties() - .getProperty(SentinelDataSourceConstants.NACOS_DATASOURCE_AK)); - this.setSecretKey(System.getProperties() - .getProperty(SentinelDataSourceConstants.NACOS_DATASOURCE_SK)); + if (StringUtils.isEmpty(serverAddr) && acmPropertiesInvalid()) { + throw new IllegalArgumentException( + "NacosDataSource properties value not correct. serverAddr is empty but there is empty value in accessKey, secretKey, endpoint, namespace property"); } } @@ -109,36 +96,9 @@ public class NacosDataSourceProperties extends AbstractDataSourceProperties { this.secretKey = secretKey; } - public static NacosDataSourceProperties buildFlowByEDAS() { - return buildByEDAS("flow"); + public boolean acmPropertiesInvalid() { + return StringUtils.isEmpty(endpoint) || StringUtils.isEmpty(accessKey) + || StringUtils.isEmpty(secretKey) || StringUtils.isEmpty(namespace); } - public static NacosDataSourceProperties buildDegradeByEDAS() { - return buildByEDAS("degrade"); - } - - public static NacosDataSourceProperties buildByEDAS(String type) { - NacosDataSourceProperties result = new NacosDataSourceProperties(); - result.setFactoryBeanName( - NacosDataSourceWithAuthorizationFactoryBean.class.getName()); - result.setEndpoint(System.getProperties() - .getProperty(SentinelDataSourceConstants.NACOS_DATASOURCE_ENDPOINT)); - result.setNamespace(System.getProperties() - .getProperty(SentinelDataSourceConstants.NACOS_DATASOURCE_NAMESPACE)); - result.setAccessKey(System.getProperties() - .getProperty(SentinelDataSourceConstants.NACOS_DATASOURCE_AK)); - result.setSecretKey(System.getProperties() - .getProperty(SentinelDataSourceConstants.NACOS_DATASOURCE_SK)); - result.setDataType("json"); - result.setDataId(System.getProperties() - .getProperty(SentinelDataSourceConstants.PROJECT_NAME) + "-" + type); - result.setGroupId("nacos-sentinel"); - if (type.equals(RuleType.FLOW.getName())) { - result.setRuleType(RuleType.FLOW); - } - else { - result.setRuleType(RuleType.DEGRADE); - } - return result; - } } diff --git a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/factorybean/NacosDataSourceFactoryBean.java b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/factorybean/NacosDataSourceFactoryBean.java index cc884d1c..d7894418 100644 --- a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/factorybean/NacosDataSourceFactoryBean.java +++ b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/factorybean/NacosDataSourceFactoryBean.java @@ -2,8 +2,11 @@ package org.springframework.cloud.alibaba.sentinel.datasource.factorybean; import com.alibaba.csp.sentinel.datasource.Converter; import com.alibaba.csp.sentinel.datasource.nacos.NacosDataSource; - +import com.alibaba.nacos.api.PropertyKeyConst; import org.springframework.beans.factory.FactoryBean; +import org.springframework.util.StringUtils; + +import java.util.Properties; /** * A {@link FactoryBean} for creating {@link NacosDataSource} instance. @@ -13,50 +16,99 @@ import org.springframework.beans.factory.FactoryBean; */ public class NacosDataSourceFactoryBean implements FactoryBean { - private String serverAddr; - private String groupId; - private String dataId; - private Converter converter; + private String serverAddr; + private String groupId; + private String dataId; + private Converter converter; - @Override - public NacosDataSource getObject() throws Exception { - return new NacosDataSource(serverAddr, groupId, dataId, converter); - } + private String endpoint; + private String namespace; + private String accessKey; + private String secretKey; - @Override - public Class getObjectType() { - return NacosDataSource.class; - } + @Override + public NacosDataSource getObject() throws Exception { + Properties properties = new Properties(); + if (!StringUtils.isEmpty(this.serverAddr)) { + properties.setProperty(PropertyKeyConst.SERVER_ADDR, this.serverAddr); + } + else { + properties.setProperty(PropertyKeyConst.ACCESS_KEY, this.accessKey); + properties.setProperty(PropertyKeyConst.SECRET_KEY, this.secretKey); + properties.setProperty(PropertyKeyConst.ENDPOINT, this.endpoint); + } + if (!StringUtils.isEmpty(this.namespace)) { + properties.setProperty(PropertyKeyConst.NAMESPACE, this.namespace); + } + return new NacosDataSource(properties, groupId, dataId, converter); + } - public String getServerAddr() { - return serverAddr; - } + @Override + public Class getObjectType() { + return NacosDataSource.class; + } - public void setServerAddr(String serverAddr) { - this.serverAddr = serverAddr; - } + public String getServerAddr() { + return serverAddr; + } - public String getGroupId() { - return groupId; - } + public void setServerAddr(String serverAddr) { + this.serverAddr = serverAddr; + } - public void setGroupId(String groupId) { - this.groupId = groupId; - } + public String getGroupId() { + return groupId; + } - public String getDataId() { - return dataId; - } + public void setGroupId(String groupId) { + this.groupId = groupId; + } - public void setDataId(String dataId) { - this.dataId = dataId; - } + public String getDataId() { + return dataId; + } - public Converter getConverter() { - return converter; - } + public void setDataId(String dataId) { + this.dataId = dataId; + } - public void setConverter(Converter converter) { - this.converter = converter; - } + public Converter getConverter() { + return converter; + } + + public void setConverter(Converter converter) { + this.converter = converter; + } + + public String getEndpoint() { + return endpoint; + } + + public void setEndpoint(String endpoint) { + this.endpoint = endpoint; + } + + public String getNamespace() { + return namespace; + } + + public void setNamespace(String namespace) { + this.namespace = namespace; + } + + public String getAccessKey() { + return accessKey; + } + + public void setAccessKey(String accessKey) { + this.accessKey = accessKey; + } + + public String getSecretKey() { + return secretKey; + } + + public void setSecretKey(String secretKey) { + this.secretKey = secretKey; + } } diff --git a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/factorybean/NacosDataSourceWithAuthorizationFactoryBean.java b/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/factorybean/NacosDataSourceWithAuthorizationFactoryBean.java deleted file mode 100644 index 27f0de86..00000000 --- a/spring-cloud-alibaba-sentinel-datasource/src/main/java/org/springframework/cloud/alibaba/sentinel/datasource/factorybean/NacosDataSourceWithAuthorizationFactoryBean.java +++ /dev/null @@ -1,101 +0,0 @@ -package org.springframework.cloud.alibaba.sentinel.datasource.factorybean; - -import java.util.Properties; - -import org.springframework.beans.factory.FactoryBean; -import org.springframework.cloud.alibaba.sentinel.datasource.NacosDataSourceWithAuthorization; - -import com.alibaba.csp.sentinel.datasource.Converter; -import com.alibaba.csp.sentinel.datasource.nacos.NacosDataSource; -import com.alibaba.nacos.api.PropertyKeyConst; - -/** - * A {@link FactoryBean} for creating {@link NacosDataSource} instance. - * - * @author Jim - * @see NacosDataSource - */ -public class NacosDataSourceWithAuthorizationFactoryBean - implements FactoryBean { - - private String endpoint; - private String namespace; - private String accessKey; - private String secretKey; - - private String groupId; - private String dataId; - private Converter converter; - - @Override - public NacosDataSourceWithAuthorization getObject() throws Exception { - Properties properties = new Properties(); - properties.put(PropertyKeyConst.ACCESS_KEY, accessKey); - properties.put(PropertyKeyConst.SECRET_KEY, secretKey); - properties.put(PropertyKeyConst.NAMESPACE, namespace); - properties.put(PropertyKeyConst.ENDPOINT, endpoint); - return new NacosDataSourceWithAuthorization(properties, groupId, dataId, - converter); - } - - @Override - public Class getObjectType() { - return NacosDataSourceWithAuthorization.class; - } - - public String getEndpoint() { - return endpoint; - } - - public void setEndpoint(String endpoint) { - this.endpoint = endpoint; - } - - public String getNamespace() { - return namespace; - } - - public void setNamespace(String namespace) { - this.namespace = namespace; - } - - public String getAccessKey() { - return accessKey; - } - - public void setAccessKey(String accessKey) { - this.accessKey = accessKey; - } - - public String getSecretKey() { - return secretKey; - } - - public void setSecretKey(String secretKey) { - this.secretKey = secretKey; - } - - public String getGroupId() { - return groupId; - } - - public void setGroupId(String groupId) { - this.groupId = groupId; - } - - public String getDataId() { - return dataId; - } - - public void setDataId(String dataId) { - this.dataId = dataId; - } - - public Converter getConverter() { - return converter; - } - - public void setConverter(Converter converter) { - this.converter = converter; - } -} diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/ApolloDataSourceFactoryBeanTests.java b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/ApolloDataSourceFactoryBeanTests.java new file mode 100644 index 00000000..bc210f2f --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/ApolloDataSourceFactoryBeanTests.java @@ -0,0 +1,71 @@ +/* + * 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.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.when; + +import org.junit.Test; +import org.springframework.cloud.alibaba.sentinel.datasource.converter.JsonConverter; +import org.springframework.cloud.alibaba.sentinel.datasource.factorybean.ApolloDataSourceFactoryBean; + +import com.alibaba.csp.sentinel.datasource.Converter; +import com.alibaba.csp.sentinel.datasource.apollo.ApolloDataSource; + +/** + * @author Jim + */ +public class ApolloDataSourceFactoryBeanTests { + + private String flowRuleKey = "sentinel"; + private String namespace = "namespace"; + private String defaultFlowValue = "{}"; + + @Test + public void testApolloFactoryBean() throws Exception { + ApolloDataSourceFactoryBean factoryBean = spy(new ApolloDataSourceFactoryBean()); + + Converter converter = mock(JsonConverter.class); + + factoryBean.setDefaultFlowRuleValue(defaultFlowValue); + factoryBean.setFlowRulesKey(flowRuleKey); + factoryBean.setNamespaceName(namespace); + factoryBean.setConverter(converter); + + ApolloDataSource apolloDataSource = mock(ApolloDataSource.class); + + when(apolloDataSource.readSource()).thenReturn("{}"); + doReturn(apolloDataSource).when(factoryBean).getObject(); + + assertEquals("ApolloDataSourceFactoryBean getObject error", apolloDataSource, + factoryBean.getObject()); + assertEquals("ApolloDataSource read source value was wrong", "{}", + factoryBean.getObject().readSource()); + assertEquals("ApolloDataSource converter was wrong", converter, + factoryBean.getConverter()); + assertEquals("ApolloDataSourceFactoryBean flowRuleKey was wrong", flowRuleKey, + factoryBean.getFlowRulesKey()); + assertEquals("ApolloDataSourceFactoryBean namespace was wrong", namespace, + factoryBean.getNamespaceName()); + assertEquals("ApolloDataSourceFactoryBean defaultFlowValue was wrong", + defaultFlowValue, factoryBean.getDefaultFlowRuleValue()); + } + +} 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 new file mode 100644 index 00000000..4845d486 --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/DataSourcePropertiesConfigurationTests.java @@ -0,0 +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; + } + +} diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/DataSourcePropertiesTests.java b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/DataSourcePropertiesTests.java new file mode 100644 index 00000000..e96373c8 --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/DataSourcePropertiesTests.java @@ -0,0 +1,180 @@ +/* + * 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.assertNull; + +import java.io.IOException; +import java.util.List; + +import org.codehaus.jackson.map.ObjectMapper; +import org.codehaus.jackson.type.TypeReference; +import org.junit.Test; +import org.springframework.cloud.alibaba.sentinel.datasource.config.ApolloDataSourceProperties; +import org.springframework.cloud.alibaba.sentinel.datasource.config.FileDataSourceProperties; +import org.springframework.cloud.alibaba.sentinel.datasource.config.ZookeeperDataSourceProperties; +import org.springframework.cloud.alibaba.sentinel.datasource.factorybean.ApolloDataSourceFactoryBean; +import org.springframework.cloud.alibaba.sentinel.datasource.factorybean.FileRefreshableDataSourceFactoryBean; +import org.springframework.cloud.alibaba.sentinel.datasource.factorybean.ZookeeperDataSourceFactoryBean; +import org.springframework.util.ResourceUtils; +import org.springframework.util.StringUtils; + +import com.alibaba.csp.sentinel.datasource.Converter; +import com.alibaba.csp.sentinel.datasource.FileRefreshableDataSource; +import com.alibaba.csp.sentinel.slots.block.flow.FlowRule; +import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager; + +/** + * @author Jim + */ +public class DataSourcePropertiesTests { + + @Test + public void testApollo() { + ApolloDataSourceProperties apolloDataSourceProperties = new ApolloDataSourceProperties(); + apolloDataSourceProperties.setFlowRulesKey("test-key"); + apolloDataSourceProperties.setDefaultFlowRuleValue("dft-val"); + apolloDataSourceProperties.setNamespaceName("namespace"); + apolloDataSourceProperties.setRuleType(RuleType.DEGRADE); + assertEquals("Apollo flow rule key was wrong", "test-key", + apolloDataSourceProperties.getFlowRulesKey()); + assertEquals("Apollo namespace was wrong", "namespace", + apolloDataSourceProperties.getNamespaceName()); + assertEquals("Apollo default data type was wrong", "json", + apolloDataSourceProperties.getDataType()); + assertEquals("Apollo rule type was wrong", RuleType.DEGRADE, + apolloDataSourceProperties.getRuleType()); + assertEquals("Apollo default flow value was wrong", "dft-val", + apolloDataSourceProperties.getDefaultFlowRuleValue()); + assertEquals("Apollo factory bean was wrong", + ApolloDataSourceFactoryBean.class.getName(), + apolloDataSourceProperties.getFactoryBeanName()); + assertNull("Apollo converterClass was not null", + apolloDataSourceProperties.getConverterClass()); + } + + @Test + public void testZK() { + ZookeeperDataSourceProperties zookeeperDataSourceProperties = new ZookeeperDataSourceProperties(); + + zookeeperDataSourceProperties.setServerAddr("localhost:2181"); + zookeeperDataSourceProperties.setGroupId("groupId"); + zookeeperDataSourceProperties.setDataId("dataId"); + zookeeperDataSourceProperties.setPath("/path"); + zookeeperDataSourceProperties.setConverterClass("test.ConverterClass"); + zookeeperDataSourceProperties.setRuleType(RuleType.AUTHORITY); + + assertEquals("ZK serverAddr was wrong", "localhost:2181", + zookeeperDataSourceProperties.getServerAddr()); + assertEquals("ZK groupId was wrong", "groupId", + zookeeperDataSourceProperties.getGroupId()); + assertEquals("ZK dataId was wrong", "dataId", + zookeeperDataSourceProperties.getDataId()); + assertEquals("ZK path was wrong", "/path", + zookeeperDataSourceProperties.getPath()); + assertEquals("ZK factory bean was wrong", + ZookeeperDataSourceFactoryBean.class.getName(), + zookeeperDataSourceProperties.getFactoryBeanName()); + assertEquals("ZK custom converter class was wrong", "test.ConverterClass", + zookeeperDataSourceProperties.getConverterClass()); + assertEquals("ZK rule type was wrong", RuleType.AUTHORITY, + zookeeperDataSourceProperties.getRuleType()); + } + + @Test + public void testFileDefaultValue() { + FileDataSourceProperties fileDataSourceProperties = new FileDataSourceProperties(); + + fileDataSourceProperties.setFile("/tmp/test.json"); + fileDataSourceProperties.setRuleType(RuleType.PARAM_FLOW); + + assertEquals("File path was wrong", "/tmp/test.json", + fileDataSourceProperties.getFile()); + assertEquals("File charset was wrong", "utf-8", + fileDataSourceProperties.getCharset()); + assertEquals("File refresh time was wrong", 3000L, + fileDataSourceProperties.getRecommendRefreshMs()); + assertEquals("File buf size was wrong", 1024 * 1024, + fileDataSourceProperties.getBufSize()); + assertEquals("File factory bean was wrong", + FileRefreshableDataSourceFactoryBean.class.getName(), + fileDataSourceProperties.getFactoryBeanName()); + assertEquals("File rule type was wrong", RuleType.PARAM_FLOW, + fileDataSourceProperties.getRuleType()); + } + + @Test + public void testFileCustomValue() { + FileDataSourceProperties fileDataSourceProperties = new FileDataSourceProperties(); + + fileDataSourceProperties.setFile("/tmp/test.json"); + fileDataSourceProperties.setBufSize(1024); + fileDataSourceProperties.setRecommendRefreshMs(2000); + fileDataSourceProperties.setCharset("ISO8859-1"); + + assertEquals("File path was wrong", "/tmp/test.json", + fileDataSourceProperties.getFile()); + assertEquals("File charset was wrong", "ISO8859-1", + fileDataSourceProperties.getCharset()); + assertEquals("File refresh time was wrong", 2000L, + fileDataSourceProperties.getRecommendRefreshMs()); + assertEquals("File buf size was wrong", 1024, + fileDataSourceProperties.getBufSize()); + } + + @Test(expected = RuntimeException.class) + public void testFileException() { + FileDataSourceProperties fileDataSourceProperties = new FileDataSourceProperties(); + fileDataSourceProperties.setFile("classpath: 1.json"); + fileDataSourceProperties.preCheck("test-ds"); + } + + @Test + public void testPostRegister() throws Exception { + FileDataSourceProperties fileDataSourceProperties = new FileDataSourceProperties(); + + fileDataSourceProperties.setFile("classpath: flowrule.json"); + fileDataSourceProperties.setRuleType(RuleType.FLOW); + + FileRefreshableDataSource fileRefreshableDataSource = new FileRefreshableDataSource( + ResourceUtils + .getFile(StringUtils + .trimAllWhitespace(fileDataSourceProperties.getFile())) + .getAbsolutePath(), + new Converter>() { + ObjectMapper objectMapper = new ObjectMapper(); + + @Override + public List convert(String source) { + try { + return objectMapper.readValue(source, + new TypeReference>() { + }); + } + catch (IOException e) { + // ignore + } + return null; + } + }); + fileDataSourceProperties.postRegister(fileRefreshableDataSource); + assertEquals("DataSourceProperties postRegister error", + fileRefreshableDataSource.loadConfig(), FlowRuleManager.getRules()); + } + +} diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/FileRefreshableDataSourceFactoryBeanTests.java b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/FileRefreshableDataSourceFactoryBeanTests.java new file mode 100644 index 00000000..58b87775 --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/FileRefreshableDataSourceFactoryBeanTests.java @@ -0,0 +1,109 @@ +/* + * 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 java.io.FileNotFoundException; +import java.io.IOException; +import java.util.List; + +import org.codehaus.jackson.map.ObjectMapper; +import org.codehaus.jackson.type.TypeReference; +import org.junit.Test; +import org.springframework.cloud.alibaba.sentinel.datasource.factorybean.FileRefreshableDataSourceFactoryBean; +import org.springframework.context.annotation.AnnotationConfigApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.util.ResourceUtils; + +import com.alibaba.csp.sentinel.datasource.Converter; +import com.alibaba.csp.sentinel.datasource.FileRefreshableDataSource; +import com.alibaba.csp.sentinel.slots.block.flow.FlowRule; + +/** + * @author Jim + */ +public class FileRefreshableDataSourceFactoryBeanTests { + + @Test + public void testFile() throws Exception { + AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext( + TestConfig.class); + assertNotNull("FileRefreshableDataSourceFactoryBean was not created", + annotationConfigApplicationContext.getBean("fileBean")); + FileRefreshableDataSource fileRefreshableDataSource = annotationConfigApplicationContext + .getBean("fileBean", FileRefreshableDataSource.class); + assertEquals("FileRefreshableDataSourceFactoryBean flow rule size was wrong", 1, + ((List) fileRefreshableDataSource.loadConfig()).size()); + FileRefreshableDataSourceFactoryBean factoryBean = annotationConfigApplicationContext + .getBean("&fileBean", FileRefreshableDataSourceFactoryBean.class); + assertEquals("FileRefreshableDataSourceFactoryBean buf size was wrong", 1024, + factoryBean.getBufSize()); + assertEquals("FileRefreshableDataSourceFactoryBean charset was wrong", "utf-8", + factoryBean.getCharset()); + assertEquals("FileRefreshableDataSourceFactoryBean recommendRefreshMs was wrong", + 2000, factoryBean.getRecommendRefreshMs()); + assertNotNull("FileRefreshableDataSourceFactoryBean file was null", + factoryBean.getFile()); + assertNotNull("FileRefreshableDataSourceFactoryBean converter was null", + factoryBean.getConverter()); + } + + @Configuration + public static class TestConfig { + + @Bean + public FileRefreshableDataSourceFactoryBean fileBean() { + FileRefreshableDataSourceFactoryBean factoryBean = new FileRefreshableDataSourceFactoryBean(); + factoryBean.setBufSize(1024); + factoryBean.setCharset("utf-8"); + factoryBean.setRecommendRefreshMs(2000); + try { + factoryBean.setFile(ResourceUtils.getFile("classpath:flowrule.json") + .getAbsolutePath()); + } + catch (FileNotFoundException e) { + // ignore + } + factoryBean.setConverter(buildConverter()); + return factoryBean; + } + + private Converter buildConverter() { + return new Converter>() { + ObjectMapper objectMapper = new ObjectMapper(); + + @Override + public List convert(String source) { + try { + return objectMapper.readValue(source, + new TypeReference>() { + }); + } + catch (IOException e) { + // ignore + } + return null; + } + }; + } + + } + +} diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/NacosDataSourceFactoryBeanTests.java b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/NacosDataSourceFactoryBeanTests.java new file mode 100644 index 00000000..e724278c --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/NacosDataSourceFactoryBeanTests.java @@ -0,0 +1,115 @@ +/* + * 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.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.when; + +import org.junit.Test; +import org.springframework.cloud.alibaba.sentinel.datasource.converter.SentinelConverter; +import org.springframework.cloud.alibaba.sentinel.datasource.factorybean.NacosDataSourceFactoryBean; + +import com.alibaba.csp.sentinel.datasource.Converter; +import com.alibaba.csp.sentinel.datasource.nacos.NacosDataSource; + +/** + * @author Jim + */ +public class NacosDataSourceFactoryBeanTests { + + private String dataId = "sentinel"; + private String groupId = "DEFAULT_GROUP"; + private String serverAddr = "localhost:8848"; + private String accessKey = "ak"; + private String secretKey = "sk"; + private String endpoint = "endpoint"; + private String namespace = "namespace"; + + @Test + public void testNacosFactoryBeanServerAddr() throws Exception { + NacosDataSourceFactoryBean factoryBean = spy(new NacosDataSourceFactoryBean()); + + Converter converter = mock(SentinelConverter.class); + + factoryBean.setDataId(dataId); + factoryBean.setGroupId(groupId); + factoryBean.setServerAddr(serverAddr); + factoryBean.setConverter(converter); + + NacosDataSource nacosDataSource = mock(NacosDataSource.class); + + doReturn(nacosDataSource).when(factoryBean).getObject(); + when(nacosDataSource.readSource()).thenReturn("{}"); + + assertEquals("NacosDataSourceFactoryBean getObject was wrong", nacosDataSource, + factoryBean.getObject()); + assertEquals("NacosDataSource read source value was wrong", "{}", + factoryBean.getObject().readSource()); + assertEquals("NacosDataSource converter was wrong", converter, + factoryBean.getConverter()); + assertEquals("NacosDataSourceFactoryBean dataId was wrong", dataId, + factoryBean.getDataId()); + assertEquals("NacosDataSourceFactoryBean groupId was wrong", groupId, + factoryBean.getGroupId()); + assertEquals("NacosDataSourceFactoryBean serverAddr was wrong", serverAddr, + factoryBean.getServerAddr()); + } + + @Test + public void testNacosFactoryBeanProperties() throws Exception { + NacosDataSourceFactoryBean factoryBean = spy(new NacosDataSourceFactoryBean()); + + Converter converter = mock(SentinelConverter.class); + + factoryBean.setDataId(dataId); + factoryBean.setGroupId(groupId); + factoryBean.setAccessKey(accessKey); + factoryBean.setSecretKey(secretKey); + factoryBean.setEndpoint(endpoint); + factoryBean.setNamespace(namespace); + factoryBean.setConverter(converter); + + NacosDataSource nacosDataSource = mock(NacosDataSource.class); + + doReturn(nacosDataSource).when(factoryBean).getObject(); + when(nacosDataSource.readSource()).thenReturn("{}"); + + assertEquals("NacosDataSourceFactoryBean getObject was wrong", nacosDataSource, + factoryBean.getObject()); + assertEquals("NacosDataSource read source value was wrong", "{}", + factoryBean.getObject().readSource()); + assertEquals("NacosDataSource converter was wrong", converter, + factoryBean.getConverter()); + assertEquals("NacosDataSourceFactoryBean dataId was wrong", dataId, + factoryBean.getDataId()); + assertEquals("NacosDataSourceFactoryBean groupId was wrong", groupId, + factoryBean.getGroupId()); + assertEquals("NacosDataSourceFactoryBean namespace was wrong", namespace, + factoryBean.getNamespace()); + assertEquals("NacosDataSourceFactoryBean endpoint was wrong", endpoint, + factoryBean.getEndpoint()); + assertEquals("NacosDataSourceFactoryBean ak was wrong", accessKey, + factoryBean.getAccessKey()); + assertEquals("NacosDataSourceFactoryBean sk was wrong", secretKey, + factoryBean.getSecretKey()); + + } + +} diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/NacosDataSourcePropertiesTests.java b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/NacosDataSourcePropertiesTests.java new file mode 100644 index 00000000..fd2a157c --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/NacosDataSourcePropertiesTests.java @@ -0,0 +1,73 @@ +/* + * 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 org.junit.Test; +import org.springframework.cloud.alibaba.sentinel.datasource.config.NacosDataSourceProperties; +import org.springframework.cloud.alibaba.sentinel.datasource.factorybean.NacosDataSourceFactoryBean; + +/** + * @author Jim + */ +public class NacosDataSourcePropertiesTests { + + @Test + public void testNacosWithAddr() { + NacosDataSourceProperties nacosDataSourceProperties = new NacosDataSourceProperties(); + nacosDataSourceProperties.setServerAddr("127.0.0.1:8848"); + nacosDataSourceProperties.setRuleType(RuleType.FLOW); + nacosDataSourceProperties.setDataId("sentinel"); + nacosDataSourceProperties.setGroupId("custom-group"); + nacosDataSourceProperties.setDataType("xml"); + + assertEquals("Nacos groupId was wrong", "custom-group", + nacosDataSourceProperties.getGroupId()); + assertEquals("Nacos dataId was wrong", "sentinel", + nacosDataSourceProperties.getDataId()); + assertEquals("Nacos default data type was wrong", "xml", + nacosDataSourceProperties.getDataType()); + assertEquals("Nacos rule type was wrong", RuleType.FLOW, + nacosDataSourceProperties.getRuleType()); + assertEquals("Nacos default factory bean was wrong", + NacosDataSourceFactoryBean.class.getName(), + nacosDataSourceProperties.getFactoryBeanName()); + } + + @Test + public void testNacosWithProperties() { + NacosDataSourceProperties nacosDataSourceProperties = new NacosDataSourceProperties(); + nacosDataSourceProperties.setAccessKey("ak"); + nacosDataSourceProperties.setSecretKey("sk"); + nacosDataSourceProperties.setEndpoint("endpoint"); + nacosDataSourceProperties.setNamespace("namespace"); + nacosDataSourceProperties.setRuleType(RuleType.SYSTEM); + + assertEquals("Nacos ak was wrong", "ak", + nacosDataSourceProperties.getAccessKey()); + assertEquals("Nacos sk was wrong", "sk", + nacosDataSourceProperties.getSecretKey()); + assertEquals("Nacos endpoint was wrong", "endpoint", + nacosDataSourceProperties.getEndpoint()); + assertEquals("Nacos namespace was wrong", "namespace", + nacosDataSourceProperties.getNamespace()); + assertEquals("Nacos rule type was wrong", RuleType.SYSTEM, + nacosDataSourceProperties.getRuleType()); + } + +} diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/RuleTypeTests.java b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/RuleTypeTests.java new file mode 100644 index 00000000..a540ab86 --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/RuleTypeTests.java @@ -0,0 +1,87 @@ +/* + * 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.assertFalse; +import static org.junit.Assert.assertTrue; + +import org.junit.Test; + +import com.alibaba.csp.sentinel.slots.block.AbstractRule; +import com.alibaba.csp.sentinel.slots.block.authority.AuthorityRule; +import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRule; +import com.alibaba.csp.sentinel.slots.block.flow.FlowRule; +import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowRule; +import com.alibaba.csp.sentinel.slots.system.SystemRule; + +/** + * @author Jim + */ +public class RuleTypeTests { + + @Test + public void testGetByName() { + assertFalse("empty str rule name was not null", + RuleType.getByName("").isPresent()); + assertFalse("test rule name was not null", + RuleType.getByName("test").isPresent()); + assertFalse("param_flow rule name was not null", + RuleType.getByName("param_flow").isPresent()); + assertFalse("param rule name was not null", + RuleType.getByName("param").isPresent()); + assertFalse("FLOW rule name was not null", + RuleType.getByName("FLOW").isPresent()); + assertTrue("flow rule name was null", RuleType.getByName("flow").isPresent()); + assertTrue("degrade rule name was null", + RuleType.getByName("degrade").isPresent()); + assertTrue("param-flow rule name was null", + RuleType.getByName("param-flow").isPresent()); + assertTrue("system rule name was null", RuleType.getByName("system").isPresent()); + assertTrue("authority rule name was null", + RuleType.getByName("authority").isPresent()); + assertEquals("flow rule name was not equals RuleType.FLOW", RuleType.FLOW, + RuleType.getByName("flow").get()); + assertEquals("flow rule name was not equals RuleType.DEGRADE", RuleType.DEGRADE, + RuleType.getByName("degrade").get()); + assertEquals("flow rule name was not equals RuleType.PARAM_FLOW", + RuleType.PARAM_FLOW, RuleType.getByName("param-flow").get()); + assertEquals("flow rule name was not equals RuleType.SYSTEM", RuleType.SYSTEM, + RuleType.getByName("system").get()); + assertEquals("flow rule name was not equals RuleType.AUTHORITY", + RuleType.AUTHORITY, RuleType.getByName("authority").get()); + } + + @Test + public void testGetByClass() { + assertFalse("Object.class type type was not null", + RuleType.getByClass(Object.class).isPresent()); + assertFalse("AbstractRule.class rule type was not null", + RuleType.getByClass(AbstractRule.class).isPresent()); + assertTrue("FlowRule.class rule type was null", + RuleType.getByClass(FlowRule.class).isPresent()); + assertTrue("DegradeRule.class rule type was null", + RuleType.getByClass(DegradeRule.class).isPresent()); + assertTrue("ParamFlowRule.class rule type was null", + RuleType.getByClass(ParamFlowRule.class).isPresent()); + assertTrue("SystemRule.class rule type was null", + RuleType.getByClass(SystemRule.class).isPresent()); + assertTrue("AuthorityRule.class rule type was null", + RuleType.getByClass(AuthorityRule.class).isPresent()); + } + +} diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/SentinelConverterTests.java b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/SentinelConverterTests.java new file mode 100644 index 00000000..c6ae7a67 --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/SentinelConverterTests.java @@ -0,0 +1,131 @@ +/* + * 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 java.io.IOException; +import java.util.List; + +import org.apache.commons.io.FileUtils; +import org.junit.Test; +import org.springframework.cloud.alibaba.sentinel.datasource.converter.JsonConverter; +import org.springframework.cloud.alibaba.sentinel.datasource.converter.XmlConverter; +import org.springframework.util.ResourceUtils; +import org.springframework.util.StringUtils; + +import com.alibaba.csp.sentinel.slots.block.RuleConstant; +import com.alibaba.csp.sentinel.slots.block.flow.FlowRule; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.dataformat.xml.XmlMapper; + +/** + * @author Jim + */ +public class SentinelConverterTests { + + private ObjectMapper objectMapper = new ObjectMapper(); + + private XmlMapper xmlMapper = new XmlMapper(); + + @Test + public void testJsonConverter() { + JsonConverter jsonConverter = new JsonConverter(objectMapper, FlowRule.class); + List flowRules = jsonConverter + .convert(readFileContent("classpath: flowrule.json")); + assertEquals("json converter flow rule size was wrong", 1, flowRules.size()); + assertEquals("json converter flow rule resource name was wrong", "resource", + flowRules.get(0).getResource()); + assertEquals("json converter flow rule limit app was wrong", "default", + flowRules.get(0).getLimitApp()); + assertEquals("json converter flow rule count was wrong", "1.0", + String.valueOf(flowRules.get(0).getCount())); + assertEquals("json converter flow rule control behavior was wrong", + RuleConstant.CONTROL_BEHAVIOR_DEFAULT, + flowRules.get(0).getControlBehavior()); + assertEquals("json converter flow rule strategy was wrong", + RuleConstant.STRATEGY_DIRECT, flowRules.get(0).getStrategy()); + assertEquals("json converter flow rule grade was wrong", + RuleConstant.FLOW_GRADE_QPS, flowRules.get(0).getGrade()); + } + + @Test + public void testConverterEmptyContent() { + JsonConverter jsonConverter = new JsonConverter(objectMapper, FlowRule.class); + List flowRules = jsonConverter.convert(""); + assertEquals("json converter flow rule size was not empty", 0, flowRules.size()); + } + + @Test(expected = RuntimeException.class) + public void testConverterErrorFormat() { + JsonConverter jsonConverter = new JsonConverter(objectMapper, FlowRule.class); + jsonConverter.convert(readFileContent("classpath: flowrule-errorformat.json")); + } + + @Test(expected = RuntimeException.class) + public void testConverterErrorContent() { + JsonConverter jsonConverter = new JsonConverter(objectMapper, FlowRule.class); + jsonConverter.convert(readFileContent("classpath: flowrule-errorcontent.json")); + } + + @Test + public void testXmlConverter() { + XmlConverter jsonConverter = new XmlConverter(xmlMapper, FlowRule.class); + List flowRules = jsonConverter + .convert(readFileContent("classpath: flowrule.xml")); + assertEquals("xml converter flow rule size was wrong", 2, flowRules.size()); + assertEquals("xml converter flow rule1 resource name was wrong", "resource", + flowRules.get(0).getResource()); + assertEquals("xml converter flow rule2 limit app was wrong", "default", + flowRules.get(0).getLimitApp()); + assertEquals("xml converter flow rule1 count was wrong", "1.0", + String.valueOf(flowRules.get(0).getCount())); + assertEquals("xml converter flow rule1 control behavior was wrong", + RuleConstant.CONTROL_BEHAVIOR_DEFAULT, + flowRules.get(0).getControlBehavior()); + assertEquals("xml converter flow rule1 strategy was wrong", + RuleConstant.STRATEGY_DIRECT, flowRules.get(0).getStrategy()); + assertEquals("xml converter flow rule1 grade was wrong", + RuleConstant.FLOW_GRADE_QPS, flowRules.get(0).getGrade()); + + assertEquals("xml converter flow rule2 resource name was wrong", "test", + flowRules.get(1).getResource()); + assertEquals("xml converter flow rule2 limit app was wrong", "default", + flowRules.get(1).getLimitApp()); + assertEquals("xml converter flow rule2 count was wrong", "1.0", + String.valueOf(flowRules.get(1).getCount())); + assertEquals("xml converter flow rule2 control behavior was wrong", + RuleConstant.CONTROL_BEHAVIOR_DEFAULT, + flowRules.get(1).getControlBehavior()); + assertEquals("xml converter flow rule2 strategy was wrong", + RuleConstant.STRATEGY_DIRECT, flowRules.get(1).getStrategy()); + assertEquals("xml converter flow rule2 grade was wrong", + RuleConstant.FLOW_GRADE_QPS, flowRules.get(1).getGrade()); + } + + private String readFileContent(String file) { + try { + return FileUtils.readFileToString( + ResourceUtils.getFile(StringUtils.trimAllWhitespace(file))); + } + catch (IOException e) { + return ""; + } + } + +} diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/ZookeeperDataSourceFactoryBeanTests.java b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/ZookeeperDataSourceFactoryBeanTests.java new file mode 100644 index 00000000..df7158ce --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/java/org/springframework/cloud/alibaba/sentinel/datasource/ZookeeperDataSourceFactoryBeanTests.java @@ -0,0 +1,102 @@ +/* + * 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.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.when; + +import org.junit.Test; +import org.springframework.cloud.alibaba.sentinel.datasource.converter.XmlConverter; +import org.springframework.cloud.alibaba.sentinel.datasource.factorybean.ZookeeperDataSourceFactoryBean; + +import com.alibaba.csp.sentinel.datasource.Converter; +import com.alibaba.csp.sentinel.datasource.zookeeper.ZookeeperDataSource; + +/** + * @author Jim + */ +public class ZookeeperDataSourceFactoryBeanTests { + + private String dataId = "dataId"; + private String groupId = "groupId"; + private String serverAddr = "localhost:2181"; + + private String path = "/sentinel"; + + @Test + public void testZKWithoutPathFactoryBean() throws Exception { + ZookeeperDataSourceFactoryBean factoryBean = spy( + ZookeeperDataSourceFactoryBean.class); + + Converter converter = mock(XmlConverter.class); + + ZookeeperDataSource zookeeperDataSource = mock(ZookeeperDataSource.class); + + factoryBean.setConverter(converter); + factoryBean.setDataId(dataId); + factoryBean.setGroupId(groupId); + factoryBean.setServerAddr(serverAddr); + + when(zookeeperDataSource.readSource()).thenReturn("{}"); + doReturn(zookeeperDataSource).when(factoryBean).getObject(); + + assertEquals("ZookeeperDataSource getObject was wrong", zookeeperDataSource, + factoryBean.getObject()); + assertEquals("ZookeeperDataSource read source value was wrong", "{}", + factoryBean.getObject().readSource()); + assertEquals("ZookeeperDataSourceFactoryBean dataId was wrong", dataId, + factoryBean.getDataId()); + assertEquals("ZookeeperDataSourceFactoryBean converter was wrong", converter, + factoryBean.getConverter()); + assertEquals("ZookeeperDataSourceFactoryBean groupId was wrong", groupId, + factoryBean.getGroupId()); + assertEquals("ZookeeperDataSourceFactoryBean serverAddr was wrong", serverAddr, + factoryBean.getServerAddr()); + } + + @Test + public void testZKWithPathFactoryBean() throws Exception { + ZookeeperDataSourceFactoryBean factoryBean = spy( + ZookeeperDataSourceFactoryBean.class); + + Converter converter = mock(XmlConverter.class); + + ZookeeperDataSource zookeeperDataSource = mock(ZookeeperDataSource.class); + + factoryBean.setConverter(converter); + factoryBean.setPath(path); + factoryBean.setServerAddr(serverAddr); + + when(zookeeperDataSource.readSource()).thenReturn("{}"); + doReturn(zookeeperDataSource).when(factoryBean).getObject(); + + assertEquals("ZookeeperDataSource value was wrong", zookeeperDataSource, + factoryBean.getObject()); + assertEquals("ZookeeperDataSource read source value was wrong", "{}", + factoryBean.getObject().readSource()); + assertEquals("ZookeeperDataSourceFactoryBean converter was wrong", converter, + factoryBean.getConverter()); + assertEquals("ZookeeperDataSourceFactoryBean path was wrong", path, + factoryBean.getPath()); + assertEquals("ZookeeperDataSourceFactoryBean serverAddr was wrong", serverAddr, + factoryBean.getServerAddr()); + } + +} diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule-errorcontent.json b/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule-errorcontent.json new file mode 100644 index 00000000..7bf60e61 --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule-errorcontent.json @@ -0,0 +1,11 @@ +[ + { + "test": 1, + "controlBehavior": 0, + "count": 1, + "grade": 1, + "limitApp": "default", + "strategy": 0 + } +] + diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule-errorformat.json b/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule-errorformat.json new file mode 100644 index 00000000..48c738b6 --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule-errorformat.json @@ -0,0 +1,10 @@ +[ + { + "resource": "resource", + "controlBehavior": 0, + "count": 1, + "grade": 1, + "limitApp": "default", + "strategy": 0 + }== +] diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule.json b/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule.json new file mode 100644 index 00000000..0f8fbe2b --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule.json @@ -0,0 +1,10 @@ +[ + { + "resource": "resource", + "controlBehavior": 0, + "count": 1, + "grade": 1, + "limitApp": "default", + "strategy": 0 + } +] diff --git a/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule.xml b/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule.xml new file mode 100644 index 00000000..7f1926d3 --- /dev/null +++ b/spring-cloud-alibaba-sentinel-datasource/src/test/resources/flowrule.xml @@ -0,0 +1,21 @@ + + + + resource + 0 + 1 + 1 + default + 0 + + + test + 0 + 1 + 1 + default + 0 + + + + diff --git a/spring-cloud-alibaba-sentinel/pom.xml b/spring-cloud-alibaba-sentinel/pom.xml index 3abdf979..9410a293 100644 --- a/spring-cloud-alibaba-sentinel/pom.xml +++ b/spring-cloud-alibaba-sentinel/pom.xml @@ -42,6 +42,12 @@ true + + org.springframework.cloud + spring-cloud-commons + true + + org.springframework.cloud spring-cloud-starter-netflix-ribbon diff --git a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/SentinelProperties.java b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/SentinelProperties.java index 53aea051..d4621bd7 100644 --- a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/SentinelProperties.java +++ b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/SentinelProperties.java @@ -16,18 +16,17 @@ package org.springframework.cloud.alibaba.sentinel; -import java.util.List; -import java.util.Map; -import java.util.TreeMap; - +import com.alibaba.csp.sentinel.config.SentinelConfig; +import com.alibaba.csp.sentinel.log.LogBase; +import com.alibaba.csp.sentinel.transport.config.TransportConfig; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.cloud.alibaba.sentinel.datasource.config.DataSourcePropertiesConfiguration; import org.springframework.core.Ordered; import org.springframework.validation.annotation.Validated; -import com.alibaba.csp.sentinel.config.SentinelConfig; -import com.alibaba.csp.sentinel.log.LogBase; -import com.alibaba.csp.sentinel.transport.config.TransportConfig; +import java.util.List; +import java.util.Map; +import java.util.TreeMap; /** * {@link ConfigurationProperties} for Sentinel. 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 d70fe785..c9699e66 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 @@ -16,11 +16,7 @@ package org.springframework.cloud.alibaba.sentinel; -import java.util.ArrayList; -import java.util.List; - -import javax.servlet.Filter; - +import com.alibaba.csp.sentinel.adapter.servlet.CommonFilter; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; @@ -31,7 +27,9 @@ import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import com.alibaba.csp.sentinel.adapter.servlet.CommonFilter; +import javax.servlet.Filter; +import java.util.ArrayList; +import java.util.List; /** * @author xiaojing diff --git a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelAutoConfiguration.java b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelAutoConfiguration.java index 27739845..26613a42 100644 --- a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelAutoConfiguration.java +++ b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelAutoConfiguration.java @@ -16,25 +16,6 @@ package org.springframework.cloud.alibaba.sentinel.custom; -import java.util.Optional; - -import javax.annotation.PostConstruct; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.beans.factory.support.DefaultListableBeanFactory; -import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; -import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; -import org.springframework.boot.context.properties.EnableConfigurationProperties; -import org.springframework.cloud.alibaba.sentinel.SentinelProperties; -import org.springframework.cloud.alibaba.sentinel.datasource.converter.JsonConverter; -import org.springframework.cloud.alibaba.sentinel.datasource.converter.XmlConverter; -import org.springframework.context.ApplicationContext; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import org.springframework.util.StringUtils; - import com.alibaba.csp.sentinel.adapter.servlet.callback.RequestOriginParser; import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlBlockHandler; import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlCleaner; @@ -51,9 +32,25 @@ import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowRule; import com.alibaba.csp.sentinel.slots.system.SystemRule; import com.alibaba.csp.sentinel.transport.config.TransportConfig; import com.alibaba.csp.sentinel.util.AppNameUtil; - import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.dataformat.xml.XmlMapper; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.beans.factory.support.DefaultListableBeanFactory; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.cloud.alibaba.sentinel.SentinelProperties; +import org.springframework.cloud.alibaba.sentinel.datasource.converter.JsonConverter; +import org.springframework.cloud.alibaba.sentinel.datasource.converter.XmlConverter; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.util.StringUtils; + +import javax.annotation.PostConstruct; +import java.util.Optional; /** * @author xiaojing 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 18580aa5..4b222d01 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 @@ -16,10 +16,7 @@ package org.springframework.cloud.alibaba.sentinel.custom; -import java.lang.reflect.Method; -import java.util.Arrays; -import java.util.concurrent.ConcurrentHashMap; - +import com.alibaba.csp.sentinel.slots.block.BlockException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.BeansException; @@ -40,7 +37,9 @@ import org.springframework.util.ClassUtils; import org.springframework.util.StringUtils; import org.springframework.web.client.RestTemplate; -import com.alibaba.csp.sentinel.slots.block.BlockException; +import java.lang.reflect.Method; +import java.util.Arrays; +import java.util.concurrent.ConcurrentHashMap; /** * PostProcessor handle @SentinelRestTemplate Annotation, add interceptor for RestTemplate diff --git a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelCircuitBreakerConfiguration.java b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelCircuitBreakerConfiguration.java new file mode 100644 index 00000000..f8d61034 --- /dev/null +++ b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/custom/SentinelCircuitBreakerConfiguration.java @@ -0,0 +1,12 @@ +package org.springframework.cloud.alibaba.sentinel.custom; + +import org.springframework.context.annotation.Configuration; + +/** + * @author lengleng + *

+ * support @EnableCircuitBreaker ,Do nothing + */ +@Configuration +public class SentinelCircuitBreakerConfiguration { +} 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 a6cf6dfa..f781a4ab 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 @@ -6,7 +6,6 @@ import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Optional; -import java.util.TreeMap; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -14,12 +13,8 @@ import org.springframework.beans.factory.SmartInitializingSingleton; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.support.BeanDefinitionBuilder; import org.springframework.beans.factory.support.DefaultListableBeanFactory; -import org.springframework.cloud.alibaba.sentinel.SentinelConstants; import org.springframework.cloud.alibaba.sentinel.SentinelProperties; -import org.springframework.cloud.alibaba.sentinel.datasource.SentinelDataSourceConstants; import org.springframework.cloud.alibaba.sentinel.datasource.config.AbstractDataSourceProperties; -import org.springframework.cloud.alibaba.sentinel.datasource.config.DataSourcePropertiesConfiguration; -import org.springframework.cloud.alibaba.sentinel.datasource.config.NacosDataSourceProperties; import org.springframework.cloud.alibaba.sentinel.datasource.converter.JsonConverter; import org.springframework.cloud.alibaba.sentinel.datasource.converter.XmlConverter; import org.springframework.util.CollectionUtils; @@ -29,8 +24,6 @@ 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 com.alibaba.csp.sentinel.slots.block.degrade.DegradeRuleManager; -import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager; /** * Sentinel {@link ReadableDataSource} Handler Handle the configurations of @@ -63,27 +56,6 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton { @Override public void afterSingletonsInstantiated() { - // commercialization - if (!StringUtils.isEmpty(System.getProperties() - .getProperty(SentinelDataSourceConstants.NACOS_DATASOURCE_ENDPOINT))) { - Map newDataSourceMap = new TreeMap<>( - String.CASE_INSENSITIVE_ORDER); - for (Map.Entry entry : sentinelProperties - .getDatasource().entrySet()) { - if (entry.getValue().getValidDataSourceProperties() - .getClass() != NacosDataSourceProperties.class) { - newDataSourceMap.put(entry.getKey(), entry.getValue()); - } - } - newDataSourceMap.put(SentinelConstants.FLOW_DATASOURCE_NAME, - new DataSourcePropertiesConfiguration( - NacosDataSourceProperties.buildFlowByEDAS())); - newDataSourceMap.put(SentinelConstants.DEGRADE_DATASOURCE_NAME, - new DataSourcePropertiesConfiguration( - NacosDataSourceProperties.buildDegradeByEDAS())); - sentinelProperties.setDatasource(newDataSourceMap); - } - sentinelProperties.getDatasource() .forEach((dataSourceName, dataSourceProperties) -> { try { @@ -214,17 +186,6 @@ public class SentinelDataSourceHandler implements SmartInitializingSingleton { // register property in RuleManager dataSourceProperties.postRegister(newDataSource); - - // commercialization - if (!StringUtils.isEmpty(System.getProperties() - .getProperty(SentinelDataSourceConstants.NACOS_DATASOURCE_ENDPOINT))) { - if (dataSourceName.contains(SentinelConstants.FLOW_DATASOURCE_NAME)) { - FlowRuleManager.register2Property(newDataSource.getProperty()); - } - else if (dataSourceName.contains(SentinelConstants.DEGRADE_DATASOURCE_NAME)) { - DegradeRuleManager.register2Property(newDataSource.getProperty()); - } - } } private void logAndCheckRuleType(AbstractDataSource dataSource, String dataSourceName, 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 49bd003f..a6dcb3c0 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 @@ -16,11 +16,12 @@ package org.springframework.cloud.alibaba.sentinel.custom; -import java.io.IOException; -import java.lang.reflect.InvocationTargetException; -import java.lang.reflect.Method; -import java.net.URI; - +import com.alibaba.csp.sentinel.Entry; +import com.alibaba.csp.sentinel.SphU; +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; @@ -30,12 +31,10 @@ import org.springframework.http.client.ClientHttpRequestExecution; import org.springframework.http.client.ClientHttpRequestInterceptor; import org.springframework.http.client.ClientHttpResponse; -import com.alibaba.csp.sentinel.Entry; -import com.alibaba.csp.sentinel.SphU; -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 java.io.IOException; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.net.URI; /** * Interceptor using by SentinelRestTemplate diff --git a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/endpoint/SentinelEndpoint.java b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/endpoint/SentinelEndpoint.java index d2500768..f42898bc 100644 --- a/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/endpoint/SentinelEndpoint.java +++ b/spring-cloud-alibaba-sentinel/src/main/java/org/springframework/cloud/alibaba/sentinel/endpoint/SentinelEndpoint.java @@ -16,21 +16,21 @@ package org.springframework.cloud.alibaba.sentinel.endpoint; -import java.util.HashMap; -import java.util.Map; - -import org.springframework.boot.actuate.endpoint.annotation.Endpoint; -import org.springframework.boot.actuate.endpoint.annotation.ReadOperation; -import org.springframework.cloud.alibaba.sentinel.SentinelProperties; - import com.alibaba.csp.sentinel.adapter.servlet.config.WebServletConfig; import com.alibaba.csp.sentinel.config.SentinelConfig; import com.alibaba.csp.sentinel.log.LogBase; import com.alibaba.csp.sentinel.slots.block.authority.AuthorityRuleManager; +import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRuleManager; import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager; import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowRuleManager; import com.alibaba.csp.sentinel.slots.system.SystemRuleManager; import com.alibaba.csp.sentinel.transport.config.TransportConfig; +import org.springframework.boot.actuate.endpoint.annotation.Endpoint; +import org.springframework.boot.actuate.endpoint.annotation.ReadOperation; +import org.springframework.cloud.alibaba.sentinel.SentinelProperties; + +import java.util.HashMap; +import java.util.Map; /** * Endpoint for Sentinel, contains ans properties and rules @@ -67,7 +67,7 @@ public class SentinelEndpoint { final Map rules = new HashMap<>(); result.put("rules", rules); rules.put("flowRules", FlowRuleManager.getRules()); - rules.put("degradeRules", SystemRuleManager.getRules()); + rules.put("degradeRules", DegradeRuleManager.getRules()); rules.put("systemRules", SystemRuleManager.getRules()); rules.put("authorityRule", AuthorityRuleManager.getRules()); rules.put("paramFlowRule", ParamFlowRuleManager.getRules()); diff --git a/spring-cloud-alibaba-sentinel/src/main/resources/META-INF/spring.factories b/spring-cloud-alibaba-sentinel/src/main/resources/META-INF/spring.factories index 702bb5bb..d964e3b0 100644 --- a/spring-cloud-alibaba-sentinel/src/main/resources/META-INF/spring.factories +++ b/spring-cloud-alibaba-sentinel/src/main/resources/META-INF/spring.factories @@ -3,3 +3,6 @@ org.springframework.cloud.alibaba.sentinel.SentinelWebAutoConfiguration,\ org.springframework.cloud.alibaba.sentinel.endpoint.SentinelEndpointAutoConfiguration,\ org.springframework.cloud.alibaba.sentinel.custom.SentinelAutoConfiguration,\ org.springframework.cloud.alibaba.sentinel.feign.SentinelFeignAutoConfiguration + +org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker=\ +org.springframework.cloud.alibaba.sentinel.custom.SentinelCircuitBreakerConfiguration diff --git a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelAutoConfigurationTests.java b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelAutoConfigurationTests.java index 2cd3b53a..138c6502 100644 --- a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelAutoConfigurationTests.java +++ b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelAutoConfigurationTests.java @@ -16,15 +16,16 @@ package org.springframework.cloud.alibaba.sentinel; -import static org.assertj.core.api.Assertions.assertThatExceptionOfType; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.mockito.Mockito.mock; -import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; - -import java.util.Arrays; -import java.util.Map; - +import com.alibaba.csp.sentinel.adapter.servlet.config.WebServletConfig; +import com.alibaba.csp.sentinel.config.SentinelConfig; +import com.alibaba.csp.sentinel.log.LogBase; +import com.alibaba.csp.sentinel.slots.block.BlockException; +import com.alibaba.csp.sentinel.slots.block.RuleConstant; +import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRule; +import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRuleManager; +import com.alibaba.csp.sentinel.slots.block.flow.FlowRule; +import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager; +import com.alibaba.csp.sentinel.transport.config.TransportConfig; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; @@ -50,16 +51,14 @@ import org.springframework.test.context.junit4.SpringRunner; import org.springframework.web.client.RestClientException; import org.springframework.web.client.RestTemplate; -import com.alibaba.csp.sentinel.adapter.servlet.config.WebServletConfig; -import com.alibaba.csp.sentinel.config.SentinelConfig; -import com.alibaba.csp.sentinel.log.LogBase; -import com.alibaba.csp.sentinel.slots.block.BlockException; -import com.alibaba.csp.sentinel.slots.block.RuleConstant; -import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRule; -import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRuleManager; -import com.alibaba.csp.sentinel.slots.block.flow.FlowRule; -import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager; -import com.alibaba.csp.sentinel.transport.config.TransportConfig; +import java.util.Arrays; +import java.util.Map; + +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.mockito.Mockito.mock; +import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; /** * @author Jim diff --git a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelBeanAutowiredTests.java b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelBeanAutowiredTests.java index b22f17e8..ed24c33f 100644 --- a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelBeanAutowiredTests.java +++ b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelBeanAutowiredTests.java @@ -16,14 +16,12 @@ package org.springframework.cloud.alibaba.sentinel; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; - -import java.io.IOException; - -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - +import com.alibaba.csp.sentinel.adapter.servlet.callback.RequestOriginParser; +import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlBlockHandler; +import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlCleaner; +import com.alibaba.csp.sentinel.adapter.servlet.callback.WebCallbackManager; +import com.alibaba.csp.sentinel.adapter.servlet.util.FilterUtil; +import com.alibaba.csp.sentinel.slots.block.BlockException; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; @@ -35,12 +33,12 @@ import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.test.context.junit4.SpringRunner; -import com.alibaba.csp.sentinel.adapter.servlet.callback.RequestOriginParser; -import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlBlockHandler; -import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlCleaner; -import com.alibaba.csp.sentinel.adapter.servlet.callback.WebCallbackManager; -import com.alibaba.csp.sentinel.adapter.servlet.util.FilterUtil; -import com.alibaba.csp.sentinel.slots.block.BlockException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import java.io.IOException; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; /** * @author Jim diff --git a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelDataSourceTests.java b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelDataSourceTests.java index 13a6e322..1c3be389 100644 --- a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelDataSourceTests.java +++ b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelDataSourceTests.java @@ -16,10 +16,6 @@ package org.springframework.cloud.alibaba.sentinel; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertNull; - import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; @@ -31,6 +27,10 @@ import org.springframework.cloud.alibaba.sentinel.datasource.RuleType; 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.junit.Assert.assertNull; + /** * @author Jim */ diff --git a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelFeignTests.java b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelFeignTests.java index 3f56f700..b7d03670 100644 --- a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelFeignTests.java +++ b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelFeignTests.java @@ -16,14 +16,9 @@ package org.springframework.cloud.alibaba.sentinel; -import static org.assertj.core.api.Assertions.assertThatExceptionOfType; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertNotEquals; -import static org.junit.Assert.assertNotNull; - -import java.util.Arrays; - +import com.alibaba.csp.sentinel.slots.block.RuleConstant; +import com.alibaba.csp.sentinel.slots.block.flow.FlowRule; +import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; @@ -40,9 +35,13 @@ import org.springframework.test.context.junit4.SpringRunner; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; -import com.alibaba.csp.sentinel.slots.block.RuleConstant; -import com.alibaba.csp.sentinel.slots.block.flow.FlowRule; -import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager; +import java.util.Arrays; + +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotEquals; +import static org.junit.Assert.assertNotNull; /** * @author Jim diff --git a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelRestTemplateTests.java b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelRestTemplateTests.java index f43af925..f95c4616 100644 --- a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelRestTemplateTests.java +++ b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/SentinelRestTemplateTests.java @@ -16,8 +16,7 @@ package org.springframework.cloud.alibaba.sentinel; -import static org.junit.Assert.assertEquals; - +import com.alibaba.csp.sentinel.slots.block.BlockException; import org.junit.Test; import org.springframework.beans.factory.BeanCreationException; import org.springframework.cloud.alibaba.sentinel.annotation.SentinelRestTemplate; @@ -31,7 +30,7 @@ import org.springframework.http.HttpRequest; import org.springframework.http.client.ClientHttpRequestExecution; import org.springframework.web.client.RestTemplate; -import com.alibaba.csp.sentinel.slots.block.BlockException; +import static org.junit.Assert.assertEquals; /** * @author Jim diff --git a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/TestConverter.java b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/TestConverter.java index e7247a41..43012442 100644 --- a/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/TestConverter.java +++ b/spring-cloud-alibaba-sentinel/src/test/java/org/springframework/cloud/alibaba/sentinel/TestConverter.java @@ -16,15 +16,14 @@ package org.springframework.cloud.alibaba.sentinel; -import java.io.IOException; -import java.util.List; - import com.alibaba.csp.sentinel.datasource.Converter; import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowRule; - import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.databind.ObjectMapper; +import java.io.IOException; +import java.util.List; + /** * @author Jim */ diff --git a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmEndpointAutoConfiguration.java b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmEndpointAutoConfiguration.java index 86c7fa18..a2f7d312 100644 --- a/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmEndpointAutoConfiguration.java +++ b/spring-cloud-alicloud-acm/src/main/java/org/springframework/cloud/alicloud/acm/endpoint/AcmEndpointAutoConfiguration.java @@ -51,6 +51,7 @@ public class AcmEndpointAutoConfiguration { } @Bean + @ConditionalOnMissingBean public AcmHealthIndicator acmHealthIndicator(AcmProperties acmProperties, AcmPropertySourceRepository acmPropertySourceRepository) { return new AcmHealthIndicator(acmProperties, acmPropertySourceRepository); diff --git a/spring-cloud-alicloud-ans/pom.xml b/spring-cloud-alicloud-ans/pom.xml index d1fdf2c9..3aa33c0b 100644 --- a/spring-cloud-alicloud-ans/pom.xml +++ b/spring-cloud-alicloud-ans/pom.xml @@ -103,6 +103,18 @@ 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-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 d563632e..d5ab0935 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 @@ -16,7 +16,7 @@ package org.springframework.cloud.alicloud.ans; -import org.springframework.boot.autoconfigure.AutoConfigureBefore; +import org.springframework.boot.autoconfigure.AutoConfigureAfter; import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; @@ -42,8 +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 -@AutoConfigureBefore({ AutoServiceRegistrationAutoConfiguration.class, - AnsDiscoveryClientAutoConfiguration.class }) +@AutoConfigureAfter(AutoServiceRegistrationAutoConfiguration.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 46e1a1bb..36c28c9f 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 @@ -21,7 +21,12 @@ import com.alibaba.ans.shaded.com.taobao.vipserver.client.core.Host; import org.springframework.cloud.client.ServiceInstance; import org.springframework.cloud.client.discovery.DiscoveryClient; -import java.util.*; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Set; /** * @author xiaolongzuo diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateRefreshEventListener.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateRefreshEventListener.java index bb1ac8fa..70d12113 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateRefreshEventListener.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/migrate/MigrateRefreshEventListener.java @@ -1,17 +1,15 @@ package org.springframework.cloud.alicloud.ans.migrate; -import java.util.concurrent.Executors; -import java.util.concurrent.TimeUnit; - -import javax.annotation.PostConstruct; - +import com.netflix.loadbalancer.ILoadBalancer; import org.springframework.cloud.context.named.NamedContextFactory; import org.springframework.cloud.endpoint.event.RefreshEvent; import org.springframework.context.ApplicationListener; import org.springframework.core.env.Environment; import org.springframework.stereotype.Component; -import com.netflix.loadbalancer.ILoadBalancer; +import javax.annotation.PostConstruct; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; /** * @author pbting 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 c863399b..98fe851e 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 @@ -1,15 +1,14 @@ 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.springframework.beans.BeansException; import org.springframework.beans.factory.BeanClassLoaderAware; import org.springframework.beans.factory.config.BeanPostProcessor; -import com.netflix.client.config.IClientConfig; -import com.netflix.loadbalancer.ILoadBalancer; -import com.netflix.loadbalancer.ServerList; - public class MigrateRibbonBeanPostProcessor implements BeanPostProcessor, BeanClassLoaderAware { 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 23964363..16a31147 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 @@ -9,7 +9,12 @@ import org.apache.commons.logging.LogFactory; import org.springframework.cloud.alicloud.ans.ribbon.AnsServer; import org.springframework.cloud.alicloud.ans.ribbon.AnsServerList; -import java.util.*; +import java.util.Collections; +import java.util.Iterator; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Set; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; import java.util.concurrent.ConcurrentSkipListSet; diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsRegistration.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsRegistration.java index 39a98b73..5cbcb732 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsRegistration.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/registry/AnsRegistration.java @@ -16,11 +16,6 @@ package org.springframework.cloud.alicloud.ans.registry; -import java.net.URI; -import java.util.Map; - -import javax.annotation.PostConstruct; - import org.springframework.cloud.alicloud.context.ans.AnsProperties; import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.ServiceInstance; @@ -30,14 +25,18 @@ import org.springframework.context.ApplicationContext; import org.springframework.core.env.Environment; import org.springframework.util.StringUtils; +import javax.annotation.PostConstruct; +import java.net.URI; +import java.util.Map; + /** * @author xiaolongzuo */ public class AnsRegistration implements Registration, ServiceInstance { - private static final String MANAGEMENT_PORT = "management.port"; - private static final String MANAGEMENT_CONTEXT_PATH = "management.context-path"; - private static final String MANAGEMENT_ADDRESS = "management.address"; + static final String MANAGEMENT_PORT = "management.port"; + static final String MANAGEMENT_CONTEXT_PATH = "management.context-path"; + static final String MANAGEMENT_ADDRESS = "management.address"; private AnsProperties ansProperties; private ApplicationContext context; 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 93393ed9..3f1f1516 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 @@ -16,15 +16,14 @@ package org.springframework.cloud.alicloud.ans.ribbon; +import com.netflix.client.config.IClientConfig; +import com.netflix.loadbalancer.ServerList; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.cloud.alicloud.ans.migrate.MigrateOnConditionMissingClass; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Conditional; import org.springframework.context.annotation.Configuration; -import com.netflix.client.config.IClientConfig; -import com.netflix.loadbalancer.ServerList; - /** * @author xiaolongzuo */ diff --git a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/MigrateRibbonCofiguration.java b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/MigrateRibbonCofiguration.java index 5bda207c..9074b786 100644 --- a/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/MigrateRibbonCofiguration.java +++ b/spring-cloud-alicloud-ans/src/main/java/org/springframework/cloud/alicloud/ans/ribbon/MigrateRibbonCofiguration.java @@ -1,13 +1,12 @@ package org.springframework.cloud.alicloud.ans.ribbon; -import org.springframework.cloud.alicloud.ans.migrate.MigrateRibbonBeanPostProcessor; +import com.netflix.client.config.IClientConfig; import org.springframework.cloud.alicloud.ans.migrate.MigrateOnConditionClass; +import org.springframework.cloud.alicloud.ans.migrate.MigrateRibbonBeanPostProcessor; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Conditional; import org.springframework.context.annotation.Configuration; -import com.netflix.client.config.IClientConfig; - @Configuration @Conditional(MigrateOnConditionClass.class) public class MigrateRibbonCofiguration { diff --git a/spring-cloud-alicloud-ans/src/main/resources/META-INF/spring.factories b/spring-cloud-alicloud-ans/src/main/resources/META-INF/spring.factories index f733a74e..63f54329 100644 --- a/spring-cloud-alicloud-ans/src/main/resources/META-INF/spring.factories +++ b/spring-cloud-alicloud-ans/src/main/resources/META-INF/spring.factories @@ -3,6 +3,5 @@ org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.cloud.alicloud.ans.ribbon.RibbonAnsAutoConfiguration,\ org.springframework.cloud.alicloud.ans.AnsAutoConfiguration,\ org.springframework.cloud.alicloud.ans.migrate.MigrateEndpointAutoConfiguration,\ - org.springframework.cloud.alicloud.ans.migrate.MigrationAutoconfiguration -org.springframework.cloud.client.discovery.EnableDiscoveryClient=\ + org.springframework.cloud.alicloud.ans.migrate.MigrationAutoconfiguration,\ org.springframework.cloud.alicloud.ans.AnsDiscoveryClientAutoConfiguration \ No newline at end of file diff --git a/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/AnsDiscoveryClientTests.java b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/AnsDiscoveryClientTests.java new file mode 100644 index 00000000..3e02bc3d --- /dev/null +++ b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/AnsDiscoveryClientTests.java @@ -0,0 +1,116 @@ +/* + * 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.ans; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.when; +import static org.springframework.cloud.alicloud.ans.test.AnsMockTest.hostInstance; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.powermock.api.mockito.PowerMockito; +import org.powermock.core.classloader.annotations.PrepareForTest; +import org.powermock.modules.junit4.PowerMockRunner; +import org.springframework.cloud.client.ServiceInstance; + +import com.alibaba.ans.core.NamingService; +import com.alibaba.ans.shaded.com.taobao.vipserver.client.core.Host; + +/** + * @author xiaojing + */ +@RunWith(PowerMockRunner.class) +@PrepareForTest(NamingService.class) +public class AnsDiscoveryClientTests { + + private String host = "123.123.123.123"; + private int port = 8888; + private String serviceName = "test-service"; + + @Test + public void testGetServers() throws Exception { + + ArrayList hosts = new ArrayList<>(); + + HashMap map = new HashMap<>(); + map.put("test-key", "test-value"); + map.put("secure", "true"); + + hosts.add(hostInstance(serviceName, false, host, port, map)); + + PowerMockito.mockStatic(NamingService.class); + when(NamingService.getHosts(eq(serviceName))).thenReturn(hosts); + + AnsDiscoveryClient discoveryClient = new AnsDiscoveryClient(); + + List serviceInstances = discoveryClient + .getInstances(serviceName); + + assertThat(serviceInstances.size()).isEqualTo(1); + + ServiceInstance serviceInstance = serviceInstances.get(0); + + assertThat(serviceInstance.getServiceId()).isEqualTo(serviceName); + assertThat(serviceInstance.getHost()).isEqualTo(host); + assertThat(serviceInstance.getPort()).isEqualTo(port); + // assertThat(serviceInstance.isSecure()).isEqualTo(true); + // ans doesn't support metadata + assertThat(serviceInstance.getUri().toString()) + .isEqualTo(getUri(serviceInstance)); + // assertThat(serviceInstance.getMetadata().get("test-key")).isEqualTo("test-value"); + // ans doesn't support metadata + + } + + @Test + public void testGetAllService() throws Exception { + + Set subscribedServices = new HashSet<>(); + + subscribedServices.add(serviceName + "1"); + subscribedServices.add(serviceName + "2"); + subscribedServices.add(serviceName + "3"); + + PowerMockito.mockStatic(NamingService.class); + when(NamingService.getDomsSubscribed()).thenReturn(subscribedServices); + + AnsDiscoveryClient discoveryClient = new AnsDiscoveryClient(); + List services = discoveryClient.getServices(); + + assertThat(services.size()).isEqualTo(3); + assertThat(services.contains(serviceName + "1")); + assertThat(services.contains(serviceName + "2")); + assertThat(services.contains(serviceName + "3")); + + } + + private String getUri(ServiceInstance instance) { + + if (instance.isSecure()) { + return "https://" + host + ":" + port; + } + + return "http://" + host + ":" + port; + } +} diff --git a/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationIpNetworkInterfaceTests.java b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationIpNetworkInterfaceTests.java new file mode 100644 index 00000000..7a31f30d --- /dev/null +++ b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationIpNetworkInterfaceTests.java @@ -0,0 +1,148 @@ +/* + * 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.ans.registry; + +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertEquals; +import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; + +import java.net.Inet4Address; +import java.net.InetAddress; +import java.net.NetworkInterface; +import java.util.Enumeration; + +import org.junit.Ignore; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.autoconfigure.ImportAutoConfiguration; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.cloud.alicloud.ans.AnsAutoConfiguration; +import org.springframework.cloud.alicloud.ans.AnsDiscoveryClientAutoConfiguration; +import org.springframework.cloud.alicloud.context.ans.AnsProperties; +import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; +import org.springframework.cloud.commons.util.InetUtils; +import org.springframework.context.annotation.Configuration; +import org.springframework.test.context.junit4.SpringRunner; + +/** + * @author xiaojing + */ + +@RunWith(SpringRunner.class) +@SpringBootTest(classes = AnsAutoServiceRegistrationIpNetworkInterfaceTests.TestConfig.class, properties = { + "spring.application.name=myTestService1", + "spring.cloud.alicloud.ans.server-list=127.0.0.1", + "spring.cloud.alicloud.ans.server-port=8080" }, webEnvironment = RANDOM_PORT) +public class AnsAutoServiceRegistrationIpNetworkInterfaceTests { + + @Autowired + private AnsRegistration registration; + + @Autowired + private AnsAutoServiceRegistration ansAutoServiceRegistration; + + @Autowired + private AnsProperties properties; + + @Autowired + private InetUtils inetUtils; + + @Test + public void contextLoads() throws Exception { + + assertNotNull("AnsRegistration was not created", registration); + assertNotNull("AnsProperties was not created", properties); + assertNotNull("AnsAutoServiceRegistration was not created", + ansAutoServiceRegistration); + + checkoutAnsDiscoveryServiceIP(); + + } + + private void checkoutAnsDiscoveryServiceIP() { + assertEquals("AnsProperties service IP was wrong", + getIPFromNetworkInterface(TestConfig.netWorkInterfaceName), + registration.getHost()); + + } + + private String getIPFromNetworkInterface(String networkInterface) { + + if (!TestConfig.hasValidNetworkInterface) { + return inetUtils.findFirstNonLoopbackHostInfo().getIpAddress(); + } + + try { + NetworkInterface netInterface = NetworkInterface.getByName(networkInterface); + + Enumeration inetAddress = netInterface.getInetAddresses(); + while (inetAddress.hasMoreElements()) { + InetAddress currentAddress = inetAddress.nextElement(); + if (currentAddress instanceof Inet4Address + && !currentAddress.isLoopbackAddress()) { + return currentAddress.getHostAddress(); + } + } + return networkInterface; + } + catch (Exception e) { + return networkInterface; + } + } + + @Configuration + @EnableAutoConfiguration + @ImportAutoConfiguration({ AutoServiceRegistrationConfiguration.class, + AnsDiscoveryClientAutoConfiguration.class, AnsAutoConfiguration.class }) + public static class TestConfig { + + static boolean hasValidNetworkInterface = false; + static String netWorkInterfaceName; + + static { + + try { + Enumeration enumeration = NetworkInterface + .getNetworkInterfaces(); + while (enumeration.hasMoreElements() && !hasValidNetworkInterface) { + NetworkInterface networkInterface = enumeration.nextElement(); + Enumeration inetAddress = networkInterface + .getInetAddresses(); + while (inetAddress.hasMoreElements()) { + InetAddress currentAddress = inetAddress.nextElement(); + if (currentAddress instanceof Inet4Address + && !currentAddress.isLoopbackAddress()) { + hasValidNetworkInterface = true; + netWorkInterfaceName = networkInterface.getName(); + System.setProperty( + "spring.cloud.alicloud.ans.client-interface-name", + networkInterface.getName()); + break; + } + } + } + + } + catch (Exception e) { + + } + } + } + +} diff --git a/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationIpTests.java b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationIpTests.java new file mode 100644 index 00000000..53d7b5c2 --- /dev/null +++ b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationIpTests.java @@ -0,0 +1,81 @@ +/* + * 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.ans.registry; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +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; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.autoconfigure.ImportAutoConfiguration; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.cloud.alicloud.ans.AnsAutoConfiguration; +import org.springframework.cloud.alicloud.ans.AnsDiscoveryClientAutoConfiguration; +import org.springframework.cloud.alicloud.context.ans.AnsProperties; +import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; +import org.springframework.context.annotation.Configuration; +import org.springframework.test.context.junit4.SpringRunner; + +/** + * @author xiaojing + */ + +@RunWith(SpringRunner.class) +@SpringBootTest(classes = AnsAutoServiceRegistrationIpTests.TestConfig.class, properties = { + "spring.application.name=myTestService1", + "spring.cloud.alicloud.ans.server-list=127.0.0.1", + "spring.cloud.alicloud.ans.server-port=8080", + "spring.cloud.alicloud.ans.client-ip=123.123.123.123" }, webEnvironment = RANDOM_PORT) +public class AnsAutoServiceRegistrationIpTests { + + @Autowired + private AnsRegistration registration; + + @Autowired + private AnsAutoServiceRegistration ansAutoServiceRegistration; + + @Autowired + private AnsProperties properties; + + @Test + public void contextLoads() throws Exception { + + assertNotNull("AnsRegistration was not created", registration); + assertNotNull("AnsProperties was not created", properties); + assertNotNull("AnsAutoServiceRegistration was not created", + ansAutoServiceRegistration); + + checkoutAnsDiscoveryServiceIP(); + + } + + private void checkoutAnsDiscoveryServiceIP() { + assertEquals("AnsProperties service IP was wrong", "123.123.123.123", + registration.getHost()); + + } + + @Configuration + @EnableAutoConfiguration + @ImportAutoConfiguration({ AutoServiceRegistrationConfiguration.class, + AnsDiscoveryClientAutoConfiguration.class, AnsAutoConfiguration.class }) + public static class TestConfig { + } +} diff --git a/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationManagementPortTests.java b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationManagementPortTests.java new file mode 100644 index 00000000..a73f25c2 --- /dev/null +++ b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationManagementPortTests.java @@ -0,0 +1,87 @@ +/* + * 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.ans.registry; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; +import static org.springframework.cloud.alicloud.ans.registry.AnsRegistration.MANAGEMENT_CONTEXT_PATH; +import static org.springframework.cloud.alicloud.ans.registry.AnsRegistration.MANAGEMENT_PORT; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.autoconfigure.ImportAutoConfiguration; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.cloud.alicloud.ans.AnsAutoConfiguration; +import org.springframework.cloud.alicloud.ans.AnsDiscoveryClientAutoConfiguration; +import org.springframework.cloud.alicloud.context.ans.AnsProperties; +import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; +import org.springframework.context.annotation.Configuration; +import org.springframework.test.context.junit4.SpringRunner; + +/** + * @author xiaojing + */ + +@RunWith(SpringRunner.class) +@SpringBootTest(classes = AnsAutoServiceRegistrationManagementPortTests.TestConfig.class, properties = { + "spring.application.name=myTestService1", "management.server.port=8888", + "management.server.servlet.context-path=/test-context-path", + "spring.cloud.alicloud.ans.server-list=127.0.0.1", + "spring.cloud.alicloud.ans.server-port=8080" }, webEnvironment = RANDOM_PORT) +public class AnsAutoServiceRegistrationManagementPortTests { + + @Autowired + private AnsRegistration registration; + + @Autowired + private AnsAutoServiceRegistration ansAutoServiceRegistration; + + @Autowired + private AnsProperties properties; + + @Test + public void contextLoads() throws Exception { + + assertNotNull("AnsRegistration was not created", registration); + assertNotNull("AnsProperties was not created", properties); + assertNotNull("AnsAutoServiceRegistration was not created", + ansAutoServiceRegistration); + + checkoutNacosDiscoveryManagementData(); + + } + + private void checkoutNacosDiscoveryManagementData() { + assertEquals("AnsProperties management port was wrong", "8888", + properties.getClientMetadata().get(MANAGEMENT_PORT)); + + assertEquals("AnsProperties management context path was wrong", + "/test-context-path", + properties.getClientMetadata().get(MANAGEMENT_CONTEXT_PATH)); + + } + + @Configuration + @EnableAutoConfiguration + @ImportAutoConfiguration({ AutoServiceRegistrationConfiguration.class, + AnsDiscoveryClientAutoConfiguration.class, AnsAutoConfiguration.class }) + public static class TestConfig { + } +} diff --git a/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationPortTests.java b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationPortTests.java new file mode 100644 index 00000000..20e03eb4 --- /dev/null +++ b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationPortTests.java @@ -0,0 +1,81 @@ +/* + * 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.ans.registry; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +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; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.autoconfigure.ImportAutoConfiguration; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.cloud.alicloud.ans.AnsAutoConfiguration; +import org.springframework.cloud.alicloud.ans.AnsDiscoveryClientAutoConfiguration; +import org.springframework.cloud.alicloud.context.ans.AnsProperties; +import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; +import org.springframework.context.annotation.Configuration; +import org.springframework.test.context.junit4.SpringRunner; + +/** + * @author xiaojing + */ + +@RunWith(SpringRunner.class) +@SpringBootTest(classes = AnsAutoServiceRegistrationPortTests.TestConfig.class, properties = { + "spring.application.name=myTestService1", + "spring.cloud.alicloud.ans.server-list=127.0.0.1", + "spring.cloud.alicloud.ans.server-port=8080", + "spring.cloud.alicloud.ans.client-port=8888" }, webEnvironment = RANDOM_PORT) +public class AnsAutoServiceRegistrationPortTests { + + @Autowired + private AnsRegistration registration; + + @Autowired + private AnsAutoServiceRegistration ansAutoServiceRegistration; + + @Autowired + private AnsProperties properties; + + @Test + public void contextLoads() throws Exception { + + assertNotNull("AnsRegistration was not created", registration); + assertNotNull("AnsDiscoveryProperties was not created", properties); + assertNotNull("AnsAutoServiceRegistration was not created", + ansAutoServiceRegistration); + + checkoutAnsDiscoveryServicePort(); + + } + + private void checkoutAnsDiscoveryServicePort() { + assertEquals("AnsDiscoveryProperties service Port was wrong", 8888, + registration.getPort()); + + } + + @Configuration + @EnableAutoConfiguration + @ImportAutoConfiguration({ AutoServiceRegistrationConfiguration.class, + AnsDiscoveryClientAutoConfiguration.class, AnsAutoConfiguration.class }) + public static class TestConfig { + } +} diff --git a/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationTests.java b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationTests.java new file mode 100644 index 00000000..93381408 --- /dev/null +++ b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/registry/AnsAutoServiceRegistrationTests.java @@ -0,0 +1,158 @@ +/* + * 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.ans.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 java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import com.alibaba.ans.core.NamingService; +import com.alibaba.ans.shaded.com.taobao.vipserver.client.core.Host; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.autoconfigure.ImportAutoConfiguration; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.web.server.LocalServerPort; +import org.springframework.cloud.alicloud.ans.AnsAutoConfiguration; +import org.springframework.cloud.alicloud.ans.AnsDiscoveryClientAutoConfiguration; +import org.springframework.cloud.alicloud.ans.endpoint.AnsEndpoint; +import org.springframework.cloud.alicloud.context.ans.AnsProperties; +import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; +import org.springframework.cloud.commons.util.InetUtils; +import org.springframework.context.annotation.Configuration; +import org.springframework.test.context.junit4.SpringRunner; + +/** + * @author xiaojing + */ + +@RunWith(SpringRunner.class) +@SpringBootTest(classes = AnsAutoServiceRegistrationTests.TestConfig.class, properties = { + "spring.application.name=myTestService1", + "spring.cloud.alicloud.ans.server-list=127.0.0.1", + "spring.cloud.alicloud.ans.server-port=8080", + "spring.cloud.alicloud.ans.endpoint=test-endpoint" }, webEnvironment = RANDOM_PORT) +public class AnsAutoServiceRegistrationTests { + + @Autowired + private AnsRegistration registration; + + @Autowired + private AnsAutoServiceRegistration ansAutoServiceRegistration; + + @LocalServerPort + private int port; + + @Autowired + private AnsProperties properties; + + @Autowired + private InetUtils inetUtils; + + @Test + public void contextLoads() throws Exception { + + assertNotNull("AnsRegistration was not created", registration); + assertNotNull("AnsProperties was not created", properties); + assertNotNull("AnsAutoServiceRegistration was not created", + ansAutoServiceRegistration); + + checkoutAnsDiscoveryServerList(); + checkoutAnsDiscoveryServerPort(); + + checkoutAnsDiscoveryServiceName(); + checkoutAnsDiscoveryServiceIP(); + checkoutAnsDiscoveryServicePort(); + + checkAutoRegister(); + + checkoutEndpoint(); + + } + + private void checkAutoRegister() { + assertTrue("Ans Auto Registration was not start", + ansAutoServiceRegistration.isRunning()); + } + + private void checkoutAnsDiscoveryServerList() { + assertEquals("AnsDiscoveryProperties server list was wrong", "127.0.0.1", + properties.getServerList()); + + } + + private void checkoutAnsDiscoveryServerPort() { + assertEquals("AnsDiscoveryProperties server port was wrong", "8080", + properties.getServerPort()); + + } + + private void checkoutAnsDiscoveryServiceName() { + assertEquals("AnsDiscoveryProperties service name was wrong", "myTestService1", + properties.getClientDomains()); + + } + + private void checkoutAnsDiscoveryServiceIP() { + assertEquals("AnsDiscoveryProperties service IP was wrong", + inetUtils.findFirstNonLoopbackHostInfo().getIpAddress(), + registration.getHost()); + + } + + private void checkoutAnsDiscoveryServicePort() { + assertEquals("AnsDiscoveryProperties service Port was wrong", port, + registration.getPort()); + + } + + private void checkoutEndpoint() throws Exception { + AnsEndpoint ansEndpoint = new AnsEndpoint(properties); + Map map = ansEndpoint.invoke(); + assertEquals(map.get("ansProperties"), properties); + + Map subscribes = new HashMap<>(); + Set subscribeServices = NamingService.getDomsSubscribed(); + for (String service : subscribeServices) { + try { + List hosts = NamingService.getHosts(service); + subscribes.put(service, hosts); + } + catch (Exception ignoreException) { + + } + } + + assertEquals(map.get("subscribes"), subscribes); + } + + @Configuration + @EnableAutoConfiguration + @ImportAutoConfiguration({ AutoServiceRegistrationConfiguration.class, + AnsDiscoveryClientAutoConfiguration.class, AnsAutoConfiguration.class }) + public static class TestConfig { + } +} diff --git a/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/ribbon/AnsRibbonClientConfigurationTests.java b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/ribbon/AnsRibbonClientConfigurationTests.java new file mode 100644 index 00000000..beb825c7 --- /dev/null +++ b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/ribbon/AnsRibbonClientConfigurationTests.java @@ -0,0 +1,86 @@ +/* + * 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.ans.ribbon; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.autoconfigure.ImportAutoConfiguration; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.cloud.alicloud.ans.AnsAutoConfiguration; +import org.springframework.cloud.alicloud.ans.AnsDiscoveryClientAutoConfiguration; +import org.springframework.cloud.client.loadbalancer.LoadBalanced; +import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.web.client.RestTemplate; + +import com.netflix.client.config.DefaultClientConfigImpl; +import com.netflix.client.config.IClientConfig; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; + +/** + * @author xiaojing + */ +@RunWith(SpringRunner.class) +@SpringBootTest(classes = AnsRibbonClientConfigurationTests.TestConfig.class, properties = { + "spring.application.name=myTestService1", + "spring.cloud.alicloud.ans.server-list=127.0.0.1", + "spring.cloud.alicloud.ans.server-port=8080", + "spring.cloud.alicloud.ans.endpoint=test-endpoint" }, webEnvironment = RANDOM_PORT) +public class AnsRibbonClientConfigurationTests { + + @Autowired + private AnsServerList serverList; + + @Test + public void contextLoads() throws Exception { + assertThat(serverList.getDom()).isEqualTo("myapp"); + } + + @Configuration + public static class AnsRibbonTestConfiguration { + + @Bean + IClientConfig iClientConfig() { + DefaultClientConfigImpl config = new DefaultClientConfigImpl(); + config.setClientName("myapp"); + return config; + } + + @Bean + @LoadBalanced + RestTemplate restTemplate() { + return new RestTemplate(); + } + + } + + @Configuration + @EnableAutoConfiguration + @ImportAutoConfiguration({ AutoServiceRegistrationConfiguration.class, + AnsDiscoveryClientAutoConfiguration.class, AnsAutoConfiguration.class, + AnsRibbonTestConfiguration.class, RibbonAnsAutoConfiguration.class, + AnsRibbonClientConfiguration.class }) + public static class TestConfig { + } + +} diff --git a/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/ribbon/AnsServerListTests.java b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/ribbon/AnsServerListTests.java new file mode 100644 index 00000000..815fa89d --- /dev/null +++ b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/ribbon/AnsServerListTests.java @@ -0,0 +1,148 @@ +/* + * 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.ans.ribbon; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; +import static org.springframework.cloud.alicloud.ans.test.AnsMockTest.hostInstance; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.stream.Collectors; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.powermock.api.mockito.PowerMockito; +import org.powermock.core.classloader.annotations.PrepareForTest; +import org.powermock.modules.junit4.PowerMockRunner; + +import com.alibaba.ans.core.NamingService; +import com.alibaba.ans.shaded.com.taobao.vipserver.client.core.Host; + +import com.netflix.client.config.IClientConfig; + +/** + * @author xiaojing + */ +@RunWith(PowerMockRunner.class) +@PrepareForTest({ NamingService.class, AnsServer.class }) +public class AnsServerListTests { + + @Test + @SuppressWarnings("unchecked") + public void testEmptyInstancesReturnsEmptyList() throws Exception { + + PowerMockito.mockStatic(NamingService.class); + when(NamingService.getHosts(anyString())).thenReturn(Collections.EMPTY_LIST); + + IClientConfig clientConfig = mock(IClientConfig.class); + when(clientConfig.getClientName()).thenReturn("test-service"); + AnsServerList serverList = new AnsServerList("test-service"); + serverList.initWithNiwsConfig(clientConfig); + List servers = serverList.getInitialListOfServers(); + assertThat(servers).isEmpty(); + } + + @Test + @SuppressWarnings("unchecked") + public void testGetServers() throws Exception { + + ArrayList hosts = new ArrayList<>(); + hosts.add(hostInstance("test-service", true, Collections.emptyMap())); + + PowerMockito.mockStatic(NamingService.class); + when(NamingService.getHosts(anyString())).thenReturn(hosts); + PowerMockito.stub(PowerMockito.method(AnsServer.class, "isAlive", long.class)) + .toReturn(true); + + IClientConfig clientConfig = mock(IClientConfig.class); + when(clientConfig.getClientName()).thenReturn("test-service"); + AnsServerList serverList = new AnsServerList("test-service"); + serverList.initWithNiwsConfig(clientConfig); + List servers = serverList.getInitialListOfServers(); + assertThat(servers).hasSize(1); + + servers = serverList.getUpdatedListOfServers(); + assertThat(servers).hasSize(1); + } + + @Test + @SuppressWarnings("unchecked") + public void testGetServersWithInstanceStatus() throws Exception { + ArrayList hosts = new ArrayList<>(); + + HashMap map1 = new HashMap<>(); + map1.put("instanceNum", "1"); + HashMap map2 = new HashMap<>(); + map2.put("instanceNum", "2"); + hosts.add(hostInstance("test-service", false, map1)); + hosts.add(hostInstance("test-service", true, map2)); + + PowerMockito.mockStatic(NamingService.class); + when(NamingService.getHosts(eq("test-service"))).thenReturn( + hosts.stream().filter(Host::isValid).collect(Collectors.toList())); + + PowerMockito.stub(PowerMockito.method(AnsServer.class, "isAlive", long.class)) + .toReturn(true); + + IClientConfig clientConfig = mock(IClientConfig.class); + when(clientConfig.getClientName()).thenReturn("test-service"); + AnsServerList serverList = new AnsServerList("test-service"); + serverList.initWithNiwsConfig(clientConfig); + List servers = serverList.getInitialListOfServers(); + assertThat(servers).hasSize(1); + + AnsServer ansServer = servers.get(0); + Host host = ansServer.getHealthService(); + + assertThat(ansServer.getMetaInfo().getInstanceId()).isEqualTo( + host.getIp() + ":" + host.getHostname() + ":" + host.getPort()); + assertThat(ansServer.getHealthService().isValid()).isEqualTo(true); + assertThat(ansServer.getHealthService().getHostname()).isEqualTo("test-service"); + + } + + @Test + public void testUpdateServers() throws Exception { + ArrayList hosts = new ArrayList<>(); + + HashMap map = new HashMap<>(); + map.put("instanceNum", "1"); + hosts.add(hostInstance("test-service", true, map)); + + PowerMockito.mockStatic(NamingService.class); + when(NamingService.getHosts(eq("test-service"))).thenReturn( + hosts.stream().filter(Host::isValid).collect(Collectors.toList())); + PowerMockito.stub(PowerMockito.method(AnsServer.class, "isAlive", long.class)) + .toReturn(true); + + IClientConfig clientConfig = mock(IClientConfig.class); + when(clientConfig.getClientName()).thenReturn("test-service"); + AnsServerList serverList = new AnsServerList("test-service"); + serverList.initWithNiwsConfig(clientConfig); + + List servers = serverList.getUpdatedListOfServers(); + assertThat(servers).hasSize(1); + + assertThat(servers.get(0).getHealthService().isValid()).isEqualTo(true); + } +} \ No newline at end of file diff --git a/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alibaba/ans/ribbon/AnsServiceListTests.java b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/ribbon/AnsServiceListTests.java similarity index 92% rename from spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alibaba/ans/ribbon/AnsServiceListTests.java rename to spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/ribbon/AnsServiceListTests.java index 5cb38532..3e3d59e4 100644 --- a/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alibaba/ans/ribbon/AnsServiceListTests.java +++ b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/ribbon/AnsServiceListTests.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.springframework.cloud.alibaba.ans.ribbon; +package org.springframework.cloud.alicloud.ans.ribbon; import static org.junit.Assert.*; import static org.mockito.BDDMockito.given; @@ -24,8 +24,6 @@ import java.util.Arrays; import java.util.List; import org.junit.Test; -import org.springframework.cloud.alicloud.ans.ribbon.AnsServer; -import org.springframework.cloud.alicloud.ans.ribbon.AnsServerList; import com.alibaba.ans.shaded.com.taobao.vipserver.client.core.Host; import com.netflix.loadbalancer.Server; diff --git a/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/test/AnsMockTest.java b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/test/AnsMockTest.java new file mode 100644 index 00000000..795f2b49 --- /dev/null +++ b/spring-cloud-alicloud-ans/src/test/java/org/springframework/cloud/alicloud/ans/test/AnsMockTest.java @@ -0,0 +1,45 @@ +/* + * 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.ans.test; + +import java.util.Map; + +import com.alibaba.ans.shaded.com.taobao.vipserver.client.core.Host; + +/** + * @author xiaojing + */ +public class AnsMockTest { + + public static Host hostInstance(String serviceName, boolean valid, + Map metadata) { + Host host = new Host(); + host.setHostname(serviceName); + host.setValid(valid); + return host; + } + + public static Host hostInstance(String serviceName, boolean valid, String ip, + int port, Map metadata) { + Host host = new Host(); + host.setIp(ip); + host.setPort(port); + host.setValid(valid); + host.setHostname(serviceName); + return host; + } +} diff --git a/spring-cloud-alicloud-context/pom.xml b/spring-cloud-alicloud-context/pom.xml index 496aea37..b87d920d 100644 --- a/spring-cloud-alicloud-context/pom.xml +++ b/spring-cloud-alicloud-context/pom.xml @@ -113,6 +113,20 @@ test + + org.powermock + powermock-module-junit4 + 2.0.0 + test + + + + org.powermock + powermock-api-mockito2 + 2.0.0 + test + + diff --git a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/ans/AnsProperties.java b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/ans/AnsProperties.java index 2852ff57..1952a524 100644 --- a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/ans/AnsProperties.java +++ b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/ans/AnsProperties.java @@ -42,84 +42,94 @@ import com.alibaba.cloud.context.ans.AnsConfiguration; public class AnsProperties implements AnsConfiguration { /** - * 服务端模式,默认为LOCAL + * Server side mode,the default is LOCAL. */ private AliCloudServerMode serverMode = AliCloudServerMode.LOCAL; /** - * 服务端列表 + * Server list. */ private String serverList = "127.0.0.1"; /** - * 服务端列表 + * Server port. */ private String serverPort = "8080"; /** - * 注册的服务名,默认从 spring.cloud.alicloud.ans.doms 中获取,当没有配置时,使用 spring.application.name + * Service names,default value is ${spring.cloud.alicloud.ans.doms}. When not + * configured, use ${spring.application.name}. */ @Value("${spring.cloud.alicloud.ans.client-domains:${spring.application.name:}}") private String clientDomains; /** - * 注册服务的权重,从配置 spring.cloud.alicloud.ans.weight 中获取,默认为 1 + * The weight of the registration service, obtained from the configuration + * ${spring.cloud.alicloud.ans.weight}, the default is 1. */ private float clientWeight = 1; /** - * 当存在多个doms,需要对应不同的 weight 时,通过 spring.cloud.alicloud.ans.weight.dom1=weight1 的方式配置 + * When there are multiple doms and need to correspond to different weights, configure + * them by spring.cloud.alicloud.ans.weight.dom1=weight1. */ private Map clientWeights = new HashMap(); /** - * 注册服务的 token ,从 spring.cloud.alicloud.ans.token 中获取 + * The token of the registration service, obtained from + * ${spring.cloud.alicloud.ans.token}. */ private String clientToken; /** - * 当存在多个doms,需要对应不同的token时,通过 spring.cloud.alicloud.ans.tokens.dom1=token1 的方式配置 + * When there are multiple doms and need to correspond to different tokens, configure + * them by spring.cloud.alicloud.ans.tokens.dom1=token1. */ private Map clientTokens = new HashMap(); /** - * 配置注册到哪个集群,从 spring.cloud.alicloud.ans.cluster 中获取,默认为 DEFAULT + * Configure which cluster to register with, obtained from + * ${spring.cloud.alicloud.ans.cluster}, defaults to DEFAULT. */ private String clientCluster = "DEFAULT"; /** - * metadata 实现 serviceInstance 接口所需的字段,但 ans 目前尚不支持此字段,配置了也没用 + * Temporarily not supported, reserved fields. */ private Map clientMetadata = new HashMap<>(); /** - * 默认打开注册,可以通过 spring.cloud.alicloud.ans.register-enabled=false 的配置来关闭注册 + * Registration is turned on by default, and registration can be turned off by the + * configuration of spring.cloud.alicloud.ans.register-enabled=false. */ private boolean registerEnabled = true; /** - * 想要发布的服务的ip,从 spring.cloud.alicloud.ans.client-ip 中获取 + * The ip of the service you want to publish, obtained from + * ${spring.cloud.alicloud.ans.client-ip}. */ private String clientIp; /** - * 想要发布的服务的ip从哪一块网卡中获取 + * Configure which NIC the ip of the service you want to publish is obtained from. */ private String clientInterfaceName; /** - * 想要发布的服务的端口,从 spring.cloud.alicloud.ans.port 中获取 + * The port of the service you want to publish. */ private int clientPort = -1; /** - * 租户下的环境隔离配置,相同租户的相同环境下的服务才能互相发现 + * The environment isolation configuration under the tenant, the services in the same + * environment of the same tenant can discover each other. */ @Value("${spring.cloud.alicloud.ans.env:${env.id:DEFAULT}}") private String env; /** - * 是否注册成 https 的形式,通过 spring.cloud.alicloud.ans.secure 来配置,默认为false + * Whether to register as https, configured by ${spring.cloud.alicloud.ans.secure}, + * default is false. */ private boolean secure = false; @@ -131,11 +141,10 @@ public class AnsProperties implements AnsConfiguration { @PostConstruct public void init() throws SocketException { - // 增加注册类型,标记为 spring cloud 应用 + // Marked as spring cloud application tags.put("ANS_SERVICE_TYPE", "SPRING_CLOUD"); if (StringUtils.isEmpty(clientIp)) { - // 如果没有指定注册的ip对应的网卡名,则通过遍历网卡去获取 if (StringUtils.isEmpty(clientInterfaceName)) { clientIp = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress(); } diff --git a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/listener/AbstractOnceApplicationListener.java b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/listener/AbstractOnceApplicationListener.java index d8b822a9..dbe554d9 100644 --- a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/listener/AbstractOnceApplicationListener.java +++ b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/listener/AbstractOnceApplicationListener.java @@ -42,9 +42,8 @@ public abstract class AbstractOnceApplicationListener { private static final Logger log = LoggerFactory @@ -27,12 +30,14 @@ public class NacosParameterInitListener EdasChangeOrderConfiguration edasChangeOrderConfiguration = EdasChangeOrderConfigurationFactory .getEdasChangeOrderConfiguration(); - log.info("Initialize Nacos Parameter from edas change order,is edas 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 System.getProperties().setProperty("spring.cloud.nacos.config.server-addr", ""); System.getProperties().setProperty("spring.cloud.nacos.config.endpoint", diff --git a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/oss/OssContextAutoConfiguration.java b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/oss/OssContextAutoConfiguration.java index 0a3e1309..f197a0f0 100644 --- a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/oss/OssContextAutoConfiguration.java +++ b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/oss/OssContextAutoConfiguration.java @@ -19,6 +19,7 @@ package org.springframework.cloud.alicloud.context.oss; import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.cloud.alicloud.context.AliCloudContextAutoConfiguration; import org.springframework.cloud.alicloud.context.AliCloudProperties; @@ -39,6 +40,7 @@ import com.aliyun.oss.OSSClientBuilder; */ @Configuration @ConditionalOnClass(name = "org.springframework.cloud.alicloud.oss.OssAutoConfiguration") +@ConditionalOnProperty(name = "spring.cloud.alicloud.oss.enabled", matchIfMissing = true) @EnableConfigurationProperties(OssProperties.class) @ImportAutoConfiguration(AliCloudContextAutoConfiguration.class) public class OssContextAutoConfiguration { diff --git a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/scx/ScxContextAutoConfiguration.java b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/scx/ScxContextAutoConfiguration.java index 0d43e86f..d4640c73 100644 --- a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/scx/ScxContextAutoConfiguration.java +++ b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/scx/ScxContextAutoConfiguration.java @@ -16,106 +16,37 @@ package org.springframework.cloud.alicloud.context.scx; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.InitializingBean; -import org.springframework.beans.factory.annotation.Autowired; +import com.alibaba.cloud.context.edas.AliCloudEdasSdk; +import com.alibaba.cloud.context.scx.AliCloudScxInitializer; +import com.alibaba.edas.schedulerx.SchedulerXClient; import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.cloud.alicloud.context.AliCloudProperties; import org.springframework.cloud.alicloud.context.edas.EdasContextAutoConfiguration; import org.springframework.cloud.alicloud.context.edas.EdasProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import org.springframework.util.Assert; -import org.springframework.util.StringUtils; - -import com.alibaba.cloud.context.edas.AliCloudEdasSdk; -import com.alibaba.cloud.context.edas.EdasChangeOrderConfiguration; -import com.alibaba.cloud.context.edas.EdasChangeOrderConfigurationFactory; -import com.alibaba.dts.common.exception.InitException; -import com.alibaba.edas.schedulerx.SchedulerXClient; -import com.aliyuncs.edas.model.v20170801.GetSecureTokenResponse; /** * @author xiaolongzuo */ @Configuration @ConditionalOnClass(name = "org.springframework.cloud.alicloud.scx.ScxAutoConfiguration") +@ConditionalOnProperty(name = "spring.cloud.alicloud.scx.enabled", matchIfMissing = true) @EnableConfigurationProperties(ScxProperties.class) @ImportAutoConfiguration(EdasContextAutoConfiguration.class) -public class ScxContextAutoConfiguration implements InitializingBean { +public class ScxContextAutoConfiguration { - private static final Logger log = LoggerFactory - .getLogger(ScxContextAutoConfiguration.class); - - private static final String TEST_REGION = "cn-test"; - - private static final String DEFAULT_KEY = "123456"; - - @Autowired - private SchedulerXClient schedulerXClient; - - @Bean + @Bean(initMethod = "init") + @ConditionalOnMissingBean public SchedulerXClient schedulerXClient(AliCloudProperties aliCloudProperties, EdasProperties edasProperties, ScxProperties scxProperties, AliCloudEdasSdk aliCloudEdasSdk) { - Assert.isTrue(!StringUtils.isEmpty(scxProperties.getGroupId()), - "${spring.cloud.alicloud.scx.group-id} can't be null."); - SchedulerXClient schedulerXClient = new SchedulerXClient(); - schedulerXClient.setGroupId(scxProperties.getGroupId()); - - EdasChangeOrderConfiguration edasChangeOrderConfiguration = EdasChangeOrderConfigurationFactory - .getEdasChangeOrderConfiguration(); - if (edasChangeOrderConfiguration.isEdasManaged()) { - if (edasChangeOrderConfiguration.getRegionId() != null) { - schedulerXClient - .setRegionName(edasChangeOrderConfiguration.getRegionId()); - } - else { - Assert.isTrue(!StringUtils.isEmpty(edasProperties.getNamespace()), - "${spring.cloud.alicloud.edas.namespace} can't be null."); - schedulerXClient.setRegionName(edasProperties.getRegionId()); - } - schedulerXClient.setDomainName(scxProperties.getDomainName()); - schedulerXClient - .setAccessKey(edasChangeOrderConfiguration.getDauthAccessKey()); - schedulerXClient - .setSecretKey(edasChangeOrderConfiguration.getDauthSecretKey()); - } - else if (TEST_REGION.equals(edasProperties.getNamespace())) { - Assert.isTrue(!StringUtils.isEmpty(edasProperties.getNamespace()), - "${spring.cloud.alicloud.edas.namespace} can't be null."); - schedulerXClient.setRegionName(edasProperties.getNamespace()); - schedulerXClient.setAccessKey(DEFAULT_KEY); - schedulerXClient.setSecretKey(DEFAULT_KEY); - } - else { - Assert.isTrue(!StringUtils.isEmpty(edasProperties.getNamespace()), - "${spring.cloud.alicloud.edas.namespace} can't be null."); - Assert.isTrue(!StringUtils.isEmpty(aliCloudProperties.getAccessKey()), - "${spring.cloud.alicloud.access-key} can't be empty."); - Assert.isTrue(!StringUtils.isEmpty(aliCloudProperties.getSecretKey()), - "${spring.cloud.alicloud.secret-key} can't be empty."); - GetSecureTokenResponse.SecureToken secureToken = aliCloudEdasSdk - .getSecureToken(edasProperties.getNamespace()); - schedulerXClient.setRegionName(edasProperties.getRegionId()); - schedulerXClient.setDomainName(scxProperties.getDomainName()); - schedulerXClient.setAccessKey(secureToken.getAccessKey()); - schedulerXClient.setSecretKey(secureToken.getSecretKey()); - } - return schedulerXClient; + return AliCloudScxInitializer.initialize(aliCloudProperties, edasProperties, + scxProperties, aliCloudEdasSdk); } - @Override - public void afterPropertiesSet() { - try { - schedulerXClient.init(); - } - catch (InitException e) { - log.error("Init SchedulerX failed.", e); - throw new RuntimeException(e); - } - } } diff --git a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsConfigProperties.java b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsConfigProperties.java deleted file mode 100644 index 022c5e19..00000000 --- a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsConfigProperties.java +++ /dev/null @@ -1,107 +0,0 @@ -package org.springframework.cloud.alicloud.context.sms; - -import org.springframework.boot.context.properties.ConfigurationProperties; -import org.springframework.cloud.alicloud.context.AliCloudProperties; -import org.springframework.core.env.Environment; -import org.springframework.util.StringUtils; - -import java.io.Serializable; - -/** - * @author pbting - */ -@ConfigurationProperties(prefix = "spring.cloud.alicloud.sms") -public class SmsConfigProperties implements Serializable { - - // 产品名称:云通信短信API产品,开发者无需替换 - public static final String smsProduct = "Dysmsapi"; - // 产品域名,开发者无需替换 - public static final String smsDomain = "dysmsapi.aliyuncs.com"; - - private AliCloudProperties aliCloudProperties; - - /** - * - */ - private String reportQueueName; - /** - * - */ - private String upQueueName; - - /** - * - */ - protected String connnectTimeout = "10000"; - - /** - * - */ - protected String readTimeout = "10000"; - - public SmsConfigProperties(AliCloudProperties aliCloudProperties) { - this.aliCloudProperties = aliCloudProperties; - } - - public String getConnnectTimeout() { - return connnectTimeout; - } - - public void setConnnectTimeout(String connnectTimeout) { - this.connnectTimeout = connnectTimeout; - } - - public String getReadTimeout() { - return readTimeout; - } - - public void setReadTimeout(String readTimeout) { - this.readTimeout = readTimeout; - } - - public void overiideFromEnv(Environment environment) { - overiideCustomFromEnv(environment); - if (StringUtils.isEmpty(connnectTimeout)) { - String resolveResult = environment.resolveRequiredPlaceholders( - "${spring.cloud.alibaba.sms.connect-timeout:}"); - this.setConnnectTimeout( - StringUtils.isEmpty(resolveResult) ? "10000" : resolveResult); - } - - if (StringUtils.isEmpty(readTimeout)) { - String resolveResult = environment.resolveRequiredPlaceholders( - "${spring.cloud.alibaba.sms.read-timeout:}"); - this.setReadTimeout( - StringUtils.isEmpty(resolveResult) ? "10000" : resolveResult); - } - } - - public void overiideCustomFromEnv(Environment environment) { - // nothing to do - } - - public String getReportQueueName() { - return reportQueueName; - } - - public void setReportQueueName(String reportQueueName) { - this.reportQueueName = reportQueueName; - } - - public String getUpQueueName() { - return upQueueName; - } - - public String getAccessKeyId() { - return aliCloudProperties.getAccessKey(); - } - - public String getAccessKeySecret() { - return aliCloudProperties.getSecretKey(); - } - - public void setUpQueueName(String upQueueName) { - this.upQueueName = upQueueName; - } - -} \ No newline at end of file diff --git a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsConfigRegistration.java b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsConfigRegistration.java deleted file mode 100644 index 55564262..00000000 --- a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsConfigRegistration.java +++ /dev/null @@ -1,26 +0,0 @@ -package org.springframework.cloud.alicloud.context.sms; - -import org.springframework.core.env.Environment; - -import javax.annotation.PostConstruct; - -/** - * @author pbting - */ -public class SmsConfigRegistration { - - private Environment environment; - - private SmsConfigProperties smsConfigProperties; - - public SmsConfigRegistration(Environment environment, - SmsConfigProperties smsConfigProperties) { - this.environment = environment; - this.smsConfigProperties = smsConfigProperties; - } - - @PostConstruct - public void initSmsConfigRegistration() { - smsConfigProperties.overiideFromEnv(environment); - } -} \ No newline at end of file diff --git a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsContextAutoConfiguration.java b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsContextAutoConfiguration.java index 6f1e4416..664647dd 100644 --- a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsContextAutoConfiguration.java +++ b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsContextAutoConfiguration.java @@ -3,28 +3,16 @@ package org.springframework.cloud.alicloud.context.sms; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.boot.context.properties.EnableConfigurationProperties; -import org.springframework.cloud.alicloud.context.AliCloudProperties; -import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import org.springframework.core.env.Environment; +/** + * @author pbting + * @author xiaolongzuo + */ @Configuration -@EnableConfigurationProperties +@EnableConfigurationProperties(SmsProperties.class) @ConditionalOnClass(name = "com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest") @ConditionalOnProperty(value = "spring.cloud.alibaba.deshao.enable.sms", matchIfMissing = true) public class SmsContextAutoConfiguration { - @Bean - public SmsConfigProperties smsConfigProperties( - AliCloudProperties aliCloudProperties) { - - return new SmsConfigProperties(aliCloudProperties); - } - - @Bean - public SmsConfigRegistration smsConfigRegistration(Environment environment, - SmsConfigProperties smsConfigProperties) { - - return new SmsConfigRegistration(environment, smsConfigProperties); - } } \ No newline at end of file diff --git a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsProperties.java b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsProperties.java new file mode 100644 index 00000000..33577863 --- /dev/null +++ b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/sms/SmsProperties.java @@ -0,0 +1,74 @@ +package org.springframework.cloud.alicloud.context.sms; + +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * @author pbting + * @author xiaolongzuo + */ +@ConfigurationProperties(prefix = "spring.cloud.alicloud.sms") +public class SmsProperties { + + /** + * Product name. + */ + public static final String smsProduct = "Dysmsapi"; + + /** + * Product domain. + */ + public static final String smsDomain = "dysmsapi.aliyuncs.com"; + + /** + * Report queue name. + */ + private String reportQueueName; + + /** + * Up queue name. + */ + private String upQueueName; + + /** + * Connect timeout. + */ + private String connectTimeout = "10000"; + + /** + * Read timeout. + */ + private String readTimeout = "10000"; + + public String getConnectTimeout() { + return connectTimeout; + } + + public void setConnectTimeout(String connectTimeout) { + this.connectTimeout = connectTimeout; + } + + public String getReadTimeout() { + return readTimeout; + } + + public void setReadTimeout(String readTimeout) { + this.readTimeout = readTimeout; + } + + public String getReportQueueName() { + return reportQueueName; + } + + public void setReportQueueName(String reportQueueName) { + this.reportQueueName = reportQueueName; + } + + public String getUpQueueName() { + return upQueueName; + } + + public void setUpQueueName(String upQueueName) { + this.upQueueName = upQueueName; + } + +} \ No newline at end of file diff --git a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/statistics/StatisticsTaskStarter.java b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/statistics/StatisticsTaskStarter.java index 41c3591b..709315d8 100644 --- a/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/statistics/StatisticsTaskStarter.java +++ b/spring-cloud-alicloud-context/src/main/java/org/springframework/cloud/alicloud/context/statistics/StatisticsTaskStarter.java @@ -46,6 +46,10 @@ import com.alibaba.cloud.context.statistics.StatisticsTask; AcmContextBootstrapConfiguration.class }) public class StatisticsTaskStarter implements InitializingBean { + private static final String NACOS_CONFIG_SERVER_MODE_KEY = "spring.cloud.nacos.config.server-mode"; + + private static final String NACOS_CONFIG_SERVER_MODE_VALUE = "EDAS"; + @Autowired(required = false) private AliCloudEdasSdk aliCloudEdasSdk; @@ -102,6 +106,10 @@ public class StatisticsTaskStarter implements InitializingBean { if (acmContextBootstrapConfiguration != null && acmEnableEdas) { components.add("SC-ACM"); } + if (NACOS_CONFIG_SERVER_MODE_VALUE + .equals(System.getProperty(NACOS_CONFIG_SERVER_MODE_KEY))) { + components.add("SC-NACOS-CONFIG"); + } return components; } diff --git a/spring-cloud-alicloud-context/src/test/java/com/alibaba/csp/sentinel/datasource/nacos/NacosDataSource.java b/spring-cloud-alicloud-context/src/test/java/com/alibaba/csp/sentinel/datasource/nacos/NacosDataSource.java new file mode 100644 index 00000000..7159a2f4 --- /dev/null +++ b/spring-cloud-alicloud-context/src/test/java/com/alibaba/csp/sentinel/datasource/nacos/NacosDataSource.java @@ -0,0 +1,23 @@ +/* + * 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 com.alibaba.csp.sentinel.datasource.nacos; + +/** + * @author xiaolongzuo + */ +public class NacosDataSource { +} diff --git a/spring-cloud-alicloud-context/src/test/java/com/aliyuncs/dysmsapi/model/v20170525/SendSmsRequest.java b/spring-cloud-alicloud-context/src/test/java/com/aliyuncs/dysmsapi/model/v20170525/SendSmsRequest.java new file mode 100644 index 00000000..ef660e84 --- /dev/null +++ b/spring-cloud-alicloud-context/src/test/java/com/aliyuncs/dysmsapi/model/v20170525/SendSmsRequest.java @@ -0,0 +1,23 @@ +/* + * 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 com.aliyuncs.dysmsapi.model.v20170525; + +/** + * @author xiaolongzuo + */ +public class SendSmsRequest { +} diff --git a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigAutoConfiguration.java b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigAutoConfiguration.java new file mode 100644 index 00000000..3ae897f4 --- /dev/null +++ b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alibaba/nacos/NacosConfigAutoConfiguration.java @@ -0,0 +1,23 @@ +/* + * 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; + +/** + * @author xiaolongzuo + */ +public class NacosConfigAutoConfiguration { +} diff --git a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/AliCloudSpringApplicationTests.java b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/BaseAliCloudSpringApplication.java similarity index 62% rename from spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/AliCloudSpringApplicationTests.java rename to spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/BaseAliCloudSpringApplication.java index 471ffbb9..6cc999ff 100644 --- a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/AliCloudSpringApplicationTests.java +++ b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/BaseAliCloudSpringApplication.java @@ -16,36 +16,35 @@ package org.springframework.cloud.alicloud.context; -import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; - -import org.junit.Test; import org.junit.runner.RunWith; +import org.powermock.core.classloader.annotations.PowerMockIgnore; +import org.powermock.modules.junit4.PowerMockRunner; +import org.powermock.modules.junit4.PowerMockRunnerDelegate; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.test.context.SpringBootTest; -import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.junit4.SpringRunner; /** * @author xiaolongzuo */ -@RunWith(SpringRunner.class) -@SpringBootTest(classes = AliCloudSpringApplicationTests.AliCloudDisabledApp.class, properties = { +@RunWith(PowerMockRunner.class) +@PowerMockRunnerDelegate(SpringRunner.class) +@PowerMockIgnore("javax.management.*") +@SpringBootTest(classes = BaseAliCloudSpringApplication.AliCloudApplication.class, properties = { "spring.application.name=myapp", "spring.cloud.alicloud.edas.application.name=myapp", "spring.cloud.alicloud.access-key=ak", "spring.cloud.alicloud.secret-key=sk", "spring.cloud.alicloud.oss.endpoint=test", "spring.cloud.alicloud.scx.group-id=1-2-3-4", - "spring.cloud.alicloud.edas.namespace=cn-test" }, webEnvironment = RANDOM_PORT) -@DirtiesContext -public class AliCloudSpringApplicationTests { - - @Test - public void contextLoads() { - System.out.println("Context load..."); - } + "spring.cloud.alicloud.edas.namespace=cn-test", + "spring.cloud.alicloud.ans.server-list=192.168.1.100", + "spring.cloud.alicloud.ans.server-port=8888", + "spring.cloud.alicloud.oss.enabled=false", + "spring.cloud.alicloud.scx.enabled=false" }) +public abstract class BaseAliCloudSpringApplication { @SpringBootApplication - public static class AliCloudDisabledApp { + public static class AliCloudApplication { } diff --git a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/ans/AnsContextApplicationListenerTests.java b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/ans/AnsContextApplicationListenerTests.java new file mode 100644 index 00000000..153e234d --- /dev/null +++ b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/ans/AnsContextApplicationListenerTests.java @@ -0,0 +1,37 @@ +/* + * 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.ans; + +import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat; + +import org.junit.Test; +import org.springframework.cloud.alicloud.context.BaseAliCloudSpringApplication; + +/** + * @author xiaolongzuo + */ +public class AnsContextApplicationListenerTests extends BaseAliCloudSpringApplication { + + @Test + public void testAnsContextApplicationListenerDefault() { + assertThat(System + .getProperty("com.alibaba.ans.shaded.com.taobao.vipserver.serverlist")) + .isEqualTo("192.168.1.100"); + assertThat(System.getProperty("vipserver.server.port")).isEqualTo("8888"); + } + +} diff --git a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/ans/AnsPropertiesTests.java b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/ans/AnsPropertiesTests.java index a81f0ab5..023c5ad8 100644 --- a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/ans/AnsPropertiesTests.java +++ b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/ans/AnsPropertiesTests.java @@ -18,7 +18,17 @@ package org.springframework.cloud.alicloud.context.ans; import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat; +import java.net.Inet4Address; +import java.net.InetAddress; +import java.net.NetworkInterface; +import java.net.SocketException; +import java.util.Vector; + import org.junit.Test; +import org.junit.runner.RunWith; +import org.powermock.api.mockito.PowerMockito; +import org.powermock.core.classloader.annotations.PrepareForTest; +import org.powermock.modules.junit4.PowerMockRunner; import org.springframework.boot.autoconfigure.AutoConfigurations; import org.springframework.boot.test.context.runner.ApplicationContextRunner; import org.springframework.cloud.alicloud.context.AliCloudContextAutoConfiguration; @@ -29,6 +39,8 @@ import com.alibaba.cloud.context.AliCloudServerMode; /** * @author xiaolongzuo */ +@RunWith(PowerMockRunner.class) +@PrepareForTest({ NetworkInterface.class, AnsProperties.class }) public class AnsPropertiesTests { private ApplicationContextRunner contextRunner = new ApplicationContextRunner() @@ -37,8 +49,7 @@ public class AnsPropertiesTests { AliCloudContextAutoConfiguration.class)); @Test - public void testConfigurationValueDefaultsAreAsExpected() - throws ClassNotFoundException { + public void testConfigurationValueDefaultsAreAsExpected() { this.contextRunner.withPropertyValues().run(context -> { AnsProperties ansProperties = context.getBean(AnsProperties.class); assertThat(ansProperties.getServerMode()).isEqualTo(AliCloudServerMode.LOCAL); @@ -65,7 +76,7 @@ public class AnsPropertiesTests { } @Test - public void testConfigurationValuesAreCorrectlyLoaded() { + public void testConfigurationValuesAreCorrectlyLoaded1() { this.contextRunner .withPropertyValues("spring.cloud.alicloud.ans.server-mode=EDAS", "spring.cloud.alicloud.ans.server-port=11111", @@ -99,4 +110,37 @@ public class AnsPropertiesTests { }); } + @Test(expected = RuntimeException.class) + public void testConfigurationValuesAreCorrectlyLoaded2() { + this.contextRunner.withPropertyValues( + "spring.cloud.alicloud.ans.client-interface-name=noneinterfacename") + .run(context -> { + AnsProperties ansProperties = context.getBean(AnsProperties.class); + assertThat(ansProperties.getClientInterfaceName()) + .isEqualTo("noneinterfacename"); + }); + } + + @Test + public void testConfigurationValuesAreCorrectlyLoaded3() throws SocketException { + NetworkInterface networkInterface = PowerMockito.mock(NetworkInterface.class); + Vector inetAddressList = new Vector<>(); + Inet4Address inetAddress = PowerMockito.mock(Inet4Address.class); + PowerMockito.when(inetAddress.getHostAddress()).thenReturn("192.168.1.100"); + inetAddressList.add(inetAddress); + PowerMockito.when(networkInterface.getInetAddresses()) + .thenReturn(inetAddressList.elements()); + PowerMockito.mockStatic(NetworkInterface.class); + PowerMockito.when(NetworkInterface.getByName("eth0")) + .thenReturn(networkInterface); + this.contextRunner + .withPropertyValues( + "spring.cloud.alicloud.ans.client-interface-name=eth0") + .run(context -> { + AnsProperties ansProperties = context.getBean(AnsProperties.class); + assertThat(ansProperties.getClientInterfaceName()).isEqualTo("eth0"); + assertThat(ansProperties.getClientIp()).isEqualTo("192.168.1.100"); + }); + } + } 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/NacosParameterInitListenerTests.java new file mode 100644 index 00000000..fe0451fd --- /dev/null +++ b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/nacos/NacosParameterInitListenerTests.java @@ -0,0 +1,58 @@ +/* + * 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 static org.assertj.core.api.AssertionsForClassTypes.assertThat; + +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 com.alibaba.cloud.context.ans.AliCloudAnsInitializer; +import com.alibaba.cloud.context.edas.EdasChangeOrderConfigurationFactory; + +/** + * @author xiaolongzuo + */ +@PrepareForTest({ EdasChangeOrderConfigurationFactory.class, + NacosParameterInitListener.class, AliCloudAnsInitializer.class }) +public class NacosParameterInitListenerTests extends BaseAliCloudSpringApplication { + + @BeforeClass + public static void setUp() { + ChangeOrderUtils.mockChangeOrder(); + } + + @Test + public void testNacosParameterInitListener() { + assertThat(System.getProperty("spring.cloud.nacos.config.server-mode")) + .isEqualTo("EDAS"); + 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"); + + } +} diff --git a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/oss/OssAutoConfigurationTests.java b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/oss/OssAutoConfigurationTests.java index 042ec087..44297f59 100644 --- a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/oss/OssAutoConfigurationTests.java +++ b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/oss/OssAutoConfigurationTests.java @@ -35,11 +35,13 @@ public class OssAutoConfigurationTests { private ApplicationContextRunner contextRunner = new ApplicationContextRunner() .withConfiguration(AutoConfigurations.of(OssContextAutoConfiguration.class)) - .withPropertyValues("spring.cloud.alicloud.accessKey=your-ak") - .withPropertyValues("spring.cloud.alicloud.secretKey=your-sk") - .withPropertyValues( - "spring.cloud.alicloud.oss.endpoint=http://oss-cn-beijing.aliyuncs.com") - .withPropertyValues("spring.cloud.alicloud.oss.config.userAgent=alibaba"); + .withPropertyValues("spring.cloud.alicloud.accessKey=your-ak", + "spring.cloud.alicloud.secretKey=your-sk", + "spring.cloud.alicloud.oss.endpoint=http://oss-cn-beijing.aliyuncs.com", + "spring.cloud.alicloud.oss.config.userAgent=alibaba", + "spring.cloud.alicloud.oss.sts.access-key=your-sts-ak", + "spring.cloud.alicloud.oss.sts.secret-key=your-sts-sk", + "spring.cloud.alicloud.oss.sts.security-token=your-sts-token"); @Test public void testOSSProperties() { @@ -53,11 +55,15 @@ public class OssAutoConfigurationTests { assertThat(ossProperties.getEndpoint()) .isEqualTo("http://oss-cn-beijing.aliyuncs.com"); assertThat(ossProperties.getConfig().getUserAgent()).isEqualTo("alibaba"); + assertThat(ossProperties.getSts().getAccessKey()).isEqualTo("your-sts-ak"); + assertThat(ossProperties.getSts().getSecretKey()).isEqualTo("your-sts-sk"); + assertThat(ossProperties.getSts().getSecurityToken()) + .isEqualTo("your-sts-token"); }); } @Test - public void testOSSClient() { + public void testOSSClient1() { this.contextRunner.run(context -> { assertThat(context.getBeansOfType(OSS.class).size() == 1).isTrue(); assertThat(context.getBeanNamesForType(OSS.class)[0]).isEqualTo("ossClient"); @@ -74,4 +80,26 @@ public class OssAutoConfigurationTests { }); } + @Test + public void testOSSClient2() { + this.contextRunner + .withPropertyValues("spring.cloud.alicloud.oss.authorization-mode=STS") + .run(context -> { + assertThat(context.getBeansOfType(OSS.class).size() == 1).isTrue(); + assertThat(context.getBeanNamesForType(OSS.class)[0]) + .isEqualTo("ossClient"); + OSSClient ossClient = (OSSClient) context.getBean(OSS.class); + assertThat(ossClient.getEndpoint().toString()) + .isEqualTo("http://oss-cn-beijing.aliyuncs.com"); + assertThat(ossClient.getClientConfiguration().getUserAgent()) + .isEqualTo("alibaba"); + assertThat(ossClient.getCredentialsProvider().getCredentials() + .getAccessKeyId()).isEqualTo("your-sts-ak"); + assertThat(ossClient.getCredentialsProvider().getCredentials() + .getSecretAccessKey()).isEqualTo("your-sts-sk"); + assertThat(ossClient.getCredentialsProvider().getCredentials() + .getSecurityToken()).isEqualTo("your-sts-token"); + }); + } + } diff --git a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/sentinel/SentinelAliCloudListenerTests.java b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/sentinel/SentinelAliCloudListenerTests.java new file mode 100644 index 00000000..6a812daf --- /dev/null +++ b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/sentinel/SentinelAliCloudListenerTests.java @@ -0,0 +1,56 @@ +/* + * 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.sentinel; + +import static org.assertj.core.api.AssertionsForClassTypes.assertThat; + +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.context.Constants; +import org.springframework.cloud.alicloud.utils.ChangeOrderUtils; + +import com.alibaba.cloud.context.edas.EdasChangeOrderConfigurationFactory; + +/** + * @author xiaolongzuo + */ +@PrepareForTest({ EdasChangeOrderConfigurationFactory.class, + SentinelAliCloudListener.class }) +public class SentinelAliCloudListenerTests extends BaseAliCloudSpringApplication { + + @BeforeClass + public static void setUp() { + ChangeOrderUtils.mockChangeOrder(); + } + + @Test + public void testNacosParameterInitListener() { + assertThat(System.getProperty(Constants.Sentinel.NACOS_DATASOURCE_ENDPOINT)) + .isEqualTo("testDomain"); + assertThat(System.getProperty(Constants.Sentinel.PROJECT_NAME)) + .isEqualTo("testProjectName"); + assertThat(System.getProperty(Constants.Sentinel.NACOS_DATASOURCE_NAMESPACE)) + .isEqualTo("testTenantId"); + assertThat(System.getProperty(Constants.Sentinel.NACOS_DATASOURCE_AK)) + .isEqualTo("testAK"); + assertThat(System.getProperty(Constants.Sentinel.NACOS_DATASOURCE_SK)) + .isEqualTo("testSK"); + + } +} diff --git a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/sms/SmsPropertiesTests.java b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/sms/SmsPropertiesTests.java new file mode 100644 index 00000000..4a2f74ea --- /dev/null +++ b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/context/sms/SmsPropertiesTests.java @@ -0,0 +1,69 @@ +/* + * 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.sms; + +import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat; + +import org.assertj.core.api.AssertionsForClassTypes; +import org.junit.Test; +import org.springframework.boot.autoconfigure.AutoConfigurations; +import org.springframework.boot.test.context.runner.ApplicationContextRunner; +import org.springframework.cloud.alicloud.context.AliCloudContextAutoConfiguration; +import org.springframework.cloud.alicloud.context.edas.EdasContextAutoConfiguration; + +/** + * @author xiaolongzuo + */ +public class SmsPropertiesTests { + + private ApplicationContextRunner contextRunner = new ApplicationContextRunner() + .withConfiguration(AutoConfigurations.of(SmsContextAutoConfiguration.class, + EdasContextAutoConfiguration.class, + AliCloudContextAutoConfiguration.class)); + + @Test + public void testConfigurationValueDefaultsAreAsExpected() { + this.contextRunner.run(context -> { + SmsProperties config = context.getBean(SmsProperties.class); + assertThat(config.getReportQueueName()).isNull(); + assertThat(config.getUpQueueName()).isNull(); + assertThat(config.getConnectTimeout()).isEqualTo("10000"); + assertThat(config.getReadTimeout()).isEqualTo("10000"); + }); + } + + @Test + public void testConfigurationValuesAreCorrectlyLoaded() { + this.contextRunner + .withPropertyValues("spring.cloud.alicloud.sms.reportQueueName=q1", + "spring.cloud.alicloud.sms.upQueueName=q2", + "spring.cloud.alicloud.sms.connect-timeout=20", + "spring.cloud.alicloud.sms.read-timeout=30") + .run(context -> { + SmsProperties config = context.getBean(SmsProperties.class); + AssertionsForClassTypes.assertThat(config.getReportQueueName()) + .isEqualTo("q1"); + AssertionsForClassTypes.assertThat(config.getUpQueueName()) + .isEqualTo("q2"); + AssertionsForClassTypes.assertThat(config.getConnectTimeout()) + .isEqualTo("20"); + AssertionsForClassTypes.assertThat(config.getReadTimeout()) + .isEqualTo("30"); + }); + } + +} diff --git a/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/utils/ChangeOrderUtils.java b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/utils/ChangeOrderUtils.java new file mode 100644 index 00000000..adfd750f --- /dev/null +++ b/spring-cloud-alicloud-context/src/test/java/org/springframework/cloud/alicloud/utils/ChangeOrderUtils.java @@ -0,0 +1,54 @@ +/* + * 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.utils; + +import org.powermock.api.mockito.PowerMockito; + +import com.alibaba.cloud.context.edas.EdasChangeOrderConfiguration; +import com.alibaba.cloud.context.edas.EdasChangeOrderConfigurationFactory; + +/** + * @author xiaolongzuo + */ +public class ChangeOrderUtils { + + private ChangeOrderUtils() { + } + + public static void mockChangeOrder() { + EdasChangeOrderConfiguration edasChangeOrderConfiguration = PowerMockito + .mock(EdasChangeOrderConfiguration.class); + PowerMockito.when(edasChangeOrderConfiguration.isEdasManaged()).thenReturn(true); + PowerMockito.when(edasChangeOrderConfiguration.getAddressServerDomain()) + .thenReturn("testDomain"); + PowerMockito.when(edasChangeOrderConfiguration.getTenantId()) + .thenReturn("testTenantId"); + PowerMockito.when(edasChangeOrderConfiguration.getDauthAccessKey()) + .thenReturn("testAK"); + PowerMockito.when(edasChangeOrderConfiguration.getDauthSecretKey()) + .thenReturn("testSK"); + PowerMockito.when(edasChangeOrderConfiguration.getProjectName()) + .thenReturn("testProjectName"); + PowerMockito.when(edasChangeOrderConfiguration.getAddressServerPort()) + .thenReturn("8080"); + PowerMockito.mockStatic(EdasChangeOrderConfigurationFactory.class); + PowerMockito + .when(EdasChangeOrderConfigurationFactory + .getEdasChangeOrderConfiguration()) + .thenReturn(edasChangeOrderConfiguration); + } +} diff --git a/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/OssApplicationListener.java b/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/OssApplicationListener.java index 23120e38..fa0473d6 100644 --- a/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/OssApplicationListener.java +++ b/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/OssApplicationListener.java @@ -26,22 +26,23 @@ import org.springframework.context.event.ContextClosedEvent; import com.aliyun.oss.OSS; /** - * Shutdown All OSS Clients when {@code ApplicationContext} gets closed {@link ApplicationListener} + * Shutdown All OSS Clients when {@code ApplicationContext} gets closed + * {@link ApplicationListener} * * @author Jim */ public class OssApplicationListener implements ApplicationListener { - private static final Logger logger = LoggerFactory + private static final Logger log = LoggerFactory .getLogger(OssApplicationListener.class); @Override public void onApplicationEvent(ContextClosedEvent event) { Map ossClientMap = event.getApplicationContext() .getBeansOfType(OSS.class); - logger.info("{} OSSClients will be shutdown soon", ossClientMap.size()); + log.info("{} OSSClients will be shutdown soon", ossClientMap.size()); ossClientMap.keySet().forEach(beanName -> { - logger.info("shutdown ossClient: {}", beanName); + log.info("shutdown ossClient: {}", beanName); ossClientMap.get(beanName).shutdown(); }); } diff --git a/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/endpoint/OssEndpointAutoConfiguration.java b/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/endpoint/OssEndpointAutoConfiguration.java index 0378dd4f..aec1cae9 100644 --- a/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/endpoint/OssEndpointAutoConfiguration.java +++ b/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/endpoint/OssEndpointAutoConfiguration.java @@ -34,7 +34,7 @@ public class OssEndpointAutoConfiguration { @Bean @ConditionalOnMissingBean @ConditionalOnEnabledEndpoint - public OssEndpoint sentinelEndPoint() { + public OssEndpoint ossEndpoint() { return new OssEndpoint(); } diff --git a/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/resource/OssStorageProtocolResolver.java b/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/resource/OssStorageProtocolResolver.java index 681f3e88..b062e644 100644 --- a/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/resource/OssStorageProtocolResolver.java +++ b/spring-cloud-alicloud-oss/src/main/java/org/springframework/cloud/alicloud/oss/resource/OssStorageProtocolResolver.java @@ -39,7 +39,7 @@ public class OssStorageProtocolResolver public static final String PROTOCOL = "oss://"; - private static final Logger logger = LoggerFactory + private static final Logger log = LoggerFactory .getLogger(OssStorageProtocolResolver.class); private ConfigurableListableBeanFactory beanFactory; @@ -49,8 +49,9 @@ public class OssStorageProtocolResolver private OSS getOSS() { if (this.oss == null) { if (this.beanFactory.getBeansOfType(OSS.class).size() > 1) { - logger.warn( - "There are multiple OSS instances, consider marking one of them as @Primary to resolve oss protocol."); + log.warn( + "There are multiple OSS instances, consider marking one of them as @Primary to resolve oss " + + "protocol."); } this.oss = this.beanFactory.getBean(OSS.class); } @@ -71,7 +72,7 @@ public class OssStorageProtocolResolver ((DefaultResourceLoader) resourceLoader).addProtocolResolver(this); } else { - logger.warn("The provided delegate resource loader is not an implementation " + log.warn("The provided delegate resource loader is not an implementation " + "of DefaultResourceLoader. Custom Protocol using oss:// prefix will not be enabled."); } } diff --git a/spring-cloud-alicloud-schedulerx/pom.xml b/spring-cloud-alicloud-schedulerx/pom.xml index e3c1b8e8..04b948a5 100644 --- a/spring-cloud-alicloud-schedulerx/pom.xml +++ b/spring-cloud-alicloud-schedulerx/pom.xml @@ -38,6 +38,12 @@ provided true + + org.springframework.boot + spring-boot-actuator-autoconfigure + provided + true + org.springframework.boot spring-boot-actuator diff --git a/spring-cloud-alicloud-schedulerx/src/main/java/org/springframework/cloud/alicloud/scx/endpoint/ScxEndpointAutoConfiguration.java b/spring-cloud-alicloud-schedulerx/src/main/java/org/springframework/cloud/alicloud/scx/endpoint/ScxEndpointAutoConfiguration.java index 9ca280b5..46d749d2 100644 --- a/spring-cloud-alicloud-schedulerx/src/main/java/org/springframework/cloud/alicloud/scx/endpoint/ScxEndpointAutoConfiguration.java +++ b/spring-cloud-alicloud-schedulerx/src/main/java/org/springframework/cloud/alicloud/scx/endpoint/ScxEndpointAutoConfiguration.java @@ -16,8 +16,10 @@ package org.springframework.cloud.alicloud.scx.endpoint; +import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnEnabledEndpoint; import org.springframework.boot.actuate.endpoint.annotation.Endpoint; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication; import org.springframework.cloud.alicloud.context.edas.EdasProperties; import org.springframework.cloud.alicloud.context.scx.ScxProperties; @@ -30,8 +32,12 @@ import org.springframework.context.annotation.Bean; @ConditionalOnClass(Endpoint.class) public class ScxEndpointAutoConfiguration { - @Bean - public ScxEndpoint scxEndpoint(EdasProperties edasProperties, ScxProperties scxProperties) { - return new ScxEndpoint(edasProperties, scxProperties); - } + @Bean + @ConditionalOnMissingBean + @ConditionalOnEnabledEndpoint + public ScxEndpoint scxEndpoint(EdasProperties edasProperties, + ScxProperties scxProperties) { + return new ScxEndpoint(edasProperties, scxProperties); + } + } diff --git a/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/AbstractSmsService.java b/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/AbstractSmsService.java index 02273a69..5d25bcc0 100644 --- a/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/AbstractSmsService.java +++ b/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/AbstractSmsService.java @@ -15,12 +15,12 @@ */ package org.springframework.cloud.alicloud.sms; +import java.util.concurrent.ConcurrentHashMap; + import com.aliyuncs.DefaultAcsClient; import com.aliyuncs.IAcsClient; import com.aliyuncs.profile.DefaultProfile; -import java.util.concurrent.ConcurrentHashMap; - /** * * @author pbting @@ -29,6 +29,7 @@ public abstract class AbstractSmsService implements ISmsService { private ConcurrentHashMap acsClientConcurrentHashMap = new ConcurrentHashMap<>(); + @Override public IAcsClient getHangZhouRegionClientProfile(String accessKeyId, String accessKeySecret) { diff --git a/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/SmsInitializerEventListener.java b/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/SmsInitializerEventListener.java index 0556ea06..78253878 100644 --- a/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/SmsInitializerEventListener.java +++ b/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/SmsInitializerEventListener.java @@ -18,7 +18,7 @@ package org.springframework.cloud.alicloud.sms; import com.aliyuncs.exceptions.ClientException; import com.aliyuncs.profile.DefaultProfile; import org.springframework.boot.context.event.ApplicationStartedEvent; -import org.springframework.cloud.alicloud.context.sms.SmsConfigProperties; +import org.springframework.cloud.alicloud.context.sms.SmsProperties; import org.springframework.cloud.alicloud.sms.base.MessageListener; import org.springframework.context.ApplicationListener; import org.springframework.stereotype.Component; @@ -35,11 +35,11 @@ public class SmsInitializerEventListener private final AtomicBoolean isCalled = new AtomicBoolean(false); - private SmsConfigProperties msConfigProperties; + private SmsProperties msConfigProperties; private ISmsService smsService; - public SmsInitializerEventListener(SmsConfigProperties msConfigProperties, + public SmsInitializerEventListener(SmsProperties msConfigProperties, ISmsService smsService) { this.msConfigProperties = msConfigProperties; this.smsService = smsService; @@ -54,13 +54,13 @@ public class SmsInitializerEventListener // 整个application context refreshed then do // 可自助调整超时时间 System.setProperty("sun.net.client.defaultConnectTimeout", - msConfigProperties.getConnnectTimeout()); + msConfigProperties.getConnectTimeout()); System.setProperty("sun.net.client.defaultReadTimeout", msConfigProperties.getReadTimeout()); // 初始化acsClient,暂不支持region化 try { DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", - SmsConfigProperties.smsProduct, SmsConfigProperties.smsDomain); + SmsProperties.smsProduct, SmsProperties.smsDomain); Collection messageListeners = event.getApplicationContext() .getBeansOfType(MessageListener.class).values(); if (messageListeners.isEmpty()) { diff --git a/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/SmsServiceImpl.java b/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/SmsServiceImpl.java index d32c8c64..3b83cfb6 100644 --- a/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/SmsServiceImpl.java +++ b/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/SmsServiceImpl.java @@ -15,17 +15,19 @@ */ package org.springframework.cloud.alicloud.sms; -import com.aliyuncs.dysmsapi.model.v20170525.*; -import com.aliyuncs.exceptions.ClientException; -import com.aliyuncs.exceptions.ServerException; +import java.text.ParseException; + import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; -import org.springframework.cloud.alicloud.context.sms.SmsConfigProperties; +import org.springframework.cloud.alicloud.context.AliCloudProperties; +import org.springframework.cloud.alicloud.context.sms.SmsProperties; import org.springframework.cloud.alicloud.sms.base.DefaultAlicomMessagePuller; import org.springframework.cloud.alicloud.sms.endpoint.EndpointManager; import org.springframework.cloud.alicloud.sms.endpoint.ReceiveMessageEntity; -import java.text.ParseException; +import com.aliyuncs.dysmsapi.model.v20170525.*; +import com.aliyuncs.exceptions.ClientException; +import com.aliyuncs.exceptions.ServerException; /** * @author pbting @@ -38,17 +40,22 @@ public final class SmsServiceImpl extends AbstractSmsService { * @param sendSmsRequest * @return */ - private SmsConfigProperties smsConfigProperties; + private SmsProperties smsProperties; - public SmsServiceImpl(SmsConfigProperties smsConfigProperties) { - this.smsConfigProperties = smsConfigProperties; + private AliCloudProperties aliCloudProperties; + + public SmsServiceImpl(AliCloudProperties aliCloudProperties, + SmsProperties smsProperties) { + this.aliCloudProperties = aliCloudProperties; + this.smsProperties = smsProperties; } + @Override public SendSmsResponse sendSmsRequest(SendSmsRequest sendSmsRequest) throws ClientException { - return sendSmsRequest(sendSmsRequest, smsConfigProperties.getAccessKeyId(), - smsConfigProperties.getAccessKeySecret()); + return sendSmsRequest(sendSmsRequest, aliCloudProperties.getAccessKey(), + aliCloudProperties.getSecretKey()); } /** @@ -62,6 +69,7 @@ public final class SmsServiceImpl extends AbstractSmsService { * @throws ClientException * @return SendSmsResponse */ + @Override public SendSmsResponse sendSmsRequest(SendSmsRequest sendSmsRequest, String accessKeyId, String accessKeySecret) throws ServerException, ClientException { @@ -76,10 +84,12 @@ public final class SmsServiceImpl extends AbstractSmsService { * @param smsReportMessageListener * @return boolean */ + @Override public boolean startSmsReportMessageListener( SmsReportMessageListener smsReportMessageListener) { - String messageType = "SmsReport";// 短信回执:SmsReport,短信上行:SmsUp - String queueName = smsConfigProperties.getReportQueueName(); + // 短信回执:SmsReport,短信上行:SmsUp + String messageType = "SmsReport"; + String queueName = smsProperties.getReportQueueName(); return startReceiveMsg(messageType, queueName, smsReportMessageListener); } @@ -88,9 +98,11 @@ public final class SmsServiceImpl extends AbstractSmsService { * @param smsUpMessageListener * @return boolean */ + @Override public boolean startSmsUpMessageListener(SmsUpMessageListener smsUpMessageListener) { - String messageType = "SmsUp";// 短信回执:SmsReport,短信上行:SmsUp - String queueName = smsConfigProperties.getUpQueueName(); + // 短信回执:SmsReport,短信上行:SmsUp + String messageType = "SmsUp"; + String queueName = smsProperties.getUpQueueName(); return startReceiveMsg(messageType, queueName, smsUpMessageListener); } @@ -103,8 +115,8 @@ public final class SmsServiceImpl extends AbstractSmsService { */ private boolean startReceiveMsg(String messageType, String queueName, SmsMessageListener messageListener) { - String accessKeyId = smsConfigProperties.getAccessKeyId(); - String accessKeySecret = smsConfigProperties.getAccessKeySecret(); + String accessKeyId = aliCloudProperties.getAccessKey(); + String accessKeySecret = aliCloudProperties.getSecretKey(); boolean result = true; try { new DefaultAlicomMessagePuller().startReceiveMsg(accessKeyId, accessKeySecret, @@ -135,9 +147,8 @@ public final class SmsServiceImpl extends AbstractSmsService { SendBatchSmsRequest sendBatchSmsRequest) throws ServerException, ClientException { - return sendSmsBatchRequest(sendBatchSmsRequest, - smsConfigProperties.getAccessKeyId(), - smsConfigProperties.getAccessKeySecret()); + return sendSmsBatchRequest(sendBatchSmsRequest, aliCloudProperties.getAccessKey(), + aliCloudProperties.getSecretKey()); } /** @@ -181,7 +192,7 @@ public final class SmsServiceImpl extends AbstractSmsService { @Override public QuerySendDetailsResponse querySendDetails(QuerySendDetailsRequest request) throws ClientException { - return querySendDetails(request, smsConfigProperties.getAccessKeyId(), - smsConfigProperties.getAccessKeySecret()); + return querySendDetails(request, aliCloudProperties.getAccessKey(), + aliCloudProperties.getSecretKey()); } } \ No newline at end of file diff --git a/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/config/SmsAutoConfiguration.java b/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/config/SmsAutoConfiguration.java index 12e1760b..6fb5727d 100644 --- a/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/config/SmsAutoConfiguration.java +++ b/spring-cloud-alicloud-sms/src/main/java/org/springframework/cloud/alicloud/sms/config/SmsAutoConfiguration.java @@ -18,7 +18,8 @@ package org.springframework.cloud.alicloud.sms.config; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.boot.context.properties.EnableConfigurationProperties; -import org.springframework.cloud.alicloud.context.sms.SmsConfigProperties; +import org.springframework.cloud.alicloud.context.AliCloudProperties; +import org.springframework.cloud.alicloud.context.sms.SmsProperties; import org.springframework.cloud.alicloud.sms.ISmsService; import org.springframework.cloud.alicloud.sms.SmsInitializerEventListener; import org.springframework.cloud.alicloud.sms.SmsServiceImpl; @@ -37,13 +38,14 @@ import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest; public class SmsAutoConfiguration { @Bean - public SmsServiceImpl smsService(SmsConfigProperties smsConfigProperties) { - return new SmsServiceImpl(smsConfigProperties); + public SmsServiceImpl smsService(AliCloudProperties aliCloudProperties, + SmsProperties smsProperties) { + return new SmsServiceImpl(aliCloudProperties, smsProperties); } @Bean public SmsInitializerEventListener smsInitializePostListener( - SmsConfigProperties msConfigProperties, ISmsService smsService) { - return new SmsInitializerEventListener(msConfigProperties, smsService); + SmsProperties smsProperties, ISmsService smsService) { + return new SmsInitializerEventListener(smsProperties, smsService); } } \ No newline at end of file diff --git a/spring-cloud-starter-alibaba/pom.xml b/spring-cloud-starter-alibaba/pom.xml index 3c91f8d7..c0de3644 100644 --- a/spring-cloud-starter-alibaba/pom.xml +++ b/spring-cloud-starter-alibaba/pom.xml @@ -16,6 +16,7 @@ spring-cloud-starter-alibaba-nacos-config-server spring-cloud-starter-alibaba-nacos-discovery spring-cloud-starter-alibaba-sentinel + spring-cloud-starter-alibaba-fescar spring-cloud-starter-stream-rocketmq spring-cloud-starter-bus-rocketmq diff --git a/spring-cloud-starter-alibaba/spring-cloud-starter-alibaba-fescar/pom.xml b/spring-cloud-starter-alibaba/spring-cloud-starter-alibaba-fescar/pom.xml new file mode 100644 index 00000000..8376bfc1 --- /dev/null +++ b/spring-cloud-starter-alibaba/spring-cloud-starter-alibaba-fescar/pom.xml @@ -0,0 +1,20 @@ + + 4.0.0 + + + org.springframework.cloud + spring-cloud-starter-alibaba + 0.2.2.BUILD-SNAPSHOT + + spring-cloud-starter-alibaba-fescar + Spring Cloud Starter Alibaba Fescar + + + + org.springframework.cloud + spring-cloud-alibaba-fescar + + + + diff --git a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/integration/RocketMQInboundChannelAdapter.java b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/integration/RocketMQInboundChannelAdapter.java index 55861e37..dd4c67b1 100644 --- a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/integration/RocketMQInboundChannelAdapter.java +++ b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/integration/RocketMQInboundChannelAdapter.java @@ -16,14 +16,6 @@ package org.springframework.cloud.stream.binder.rocketmq.integration; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.HashSet; -import java.util.List; -import java.util.Optional; -import java.util.Set; -import java.util.stream.Collectors; - import org.apache.commons.lang3.ClassUtils; import org.apache.rocketmq.client.consumer.DefaultMQPushConsumer; import org.apache.rocketmq.client.consumer.MessageSelector; @@ -56,6 +48,14 @@ import org.springframework.retry.support.RetryTemplate; import org.springframework.util.Assert; import org.springframework.util.StringUtils; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashSet; +import java.util.List; +import java.util.Optional; +import java.util.Set; +import java.util.stream.Collectors; + /** * @author Jim */ diff --git a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/integration/RocketMQMessageHandler.java b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/integration/RocketMQMessageHandler.java index 6efe7955..f2dd937c 100644 --- a/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/integration/RocketMQMessageHandler.java +++ b/spring-cloud-stream-binder-rocketmq/src/main/java/org/springframework/cloud/stream/binder/rocketmq/integration/RocketMQMessageHandler.java @@ -16,10 +16,6 @@ package org.springframework.cloud.stream.binder.rocketmq.integration; -import java.time.Instant; -import java.util.Map; -import java.util.Optional; - import org.apache.rocketmq.client.exception.MQBrokerException; import org.apache.rocketmq.client.exception.MQClientException; import org.apache.rocketmq.client.producer.DefaultMQProducer; @@ -48,6 +44,10 @@ import org.springframework.messaging.MessagingException; import org.springframework.messaging.support.ErrorMessage; import org.springframework.util.Assert; +import java.time.Instant; +import java.util.Map; +import java.util.Optional; + /** * @author Jim */