调整文档格式

Author: gyl-coder

docs/phoenix-2.x/phoenix-admin/function.md

@@ -40,57 +40,35 @@ phoniex-admin是配合phoenix框架使用的服务监控平台，能够实现对
 - 打快照
 - 删除快照
 - 聚合根内存查询
-
 ## grafana监控
-
 ### 概述
 
 grafana是一款美观、强大的可视化监控指标展示工具，phoenix借住了grafana+elasticsearch来实现监控功能。
-
 phoenix服务在消息内部埋有诸多监控指标，通过phoenix自带的phoenix-persist，将这些消息写入到elasticsearch中，通过配置elasticsearch作为数据源，并进行相关配置，我们可以就在grafana中看到我们关心的各种指标。
 
 ### 默认面板
 
 phoenix-admin为每个项目内置了一个通用的监控面板，提供基本的监控功能，详情如下：
 
 1. 总览
-
 ![image-20200115192350535](../../assets/phoenix2.x/phoenix-admin/image-20200115192350535.png)
-
 2. 筛选栏
-
 可选定系统中，不同的服务集群，和服务集群下面不同的节点的数据
-
 ![image-20200115111102393](../../assets/phoenix2.x/phoenix-admin/image-20200115111102393.png)
-
 3. 消息个数统计面板
-
 统计系统内各个消息的个数
-
 ![image-20200115111030625](../../assets/phoenix2.x/phoenix-admin/image-20200115111030625.png)
-
 4. 指标个数统计面板
-
 统计系统内具体埋点的数量
-
 ![image-20200115110949004](../../assets/phoenix2.x/phoenix-admin/image-20200115110949004.png)
-
 5. 耗时统计面板
-
 统计系统内各种耗时
-
 ![image-20200115111135147](../../assets/phoenix2.x/phoenix-admin/image-20200115111135147.png)
-
 6. 速率统计面板
-
 统计系统内各种速率
-
 ![image-20200115111155570](../../assets/phoenix2.x/phoenix-admin/image-20200115111155570.png)
-
 7. 数据总览面板
-
 展示数据的详细信息
-
 ![image-20200115111217069](../../assets/phoenix2.x/phoenix-admin/image-20200115111217069.png)
 
 ### 自定义面板 

docs/phoenix-2.x/phoenix-lite/api.md

@@ -38,7 +38,6 @@ public enum RetCode {
 }
 ```
 
-
 **Client端 rpc 调用返回值** `RpcResult`
 
 ```java
@@ -72,8 +71,6 @@ public enum RpcResultCode {
 
 }
 ```
-
-
 ## 客户端 API
 
 ```
