sofa-rpc用户指南

编辑
更新时间: 2021-11-17

sofa-rpc接口项目

  • 在你的接口项目中引入jar包。
      <dependency>
          <groupId>org.dromara</groupId>
          <artifactId>hmily-annotation</artifactId>
          <version>{last.version}</version>
      </dependency>
  • 在需要进行Hmily分布式事务的接口方法上加上 @Hmily 标识。

    public interface HelloService {
    
    @Hmily
    void say(String hello);
    }
    

    sofa-rpc实现项目

    • 步骤一 : 引入依赖hmily的jar包

    • 步骤二 : 新增Hmily配置

    • 步骤三 : 在实现方法上添加注解。TCC模式,则需要完成 confirmcancel方法的开发

    引入依赖

    Spring-Namespace
    • 引入依赖
        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>hmily-sofa-rpc</artifactId>
           <version>{last.version}</version>
        </dependency>
    
  • 在xml中进行如下配置

    <!--设置开启aspectj-autoproxy-->
    <aop:aspectj-autoproxy expose-proxy="true"/>
    <bean id = "hmilyTransactionAspect" class="org.dromara.hmily.spring.aop.SpringHmilyTransactionAspect"/>
    <bean id = "hmilyApplicationContextAware" class="org.dromara.hmily.spring.HmilyApplicationContextAware"/>

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

引入 hmily配置

实现接口上添加注解

上述我们已经完成了集成,下面将讲述具体的实现。

TCC模式
  • @Hmily 标识的接口方法的具体实现上,加上@HmilyTCC(confirmMethod = "confirm", cancelMethod = "cancel")

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

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

  • TCC模式应该保证 confirmcancel 方法的幂等性,用户需要自行去开发这个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模式(在开发,未发布)

  • @Hmily 标识的接口方法的具体实现上加上@HmilyTAC

重要注意事项

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

负载均衡 && 设置永不重试

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

  • 支持一下几种 hmilyConsistentHash, hmilyRandom, hmilyLocalPref, hmilyRoundRobin, hmilyWeightRoundRobin, hmilyWeightConsistentHash 几种方式均是继承sofa-rpc原生的

      <sofa:reference jvm-first="false" id="accountService" interface="org.dromara.hmily.demo.common.account.api.AccountService">
           <sofa:binding.bolt>
               <sofa:global-attrs retries="0" timeout="5000" loadBalancer ="hmilyRandom"/>
           </sofa:binding.bolt>
       </sofa:reference>       

异常

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