msb-public
/
spring-cloud-tencent
mirror of https://github.com/Tencent/spring-cloud-tencent
3
1
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
pull/1080/head
Haotian Zhang 2 years ago
parent 7db9d3c42c
commit 0acdba60a6
2 changed files with 84 additions and 98 deletions
Show Stats Download Patch File Download Diff File

94
README-zh.md
Unescape View File

@ -10,53 +10,52 @@
[English](./README.md) | 简体中文 [English](./README.md) | 简体中文
--- README:
- [介绍](#介绍)
- [如何构建](#如何构建)
- [如何使用](#如何使用)
- [使用示例](#使用示例)
更多文档请查看[Wiki](https://github.com/Tencent/spring-cloud-tencent/wiki)
## 介绍 ## 介绍
> 欢迎各位同学点击右上角 Star 按钮，持续关注我们的项目，给予我们最大的支持~ Spring Cloud Tencent 是基于 Spring Cloud SPI 实现的一站式微服务解决方案。通过集成 Spring Cloud
和腾讯中间件，让分布式服务和微服务的开发、测试、发布和运维变得更加简单。
Spring Cloud Tencent 是腾讯开源的一站式微服务解决方案。 <img src="https://user-images.githubusercontent.com/4991116/170412323-ecaf544c-1d7b-45db-9cf0-591544e50c64.png" width="80%" />
Spring Cloud Tencent 实现了Spring Cloud 标准微服务 SPI，开发者可以基于 Spring Cloud Tencent 快速开发 Spring Cloud **服务发现和治理**
云原生分布式应用。
Spring Cloud Tencent 的核心依托腾讯开源的一站式服务发现与治理平台 [PolarisMesh](https://polarismesh.cn/) Spring Cloud Tencent 集成 Spring Cloud 和北极星。北极星是一个支持多语言和多框架的服务发现和治理平台。
，实现各种分布式微服务场景。
- [Polaris Github home page](https://github.com/polarismesh/polaris) - [北极星 Github](https://github.com/polarismesh/polaris)
- [Polaris official website](https://polarismesh.cn/)
Spring Cloud Tencent提供的能力包括但不限于： Spring Cloud 集成北极星可以解决以下问题：
<img width="1029" alt="image" src="https://user-images.githubusercontent.com/4991116/170412323-ecaf544c-1d7b-45db-9cf0-591544e50c64.png"> - 服务管理：服务发现、服务发现、健康检查
- 流量控制：可自定义的流量路由、负载均衡、限频限流、访问控制
- 故障容错：服务和接口熔断和降级、实例熔断和切换
- 配置管理：版本管理、灰度发布、动态更新
- 服务注册和发现 ## 如何构建
- 动态配置管理
- 服务治理
- 服务限流
- 服务熔断
- 服务路由
- ...
- 标签透传
## 体验环境 运行以下命令进行构建。
- 管控台地址： http://14.116.241.63:8080/ **Linux and Mac**
- 账号：polaris
- 密码：polaris
- 控制面地址： `grpc://183.47.111.80:8091`
-
`spring-cloud-tencent-example` 下 example 地址都默认指向了体验服务地址（`grpc://183.47.111.80:8091`），如果您只是体验 ```
Spring Cloud ./mvnw clean package
Tencent，可直接一键运行任何 example。 ```
## 管控台 **Windows**
<img width="1727" alt="sc" src="https://user-images.githubusercontent.com/4991116/197529819-78b20ba8-0e60-450c-a8e3-0c2bf04caa15.png"> ```
.\mvnw.cmd clean package
```
## 使用指南 ## 如何使用
Spring Cloud Tencent 所有组件都已上传到 Maven 中央仓库，只需要引入依赖即可。 Spring Cloud Tencent 所有组件都已上传到 Maven 中央仓库，只需要引入依赖即可。
@ -79,7 +78,7 @@ Spring Cloud Tencent 所有组件都已上传到 Maven 中央仓库，只需要
<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>1.11.6-Hoxton.SR12</version> <version>1.11.7-Hoxton.SR12</version>
<type>pom</type> <type>pom</type>
<scope>import</scope> <scope>import</scope>
</dependency> </dependency>
@ -96,36 +95,25 @@ Spring Cloud Tencent 所有组件都已上传到 Maven 中央仓库，只需要
```` ````
## 开发入门 ## 使用示例
You can build this project with command: 北极星为开发者提供体验环境：
```shell - [北极星控制台](http://119.91.66.223:80)
## MacOS or Linux - 北极星服务端地址：`grpc://119.91.66.223:8091`
./mvnw clean package
## Win
.\mvnw.cmd clean package
```
## 文档 在 spring-cloud-tencent-example 项目里，北极星服务端地址默认配置为`grpc://119.91.66.223:8091`。
请阅读 [Wiki](https://github.com/Tencent/spring-cloud-tencent/wiki)
## 交流群 ## 交流群
扫描下面的二维码加入 Spring Cloud Tencent 交流群。 扫码二维码，加入 Spring Cloud Tencent 交流群。欢迎用户反馈使用问题和优化建议。
<img src="https://user-images.githubusercontent.com/24446200/169198148-d4cc3494-3485-4515-9897-c8cb5504f706.png" width="30%" height="30%" /> <img src="https://user-images.githubusercontent.com/24446200/169198148-d4cc3494-3485-4515-9897-c8cb5504f706.png" width="20%" height="20%" />
## License 如果上方二维码失效，请扫描下方二维码添加微信，并发送“Spring Cloud Tencent”申请加群。
The spring-cloud-tencent is licensed under the BSD 3-Clause License. Copyright and license information can be found in <img src="https://github.com/Tencent/spring-cloud-tencent/assets/24446200/77912670-aa7b-44ec-a312-42a05d59b109" width=20% height=20%>
the file [LICENSE](LICENSE)
## Stargazers over time ## Stargazers over time
如果您对 Spring Cloud Tencent 有兴趣，请关注我们的项目~ [![](https://starchart.cc/Tencent/spring-cloud-tencent.svg)](https://starchart.cc/Tencent/spring-cloud-tencent)
[![Stargazers over time](https://starchart.cc/Tencent/spring-cloud-tencent.svg)](https://starchart.cc/Tencent/spring-cloud-tencent)

88
README.md
Unescape View File

@ -11,48 +11,53 @@
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.
<img src="https://user-images.githubusercontent.com/4991116/170412596-692f8dae-42f7-495f-a451-01396e381eb0.png" width="80%" />
Spring Cloud Tencent implements the Spring Cloud standard microservice SPI, so developers can quickly develop Spring **Service discovery and governance**
Cloud cloud-native distributed applications based on Spring Cloud Tencent.
The core of Spring Cloud Tencent relies on Tencent's open-source one-stop service discovery and governance Spring Cloud Tencent integrates Spring Cloud with Polaris which is an open source system for service discovery and
platform [PolarisMesh](https://polarismesh.cn) to realize various distributed microservice scenarios. governance.
- [PolarisMesh Github home page](https://github.com/polarismesh/polaris) - [Polaris Github](https://github.com/polarismesh/polaris)
- [PolarisMesh official website](https://polarismesh.cn/)
The capabilities provided by Spring Cloud Tencent include but are not limited to: Spring Cloud with Polaris can solve these problem:
<img width="1031" alt="image" src="https://user-images.githubusercontent.com/4991116/170412596-692f8dae-42f7-495f-a451-01396e381eb0.png"> - service management: service discovery, service registry and health check
- traffic control: customizable routing, load balance, rate limiting and access control
- fault tolerance: circuit breaker for service, interface and instance
- config management: config version control, grayscale release and dynamic update
- Service registration and discovery ## How to build
- Dynamic configuration management
- Service Governance
- Service rate limit
- Service circuit breaker
- Service routing
- ...
- Label transparent transmission
## Demo Environment Run these commands to build this project as follow.
- Console Address : http://14.116.241.63:8080/ **Linux and Mac**
- 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. If you only experience Spring Cloud Tencent, you can run any example ./mvnw clean package
directly with one click. ```
## Screenshots **Windows**
<img width="1727" alt="sc" src="https://user-images.githubusercontent.com/4991116/197529819-78b20ba8-0e60-450c-a8e3-0c2bf04caa15.png"> ```
.\mvnw.cmd clean package
```
## Use Guide ## How to use
All the components of Spring Cloud Tencent have been uploaded to the Maven central repository, just need to introduce All the components of Spring Cloud Tencent have been uploaded to the Maven central repository, just need to introduce
dependencies. dependencies.
@ -76,7 +81,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>1.11.6-Hoxton.SR12</version> <version>1.11.7-Hoxton.SR12</version>
<type>pom</type> <type>pom</type>
<scope>import</scope> <scope>import</scope>
</dependency> </dependency>
@ -93,32 +98,25 @@ For example:
```` ````
## Develop Guide ## Examples
You can build this project with command:
```shell
## MacOS or Linux
./mvnw clean package
## Win The experience environment of Polaris is provided for developers:
.\mvnw.cmd clean package
```
## Documents - [Polaris Console](http://119.91.66.223:80)
- Polaris Server Address: `grpc://119.91.66.223:8091`
Pelease refer to [Wiki](https://github.com/Tencent/spring-cloud-tencent/wiki) The address of Polaris server in spring-cloud-tencent-example is `grpc://119.91.66.223:8091` by default.
## Chat Group ## Chat Group
Please scan the QR code to join the chat group. 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="30%" height="30%" /> <img src="https://user-images.githubusercontent.com/24446200/169198148-d4cc3494-3485-4515-9897-c8cb5504f706.png" width="20%" height="20%" />
If the above QR code fails, please scan the QR code to add WeChat, and send "Spring Cloud Tencent" to apply for joining the group.
## License <img src="https://github.com/Tencent/spring-cloud-tencent/assets/24446200/77912670-aa7b-44ec-a312-42a05d59b109" width=20% height=20%>
The spring-cloud-tencent is licensed under the BSD 3-Clause License. Copyright and license information can be found in
the file [LICENSE](LICENSE)
## Stargazers over time ## Stargazers over time

Write Preview
Loading…
Cancel
Save