Skip to content

Commit

Permalink
Fix quickstart docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AlbumenJ committed Sep 12, 2024
1 parent 8bb1052 commit 3faab9c
Show file tree
Hide file tree
Showing 14 changed files with 47 additions and 45 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ weight: 7

## Feature Description

Prior to dubbo 3.3.0-beta.3, dubbo and dubbo-samples were using a mix of log4j and logback, leading to frequent conflicts and errors due to some modules lacking log configuration. Therefore, after 3.3.0-beta.3, the logging components have been upgraded to log4j2 for simplicity and reduced maintenance costs. This document explains how to configure and use the logging framework to avoid conflicts caused by indirectly introducing multiple logging frameworks.
Prior to dubbo 3.3.0, dubbo and dubbo-samples were using a mix of log4j and logback, leading to frequent conflicts and errors due to some modules lacking log configuration. Therefore, after 3.3.0-beta.3, the logging components have been upgraded to log4j2 for simplicity and reduced maintenance costs. This document explains how to configure and use the logging framework to avoid conflicts caused by indirectly introducing multiple logging frameworks.

## How To Use

Expand Down
2 changes: 2 additions & 0 deletions content/zh-cn/overview/mannual/java-sdk/quick-start/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ description: 快速部署Dubbo应用
linkTitle: 部署Dubbo应用
title: 快速部署Dubbo应用
type: docs
toc_hide: true
hide_summary: true
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ weight: 2
## 快速创建应用
通过访问 <a href="https://start.dubbo.apache.org" target="_blank">start.dubbo.apache.org</a> 在线服务创建 Dubbo 微服务应用。如下图所示依次添加组件,您可以在几十秒之内快速创建一个 Dubbo 应用。下载生成的示例应用并解压源码即可。

<img style="max-width:800px;height:auto;margin-bottom:10px;" alt="项目结构截图" src="/imgs/v3/quickstart/initializer-provider.png"/>
<img style="max-width:800px;height:auto;margin-bottom:10px;" alt="项目结构截图" src="/imgs/v3/quickstart/start.jpg"/>

{{% alert title="直接使用官方准备好的示例" color="info" %}}
您还可以直接下载官方预先准备好的示例项目:
Expand Down Expand Up @@ -52,7 +52,7 @@ curl \
## 源码解析
将以上准备好的示例项目导入最喜欢的 IDE 开发工具(以 IntelliJ IDEA 为例),项目结构如下:

<img style="max-width:400px;height:auto;" alt="项目结构截图" src="/imgs/v3/quickstart/project-structure2.png"/>
<img style="max-width:400px;height:auto;" alt="项目结构截图" src="/imgs/v3/quickstart/samples.jpg"/>

### Maven 依赖
打开 pom.xml,可以看到示例项目中 Dubbo 相关核心依赖如下:
Expand All @@ -63,7 +63,7 @@ curl \
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-bom</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -191,29 +191,29 @@ dubbo:

### 序列化组件

| 组件名称 | 所需的插件 | 插件版本 | 备注 |
| ------------ | ------------------- | --------------------------------------- | ---------------------------- |
| FastJson2 | dubbo-maven-plugin | 3.3.0-beta.1-SNAPSHOT (Preview)及其以上 | |
| JDK | native-maven-plugin | 0.9.24 及其以上 | |
| Hessian-Lite | | | 对JDK 17支持不友好,暂不支持 |
| 组件名称 | 所需的插件 | 插件版本 | 备注 |
| ------------ | ------------------- |-------------| ---------------------------- |
| FastJson2 | dubbo-maven-plugin | 3.3.0 及其以上 | |
| JDK | native-maven-plugin | 0.9.24 及其以上 | |
| Hessian-Lite | | | 对JDK 17支持不友好,暂不支持 |

### 注册中心组件

| 组件名称 | 所需的插件 | 插件版本 | 备注 |
| --------- | ------------------ | ------------------------------- | ------------------------ |
| Zookeeper | dubbo-maven-plugin | 3.3.0-beta.1-SNAPSHOT (Preview) | 仅支持Zookeeper Curator5 |
| Zookeeper | dubbo-maven-plugin | 3.3.0 | 仅支持Zookeeper Curator5 |

