@ -5,53 +5,70 @@
[](https://github.com/Tencent/spring-cloud-tencent/graphs/contributors)
[](https://github.com/Tencent/spring-cloud-tencent/graphs/contributors)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://github.com/Tencent/spring-cloud-tencent/actions/workflows/junit_test.yml)
[](https://github.com/Tencent/spring-cloud-tencent/actions/workflows/junit_test.yml)
[](https://codecov.io/gh/Tencent/spring-cloud-tencent?branch=greenwich)
[](https://codecov.io/gh/Tencent/spring-cloud-tencent?branch=greenwich)
[](https://lgtm.com/projects/g/Tencent/spring-cloud-tencent/context:java)
English | [简体中文 ](./README-zh.md )
English | [简体中文 ](./README-zh.md )
README:
- [Introduction ](#introduction )
- [How to build ](#how-to-build )
- [How to use ](#how-to-use )
- [Examples ](#examples )
Visit [Wiki ](https://github.com/Tencent/spring-cloud-tencent/wiki ) to learn more
## Introduction
## Introduction
Spring Cloud Tencent is a open source one-stop microservice solution from Tencent.
Spring Cloud Tencent is an one-stop microservice solution which implements the standard Spring Cloud SPI. It integrates
Spring Cloud with Tencent middlewares and makes it easy to develop microservice.
Spring Cloud Tencent implements the Spring Cloud standard microservice SPI, so developers can quickly develop Spring Cloud cloud-native distributed applications based on Spring Cloud Tencent.
< img src = "https://user-images.githubusercontent.com/4991116/170412596-692f8dae-42f7-495f-a451-01396e381eb0.png" width = "80%" / >
The core of Spring Cloud Tencent relies on Tencent's open-source one-stop service discovery and governance platform [Polaris ](https://github.com/polarismesh/polaris ) to realize various distributed microservice scenarios.
**Service discovery and governance**
- [Polaris Github home page ](https://github.com/polarismesh/polaris )
Spring Cloud Tencent integrates Spring Cloud with Polaris which is an open source system for service discovery and
- [Polaris official website ](https://polarismesh.cn/ ) governance.
The capabilities provided by Spring Cloud Tencent include but are not limited to: - [Polaris Github ](https://github.com/polarismesh/polaris )
< img width = "1031" alt = "image" src = "https://user-images.githubusercontent.com/4991116/170412596-692f8dae-42f7-495f-a451-01396e381eb0.png" > Spring Cloud with Polaris can solve these problem:
- Service registration and discovery
- service management: service discovery, service registry and health check
- Dynamic configuration management
- traffic control: customizable routing, load balance, rate limiting and access control
- Service Governance
- fault tolerance: circuit breaker for service, interface and instance
- Service rate limit
- config management: config version control, grayscale release and dynamic update
- Service circuit breaker
- Service routing
- ...
- Label transparent transmission
## Demo Environment
## How to build
- Console Address : http://14.116.241.63:8080/
Run these commands to build this project as follow.
- Username: polaris
- Password: polaris
- Server Address: `grpc://183.47.111.80:8091`
The example addresses under `spring-cloud-tencent-example` all point to the experience service address (`grpc://183.47.111.80:8091`) by default.
**Linux and Mac**
If you only experience Spring Cloud Tencent, you can run any example directly with one click.
## Screenshots
```
./mvnw clean package
```
< img width = "1792" alt = "image" src = "https://user-images.githubusercontent.com/4991116/163402268-48493802-4555-4b93-8e31-011410f2166b.png" > **Windows**
## Use Guide
```
.\mvnw.cmd clean package
```
All the components of Spring Cloud Tencent have been uploaded to the Maven central repository, just need to introduce dependencies.
## How to use
All the components of Spring Cloud Tencent have been uploaded to the Maven central repository, just need to introduce
dependencies.
> Notice:
>
> Support Spring Cloud 2022.0, 2021.0, 2020.0, Hoxton.
>
> The version list of Spring Cloud Tencent can be found
> in
> [Spring Cloud Tencent Version Management ](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-%E7%89%88%E6%9C%AC%E7%AE%A1%E7%90%86 )
> .
For example:
For example:
@ -63,7 +80,7 @@ For example:
< groupId > com.tencent.cloud< / groupId >
< groupId > com.tencent.cloud< / groupId >
< artifactId > spring-cloud-tencent-dependencies< / artifactId >
< artifactId > spring-cloud-tencent-dependencies< / artifactId >
<!-- version number -->
<!-- version number -->
< version > ${version} < / version >
< version > 1.11.4-2021.0.6 < / version >
< type > pom< / type >
< type > pom< / type >
< scope > import< / scope >
< scope > import< / scope >
< / dependency >
< / dependency >
@ -80,28 +97,20 @@ For example:
````
````
- ### Quick Start
## Examples
- [Spring Cloud Tencent Version Management ](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Version-Management )
- [Spring Cloud Tencent Discovery ](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Discovery-Usage-Documentation )
- [Spring Cloud Tencent Config ](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Config-Usage-Documentation )
- [Spring Cloud Tencent Rate Limit ](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Rate-Limit-Usage-Document )
- [Spring Cloud Tencent CircuitBreaker ](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Circuitbreaker-Usage-Document )
- [Spring Cloud Tencent Router ](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Router-Usage-Document )
- [Spring Cloud Tencent Metadata Transfer ](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Metadata-Transfer-Usage-Document )
- ### Development Documentation
- [Project Structure Overview ](https://github.com/Tencent/spring-cloud-tencent/wiki/%E9%A1%B9%E7%9B%AE%E6%A6%82%E8%A7%88 )
- [Participate in co-construction ](https://github.com/Tencent/spring-cloud-tencent/wiki/Contributing )
## Chat Group
Please scan the QR code to join the chat group.
The experience environment of Polaris is provided for developers:
- [Polaris Console ](http://119.91.66.223:80 )
- Polaris Server Address: `grpc://119.91.66.223:8091`
< img src = "https://user-images.githubusercontent.com/24446200/169198148-d4cc3494-3485-4515-9897-c8cb5504f706.png" width = "30%" height = "30%" / > The address of Polaris server in spring-cloud-tencent-example is `grpc://119.91.66.223:8091` by default.
## License
## Chat Group
The spring-cloud-tencent is licensed under the BSD 3-Clause License. Copyright and license information can be found in the file [LICENSE ](LICENSE )
Please scan the QR code to join the chat group.
< img src = "https://user-images.githubusercontent.com/24446200/169198148-d4cc3494-3485-4515-9897-c8cb5504f706.png" width = "20%" height = "20%" / >
## Stargazers over time
## Stargazers over time
Haotian Zhang
2 years ago