@@ -102,11 +99,8 @@ public enum RpcResultCode {
 | requestId | string | 必填     |  请求ID  （预留字段） |
 | timeoutMs   | long   | 必填     | 超时时间            |
 
-
 ## 服务端 API
-
 ### 注解
-
 #### @EntityAggregateAnnotation
 
 这个注释是为了找到聚合根类，为spring ioc注入存储库。 使用 `aggregateRootType` 标识该聚合根的类型
@@ -132,7 +126,6 @@ public class BankAccountAggregate implements Serializable {
 
 该注解一般用于 `act` 方法，aggregateId用于标识事件中的属性，该属性将提供查找Saga实例的值。通常，此值是特定saga监视的聚合的聚合标识符。  
 
-
 ```java
 @AggregateIdAnnotation(aggregateId = "accountCode")
 public ActReturn act(MockCmd cmd) {

docs/phoenix-2.x/phoenix-lite/concept.md

@@ -8,101 +8,82 @@ title: 基本概念
 ### 消息 msg
 
 定义：
-
 - phoenix 中，消息用于服务跟服务之间的通讯
-
 相关概念：
-
 * 消息的ID，全局唯一
 
 ### 命令 cmd
 
 定义：
-
 - 请求，未发生
-
 相关概念：
-
 - 命令Id cmdId
 
 ### 事件 event
 
 定义：
-
 - 事实，已发生
 
-
 ## 聚合根相关
 
 ### 聚合根类别  aggregateRootType
 
 定义：
-
 * phoenix中，每个聚合根类会有一个聚合根类别，用于区分不同的聚合根类，全局唯一
 * 长度不超过32字节
 
 ### 聚合根ID  aggregateRootId 
 
 定义：
-
 * 聚合根类的唯一标识，在同一个聚合根类别下唯一
 * 长度不超过64字节
 
-
 ## EventSourcing相关
 
 ### 事件存储 EeventStore ES
 
 定义：
-
 - 存储领域事件
 
 ### 事件回溯 EventSourcing ES
 
 定义：
-
 - 通过领域事件重建聚合
 
 ### 快照 Snapshot
 
 定义：
-
 - 快照用于加速事件回溯速度
 
 ## 服务相关
 
 ### 服务名 applicationName
 
 定义：
-
 - phoenix是一套微服务框架，applicationName为每个服务的名字，全局唯一
 
 ## mq相关
 
 ### 订阅主题  subscribeTopic
 
 定义：
-
 - 服务采用MQ对外通讯时， 订阅主题为服务用于接收消息的topic名字
 
 ## 路由相关
 
 ### 服务地址 
 
 定义：
-
 - 服务采用mq通讯对外通讯时，采用服务接收的topic名字
 
 ### 消息目的地址 dst
 
 定义：
-
 - 用于路由消息到聚合根对象       格式： 服务地址/聚合类别/聚合根类别
 
 ### 消息来源地址 src
 
 定义：
-
 - 用于标识一个消息的来源，用于在需要回复的场景中进行消息回复。
   格式：服务地址/聚合类别/聚合根类别
 
@@ -112,7 +93,6 @@ title: 基本概念
 ### 事务ID transId
 
 定义：
-
 - 事务 Id
 
 ### 子事务Id subTransId
@@ -122,13 +102,11 @@ title: 基本概念
 ### 子事务类型 subTransactionType
 
 定义：
-
 - 分类有：SAGA， TCC
 
 ### 子事务动作类型 subTransactionActionType  
 
 定义：
-
 * subTransactionType为SAGA时，值有：T， C
 * subTransactionType为TCC时， 值有：Try, Confirm, Cancel
 

docs/phoenix-2.x/phoenix-lite/config.md

@@ -15,11 +15,9 @@ title: 配置
 | quantex.phoenix.akka.service-name             | 服务名                                                     | String  | 服务名 | 
 | quantex.phoenix.akka.discovery-method         | 集群发现的方式                                             | String  | config | 
 | quantex.phoenix.akka.cinnamon-application     |                                                            | String  | 服务名 | 
-|      |       |       |        | 
 | 路由表（routers）配置                         |                                                            |         |        | 
 | quantex.phoenix.routers.message               | msgName                                                    | String  | 无     | 
 | quantex.phoenix.routers.dst                   | 目标地址   地址定义： 服务名/聚合类别/聚合根类别           | String  | 无     | 
-|      |       |       |        | 
 | ServerWorker配置                              |                                                            |         |        | 
 | quantex.phoenix.server.name                   | Server端服务名                                             | String  | 无     | 
 | quantex.phoenix.server.mq.type                | MQ 类型                                                    | String  | kafka     | 
@@ -41,7 +39,6 @@ title: 配置
 | quantex.phoenix.performance.retry-by-nofinished | AtLeastOneDeliveryAggregate 根据未完成事务个数判断是否继续重试 | Int | 10000|
 | quantex.phoenix.performance.batch-retry       | AtLeastOneDeliveryAggregate 批量持久化                           | Int | 1000 |
 | quantex.phoenix.performance.batch-persist     | event-store 批量持久化 批次大小                                  | Int | 200  |
-|      |       |       |        | 
 | client相关配置                                |                                                            |         |        | 
 | quantex.phoenix.client.name                   | Client 端服务名                                            | String  | 无     | 
 | quantex.phoenix.client.mq.type                | MQ 类型                                                    | String  | kafka     | 
@@ -52,7 +49,6 @@ title: 配置
 | quantex.phoenix.client.jaas-conf-path         | jaas配置文件路径                                           | String  | 无     | 
 | quantex.phoenix.client.krb5-conf-path         | krb5配置文件路径                                           | String  | 无     | 
 | quantex.phoenix.client.krb-service-name       | krb服务名                                                  | String  | 无     | 
-|      |       |       |        | 
 
 
 

docs/phoenix-2.x/phoenix-lite/feature.md

@@ -26,12 +26,9 @@ eventstore保证消息有序不丢，在服务宕机恢复是可通过从eventst
 ## 消息幂等
 
 phoenix 通过重发机制来保证消息的可靠性投递，需要设计消息幂等机制来保证同一个消息不会被多次处理。
-
 phoenix 通过两种方式来实现消息幂等
-
  - 在内存中维护一个固定大小的幂等队列
  - 通过 eventstore 的主键和唯一键索引冲突，来防止将同一消息持久化多次
-
 phoenix 维护了一个1000大小的幂等集合，来存储最新处理的1000个消息的msgId，通过该集合来保证消息的幂等。由于某些不可预测的原因，可能该幂等集合幂等失败，这个时候我们可以通过eventstore表的主键和唯一键索引来保证幂等。（消息产生之后在处理之前需要先执行eventstore操作将消息持久化下来。）
 
 

docs/phoenix-2.x/phoenix-lite/http-api.md

@@ -58,9 +58,6 @@ title: HTTP API
     }
 }
 ```
----
-
-
 
 ## 快照版本列表查询
 
@@ -141,10 +138,6 @@ title: HTTP API
 }
 ```
 
----
-
-
-
 ## 删除快照
 
 ```
@@ -180,10 +173,6 @@ title: HTTP API
 }
 ```
 
-------
-
-
-
 ## 查看内存数据
 
 ```
