init repository

.gitignore

@@ -0,0 +1,19 @@
+.git
+.gradle
+.settings
+logs
+.DS_Store
+.*.swp
+*.ipr
+*.iml
+*.iws
+*.class
+*.log
+.idea
+build
+.classpath
+.project
+test-output
+dist
+.pmd
+classes

README-EN.md

@@ -0,0 +1,66 @@
+## DeFiBus (Decentralized Financial Message Bus)
+      
+**DeFiBus=RPC+MQ, a reliable distributed financial message bus which is build base on open sourcing message mid-ware. DeFiBus offsers not only traditional feature of MQ system (event notification, multicast, broadcast etc.) but also synchronize call and high availability such as application multi active, service nearby, dark launch. The enhancement of fault tolerant enable DeFiBus running more reliable and offer a all days online service.**  
+
+
+## Architecture  
+<div align=center>
+
+![architecture1](./docs/images/features/a-distributing-architecture-in-financial-EN.png)
+
+</div>
+
+![architecture2](./docs/images/features/architecture-p1.png)
+
+DeFiBus including the following component:
+* **Broker**: Offering message store via the mechanism of topic and queue. Broker registers to Name server periodically. Brokers in the same cluster should register to the same name server to keep route info in all name server is consistent.
+
+* **NameServer**: NameServer maintains route info of topic and provide clients an interface to get route info of given topic.
+
+* **GSL**: GSL(Global Service Location) service provides service-level routing discovery. Services can be deployed in different areas (such as different data centers, logical partitions, etc.). When requesting a specific service, service requesters need not pay attention to the area of service username. GSL can automatically locate specific services according to service discovery rules and return service information to clients.
+
+* **SGS**: SGS(Service Governance System) is responsible for the overall service management, including new service applying, service username, service offline. In DeFiBus, every service correspond to exactly one Topic. The creation, update and deletion of Topic are managed by SGS. After creating Topic in Broker cluster, SGS updates global service routing data for GSL.
+
+* **Proxy**: Proxy provide HTTP access, allowing access to client of other language such C/C++, Go, Python etc accessing .
+
+
+## Definition of Service & Topic
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+Each service in DeFiBus correspond to exactly a Topic. Topic is named according to the unique ID of the service and the username area of the service. Each service needs a unique identity, which can be represented by a digital ID or string. Each username area is represented by a 3-bit string of limited numbers and letters.  
+
+Topic is named in the following format:
+```
+[区域代码]-[服务唯一ID]
+``` 
+For example, the service ID of the balance query service is 20190001, and it is deployed in the area of "A10". The Topic of such service in the area of A10 is named "A10-20190001". 
+
+## 特性列表:
+* [Request-Reply call：support sync invocation between systems](docs/cn/features/1-request-response-call.md)
+* Pub/Sub：message publish and subscrbe
+* [Dark launch：support dark launch at level of topic](docs/cn/features/2-dark-launch.md)
+* [Circuit break mechainsm: circuit break at level of client instance](docs/cn/features/3-circuit-break-mechanism.md)
+* [Service nearby：invoke service nearby, reducing invocation cross region](docs/cn/features/4-invoke-service-nearby.md)
+* [Multi active：multi active of application among multi region or idc](docs/cn/features/5-multi-active.md)
+* [Dynamic expand/shrink queue：expand/shrink queue number according to alive instance adaptive](docs/cn/features/6-dynamic-adjust-queue.md)
+* [Fault tolerant](docs/cn/features/8-fault-tolerant.md)
+* GSL(under planning for open sourcing)
+* Proxy(under planning open sourcing)
+* SGS(under planning open sourcing)
+* graceful upgrade(under planning open sourcing)
+
+## Quick Start
+We offser a instruction of quick start, read[ this ](docs/cn/quickstart.md) to get more information.   
+Examples are also provide in defibus-examples module, get more detail from [here](defibus-examples).
+
+## License
+Copyright (C) 2015-2019 Webank Group Holding Limited
+
+## Contacts
+WeChat & QQ group：
+
+![wechat_qr](./docs/images/wechat_helper.png)
+![qqgroup_qr](./docs/images/qqgroup-crcode.png)
+
+DingDing group: 23372793
+
+Email: [email protected]

README.md

