Tars User Guide

• Step 1: Introduce the jar packages

• Step 2: Introduce the Hmily configuration

• Step 3: Add @Hmily annotation on the auto-generated Servant interface method which required the Hmily Distributed Transaction.

• Step 4: Add @HmilyTCC or @HmilyTAC annotation on the concrete implementation method(Service provider).

Introduce The Maven dependency

Spring-Namespace

• Introduce the hmily-tars dependency
  

        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>hmily-tars</artifactId>
            <version>{last.version}</version>
        </dependency>

• make the configuration in the XML configuration file as below:

  <!--Configure the base packages that the Hmily framework need to scan -->
  <context:component-scan base-package="org.dromara.hmily.*"/>
  <!-- set up to enable the aspectj-autoproxy -->
  <aop:aspectj-autoproxy expose-proxy="true"/>
  <!-- Configure the bean parameters for Hmily startup -->
  <bean id="hmilyApplicationContextAware" class="org.dromara.hmily.spring.HmilyApplicationContextAware"/>
  <bean id="hmilyCommunicatorBeanPostProcessor" class="org.dromara.hmily.tars.spring.TarsHmilyCommunicatorBeanPostProcessor"/>
  <bean id="tarsHmilyStartupBean" class="org.dromara.hmily.tars.spring.TarsHmilyFilterStartupBean"/>
  

  Spring-Boot

  • Introduce the hmily-spring-boot-starter-tars dependency
    xml <dependency> <groupId>org.dromara</groupId> <artifactId>hmily-spring-boot-starter-tars</artifactId> <version>{last.version}</version> </dependency>

Introduce the Hmily configuration

• new a configuration file named hmily.yml under the resource directory of the current project

• the specific parameter configuration can refer to configuration detail,Local configuration mode, Zookeeper configuration mode, nacos configuration mode,apollo configuration mode

Add annotations on the service implementation interface

We have completed the integration described above,and the next we will talk about the specific implementation.

TCC Mode

• Add @HmilyTCC (confirmMethod = "confirm", cancelMethod = "cancel") annotation to the concrete implementation of the interface method identified by ‘@Hmily’.

• confirmMethod : the method name for confirm，The method parameter list and return type should be consistent with the identification method.

• cancelMethod : the method for cancel，The method parameter list and return type should be consistent with the identification method.

• The TCC mode should ensure the idempotence of the confirm and cancel methods,Users need to develop these two methods by themselves,The confirmation and rollback behavior of all transactions are completely up tp users.The Hmily framework is just responsible for making calls.

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");
    }
}

Important Notes

Exception

• Do not catch any exceptions of the try, confirm, cancel method by yourself. Any exceptions should be thrown to the Hmily framework to handle.