SOAR接口设计规范

SOAR接口设计规范v1.0

本文档适合于SOAR2009及以后版本。

一、名词描述：

a)接口设计：指将本业务需要给其他业务提供的服务方法和进行远程调用的方法提取

为接口的设计方式；

b)接口：指上述设计所涉及的类，包括接口类及接口方法中所使用的业务对象（如

VO）和业务异常。不包括接口类的具体实现类；

c)代码设计：指代码即为设计文档，要求其注释可生成JavaDoc文件；

d)设计阶段：分为总体设计、详细设计；

二、设计要求：

a)设计工具：采用Eclipse直接进行代码设计；

b)文档格式：JavaDoc文档，文档中包含接口中使用的接口类、业务对象和业务异常

的描述；

c)JavaDoc注释要求：

符合标准JavaDoc文档所要求的输写规范，具体写发详见JDK DOC帮助文件。对

具体对象要求如下：

i.接口类：

ii.业务对象类：

iii.业务异常类：

d)不同设计阶段要求：

i.总体设计：明确描述接口类名称和用途，接口方法名称和用途；

ii.详细设计：明确描述接口方法参数和返回值，明确描述方法使用的业务对象和异常，明确描述接口方法用例；

三、应用实例

a)接口类：com.hzfc.soar.test.ITestBService

b)业务对象类：com.hzfc.soar.test.BusinessVO

c)业务异常类：com.hzfc.soar.test.BusinessException

d)生成的JavaDoc文件