SDK开发工具包的添加方法和应用案例分享

1.在项目中加入SDK包

离线复制如图5-18所示的jar包到Java项目中。

图5-18　SDK开发工具包

复制完成后再将该hearken-das-sdk-1.0.0.jar包加入项目的引用，便完成了SDK包的添加，如图5-19所示。

图5-19　加入类路径

2.HKDAS应用的入口

（1）在启动类上加入@DasBootApplication注解。

（2）调用DasApplication类的run方法（静态方法）。

简单的应用开发案例如图5-20所示。

图5-20　应用案例

3.发布服务

1）REST服务

创建一个普通的Java类，在类上加注解@Bean，将该类加入HKDAS应用容器。再添加注解@Path，表示该类Rest接口的根路径。再为这个类写一个方法，在方法上可以添加@Path表示Rest服务的具体路径，@POST表示可以通过POST方法访问，@GET表示可以通过GET方法访问，@Produces表示返回参数的格式，@Consumes表示参数传递的格式。

简单的应用开发案例如图5-21所示。

图5-21　Rest服务开发案例

2）RPC服务

服务消费者和服务提供者之间的RPC服务，需通过统一的接口调用，因此在发布一个服务之前，应该确定一个Java接口。然后服务提供者需要实现这个接口，并将这个接口发布为一个服务。首先在接口实现类上添加@Bean注解，将该类加入HKDAS应用容器，再添加@Provider注解，该注解有一个参数，参数值为需要发布的接口类型的Class，应用开发案例如图5-22所示。

图5-22　RPC服务开发案例

4.订阅服务

在HKDAS应用的入口类中加入注解@Subscribe，该注解参数解释如图5-23所示。(www.xing528.com)

图5-23　订阅服务注解

通过该注解可以指定订阅服务的接口和版本号、服务调用的方式（同步和异步）、服务调用超时时间、服务调用容错的方式、服务调用时数据序列化的方式。

服务调用失败容错方式解释如图5-24所示。

图5-24　服务调用容错解释

订阅服务案例如图5-25所示。

图5-25　服务订阅案例

5.Rest服务文档生成

在Rest服务的方法和参数上面添加注解，系统启动时自动通过解析注解内容生成相关文档。相关注解解释如下：

@Describe：可添加在方法和参数上对一个Rest服务和参数进行描述。

@Summary：对服务的简单介绍。

@ResponseDesc：对服务的返回值进行描述。通过指定一个实体进行参数描述。

指定实体时需要加前缀“#/definitions/”，指定某个实体需要添加@ResponseEntity注解。

@ResponseEntity：标识一个实体为Rest服务返回类型。

开发案例如图5-26和图5-27所示。

图5-26　实体描述

图5-27　Rest服务文档生成案例

文档生成效果如图5-28所示。

图5-28　Rest服务文档生成效果