Skip to content

Commit

Permalink
update readme.md (#1110)
Browse files Browse the repository at this point in the history
Co-authored-by: 致节 <hzj266771@antgroup.com>
  • Loading branch information
HzjNeverStop and 致节 authored Mar 9, 2023
1 parent f19852f commit 4c2e077
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 15 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ Please refer to SOFAStack Documentation for [SOFABoot quick start guide](https:/

### Demos
Some SOFABoot demo projects to get your hands dirty:
- [Class Isolation](https://github.com/sofastack-guides/sofa-boot-guides/tree/master/sofaboot-sample-with-isolation)
- [Spring Context Isolation](https://github.com/sofastack-guides/sofa-boot-guides/tree/master/sofaboot-sample-with-isolation)
- [SOFA RPC](https://github.com/sofastack-guides/sofa-boot-guides/tree/master/sofaboot-sample-with-rpc)
- [Scheduler with Batch](https://github.com/sofastack-guides/sofa-boot-guides/tree/master/sofaboot-scheduler-batch-sample)
* [Standard project](https://github.com/sofastack-guides/sofa-boot-guides/tree/4.x/sofaboot-sample)
- [Class Isolation](https://github.com/sofastack-guides/sofa-boot-guides/tree/4.x/sofaboot-sample-with-isolation)
- [Spring Context Isolation](https://github.com/sofastack-guides/sofa-boot-guides/tree/4.x/sofaboot-sample-with-isolation)
- [SOFA RPC](https://github.com/sofastack-guides/sofa-boot-guides/tree/4.x/sofaboot-sample-with-rpc)

## Functionality
To supplement the abilities of deploying large-scale microservices in production environment for Spring Boot, SOFABoot offers following enhancements:
Expand All @@ -44,7 +44,7 @@ While Spring Boot health indicators are practical real-time exposure of applicat
Therefore, readiness check is an indispensable part of deployment automation in production environment and SOFABoot provides the readiness check for application out of box.
For reliable application startup, all SOFAStack middleware services won't reveal themselves (e.g., RPC services publishing to Service Registry) until readiness check passes.

Platform PaaS can also make use of the readiness check result via URL `http://localhost:8080/health/readiness` to control gracefully external traffic originating such as gateway, load balancer, etc.
Platform PaaS can also make use of the readiness check result via URL `http://localhost:8080/actuator/readiness` to control gracefully external traffic originating such as gateway, load balancer, etc.

### Class Isolation
Aimed to solve class or dependency conflicts, [SOFAArk](https://github.com/sofastack/sofa-ark) is created.
Expand Down Expand Up @@ -78,7 +78,7 @@ All of them are packaged as self-contained "starters" to provide the correspondi
## Contribution
We love contributions! Before taking any further steps, please take a look at [Contributing to SOFABoot](./CONTRIBUTING.md).

SOFABoot is compiled under JDK 8 currently and needs [Apache Maven 3.2.5](https://archive.apache.org/dist/maven/maven-3/3.2.5/binaries/) or higher version.
SOFABoot is compiled under JDK 17 currently and needs [Apache Maven 3.5.4](https://archive.apache.org/dist/maven/maven-3/3.5.4/binaries/) or higher version.

### Community
See our community [materials](https://github.com/sofastack/community/blob/master/ROLES-EN.md).
Expand Down
17 changes: 8 additions & 9 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Spring Boot 是一个非常优秀的开源框架,可以非常方便地就构

针对 Spring Boot 缺少 Readiness Check 能力的情况,SOFABoot 增加了 Spring Boot 现有的健康检查的能力,提供了 Readiness Check 的能力。利用 Readiness Check 的能力,SOFA 中间件中的各个组件只有在 Readiness Check 通过之后,才将流量引入到应用的实例中,比如 RPC,只有在 Readiness Check 通过之后,才会向服务注册中心注册,后面来自上游应用的流量才会进入。

除了中间件可以利用 Readiness Check 的事件来控制流量的进入之外,PAAS 系统也可以通过访问 `http://localhost:8080/health/readiness` 来获取应用的 Readiness Check 的状况,用来控制例如负载均衡设备等等流量的进入。
除了中间件可以利用 Readiness Check 的事件来控制流量的进入之外,PAAS 系统也可以通过访问 `http://localhost:8080/actuator/readiness` 来获取应用的 Readiness Check 的状况,用来控制例如负载均衡设备等等流量的进入。

### 2.2 提供类隔离的能力

Expand All @@ -44,7 +44,7 @@ Spring Boot 是一个非常优秀的开源框架,可以非常方便地就构

### 2.5 模块化开发

SOFABoot 从 2.4.0 版本开始支持基于 Spring 上下文隔离的模块化开发能力,每个 SOFABoot 模块使用独立的 Spring 上下文,避免不同 SOFABoot 模块间的 BeanId 冲突,有效降低企业级多模块开发时团队间的沟通成本。
SOFABoot 支持基于 Spring 上下文隔离的模块化开发能力,每个 SOFABoot 模块使用独立的 Spring 上下文,避免不同 SOFABoot 模块间的 BeanId 冲突,有效降低企业级多模块开发时团队间的沟通成本。

## 三、快速开始

Expand All @@ -54,20 +54,19 @@ SOFABoot 从 2.4.0 版本开始支持基于 Spring 上下文隔离的模块化

在贡献代码之前,请阅读[如何贡献](./CONTRIBUTING.md)来了解如何向 SOFABoot 贡献代码。

SOFABoot 的编译环境的要求为 JDK8,需要采用 [Apache Maven 3.2.5](https://archive.apache.org/dist/maven/maven-3/3.2.5/binaries/) 或者更高的版本进行编译。
SOFABoot 的编译环境的要求为 JDK17,需要采用 [Apache Maven 3.5.4](https://archive.apache.org/dist/maven/maven-3/3.5.4/binaries/) 或者更高的版本进行编译。

## 五、感谢

SOFA 的第一个版本是阿玺创造的,感谢阿玺给 SOFA 打下了坚实地基础,也非常感谢在 SOFA 的历史中给 SOFA 贡献过代码的人们。

## 六、示例

SOFABoot 的示例工程 [sofaboot-samples](https://github.com/sofastack-guides/sofa-boot-guides/tree/master) 包含以下 demo 项目:
* [SOFABoot 示例工程](https://github.com/sofastack-guides/sofa-boot-guides/tree/master/sofaboot-sample)
* [SOFABoot 示例工程(包含类隔离能力)](https://github.com/sofastack-guides/sofa-boot-guides/blob/master/sofaboot-sample-with-isolation)
* [SOFABoot 示例工程(包含模块化开发能力)](https://github.com/sofastack-guides/sofa-boot-guides/blob/master/sofaboot-sample-with-isle)
* [SOFABoot 示例工程(使用 SOFARPC)](https://github.com/sofastack-guides/sofa-boot-guides/blob/master/sofaboot-sample-with-rpc)
* [SOFABoot 示例工程(使用定时任务)](https://github.com/sofastack-guides/sofa-boot-guides/blob/master/sofaboot-scheduler-batch-sample)
SOFABoot 的示例工程 [sofaboot-samples](https://github.com/sofastack-guides/sofa-boot-guides/tree/4.x) 包含以下 demo 项目:
* [SOFABoot 示例工程](https://github.com/sofastack-guides/sofa-boot-guides/tree/4.x/sofaboot-sample)
* [SOFABoot 示例工程(包含类隔离能力)](https://github.com/sofastack-guides/sofa-boot-guides/blob/4.x/sofaboot-sample-with-isolation)
* [SOFABoot 示例工程(包含模块化开发能力)](https://github.com/sofastack-guides/sofa-boot-guides/blob/4.x/sofaboot-sample-with-isle)
* [SOFABoot 示例工程(使用 SOFARPC)](https://github.com/sofastack-guides/sofa-boot-guides/blob/4.x/sofaboot-sample-with-rpc)

## 七、文档

Expand Down

0 comments on commit 4c2e077

Please sign in to comment.