You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by li...@apache.org on 2020/11/27 06:58:07 UTC
[servicecomb-docs] branch master updated: [SCB-2073]create
documents to integrate logger for java-chassis (#208)
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 f5b6729 [SCB-2073]create documents to integrate logger for java-chassis (#208)
f5b6729 is described below
commit f5b67296e722ea0c4d65b67cf3e8b86ec1717747
Author: bao liu <bi...@qq.com>
AuthorDate: Fri Nov 27 14:58:01 2020 +0800
[SCB-2073]create documents to integrate logger for java-chassis (#208)
---
.../docs/build-consumer/using-AsyncRestTemplate.md | 2 +-
.../en_US/docs/catalog/build-consumer.md | 2 +-
java-chassis-reference/en_US/mkdocs.yml | 2 +-
.../zh_CN/docs/build-consumer/catalog.md | 2 +-
.../docs/build-consumer/using-AsyncRestTemplate.md | 20 ++++++++++-
.../zh_CN/docs/catalog/build-consumer.md | 2 +-
.../zh_CN/docs/general-development/CORS.md | 2 +-
.../zh_CN/docs/general-development/catalog.md | 5 ++-
.../zh_CN/docs/general-development/config-logs.md | 41 ++++++++++++++++++++++
java-chassis-reference/zh_CN/docs/toc.md | 5 +--
10 files changed, 71 insertions(+), 12 deletions(-)
diff --git a/java-chassis-reference/en_US/docs/build-consumer/using-AsyncRestTemplate.md b/java-chassis-reference/en_US/docs/build-consumer/using-AsyncRestTemplate.md
index 3f42da5..1c5676a 100644
--- a/java-chassis-reference/en_US/docs/build-consumer/using-AsyncRestTemplate.md
+++ b/java-chassis-reference/en_US/docs/build-consumer/using-AsyncRestTemplate.md
@@ -1,4 +1,4 @@
-# Develop consumer with AsynRestTemplate
+# Develop consumer with AsyncRestTemplate
## Concepts
diff --git a/java-chassis-reference/en_US/docs/catalog/build-consumer.md b/java-chassis-reference/en_US/docs/catalog/build-consumer.md
index 2533943..44ae168 100644
--- a/java-chassis-reference/en_US/docs/catalog/build-consumer.md
+++ b/java-chassis-reference/en_US/docs/catalog/build-consumer.md
@@ -1,7 +1,7 @@
## Develop consumer with Rest Template
RestTemplate is a RESTful API provided by the Spring framework. ServiceComb provides the implementation class for service calling
-## Develop consumer with AsynRestTemplate
+## Develop consumer with AsyncRestTemplate
AsyncRestTemplate allows users to make asynchronous service calls. The logic is similar to restTemplate, except that the service is called asynchronously.
## Develop consumer with transparent RPC
diff --git a/java-chassis-reference/en_US/mkdocs.yml b/java-chassis-reference/en_US/mkdocs.yml
index e020477..7a14320 100644
--- a/java-chassis-reference/en_US/mkdocs.yml
+++ b/java-chassis-reference/en_US/mkdocs.yml
@@ -27,7 +27,7 @@ nav:
- Writing Service Consumer:
- Consumer common configuration: build-consumer/common-configuration.md
- Using Rest Template: build-consumer/using-resttemplate.md
- - Using AsynRestTemplate: build-consumer/using-AsyncRestTemplate.md
+ - Using AsyncRestTemplate: build-consumer/using-AsyncRestTemplate.md
- Using with RPC: build-consumer/develop-consumer-using-rpc.md
- Contract: build-consumer/with-contract.md
- Invoke control:
diff --git a/java-chassis-reference/zh_CN/docs/build-consumer/catalog.md b/java-chassis-reference/zh_CN/docs/build-consumer/catalog.md
index 6897227..adb9bf5 100644
--- a/java-chassis-reference/zh_CN/docs/build-consumer/catalog.md
+++ b/java-chassis-reference/zh_CN/docs/build-consumer/catalog.md
@@ -2,7 +2,7 @@
* [消费者通用配置项](common-configuration.md)
* [使用RestTemplate开发服务消费者](using-resttemplate.md)
-* [使用AsynRestTemplate开发服务消费者](using-AsyncRestTemplate.md)
+* [使用AsyncRestTemplate开发服务消费者](using-AsyncRestTemplate.md)
* [使用RPC方式开发服务消费者](develop-consumer-using-rpc.md)
* [泛化调用](../featured-topics/features/invoker.md)
* [使用服务契约](with-contract.md)
diff --git a/java-chassis-reference/zh_CN/docs/build-consumer/using-AsyncRestTemplate.md b/java-chassis-reference/zh_CN/docs/build-consumer/using-AsyncRestTemplate.md
index d86ee7b..a5816f8 100644
--- a/java-chassis-reference/zh_CN/docs/build-consumer/using-AsyncRestTemplate.md
+++ b/java-chassis-reference/zh_CN/docs/build-consumer/using-AsyncRestTemplate.md
@@ -1,4 +1,22 @@
-# 使用AsynRestTemplate开发服务消费者
+# 使用AsyncRestTemplate开发服务消费者
+
+***注意***: AsyncRestTemplate 接口在新版本的 Spring 接口中已经废弃。 建议使用异步 RPC 接口访问， 例如：
+
+```
+interface Hello {
+ CompletableFuture<String> sayHi(String name);
+}
+
+@Component
+public class SomeBean {
+ ......
+
+ @RpcReference(microserviceName = "helloService", schemaId = "helloSchema")
+ private Hello hello;
+
+ ......
+}
+```
## 概念阐述
diff --git a/java-chassis-reference/zh_CN/docs/catalog/build-consumer.md b/java-chassis-reference/zh_CN/docs/catalog/build-consumer.md
index de4b46b..c3f5fb8 100644
--- a/java-chassis-reference/zh_CN/docs/catalog/build-consumer.md
+++ b/java-chassis-reference/zh_CN/docs/catalog/build-consumer.md
@@ -1,7 +1,7 @@
## 使用RestTemplate开发服务消费者
RestTemplate是Spring提供的RESTful访问接口，ServiceComb提供该接口的实现类用于服务的调用。
-## 使用AsynRestTemplate开发服务消费者
+## 使用AsyncRestTemplate开发服务消费者
AsyncRestTemplate 开发方式允许用户异步的进行服务调用。具体的业务流程和 RestTemplate 类似，只是这里以异步的形式进行服务的调用。
## 使用透明RPC方式开发服务消费者
diff --git a/java-chassis-reference/zh_CN/docs/general-development/CORS.md b/java-chassis-reference/zh_CN/docs/general-development/CORS.md
index be16cff..d3d95ce 100644
--- a/java-chassis-reference/zh_CN/docs/general-development/CORS.md
+++ b/java-chassis-reference/zh_CN/docs/general-development/CORS.md
@@ -1,4 +1,4 @@
-# CORS机制
+# 跨域资源共享(CORS)配置
## 概念阐述
diff --git a/java-chassis-reference/zh_CN/docs/general-development/catalog.md b/java-chassis-reference/zh_CN/docs/general-development/catalog.md
index 9e0058f..00ce189 100644
--- a/java-chassis-reference/zh_CN/docs/general-development/catalog.md
+++ b/java-chassis-reference/zh_CN/docs/general-development/catalog.md
@@ -14,11 +14,10 @@
* [定制序列化和反序列化方法](secret-field.md)
* [使用Context传递控制消息](context.md)
* [返回值序列化扩展](produceprocess.md)
-* [CORS机制](CORS.md)
+* [跨域资源共享(CORS)配置](CORS.md)
* [获取熔断与实例隔离告警事件信息](AlarmEvent.md)
* [优雅停机](shutdown.md)
* [异常处理](error-handling.md)
* [微服务实例间多环境隔离](multienvironment.md)
* [线程模型](thread-model.md)
-
-
\ No newline at end of file
+* [配置日志](config-logs.md)
\ No newline at end of file
diff --git a/java-chassis-reference/zh_CN/docs/general-development/config-logs.md b/java-chassis-reference/zh_CN/docs/general-development/config-logs.md
new file mode 100644
index 0000000..bf4051e
--- /dev/null
+++ b/java-chassis-reference/zh_CN/docs/general-development/config-logs.md
@@ -0,0 +1,41 @@
+# 配置日志
+
+java chassis 系统内部全部采用 `slf4j` 记录日志。 `slf4j` 是一套日志 API 标准，具体实现可以由 `log4j`, `log4j2`, `logback` 等
+提供。 java chassis 默认没有提供实现的依赖， 开发者可以选项依赖适合自己的日志实现， 下面简单的介绍如何引入常见的实现。
+
+* log4j2
+
+使用 log4j2 需要在项目中提供如下依赖。
+
+```xml
+ <dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-slf4j-impl</artifactId>
+ </dependency>
+```
+
+* log4j
+
+使用 log4j 需要在项目中提供如下依赖。
+
+```xml
+ <dependency>
+ <groupId>log4j</groupId>
+ <artifactId>log4j</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-log4j12</artifactId>
+ </dependency>
+```
+
+* logback
+
+使用 logback 需要在项目中提供如下依赖。
+
+```xml
+ <dependency>
+ <groupId>ch.qos.logback</groupId>
+ <artifactId>logback-classic</artifactId>
+ </dependency>
+```
\ No newline at end of file
diff --git a/java-chassis-reference/zh_CN/docs/toc.md b/java-chassis-reference/zh_CN/docs/toc.md
index 556c0da..04a3b63 100644
--- a/java-chassis-reference/zh_CN/docs/toc.md
+++ b/java-chassis-reference/zh_CN/docs/toc.md
@@ -37,7 +37,7 @@
* [开发服务消费者](build-consumer/catalog.md)
* [消费者通用配置项](build-consumer/common-configuration.md)
* [使用RestTemplate开发服务消费者](build-consumer/using-resttemplate.md)
- * [使用AsynRestTemplate开发服务消费者](build-consumer/using-AsyncRestTemplate.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)
@@ -60,12 +60,13 @@
* [定制序列化和反序列化方法](general-development/secret-field.md)
* [使用Context传递控制消息](general-development/context.md)
* [返回值序列化扩展](general-development/produceprocess.md)
- * [CORS机制](general-development/CORS.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)
* 多样化的通信协议功能参考:
* [REST over Servlet](transports/rest-over-servlet.md)
* [REST over Vertx](transports/rest-over-vertx.md)