-
Notifications
You must be signed in to change notification settings - Fork 636
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #138 from WeBankFinTech/develop
merge develop into master , pre release 1.0.0
- Loading branch information
Showing
442 changed files
with
1,539 additions
and
19,632 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # 贡献给EventMesh | ||
|
|
||
| 欢迎使用EventMesh! 本文档是有关如何为EventMesh做出贡献的指南。 | ||
| 如果发现不正确或缺失的内容，请留下评论/建议。 | ||
|
|
||
| ## 开始之前 | ||
|
|
||
| ### 设置您的开发环境 | ||
|
|
||
| 您应该在操作系统中安装了JDK。 | ||
|
|
||
| ## 贡献 | ||
|
|
||
| 无论是对于拼写错误，BUG修复还是重要的新功能，我们总是很乐意为您做出贡献。 | ||
| 请不要犹豫，提出问题或发送请求请求。 | ||
|
|
||
| 我们非常重视文档以及与其他项目的集成。 | ||
| 我们很高兴接受这些方面的改进。 | ||
|
|
||
| ### GitHub工作流程 | ||
|
|
||
| 我们将`develop`分支用作开发分支，这表明这是一个不稳定的分支。 | ||
|
|
||
| 这是贡献者的工作流程 : | ||
|
|
||
| 1.Fork到您个人仓库 | ||
| 2.克隆到本地存储库 | ||
| 3.创建一个新分支并对其进行处理 | ||
| 4.保持分支同步 | ||
| 5.提交您的更改(确保您的提交消息简明扼要) | ||
| 6.将您的提交推送到分叉的存储库 | ||
| 7.创建PR合并请求 | ||
|
|
||
| 请遵循[Pull Requests模板](./.github/PULL_REQUEST_TEMPLATE.md). | ||
| 请确保PR对应有相应的问题. [GitHub Issues](https://github.com/WeBankFinTech/EventMesh/issues) | ||
|
|
||
| 创建PR后，将为拉取请求分配一个或多个审阅者。 | ||
| 审阅者将审阅代码。 | ||
|
|
||
| 在合并PR之前，请压缩所有修订审阅反馈，拼写错误，合并的内容和基于基础的提交内容。 | ||
| 最终的提交消息应该清晰简洁。 | ||
|
|
||
| ### 打开问题/ PR | ||
|
|
||
| 我们将使用Issues和Pull Requests作为跟踪器 | ||
| [GitHub Issues](https://github.com/WeBankFinTech/EventMesh/issues) | ||
| [Pull Requests](https://github.com/WeBankFinTech/EventMesh/pulls) | ||
|
|
||
| 如果您在文档中发现拼写错误，在代码中发现错误，想要新功能或提出建议， | ||
| 您可以提出问题[在GitHub上打开问题](https://github.com/WeBankFinTech/EventMesh/issues/new) | ||
| 请按照问题模板中的准则消息进行操作。 | ||
|
|
||
| 如果您想贡献，请遵循[贡献工作流程](#github-workflow)并创建一个新的拉取请求。 | ||
| 如果您的PR包含较大的更改，例如组件重构或新组件，请写详细文档 | ||
| 有关其设计和使用的信息。 | ||
|
|
||
| 请注意，单个拉取请求不应太大。如果需要进行重大更改，最好将更改分开 | ||
| 到一些个人PR。 | ||
|
|
||
| ### 代码审查 | ||
|
|
||
| 所有代码应由一个或多个提交者进行良好的审查。一些原则: | ||
|
|
||
| - 可读性: 重要代码应有详细记录。符合我们的代码风格 | ||
| - 优雅: 新功能，类或组件应经过精心设计 | ||
| - 可测试性: 重要代码应经过良好测试（较高的单元测试覆盖率） | ||
|
|
||
| ## 社区 | ||
|
|
||
| ### 联系我们 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| [](https://www.travis-ci.org/WeBankFinTech/EventMesh) | ||
| [](https://coveralls.io/github/WeBankFinTech/EventMesh?branch=master) | ||
| [](https://github.com/WeBankFinTech/EventMesh/releases) | ||
| [](https://www.apache.org/licenses/LICENSE-2.0.html) | ||
|
|
||
| ## 什么是Event Mesh？ | ||
| 该图显示了Event Mesh相对于应用程序框架中其他类似技术(例如Service Mesh)的定位. | ||
|  | ||
|
|
||
| EventMesh的功能全景: | ||
|  | ||
|
|
||
| Event Mesh是一个动态的插件式云原生基础服务层，用于分离应用程序和中间件层。它提供了灵活，可靠和快速的事件分发，并且可以进行管理， | ||
| 下图显示了Event Mesh的体系结构: | ||
|  | ||
|
|
||
| Event Mesh允许将来自一个应用程序的事件动态路由到任何其他应用程序. | ||
| Event Mesh的一般功能: | ||
| * 事件驱动; | ||
| * 事件治理; | ||
| * 动态路由; | ||
| * 云原生 | ||
|
|
||
| 依赖部件： | ||
| * DeFiBus：具有低延迟，高性能和可靠性，和灵活可伸缩性的分布式消息传递平台 [DeFiBus](https://github.com/WeBankFinTech/DeFiBus) | ||
|
|
||
| 关键部件： | ||
| * eventmesh-emesher：一种中间件，用于在事件产生者和使用者之间传输事件，支持云原生应用程序和微服务 | ||
| * eventmesh-sdk-java：当前支持HTTP和TCP协议，未来会支持AMQP, MQTT, Websocket and JMS, gRPC等 | ||
| * eventmesh-registry：自动在连接到单独事件网格器的应用程序和服务之间路由事件, 管理emesher | ||
|
|
||
| ## 快速开始 | ||
| 1. 构建并部署event-store([DeFiBus](https://github.com/WeBankFinTech/DeFiBus)) | ||
| 请参见说明['event-store quickstart.zh-CN'](docs/cn/instructions/eventmesh-store-quickstart.zh-CN.md) | ||
| 2. 构建并部署eventmesh-emesher，请参见说明['eventmesh-emesher quickstart.zh-CN'](docs/cn/instructions/eventmesh-emesher-quickstart.zh-CN.md) | ||
| 3. 运行eventmesh-sdk-java演示，请参见说明['eventmesh-sdk-java quickstart.zh-CN'](docs/cn/instructions/eventmesh-sdk-java-quickstart.zh-CN.md) | ||
|
|
||
| ## 贡献 | ||
| 永远欢迎参与共建, 请参阅[贡献](CONTRIBUTING.zh-CN.md)了解详细指南 | ||
|
|
||
| 您可以从问题开始. | ||
| [GitHub Issues](https://github.com/WeBankFinTech/EventMesh/issues) | ||
|
|
||
| ## License | ||
| [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) Copyright (C) Apache Software Foundation | ||
|
|
||
| ## 联系人 | ||
| 微信群: | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
docs/cn/instructions/eventmesh-emesher-quickstart.zh-CN.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| #Eventmesh-emesher快速入门说明 | ||
|
|
||
| ###依赖 | ||
| ``` | ||
| 建议使用64位操作系统，建议使用Linux / Unix； | ||
| 64位JDK 1.8+; | ||
| Gradle至少为5.6, 推荐 5.6.* | ||
| ``` | ||
|
|
||
| ###下载源码 | ||
| [https://github.com/WeBankFinTech/EventMesh](https://github.com/WeBankFinTech/EventMesh) | ||
| 您将获得**EventMesh-master.zip** | ||
|
|
||
| ###构建源码 | ||
| ```$ xslt | ||
| unzip EventMesh-master.zip | ||
| cd / *您的部署路径* /EventMesh-master/eventmesh-emesher | ||
| gradle clean tar -x test | ||
| ``` | ||
| 您将在目录/ *您的部署路径* /EventMesh-master/eventmesh-emesher/dist中获得**eventmesh-emesher_1.0.0.tar.gz** | ||
|
|
||
| ###部署 | ||
| -部署eventmesn-emesher | ||
| ```$ xslt | ||
| upload eventmesh-emesher_1.0.0.tar.gz | ||
| tar -zxvf eventmesh-emesher_1.0.0.tar.gz | ||
| cd bin | ||
| 配置 proxy.properties | ||
| cd ../bin | ||
| sh start.sh | ||
| ``` | ||
| 如果看到"ProxyTCPServer[port=10000] started...."，则说明设置成功。 |
118 changes: 118 additions & 0 deletions
118
docs/cn/instructions/eventmesh-sdk-java-quickstart.zh-CN.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| ##如何运行eventmesh-sdk-java演示 | ||
|
|
||
| > Eventmesh-sdk-java作为客户端，与eventmesh-emesher通信，用于完成消息的发送和接收。 | ||
| > | ||
| > Eventmesh-sdk-java支持同步消息，异步消息和广播消息。同步消息表示生产者发送消息，需要消费者提供响应消息；异步消息表示生产者只发送消息，不关心回复消息。广播消息表示生产者发送一次消息，所有订阅广播主题的消费者都将收到消息。味精 | ||
| > | ||
| > Eventmesh-sdk-java支持HTTP和TCP协议。 | ||
|
|
||
| ### 1. TCP DEMO | ||
|
|
||
| ####同步消息 | ||
|
|
||
| - 创建主题 | ||
|
|
||
| ``` | ||
| sh runadmin.sh updateTopic -c $ {ClusterName} -t $ {topic} -n $ {namesrvAddr} | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| *启动消费者，订阅上一步骤已经创建的Topic | ||
|
|
||
| ``` | ||
| 运行com.webank.eventmesh.client.tcp.demo.SyncResponse的主要方法 | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| 启动发送端，发送消息 | ||
|
|
||
| ``` | ||
| 运行com.webank.eventmesh.client.tcp.demo.SyncRequest的主要方法 | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ####异步消息 | ||
|
|
||
| - 创建主题 | ||
|
|
||
| ``` | ||
| sh runadmin.sh updateTopic -c $ {ClusterName} -t $ {topic} -n $ {namesrvAddr} | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| - 启动消费者，订阅上一步骤已经创建的Topic | ||
|
|
||
| ``` | ||
| 运行com.webank.eventmesh.client.tcp.demo.AsyncSubscribe的主要方法 | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| 启动发送端，发送消息 | ||
|
|
||
| ``` | ||
| 运行com.webank.eventmesh.client.tcp.demo.AsyncPublish的主要方法 | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ####广播消息 | ||
|
|
||
| - 创建主题 | ||
|
|
||
| ``` | ||
| sh runadmin.sh updateTopic -c $ {ClusterName} -t $ {topic} -n $ {namesrvAddr} | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| - 启动消费端，订阅上一步骤已经创建的Topic | ||
|
|
||
| ``` | ||
| 运行com.webank.eventmesh.client.tcp.demo.AsyncSubscribeBroadcast的主要方法 | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| *启动发送端，发送广播消息 | ||
|
|
||
| ``` | ||
| 运行com.webank.eventmesh.client.tcp.demo.AsyncPublishBroadcast的主要方法 | ||
| ``` | ||
|
|
||
| ### 2. HTTP演示 | ||
|
|
||
| >对于http，eventmesh-sdk-java仅实现msg的发送。而且它已经支持同步味精和异步味精。 | ||
| > | ||
| >在演示中，Java类`LiteMessage`的`content`字段表示一个特殊的协议，因此，如果您要使用eventmesh-sdk-java的http-client，则只需设计协议的内容并提供消费者的应用程序在同一时间。 | ||
|
|
||
|
|
||
| ####同步消息 | ||
|
|
||
| >发送消息，生产者需要等到收到用户的响应消息 | ||
| ``` | ||
| 运行com.webank.eventmesh.client.http.demo.SyncRequestInstance的主要方法 | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| >发送消息，生产者在回调中处理响应消息 | ||
| ``` | ||
| 运行com.webank.eventmesh.client.http.demo.AsyncSyncRequestInstance的主要方法 | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ####异步消息 | ||
|
|
||
| ``` | ||
| 运行com.webank.eventmesh.client.http.demo.AsyncPublishInstance的主要方法 | ||
| ``` |
Oops, something went wrong.