@@ -1,2 +1,89 @@
-# DeFiBus
-Decentralized Financial Message Bus
+## DeFiBus(Decentralized Financial Message Bus) -- 分布式金融级消息总线
+      
+**DeFiBus=RPC+MQ，是基于开源消息中间件打造的安全可靠的分布式金融级消息总线。DeFibus不仅提供了RPC同步调用，还提供了MQ的异步事件通知、事件组播和广播等常用服务调用和消息模式，同时增加了应用多中心多活、服务就近、灰度发布等分布式场景下的高可用能力。在对于机器故障的容错能力方面的增强，也让消息总线的服务更加稳定可靠，为业务提供7x24的服务。**
+
+### 整体架构  
+<div align=center>
+
+![architecture1](./docs/images/features/a-distributing-architecture-in-financial.png)
+
+</div>
+
+![architecture2](./docs/images/features/architecture-p1.png)
+
+DeFiBus主要包括以下几个组件（模块）：  
+
+* **Broker**：通过轻量的Topic和Queue机制提供消息存储功能。Broker定期将Topic信息上报到NameServer中，同集群中的Broker实例上报的NameServer必须保持一致，避免路由信息不一致。  
+
+* **NameServer**：NameServer提供Topic的发现和路由，每一个NameServer接受Broker上报的Topic信息，并维护Topic的路由信息供客户端查询。  
+
+* **GSL**：全局服务定位（Global Service Location）服务提供服务级别的路由发现。服务可以部署在不同的区域（比如不同的数据中心、逻辑分区等），服务请求方在请求某一个具体服务时，无需关注服务部署的区域，GSL能够根据服务发现规则自动定位到具体的服务，将服务信息返回给客户端。  
+
+* **SGS**：服务治理系统（Service Government System）负责全局的服务管理，包括服务的申请、服务部署规划、服务下线等服务全生命周期的管理。在DeFiBus中，服务与Topic一一对应，Topic的名称由对应的服务按照一定的规则来命名。Topic的创建、更新和删除由SGS统一管理。SGS在服务的部署区域对应的Broker集群中创建Topic之后，将更新全局服务路由数据，供GSL定位服务使用。
+
+* **Proxy**：服务代理（Proxy）提供HTTP接入方式，同时允许按照协议规范开发的C、GO、Python等其他语言客户端的接入。
+
+### 服务和Topic的定义
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+DeFiBus把服务和Topic做了一一对应，每个服务必须对应一个Topic。Topic根据服务的唯一ID和服务的部署区域来命名。每个服务需要有服务的唯一标识，可以用数字ID或者字符串来表示。每个部署区域使用3位长度的字符串（限数字和字母构成）表示。  
+Topic按照如下格式来命名：
+```
+[区域代码]-[服务唯一ID]
+```
+
+比如，余额查询服务的服务ID为20190001表示，部署在“A10”这个区域，那么该服务在A10区域的Topic就命名为“A10-20190001”。
+
+### 特性列表:
+* [RPC调用：即“Request-Reply”模式，支持系统间的同步调用](docs/cn/features/1-request-response-call.md)
+* [消息发布/订阅：消息的发布和订阅](docs/cn/features/9-publish-type.md)
+* [灰度发布：服务级别的灰度发布](docs/cn/features/2-dark-launch.md)
+* [熔断机制：应用实例级别的熔断](docs/cn/features/3-circuit-break-mechanism.md)
+* [服务就近：就近进行服务的请求和响应，减少跨区调用](docs/cn/features/4-invoke-service-nearby.md)
+* [应用多活：应用多中心多活](docs/cn/features/5-multi-active.md)
+* [动态扩缩队列 ：自适应应用实例数量，动态调整队列个数](docs/cn/features/6-dynamic-adjust-queue.md)
+* [容错机制：故障和错误隔离](docs/cn/features/8-fault-tolerant.md)
+* 服务路由和定位：动态路由及定位(后续开源)
+* 服务代理：HTTP及多语言的代理(后续开源)
+* 服务治理：服务元数据的管理(后续开源)
+* 平滑升级：平滑升级、平滑扩容(后续开源)
+
+### 产品对比
+
+| 产品名称 | Kafka | RocketMQ | DeFiBus |
+| --- | --- | --- | --- |
+| 客户端SDK| Java，Scala etc. | Java，C++， Go | Java |
+| 定时消息 | 不支持 | 支持 | 支持 |
+| 批量消息 | 通过异步生产者支持 | 通过同步模式支持，避免消息丢失 | 同RocketMQ |
+| 广播消息 | 不支持 | 支持 | 支持 |
+| 消息过滤 | 支持，可以试用Kafka Streams来过滤消息 | 支持，使用基于SQL92的属性过滤表达式 | 同RocketMQ |
+| 服务器端触发重新发送 | 不支持 | 支持 | 支持 |
+| 消息存储 | 高性能的文件存储 | 高性能和低延迟的文件存储 | 同RocketMQ |
+| 消息追溯 | 支持通过消息偏移追溯 | 支持通过时间戳和消息偏移追溯 | 同RocketMQ |
+| 高可用性和故障切换 | 需要ZooKeeper服务器来支持 | 主从模式，不需要其他组件 | 应用多活，应用部署在多个数据中心；增加了隔离机制提高容错性 |
+| 配置复杂度 | 使用key-value键值对进行配置，可通过文件或者程序参数配置 | 开箱即用，用户只需关注少量配置参数 | 同RocketMQ |
+| 管理工具 | 可通过终端命令展示核心指标 | 可通过web界面或者终端命令展示核心指标 | 同RocketMQ |
+| 服务代理 | 支持 | 不支持 | 支持，提供HTTP接入方式 |
+| 灰度发布 | 不支持 | 不支持 | 支持服务级别的灰度发布 |
+| 服务就近 | 不支持 | 不支持 | 支持，减少跨区调用，降低网络时延 |
+| 熔断机制 | 不支持 | 不支持 | 支持应用实例级别的熔断 |
+| 动态扩缩队列 | 不支持 | 不支持 | 支持，队列数目自适应应用实例数量 |
+| Request-Reply同步调用 | 不支持 | 不支持（4.5版本） | 支持 |
+
+
+## Quick Start
+DeFiBus的安装部署流程请参考：[《DeFiBus使用指引》](docs/cn/quickstart.md)   
+examples模块中提供了最佳实践样例：[defibus-examples](defibus-examples)
+
+## License
+Copyright (C) 2015-2019 Webank Group Holding Limited
+
+## Contacts
+微信/QQ群：
+
+![wechat_qr](./docs/images/wechat_helper.png)
+
+![qqgroup_qr](./docs/images/qqgroup-crcode.png)
+
+钉钉群: 23372793
+
+邮箱: [email protected]