This is an automated email from the ASF dual-hosted git repository.
liubao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-docs.git
The following commit(s) were added to refs/heads/master by this push:
new 2227c66 update design reference (#291)
2227c66 is described below
commit 2227c66afdf6d586258984cc2a2d0bf939840671
Author: liubao68 <[email protected]>
AuthorDate: Mon Oct 16 21:13:16 2023 +0800
update design reference (#291)
---
java-chassis-reference/zh_CN/docs/index.md | 1 -
java-chassis-reference/zh_CN/docs/start/design.md | 41 ++++----
java-chassis-reference/zh_CN/docs/toc.md | 114 ----------------------
java-chassis-reference/zh_CN/mkdocs.yml | 3 +-
4 files changed, 19 insertions(+), 140 deletions(-)
diff --git a/java-chassis-reference/zh_CN/docs/index.md
b/java-chassis-reference/zh_CN/docs/index.md
index 91892ea..1216ec2 100644
--- a/java-chassis-reference/zh_CN/docs/index.md
+++ b/java-chassis-reference/zh_CN/docs/index.md
@@ -31,5 +31,4 @@ Apache ServiceComb Java Chassis 给开发者提供一个快速构建微服务的
## 如何使用本文档
-* 通过[目录](toc.md)了解文档结构，查看关注的章节。
*
访问[文档源代码](https://github.com/apache/servicecomb-docs/tree/master/java-chassis-reference)
，采用 mkdocs 编译后本地使用。
并在[issue](https://github.com/apache/servicecomb-docs/issues) 提交改进建议。
diff --git a/java-chassis-reference/zh_CN/docs/start/design.md
b/java-chassis-reference/zh_CN/docs/start/design.md
index 35ca85f..2701ea2 100644
--- a/java-chassis-reference/zh_CN/docs/start/design.md
+++ b/java-chassis-reference/zh_CN/docs/start/design.md
@@ -1,18 +1,17 @@
-Apache ServiceComb Java Chassis
结合大量微服务开发实践，实现[微服务架构模式](https://microservices.io/patterns/microservice-chassis.html)，
帮
+# Java Chassis设计参考
+
+Java Chassis
结合大量微服务开发实践，实现[微服务架构模式](https://microservices.io/patterns/microservice-chassis.html)
， 帮
助开发者更加简单、快速的构建微服务应用。
-微服务架构模式的核心包含如下几部分：
+Java Chassis主要实现了如下微服务架构模式功能：
* 微服务之间的 RPC 通信。Java Chassis 提供了非常高效的通信方式，并支持多协议扩展，比如最快的 REST 通信模式实现，
异步的二进制通信模式 HIGHWAY 。
-* 分布式微服务实例和服务发现。结合 ServiceComb Service Center， 实现分布式、多集群服务发现能力，以及强大的微服务元数据管理能力。
-* 配置外置，动态、集中的配置管理。 能够使用 ServiceComb Kie， 华为云配置中心、 Nacos、 Apollo 等多种配置中心， 并且和
Spring Boot
- 配置管理能力完整融合。
-* 分布式故障管理，服务容错、隔离、熔断。 内置故障实例隔离、故障重试、耗时接口隔离等重要分布式故障处理能力。可选使用 Hystrix 的
- 容错、隔离、熔断能力， 只需要做简单的配置。
+* 分布式微服务注册和服务发现能力。Java Chassis支持使用不同的注册中心，实现分布式、多集群服务发现能力，以及微服务元数据管理能力。
+* 分布式微服务配置管理能力。Java Chassis支持使用不同的配置中心，实现动态、集中的配置管理。开发者可以使用Spring
Boot原生API访问配置，也可以使用Java Chassis新增API， 满足配置变更监听、优先级配置等高阶开发能力。
+* 分布式故障管理，服务容错、隔离、熔断。 内置故障实例隔离、故障重试、流量控制等过载防护和故障处理能力。
* 分布式日志追踪。 提供 Open Tracing 支持。
-此外还有性能监控，日志记录系统、健康检查等。 Java Chassis 采用优雅的设计模式，实现了上述所有的核心部件的功能，并且使得这些功能
-开箱即用。使用 Java Chassis , 开发者能够更加聚焦于业务功能开发，快速的构建商业可用的微服务应用。
+此外还有性能监控、日志管理、健康检查等功能。 Java Chassis 采用优雅的设计模式，实现了上述所有的核心部件的功能，并且使得这些功能开箱即用。使用
Java Chassis , 开发者能够更加聚焦于业务功能开发，快速的构建商业可用的微服务应用。
## Java Chassis 的软件工程实践 <a name="h1"></a>
@@ -34,10 +33,10 @@ Java Chassis 在设计的时候， 不仅考虑了如何更好的使用微服务
-“编程模型” 面向开发者写服务接口的习惯， “通信模型” 面向微服务之间的高效编码和通信， “运行模型” 基于“契约”， 提供一种服务服务无关
+“编程模型” 面向开发者写服务接口的习惯， “通信模型” 面向微服务之间的高效编码和通信， “运行模型” 基于“契约”， 提供一种服务无关
的插拔机制，能够让开发者独立于业务实现开发治理功能，并且灵活的移除和增加功能，以及调整这些治理功能的处理顺序。
-“运行模型” 的核心抽象接口是 Handler ， 这个接口是一个异步的定义， Java Chassis 运行时模型采用纯异步的实现， 让整个系统运行非常
+“运行模型” 的核心抽象接口是 Filter ， 这个接口是一个异步的定义， Java Chassis 运行时模型采用纯异步的实现， 让整个系统运行非常
高效。
可以阅读 [Apache ServiceComb
的开放性设计](http://servicecomb.apache.org/cn/docs/open-design/) 了解 Java Chassis
运行时架构的其他设计考虑。
@@ -52,7 +51,7 @@ Java Chassis 在设计的时候， 不仅考虑了如何更好的使用微服务
-可以阅读[单体应用微服务改造实践](https://bbs.huaweicloud.com/blogs/101611)，
了解为什么推荐这样的微服务应用架构。 Java Chassis
+可以阅读[单体应用微服务改造实践](https://bbs.huaweicloud.com/blogs/101611) ，
了解为什么推荐这样的微服务应用架构。 Java Chassis
为应用架构提供了接入网关服务 [Edge Servcie](../edge/by-servicecomb-sdk.md)。
## Java Chassis 微服务技术选型 <a name="h4"></a>
@@ -62,24 +61,21 @@ Java 语言拥有庞大的技术体系和标准， 并且广泛的应用到业
### Java Chassis 和 JSP/Servlet 标准
-Java Chassis 不依赖于 JSP/Servlet 标准， 可以基于 Vert.x 的 HTTP 实现， 提供非常轻量级和高效的 REST 服务，
在性能要求高的核心
-业务场景， 使用这种轻量级的技术非常合适。 这种场景下， 没有完整的实现 JSP/Servlet 相关接口， 比如 HttpServletRequest,
+Java Chassis 基于 Vert.x 实现了 REST 和 HIGHWAY 等 RPC 协议的实现， 在性能要求高的核心业务场景，
使用这种轻量级的技术非常合适。 这种场景下， 没有完整的实现 JSP/Servlet 相关接口， 比如 HttpServletRequest,
HttpServletResponse 等。
[servicecomb-samples](https://github.com/apache/servicecomb-samples/tree/master/porter_lightweight)
提供了一个完整的使用这种部署模式的例子。
[基于CSE的微服务架构实践-轻量级架构技术选型](https://bbs.huaweicloud.com/blogs/101875) 提供了
一些常见的组件的选型参考。
-Java Chassis 可以部署运行于 JSP/Servlet 容器里面， 在这个场景下， Java Chassis 的核心部件就是一个 Servlet
， 在这个 Servlet 里面
+Java Chassis 支持 JSP/Servlet 标准的容器。 在这个场景下， Java Chassis 的核心部件就是一个 Servlet ，
在这个 Servlet 里面
实现了 Java Chassis 的核心 RPC 系统。 采用 JSP/Servlet 容器运行 Java Chassis, 业务请求首先经过容器的
HTTP 实现， 然后经过 Filter，
-进入 Java Chassis 的 RestServlet ， 运行 Java Chassis 的运行时模型 (Handlers) ， 进入业务接口处理。
可以参考
+进入 Java Chassis 的 RestServlet ， 运行 Java Chassis 的运行时模型， 进入业务接口处理。 可以参考
[REST over Servlet](../transports/rest-over-servlet.md) 了解如何在 Servlet 容器中加载
Java Chassis 的 Servlet。
### Java Chassis 和 Spring、Spring Boot
- Java Chassis 目前依赖于 Spring， 但是从设计上是可以独立于 Spring 运行的。 Spring 是被广泛使用的技术， 非常轻量级，
- 在 Java Chassis 中可以直接使用 Spring 相关的技术。 Java Chassis 不依赖于 Spring Boot， 但是可以将
Java Chassis 运行于 Spring
- Boot 基础之上。
+ Java Chassis 建立在 Spring Boot技术之上，核心部件都通过Spring Boot技术提供实现和扩展。
- Spring Boot 2 开始也提供了多种运行环境支持， WebApplicationType.NONE,
WebApplicationType.SERVLET, WebApplicationType.REACTIVE，
+ Spring Boot 提供了多种运行环境支持， WebApplicationType.NONE, WebApplicationType.SERVLET,
WebApplicationType.REACTIVE，
Java Chassis 可以集成 NONE, SERVLET 两种模式。 在 NONE 模式下集成 Java Chassis， 和 Spring
Boot 自身的 REACTIVE 非常类似，
但是比 Spring Boot 的 REACTIVE 运行更加高效， 并且支持早期的 RestTemplate API 和 RPC API 来访问服务。
@@ -99,7 +95,7 @@ Java Chassis 可以部署运行于 JSP/Servlet 容器里面， 在这个场景
## Java Chassis 与 Spring Cloud <a name="h5"></a>
Java Chassis 和 Spring Cloud 都实现了微服务架构模式， 相比而言， Java Chassis 是一个更加紧凑的实现， 开箱即用，
而 Spring Cloud 则是
-相对松散的实现， 整合了大量的 Netflix 组件。
+相对松散的实现， 通常需要结合很多第三方的组件才能够完成端到端的微服务开发。
微服务架构模式关注微服务内部和微服务之间的设计， 也关注微服务与微服务基础设施之间的关系。 Java Chassis 微服务基础设施包括服务注册和发现，
服务配置管理， 灰度发布和契约管理等功能。 Spring Cloud 可以使用
[spring-cloud-huawei](https://github.com/huaweicloud/spring-cloud-huawei)
@@ -107,6 +103,5 @@ Java Chassis 和 Spring Cloud 都实现了微服务架构模式， 相比而言
-可以阅读[基于CSE的微服务架构实践-Spring
Cloud技术栈选型](https://bbs.huaweicloud.com/blogs/115718)了解 Java Chassis
-和 Spring Cloud 组件选型上的一些差异。
+可以阅读[基于CSE的微服务架构实践-Spring
Cloud技术栈选型](https://bbs.huaweicloud.com/blogs/115718) 了解 Java Chassis 和 Spring
Cloud 组件选型上的一些差异。
diff --git a/java-chassis-reference/zh_CN/docs/toc.md
b/java-chassis-reference/zh_CN/docs/toc.md
deleted file mode 100644
index f6b4e7f..0000000
--- a/java-chassis-reference/zh_CN/docs/toc.md
+++ /dev/null
@@ -1,114 +0,0 @@
-
-# 目录
-
-* [概述](index.md)
-* [快速入门](start/catalog.md)
- * [术语表](start/terminology.md)
- * [微服务系统架构](start/architecture.md)
- * [安装本地开发环境](start/development-environment.md)
- * [开发第一个微服务](start/first-sample.md)
- * [完整例子-bmi应用](featured-topics/application-bmi.md)
- * [完整例子-porter应用](featured-topics/application-porter.md)
-* [设计选型参考](start/design.md)
- * [Java Chassis 的软件工程实践](start/design.md#h1)
- * [Java Chassis 的运行时架构](start/design.md#h2)
- * [Java Chassis 微服务应用架构](start/design.md#h3)
- * [Java Chassis 微服务技术选型](start/design.md#h4)
- * [Java Chassis 与 Spring Cloud](start/design.md#h5)
-* [微服务定义](build-provider/definition/service-definition.md)
-* [开发服务提供者](build-provider/catalog.md)
- * [理解服务契约](build-provider/define-contract.md)
- * [用JAX-RS开发微服务](build-provider/jaxrs.md)
- * [用SpringMVC开发微服务](build-provider/springmvc.md)
- * [用透明RPC开发微服务](build-provider/transparent-rpc.md)
- * [只发布interface的方法为服务接口](build-provider/use-interface.md)
- * [使用 Context 参数](build-provider/context-param.md)
- * [多个返回值和错误码](build-provider/multi-code.md)
- * [使用Swagger注解](build-provider/swagger-annotation.md)
- * [接口定义和数据类型](build-provider/interface-constraints.md)
- * [服务监听地址和发布地址](build-provider/listen-address-and-publish-address.md)
- * [线程池](build-provider/thread-pool.md)
- * [服务启动事件](build-provider/event-listener.md)
- * [参数效验](build-provider/parameter-validator.md)
- * [程序启动逻辑](build-provider/bootup.md)
- * [IPV6配置和使用](build-provider/ipv6-configuration.md)
- * [Access Log配置](build-provider/access-log-configuration.md)
-* [开发服务消费者](build-consumer/catalog.md)
- * [消费者通用配置项](build-consumer/common-configuration.md)
- * [使用RestTemplate开发服务消费者](build-consumer/using-resttemplate.md)
- * [使用AsyncRestTemplate开发服务消费者](build-consumer/using-AsyncRestTemplate.md)
- * [使用RPC方式开发服务消费者](build-consumer/develop-consumer-using-rpc.md)
- * [泛化调用](featured-topics/features/invoker.md)
- * [使用服务契约](build-consumer/with-contract.md)
- * [调用第三方REST服务](build-consumer/3rd-party-service-invoke.md)
-* [通用功能开发](general-development/catalog.md)
- * [应用性能监控（metrics）](general-development/metrics.md)
- * [微服务调用链](general-development/microservice-invocation-chain.md)
- * [自定义调用链打点](general-development/customized-tracing.md)
- * [本地开发和测试](general-development/local-develop-test.md)
- * [Http Filter](general-development/http-filter.md)
- * [文件上传下载](general-development/upload-download.md)
- * [Reactive](general-development/reactive.md)
- * [DNS自定义配置](general-development/dnsconfig.md)
- * [代理设置](general-development/proxy.md)
- * [框架上报版本号](general-development/report-framework-version.md)
- * [跨应用调用](general-development/cross-app-invocation.md)
- * [定制序列化和反序列化方法](general-development/secret-field.md)
- * [使用Context传递控制消息](general-development/context.md)
- * [返回值序列化扩展](general-development/produceprocess.md)
- * [跨域资源共享(CORS)配置](general-development/CORS.md)
- * [获取熔断与实例隔离告警事件信息](general-development/AlarmEvent.md)
- * [优雅停机](general-development/shutdown.md)
- * [异常处理](general-development/error-handling.md)
- * [微服务实例间多环境隔离](general-development/multienvironment.md)
- * [线程模型](general-development/thread-model.md)
- * [配置日志](general-development/config-logs.md)
-* 多样化的通信协议功能参考:
- * [多协议介绍](transports/introduction.md)
- * [REST over Servlet](transports/rest-over-servlet.md)
- * [REST over Vertx](transports/rest-over-vertx.md)
- * [REST over HTTP2](transports/http2.md)
- * [Highway](transports/highway-rpc.md)
-* 多样化的服务注册与发现功能参考:
- * [注册发现说明](registry/introduction.md)
- * [使用服务中心](registry/service-center.md)
- * [本地注册发现](registry/local-registry.md)
- * [去中心化注册发现](registry/distributed.md)
-* 管理服务配置:
- * [通用配置说明](config/general-config.md)
- * [在程序中读取配置信息](config/read-config.md)
-- 服务治理功能参考:
- - [处理链介绍](references-handlers/intruduction.md)
- - [负载均衡](references-handlers/loadbalance.md)
- - [限流](references-handlers/ratelimit.md)
- - [灰度发布](references-handlers/router.md)
- - [故障注入](references-handlers/fault-injection.md)
- - [基于动态配置的流量特征治理](references-handlers/governance.md)
- - [快速失败和重试](references-handlers/fail-retry.md)
-- 网关功能参考:
- - [介绍](edge/open-service.md)
- - [使用 Edge Service 做网关](edge/by-servicecomb-sdk.md)
- - [使用 `zuul` 和 `spring cloud gateway` 做网关](edge/zuul.md)
- - [nginx 网关简单介绍](edge/nginx.md)
-- 安全特性参考:
- - [使用TLS通信](security/tls.md)
- - [使用RSA认证](security/shi-yong-rsa-ren-zheng.md)
- - [公钥认证](references-handlers/publickey.md)
-- 服务打包和运行:
- - [以standalone模式打包](packaging/standalone.md)
- - [以WEB容器模式打包](packaging/web-container.md)
-- 专题文章:
- - [在Spring Boot中使用java
chassis](using-java-chassis-in-spring-boot/using-java-chassis-in-spring-boot.md)
- - [兼容问题和兼容性策略](featured-topics/compatibility.md)
- - [新功能介绍系列文章](featured-topics/features.md)
- - [升级指导系列文章](featured-topics/upgrading.md)
- - [性能问题分析和调优](featured-topics/performance.md)
-- 常用配置项参考:
- - [REST Transport Client 配置项](config-reference/rest-transport-client.md)
- - [Config Center Client 配置项](config-reference/config-center-client.md)
- - [Service Center Client 配置项](config-reference/service-center-client.md)
- - [ServiceComb Kie Client 配置项](config-reference/kie-client.md)
-- 常见问题:
- - [FAQ](question-and-answer/faq.md)
- - [Q & A](question-and-answer/question_answer.md)
- - [微服务接口兼容常见问题](question-and-answer/interface-compatibility.md)
diff --git a/java-chassis-reference/zh_CN/mkdocs.yml
b/java-chassis-reference/zh_CN/mkdocs.yml
index a3f4664..c952fb4 100644
--- a/java-chassis-reference/zh_CN/mkdocs.yml
+++ b/java-chassis-reference/zh_CN/mkdocs.yml
@@ -3,11 +3,10 @@ use_directory_urls: false
nav:
-- 目录: toc.md
- 概述 : index.md
+- Java Chassis设计参考: start/design.md
- 3.x.x 版本介绍 : introduce3.x.x.md
- 快速入门: start/catalog.md
-- 设计选型参考: start/design.md
- 微服务定义: build-provider/definition/service-definition.md
- 开发服务提供者: build-provider/catalog.md
- 开发服务消费者: build-consumer/catalog.md
