chengsecret / hmily-admin

Hmily-admin

Hmily-admin是柔性分布式事务中间件hmily的配套展示平台，请搭配hmily 使用。 若您想更多个性化的需求，请下载hmily-dashboard 自行修改。

hmily-admin启动教程

启动前提： 分布式事务项目hmily已经部署并且运行起来，用户根据自己的RPC框架进行使用。

hmily-admin分为两个模块：hmily-admin-service、hmily-admin-dist。

• hmily-admin-service：项目的主体服务，包含项目的所有功能，可单独启动。同时包含release部署方案，详细部署方法见：快速部署体验
• hmily-admin-dist：打包模块，用于docker部署。详细部署方法见：快速部署体验

以下启动教程只涉及hmily-admin-service模块。

步骤零：准备工作

• 首先用户使用的JDK必须是1.8+ ，本地安装了git、maven ，执行以下命令：

  git clone https://github.com/dromara/hmily-admin.git
  

• 使用你的开发工具打开项目，比如idea、Eclipse

步骤一：更改配置

• 在hmily-admin-service模块的application.yml文件中，修改您的服务端口、日志存储（数据库）类型、账户信息等配置:

     #admin项目的tomcat端口
     server:
         port: 8888
         servlet:
           context-path:     # 项目访问的url前缀，可不配置
  
     #profiles.active 在hmily中指定的日志存储源类型
      spring:
         application:
           name: hmily-admin
         profiles:
           active: mysql
    
     #登录admin项目的账户密码
      hmily:
        admin :
          userName : admin
          password : admin

• 根据在上述application.yml中配置的spring.profiles.active类型，更改对应的application-mongo.yml或application-mysql.yml文件。

• 当前版本的admin仅支持mysql和mongo等两种存储方式。 application-mongo.yml参考如下：

  hmily:
     admin :
        retryMax : 10
        repository : mongo
        hmilyMongoConfig :
              mongoDbUrl  : 127.0.0.1:27017
              mongoDbName  :  hmily
              mongoUserName  : root
              mongoUserPwd   : 1
  

application-mysql.yml 参考如下：

hmily:
   admin :
      retryMax : 10
      repository : mysql
      hmilyDbConfig :
            driverClassName:  com.mysql.jdbc.Driver
            url: jdbc:mysql://localhost:3306/hmily?useUnicode=true&characterEncoding=utf8
            username: root
            password: 1

步骤二：运行 AdminApplication 中的main方法。

步骤三：访问Hmily-admin

• 在浏览器访问 http://ip:port ，输入用户名，密码登录。

步骤四：Hmily-admin功能解读

• 根据不同的查询条件对全局事务进行检索 应用名：一般为微服务的应用名称，需要保证唯一性。 模式类型下拉框：当前版本仅支持TCC。 全局事务状态： 包括运行中、成功、失败。 时间范围：可以根据事务的开始和结束时间进行搜索。

• 查看全局事务信息 一个分布式事务理解成一个包含来若干分支事务的全局事务， 全局事务的职责是协调其下管辖的分支事务达成一致， 要么一起成功提交，要么一起失败回滚。此外，通常分 支事务本身就是一个关系数据库的本地事务。

• 查看分支事务信息 分支事务作为每一个系统中事务的实际参与者，会记录很多详细的信息。 在这里，我们提供了分支事务的 应用名、全局事务ID、分支事务ID、参与者角色、模式类型、分支事务状态、重试次数、版本、事务接口、事务方法、confirm方法、cancel方法、创建时间、最后执行时间 等信息。

• 编辑重试次数（手动补偿） 点击“重试”：事务用户可以在引入配置文件中设置事务的最大重试次数，如果事务异常，达到最大重试次数后， 用户还想继续让事务进行一定次数的重试操作，就可以点击此“重试”按钮，进行重试次数的设置（但是不能超过最大重试次数）。 注意，这里设置的重试次数是已经执行的重试次数，即还会执行 （最大重试次）- （编辑设置） 次重试. 此方式主要用于您的系统突然发生崩溃后，重启项目来达成事务的一致性。

• 获取补偿信息 如果导致分支事务异常的原因是自身应用业务问题，就不能通过重试解决了。这时，我们可以通过查看补偿信息来进行手动补。 注意，这里提供的补偿信息，是序列化后转化成的16进制string字符串，需要您复制到自己的应用里，利用hmily携带的反序列化方法进行反序列化解析。 得到一份较为清晰的说明后，按照说明信息进行手动补偿 。请在补偿完成后，手动删除该条分支事务信息。

• 删除分支事务 如果分支事务异常的原因由于环境问题导致的，并且问题已经解决，自动或者手动配置重试次数， 分支事务可以正常，如果导致分支事务异常的原因是自身应用业务问题，就不能通过重试解决了。 若用户手动处理的分支事务由于分布式事务平台内部并不感知事务的状态，所以需要用户手动点击对应分支事务的“删除”按钮进行清理， 也可以批量进行删除，此删除操作需谨慎操作，以免由于误操作导致无法找到对应分支事务数据。

快速部署体验

hmily-admin含有两种部署方式：release方式、docker方式，详细见：快速部署体验

如有任何问题欢迎加入QQ群：162614487 进行讨论