我们有两个独立的产品需要通过Web服务相互通信。 支持API版本化的最佳实践是什么?

我有 this article 从2004年开始,声称没有实际标准,只有最佳实践。有更好的解决方案吗?如何解决WS版本控制?

问题描述

系统A

顾客

class SystemAClient{
    SystemBServiceStub systemB;
    public void consumeFromB(){
        SystemBObject bObject = systemB.getSomethingFromB(new SomethingFromBRequest("someKey"));

    }
}

服务

class SystemAService{
    public SystemAObject getSomethingFromA(SomethingFromARequest req){
        return new SystemAObjectFactory.getObject(req);
    }
}

可转让物

版本1

class SystemAObject{
     Integer id;
     String name;
     ... // getters and setters etc;
}

版本2

class SystemAObject{
     Long id;
     String name;
     String description;
     ... // getters and setters etc;
}

请求对象

版本1

class SomethingFromARequest {
     Integer requestedId;
     ... // getters and setters etc;

}

版本2

class SomethingFromARequest {
     Long requestedId;
     ... // getters and setters etc;

}

系统B

顾客

class SystemBClient{
    SystemAServiceStub systemA;
    public void consumeFromA(){
        SystemAObject aObject = systemA.getSomethingFromA(new SomethingFromARequest(1));
        aObject.getDescription() // fail point
        // do something with it...
    }
}

服务

class SystemBService{
    public SystemBObject getSomethingFromB(SomethingFromBRequest req){
        return new SystemBObjectFactory.getObject(req);
    }
}

可转让物

版本1

class SystemBObject{
     String key;
     Integer year;
     Integer month;
     Integer day;

     ... // getters and setters etc;
}

版本2

class SystemBObject{
     String key;
     BDate date;
     ... // getters and setters etc;
}

class BDate{
     Integer year;
     Integer month;
     Integer day;
     ... // getters and setters etc;

}

请求对象

版本1

class SomethingFromBRequest {
     String key;
     ... // getters and setters etc;
}

版本2

class SomethingFromBRequest {
     String key;
     BDate afterDate;
     BDate beforeDate;
     ... // getters and setters etc;
}

失败场景

如果A 系统A 客户机 属于 版本1 呼叫 系统B 服务 属于 版本2 它可能失败:

• 上缺少方法 SystemBObject ( getYear() , getMonth() , getDay() )
• 未知类型 BDate

如果A 系统A 客户机 属于 版本2 调用A 系统B 服务 属于 版本1 它可能失败:

• 未知类型 贝特 上 SomethingFromBRequest (客户端使用B版本1无法识别的更新的B请求对象)
• 如果系统客户端足够智能,可以使用请求对象的版本1,则在 系统对象 对象(对象) getDate() )

如果A 系统B 客户机 属于 版本1 调用A 系统A 服务 属于 版本2 它可能失败:

• 类型不匹配或溢出 SystemAObject (返回) Long 但期望 Integer )

如果A 系统B 客户机 属于 版本2 调用A 系统A 服务 属于 版本1 它可能失败:

• 类型不匹配或溢出 SystemARequest (请求 长 而不是 整数 )
• 如果请求以某种方式通过,则强制转换问题(存根是 长 但服务返回 整数 在所有的WS实现中不完全兼容)

可能的解决方案

1. 升级版本时使用数字:例如 SystemAObject1 , SystemBRequest2 等等,但缺少用于匹配源/目标版本的API
2. 在签名中,传递XML而不是对象(糟糕,传递XML中的转义XML,双重序列化,反序列化/解析,取消分析)
3. 其他:例如,document/literal/ws-i是否有补救措施?