关于java 封装某个功能为api形式供其他用户调用的问题

Question

我现在的问题是我需要将某项业务，通过封装为get请求，供其他用户来调用，这样就有一个问题，我应该如何设计这个请求的返回结果的格式？因为有多种类型的返回结果，所以将每种返回结果存放到不同的字段，我现在想到的是给一个flag字段，但是需要调用者根据flag来判断展示结果中的哪个字段，不知道有没有什么更加优雅的实现方式。

Answer 1

一般来说可以定义一个如下的返回格式。resultCode定义了多种返回类型，比如除了resultCode为0其他均为错，且errorMsg有具体说明，正常业务的返回对象由result描述，在里面我们可以定义正常逻辑的多种返回类型，比如可以用resultType表示不同的类型，多个字段分别包装不同类型结果，如果差别不大，不一定需要多个字段，一个字段即可（里面的字段内容可以为null）。

{

    String resultCode;

    String errorMsg;

    Object result;

}

result描述:

{

    String resultType;

    ResultForm resultForm;

}

Answer 2

如果是http，可以利用header传递请求要的格式，然后接口判断对应返回响应的格式。非http的也类似，调用方给出要的格式或字段，服务方根据标识相应给出不同的结果即可。

Answer 3

{

    String code;

    String msg;

    Object result;

}