SpringCloud用户指南

编辑
更新时间: 2023-01-14

Spring-Cloud 用户指南

  • 步骤一: 引入依赖jar包

  • 步骤二：引入hmily配置

  • 步骤三：在具体的实现方法上（服务提供端），加上HmilyTCC or HmilyTAC 注解

  • 步骤四：在feignClient调用方法上（消费方），加上Hmily

1.引入依赖

Spring-Namespace

  • 引入依赖
        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>hmily-springcloud</artifactId>
            <version>{last.version}</version>
        </dependency>
  • 在xml中进行如下配置
    <!--配置扫码hmily框架的包-->
    <context:component-scan base-package="org.dromara.hmily.*"/>
    <!--设置开启aspectj-autoproxy-->
    <aop:aspectj-autoproxy expose-proxy="true"/>
    <!--配置Hmily启动的bean参数-->
    <bean id="hmilyApplicationContextAware" class="org.dromara.hmily.spring.HmilyApplicationContextAware"/>

Spring-Boot-Starter

  • 引入依赖
        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>hmily-spring-boot-starter-springcloud</artifactId>
            <version>{last.version}</version>
        </dependency>

2.新增hmily配置

3. 服务实现方添加注解

TCC模式

  • 只需要在参与hmily分布式事务调用的具体实现方法上加@HmilyTCC(confirmMethod = "confirm", cancelMethod = "cancel")

  • confirmMethod : 确认方法名称，该方法参数列表与返回类型应与标识方法一致。

  • cancelMethod : 回滚方法名称，该方法参数列表与返回类型应与标识方法一致。

  • TCC模式应该保证 confirm 和 cancel 方法的幂等性，用户需要自行去开发这个2个方法，所有的事务的确认与回滚，完全由用户决定。Hmily框架只是负责来进行调用


public class HelloServiceImpl implements HelloService  {

    @HmilyTCC(confirmMethod = "sayConfrim", cancelMethod = "sayCancel")
    public void say(String hello) {
         System.out.println("hello world");
    }
    
    public void sayConfrim(String hello) {
         System.out.println(" confirm hello world");
    }

    public void sayCancel(String hello) {
         System.out.println(" cancel hello world");
    }
}

TAC模式（在开发，未发布）

  • 只需要在参与分布式事务调用的具体实现方法上加@HmilyTAC

服务消费端（FeignClient）

  • 在服务被调用方的@FeignClient 接口方法上加上 @Hmily注解。
@FeignClient(value = "helle-service")
public interface HelloService {

    @Hmily
    @RequestMapping("/helle-service/sayHello")
    void say(String hello);
}

重要注意事项

在调用任何RPC调用之前，当你需要聚合rpc调用成为一次分布式事务的时候，需要在聚合RPC调用的方法上，先行添加 @HmilyTCC 或者 @HmilyTAC 注解,表示开启全局事务。

负载均衡

  • 如果服务部署了几个节点， 负载均衡算法最好使用 hmily自带, 这样 try, confirm, cancel 调用会落在同一个节点 充分利用了缓存，提搞了效率。在你的yaml配置如下：

hmily.ribbon.rule.enabled = true

开启hystrix

  • 如果用户配置了feign.hystrix.enabled = true, 默认使用线程池模式， 将会开启 HmilyHystrixConcurrencyStrategy 它在hystrix使用线程池模式的时候，能够照样通过threadLoacl 进行RPC传参数。

设置永不重试

  • 需要进行分布式事务的SpringCloud微服务的调用方需要设置不重试，如下是参考：
ribbon:
    MaxAutoRetriesNextServer : 0
    MaxAutoRetries: 0

异常

  • try, confirm, cancel 方法的所有异常不要自行catch 任何异常都应该抛出给 Hmily框架处理。