完善字段解释

Author: xlorne

tx-manager/src/main/resources/application.properties

@@ -1,9 +1,19 @@
+
+#######################################txmanager-start#################################################
 #服务端口
 server.port=8899
+
 #tx-manager不得修改
 spring.application.name=tx-manager
+
 spring.mvc.static-path-pattern=/**
 spring.resources.static-locations=classpath:/static/
+#######################################txmanager-end#################################################
+
+
+
+#######################################redis-start#################################################
+#redis 配置文件，根据情况选择集群或者单机模式
 
 ##redis 集群环境配置
 ##redis cluster
@@ -23,22 +33,31 @@ spring.redis.pool.maxWait=-1
 spring.redis.pool.maxIdle=5
 spring.redis.pool.minIdle=0
 spring.redis.timeout=0
+#####################################redis-end###################################################
+
 
 
+
+#######################################LCN-start#################################################
 #业务模块与TxManager之间通讯的最大等待时间（单位：秒）
-tm.transaction.netty.delaytime = 3
+#通讯时间是指：发起方与响应方之间完成一次的通讯时间。
+#该字段代表的是Tx-Client模块与TxManager模块之间的最大通讯时间，超过该时间未响应本次请求失败。
+tm.transaction.netty.delaytime = 5
+
 #业务模块与TxManager之间通讯的心跳时间（单位：秒）
 tm.transaction.netty.hearttime = 15
 
 #存储到redis下的数据最大保存时间（单位：秒）
+#该字段仅代表的事务模块数据的最大保存时间，补偿数据会永久保存。
 tm.redis.savemaxtime=30
 
 #socket server Socket对外服务端口
+#TxManager的LCN协议的端口
 tm.socket.port=9999
-# 最大socket连接数
-tm.socket.maxconnection=100
-
 
+#最大socket连接数
+#TxManager最大允许的建立连接数量
+tm.socket.maxconnection=100
 
 #事务自动补偿 (true:开启，false:关闭)
 # 说明：
@@ -48,20 +67,25 @@ tm.socket.maxconnection=100
 tm.compensate.auto=false
 
 #事务补偿记录回调地址(rest api 地址，post json格式)
-#json格式如下:
-#该请求是在通知补偿事务时的补偿记录数据请求
+#请求补偿是在开启自动补偿时才会请求的地址。请求分为两种：1.补偿决策，2.补偿结果通知，可通过通过action参数区分compensate为补偿请求、notify为补偿通知。
+#*注意当请求补偿决策时，需要补偿服务返回"SUCCESS"字符串以后才可以执行自动补偿。
+#请求补偿结果通知则只需要接受通知即可。
+#请求补偿的样例数据格式:
 #{"groupId":"TtQxTwJP","action":"compensate","json":"{\"address\":\"133.133.5.100:8081\",\"className\":\"com.example.demo.service.impl.DemoServiceImpl\",\"currentTime\":1511356150413,\"data\":\"C5IBLWNvbS5leGFtcGxlLmRlbW8uc2VydmljZS5pbXBsLkRlbW9TZXJ2aWNlSW1wbAwSBHNhdmUbehBqYXZhLmxhbmcuT2JqZWN0GAAQARwjeg9qYXZhLmxhbmcuQ2xhc3MYABABJCo/cHVibGljIGludCBjb20uZXhhbXBsZS5kZW1vLnNlcnZpY2UuaW1wbC5EZW1vU2VydmljZUltcGwuc2F2ZSgp\",\"groupId\":\"TtQxTwJP\",\"methodStr\":\"public int com.example.demo.service.impl.DemoServiceImpl.save()\",\"model\":\"demo1\",\"state\":0,\"time\":36,\"txGroup\":{\"groupId\":\"TtQxTwJP\",\"hasOver\":1,\"isCommit\":0,\"list\":[{\"address\":\"133.133.5.100:8899\",\"isCommit\":0,\"isGroup\":0,\"kid\":\"wnlEJoSl\",\"methodStr\":\"public int com.example.demo.service.impl.DemoServiceImpl.save()\",\"model\":\"demo2\",\"modelIpAddress\":\"133.133.5.100:8082\",\"modelName\":\"/133.133.5.100:64153\",\"notify\":1,\"uniqueKey\":\"bc13881a5d2ab2ace89ae5d34d608447\"}],\"nowTime\":0,\"startTime\":1511356150379,\"state\":1},\"uniqueKey\":\"be6eea31e382f1f0878d07cef319e4d7\"}"}
-#该请求是在执行完补偿事务以后的反馈结果请求
+#请求补偿的返回数据样例数据格式:
+#SUCCESS
+#请求补偿结果通知的样例数据格式:
 #{"resState":true,"groupId":"TtQxTwJP","action":"notify"}
-
 tm.compensate.notifyUrl=http://ip:port/path
 
-#补偿失败，再次尝试间隔（秒），最大尝试次数3次，当超过3次即为补偿失败。
+#补偿失败，再次尝试间隔（秒），最大尝试次数3次，当超过3次即为补偿失败,失败的数据依旧还会存在TxManager下。
 tm.compensate.tryTime=30
 
-#各事务模块自动补偿的时间上限
+#各事务模块自动补偿的时间上限(秒)
+#指的是模块执行自动超时的最大时间，该最大时间若过段会导致事务机制异常，该时间必须要模块之间通讯的最大超过时间。
+#例如，若模块A与模块B，请求超时的最大时间是5秒，则建议改时间至少大于5秒。
 tm.auto.compensate.limit=20
-
+#######################################LCN-end#################################################