@@ -231,10 +220,6 @@ title: HTTP API
  }
 ```
 
-------
-
-
-
 ## 查看实例信息
 
 ```
@@ -265,6 +250,3 @@ title: HTTP API
     }
 }
 ```
-
-------
-

docs/phoenix-2.x/phoenix-test/features-test-2x.md

@@ -6,9 +6,7 @@ title: 功能性测试
  ## 前言
 
  Phoenix是宽拓自主研发的一款消息驱动型的高性能Java开发框架，专注于降低金融行业中业务复杂性高、性能要求高的应用系统的开发难度，助力研发团队打造专业、高效的微服务化的金融应用系统。
-
  本篇测试报告主要验证了 Phoenix 提供的如下功能：
-
   - 基于 Phoenix-lite 账户划拨功能正常
   - grafana 使用正常
   - EventSourcing 使用正常
@@ -23,7 +21,6 @@ title: 功能性测试
 ### 原理介绍
 
 phoenix-lite 提供了随机划拨和定向划拨两个功能：
-
  1. 定向划拨：指定账户进行转入转出操作（每个账户默认初始有1000元，划拨金额大于0为转入操作，划拨金额小于0为转出操作）
  2. 随机划拨：指定账户范围和转账次数，多个账户同时进行划拨操作。
 
@@ -66,7 +63,6 @@ phoenix-lite 提供了随机划拨和定向划拨两个功能：
 ### 概述
 
 Phoenix 提供了一套默认的 Grafana 监控面板，用于监控 Phoenix 应用的运行情况。监控指标包括如下内容：
-
  - 消息个数统计
  - 指标个数统计
  - 耗时统计
@@ -87,9 +83,7 @@ Phoenix 提供了一套默认的 Grafana 监控面板，用于监控 Phoenix 应
 #### 校验方法
 
 观察 Grafana 中展示出来的各个指标是否符合预期
-
 Grafana的入口在 Phoenix-admin 中，关于 Phoenix-admin 的使用请参考：[Phoenix-admin 使用说明](../phoenix-admin/admin-instructions-2x)
-
 关于 Grafana 各个监控指标的说明请参考：[Grafana 监控指标说明](../phoenix-admin/grafana-2x)
 
 ### 测试步骤
@@ -163,7 +157,6 @@ Phoenix 应用可以通过EventSourcing功能进行内存数据恢复，使用Sn
 ### 原理介绍
 
 Snapshot是对某一瞬间Phoenix应用内存的一次存储。Phoenix 提供的快照功能提供了如下操作：
-
  1. 每处理1000笔消息自动打一次快照
  2. 手动触发打快照
  3. 查询快照列表
@@ -220,7 +213,6 @@ Phoenix提供了一套分布式事务的解决方案，引入 phoenix-transactio
 ### 原理介绍
 
 phoenix-lite 提供了随机转账和定向转账两个功能：
-
  1. 定向转账：指定转出账户和转入账户，以及转账金额
  2. 随机转账：指定账户范围和转账次数，多个账户两两之间随机进行转账操作。