851      微信

HSF 特性使用__服务开发_开发者指南_企业级分布式应用服务 EDAS-阿里云

本文介绍 HSF 一些特性的使用方法及注意事项。

所有特性的实例 Demo 请在这里下载：Demo 下载

前提条件

使用 HSF 相关特性，请在 POM 文件中加入以下 edas-sdk 依赖。

<dependency>
    <groupId>com.alibaba.edas</groupId>
    <artifactId>edas-sdk</artifactId>
    <version>1.5.1</version>
</dependency>

隐式传参（目前仅支持字符串传输）

隐式传参一般用于传递一些简单 KV 数据，又不想通过接口方式传递，类似于 Cookie。

• 单个参数传递

  服务消费者：

  RpcContext.getContext().setAttachment("key", "args test");

  服务提供者：

  String keyVal=RpcContext.getContext().getAttachment("key");

• 多个参数传递

  服务消费者：

  Map<String,String> map=new HashMap<String,String>();
  map.put("param1", "param1 test");
  map.put("param2", "param2 test");
  map.put("param3", "param3 test");
  map.put("param4", "param4 test");
  map.put("param5", "param5 test");
  RpcContext rpcContext = RpcContext.getContext();
  rpcContext.setAttachments(map);

  服务提供者：

  Map<String,String> map=rpcContext.getAttachments();
  Set<String> set=map.keySet();
  for (String key : set) {
    System.out.println("map value:"+map.get(key));
  }

异步调用

支持异步调用 callback 和 future 两种方式。

• callback 调用方式

  客户端配置为 callback 方式调用时，需要配置一个实现了 HSFResponseCallback 接口的 listener ，结果返回之后， HSF 会调用 HSFResponseCallback 中的方法。

  注意：这个 HSFResponseCallback 接口的 listener 不能是内部类，否则 Pandora 的 classloader 在加载时就会报错。

  XML 中的配置：

  <hsf:consumer id="demoApi" interface="com.alibaba.demo.api.DemoApi"
        version="1.1.2"  group="test" >
        <hsf:asyncallMethods>
            <hsf:method name="ayncTest" type="callback" 
             listener="com.alibaba.ifree.hsf.consumer.AsynABTestCallbackHandler" />
        </hsf:asyncallMethods>
    </hsf:consumer>

  其中 AsynABTestCallbackHandler 类，是实现了 HSFResponseCallback 接口。DemoApi 接口中有一个方法是 ayncTest 。

  代码示例

  public void onAppResponse(Object appResponse) {
    //这里获取到异步调用后的值
   String msg = (String)appResponse;
   System.out.println("msg:"+msg);
  }

  注意：

  • 由于只用方法名字来标识方法，所以并不区分重载的方法。同名的方法都会被设置为同样的调用方式。
  • 不支持在 call 里再发起 HSF 调用。这种做法可能导致 IO 线程挂起，无法恢复。

• future 调用方式

  客户端配置为 future 方式调用时，发起调用之后，通过 HSFResponseFuture 中的 public static Object getResponse(long timeout) 来获取返回结果。

  XML 中的配置：

  <hsf:consumer id="demoApi" interface="com.alibaba.demo.api.DemoApi" version="1.1.2"  group="test" >
    <hsf:asyncallMethods>
           <hsf:method name="ayncTest" type="future"  />
    </hsf:asyncallMethods>
  </hsf:consumer>

  代码示例如下。

  • 单个业务异步处理：

    //发起调用
    demoApi.ayncTest();
    // 处理业务
    ...
    //直接获得消息（若无需获得结果，可以不用操作该步骤）
    String msg=(String) HSFResponseFuture.getResponse(3000);

  • 多个业务需要并发处理：

    若是多个业务需要并发处理，可以先获取 future，进行存储起来，等调用完毕后在使用。

    //定义集合
    List<HSFFuture> futures = new ArrayList<HSFFuture>();

  • 方法内进行并行调用：

    //发起调用
    demoApi.ayncTest();
    //第一步获取future对象
    HSFFuture future=HSFResponseFuture.getFuture();
    futures.add(future);
    //继续调用其他业务(同样采取异步调用)
    HSFFuture future=HSFResponseFuture.getFuture();
    futures.add(future);
    // 处理业务
    ...
    //获得数据并做处理
    for (HSFFuture hsfFuture : futures) {
       String msg=(String) hsfFuture.getResponse(3000);
       //处理相应数据
       ...
    }

泛化调用

通过泛化调用可以组合接口、方法、参数进行RPC调用,无需依赖任何业务API。

<hsf:consumer id="demoApi" interface="com.alibaba.demo.api.DemoApi"  group="unittest" generic="true"/>

public String dealMsg(String msg);
public GenericTestDO dealGenericTestDO(GenericTestDO testDO);

    Object $invoke(String methodName, String[] parameterTypes, Object[] args) throws GenericException;

svc.$invoke("dealMsg", new String[] { "java.lang.String" }, new Object[] { "hello" })

// 第一步构造实体对象GenericTestDO，该实体有id、name两个属性
GenericTestDO genericTestDO = new GenericTestDO();
genericTestDO.setId(1980l);
genericTestDO.setName("genericTestDO-tst");
// 使用 PojoUtils 生成二方包pojo的描述
Object comp = PojoUtils.generalize(genericTestDO);
// 服务泛化调用
svc.$invoke("dealGenericTestDO",new String[] { "com.alibaba.demo.generic.domain.GenericTestDO" }, new Object[] { comp });