### 元数据中心组件

| 组件名称 | 所需的插件 | 插件版本 | 备注 |
| --------- | ------------------ | ------------------------------- | ------------------------ |
| Zookeeper | dubbo-maven-plugin | 3.3.0-beta.1-SNAPSHOT (Preview) | 仅支持Zookeeper Curator5 |
| Zookeeper | dubbo-maven-plugin | 3.3.0 | 仅支持Zookeeper Curator5 |

### 配置中心组件

| 组件名称 | 所需的插件 | 插件版本 | 备注 |
| --------- | ------------------ | ------------------------------- | ------------------------ |
| Zookeeper | dubbo-maven-plugin | 3.3.0-beta.1-SNAPSHOT (Preview) | 仅支持Zookeeper Curator5 |
| 组件名称 | 所需的插件 | 插件版本 | 备注 |
| --------- | ------------------ |-------| ------------------------ |
| Zookeeper | dubbo-maven-plugin | 3.3.0 | 仅支持Zookeeper Curator5 |

### 可观测性组件

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ weight: 4
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-nacos-spring-boot-starter</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>
```

Expand All @@ -37,7 +37,7 @@ weight: 4
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>
<dependency>
<groupId>com.alibaba.nacos</groupId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Dubbo 提供了对 Spring 框架的完整支持,我们推荐使用官方提供
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-bom</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ weight: 1
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>

<!-- 为了避免 Netty 依赖冲突,您也可以是选择使用 dubbo-shaded 版本!-->
<!--
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-shaded</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>
-->
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ weight: 4
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>
<dependency>
<groupId>com.alibaba.nacos</groupId>
Expand All @@ -37,12 +37,12 @@ weight: 4
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-nacos-spring-boot-starter</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ weight: 3
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>
<!-- 仅当 Zookeeper Server 版本是 3.4.x 及以下时,使用此依赖 -->
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-zookeeper-spring-boot-starter</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>
<!-- 仅当 Zookeeper Server 版本是 3.5.x 及以上时,使用此依赖
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-zookeeper-curator5-spring-boot-starter</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>
-->
```
Expand All @@ -50,21 +50,21 @@ weight: 3
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
</dependency>
<!-- This dependency helps to introduce Curator and Zookeeper dependencies that are necessary for Dubbo to work with zookeeper as transitive dependencies. -->
<!-- 仅当 Zookeeper Server 版本是 3.4.x 及以下时,使用此依赖 -->
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-dependencies-zookeeper</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
<type>pom</type>
</dependency>
<!-- 仅当 Zookeeper Server 版本是 3.5.x 及以上时,使用此依赖
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-dependencies-zookeeper-curator5</artifactId>
<version>3.3.0-beta.1</version>
<version>3.3.0</version>
<type>pom</type>
</dependency>
-->
Expand Down
12 changes: 6 additions & 6 deletions content/zh-cn/overview/mannual/java-sdk/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ weight: 1
| <span style="display:inline-block;min-width:120px">Dubbo 分支</span> | <span style="display:inline-block;min-width:100px">最新版本</span> | <span style="display:inline-block;min-width:80px">JDK</span> | Spring Boot | <span style="display:inline-block;min-width:80px">组件版本</span> | 详细说明 |
| --- | --- | --- | --- | --- | --- | --- | --- |
| 3.3.x (当前文档) | 3.3.0 | 8, 17, 21 | [2.x、3.x](/zh-cn/overview/mannual/java-sdk/reference-manual/config/spring/spring-boot/#dubbo-spring-boot-starter) | [详情](https://github.com/apache/dubbo/blob/dubbo-3.3.0/dubbo-dependencies-bom/pom.xml#L91) | - [版本变更记录](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/version/3.2-to-3.3-compatibility-guide/) <br/><br/> - **生产可用(推荐,长期维护)!** 最新Triple协议升级,内置Metrics、Tracing、GraalVM支持等 |
| [3.2.x](https://dubbo-3-2-x.staged.apache.org/zh-cn/overview/mannual/java-sdk/) | 3.2.10 | 8, 17 | [2.x、3.x](/zh-cn/overview/mannual/java-sdk/reference-manual/config/spring/spring-boot/#dubbo-spring-boot-starter) | [详情](https://github.com/apache/dubbo/blob/dubbo-3.2.10/dubbo-dependencies-bom/pom.xml#L91) | - [版本变更记录](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/version/3.1-to-3.2-compatibility-guide/) <br/><br/> - 生产可用(长期维护)! |
| [3.1.x](https://dubbo-3-2-x.staged.apache.org/zh-cn/overview/mannual/java-sdk/) | 3.1.11 | 8, 17 | [2.x、3.x](/zh-cn/overview/mannual/java-sdk/reference-manual/config/spring/spring-boot/#dubbo-spring-boot-starter) | [详情](https://github.com/apache/dubbo/blob/dubbo-3.1.11/dubbo-dependencies-bom/pom.xml#L91) | - [版本变更记录](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/version/3.0-to-3.1-compatibility-guide/) <br/><br/> - 仅修复安全漏洞! |
| [3.0.x](https://dubbo-3-2-x.staged.apache.org/zh-cn/overview/mannual/java-sdk/) | 3.0.15 | 8 | [2.x](/zh-cn/overview/mannual/java-sdk/reference-manual/config/spring/spring-boot/#dubbo-spring-boot-starter) | [详情](https://github.com/apache/dubbo/blob/dubbo-3.0.15/dubbo-dependencies-bom/pom.xml#L91) | - [版本变更记录](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/version/2.x-to-3.x-compatibility-guide/) <br/><br/> - 停止维护! |
| [2.7.x](https://dubbo-3-2-x.staged.apache.org/zh-cn/overview/mannual/java-sdk/) | 2.7.23 | 8 | [2.x](/zh-cn/overview/mannual/java-sdk/reference-manual/config/spring/spring-boot/#dubbo-spring-boot-starter) | [详情](https://raw.githubusercontent.com/apache/dubbo/dubbo-2.7.23/dubbo-dependencies-bom/pom.xml) | - [了解如何升级到Dubbo3](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/migration/) <br/><br/> - 停止维护! |
| [2.6.x](https://dubbo-3-2-x.staged.apache.org/zh-cn/overview/mannual/java-sdk/) | 2.6.20 | 6, 7 | - | _ | - [了解如何升级到Dubbo3](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/migration/) <br/><br/> - 停止维护! |
| [2.5.x](https://dubbo-3-2-x.staged.apache.org/zh-cn/overview/mannual/java-sdk/) | 2.5.10 | 6, 7 | - | - | - [了解如何升级到Dubbo3](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/migration/) <br/><br/> - 停止维护! |
| [3.2.x](https://dubbo-202409.staged.apache.org/zh-cn/overview/mannual/java-sdk/) | 3.2.10 | 8, 17 | [2.x、3.x](/zh-cn/overview/mannual/java-sdk/reference-manual/config/spring/spring-boot/#dubbo-spring-boot-starter) | [详情](https://github.com/apache/dubbo/blob/dubbo-3.2.10/dubbo-dependencies-bom/pom.xml#L91) | - [版本变更记录](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/version/3.1-to-3.2-compatibility-guide/) <br/><br/> - 生产可用(长期维护)! |
| [3.1.x](https://dubbo-202409.staged.apache.org/zh-cn/overview/mannual/java-sdk/) | 3.1.11 | 8, 17 | [2.x、3.x](/zh-cn/overview/mannual/java-sdk/reference-manual/config/spring/spring-boot/#dubbo-spring-boot-starter) | [详情](https://github.com/apache/dubbo/blob/dubbo-3.1.11/dubbo-dependencies-bom/pom.xml#L91) | - [版本变更记录](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/version/3.0-to-3.1-compatibility-guide/) <br/><br/> - 仅修复安全漏洞! |
| [3.0.x](https://dubbo-202409.staged.apache.org/zh-cn/docs/) | 3.0.15 | 8 | [2.x](/zh-cn/overview/mannual/java-sdk/reference-manual/config/spring/spring-boot/#dubbo-spring-boot-starter) | [详情](https://github.com/apache/dubbo/blob/dubbo-3.0.15/dubbo-dependencies-bom/pom.xml#L91) | - [版本变更记录](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/version/2.x-to-3.x-compatibility-guide/) <br/><br/> - 停止维护! |
| [2.7.x](https://dubbo-202409.staged.apache.org/zh-cn/docsv2.7/) | 2.7.23 | 8 | [2.x](/zh-cn/overview/mannual/java-sdk/reference-manual/config/spring/spring-boot/#dubbo-spring-boot-starter) | [详情](https://raw.githubusercontent.com/apache/dubbo/dubbo-2.7.23/dubbo-dependencies-bom/pom.xml) | - [了解如何升级到Dubbo3](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/migration/) <br/><br/> - 停止维护! |
| 2.6.x | 2.6.20 | 6, 7 | - | _ | - [了解如何升级到Dubbo3](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/migration/) <br/><br/> - 停止维护! |
| 2.5.x | 2.5.10 | 6, 7 | - | - | - [了解如何升级到Dubbo3](/zh-cn/overview/mannual/java-sdk/reference-manual/upgrades-and-compatibility/migration/) <br/><br/> - 停止维护! |
10 changes: 5 additions & 5 deletions data/download/en/1javaReleases.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ type: java
extra_message:
extra_link:
list:
- name: 3.3.0-beta.5
- name: 3.3.0
description: >
The latest feature version of Dubbo 3 includes JDK 21 Project Loom, the new Triple protocol, etc.
changelog: https://github.com/apache/dubbo/releases/tag/dubbo-3.3.0-beta.5
archive: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0-beta.5/apache-dubbo-3.3.0-beta.5-src.zip
hash: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0-beta.5/apache-dubbo-3.3.0-beta.5-src.zip.sha512
signature: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0-beta.5/apache-dubbo-3.3.0-beta.5-src.zip.asc
changelog: https://github.com/apache/dubbo/releases/tag/dubbo-3.3.0
archive: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0/apache-dubbo-3.3.0-src.zip
hash: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0/apache-dubbo-3.3.0-src.zip.sha512
signature: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0/apache-dubbo-3.3.0-src.zip.asc
- name: 3.2.15
description: >
Dubbo 3 is the latest stable version. It is recommended that all 3.x users upgrade to this version.
Expand Down
10 changes: 5 additions & 5 deletions data/download/zh/1javaReleases.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ type: java
extra_message:
extra_link:
list:
- name: 3.3.0-beta.5
- name: 3.3.0
description: >
Dubbo 3 最新特性版本,包含了如 JDK 21 Project Loom、全新 Triple 协议等。
changelog: https://github.com/apache/dubbo/releases/tag/dubbo-3.3.0-beta.5
archive: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0-beta.5/apache-dubbo-3.3.0-beta.5-src.zip
hash: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0-beta.5/apache-dubbo-3.3.0-beta.5-src.zip.sha512
signature: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0-beta.5/apache-dubbo-3.3.0-beta.5-src.zip.asc
changelog: https://github.com/apache/dubbo/releases/tag/dubbo-3.3.0
archive: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0/apache-dubbo-3.3.0-src.zip
hash: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0/apache-dubbo-3.3.0-src.zip.sha512
signature: https://www.apache.org/dyn/closer.lua/dubbo/3.3.0/apache-dubbo-3.3.0-src.zip.asc
- name: 3.2.15
description: >
Dubbo 3 最新稳定版本,建议所有的 3.x 用户都升级到该版本。
Expand Down
Binary file added static/imgs/v3/quickstart/samples.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/imgs/v3/quickstart/start.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3faab9c

Please sign in to comment.