Web服务 – 您的WebService版本控制最佳实践是什么?

前端之家收集整理的这篇文章主要介绍了Web服务 – 您的WebService版本控制最佳实践是什么?前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
我们有两个单独的产品,需要通过网络服务相互通信。
支持API的最佳实践是什么?

从2004年起,我有this article声称没有实际的标准,只有最佳做法。任何更好的解决方案?您如何解决WS版本控制?

问题描述

系统A

客户

  1. class SystemAClient{
  2. SystemBServiceStub systemB;
  3. public void consumeFromB(){
  4. SystemBObject bObject = systemB.getSomethingFromB(new SomethingFromBRequest("someKey"));
  5.  
  6. }
  7. }

服务

  1. class SystemAService{
  2. public SystemAObject getSomethingFromA(SomethingFromARequest req){
  3. return new SystemAObjectFactory.getObject(req);
  4. }
  5. }

可转移对象

版本1

  1. class SystemAObject{
  2. Integer id;
  3. String name;
  4. ... // getters and setters etc;
  5. }

版本2

  1. class SystemAObject{
  2. Long id;
  3. String name;
  4. String description;
  5. ... // getters and setters etc;
  6. }

请求对象

版本1

  1. class SomethingFromARequest {
  2. Integer requestedId;
  3. ... // getters and setters etc;
  4.  
  5. }

版本2

  1. class SomethingFromARequest {
  2. Long requestedId;
  3. ... // getters and setters etc;
  4.  
  5. }

系统B

客户

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

服务

  1. class SystemBService{
  2. public SystemBObject getSomethingFromB(SomethingFromBRequest req){
  3. return new SystemBObjectFactory.getObject(req);
  4. }
  5. }

可转移对象

版本1

  1. class SystemBObject{
  2. String key;
  3. Integer year;
  4. Integer month;
  5. Integer day;
  6.  
  7. ... // getters and setters etc;
  8. }

版本2

  1. class SystemBObject{
  2. String key;
  3. BDate date;
  4. ... // getters and setters etc;
  5. }
  6.  
  7. class BDate{
  8. Integer year;
  9. Integer month;
  10. Integer day;
  11. ... // getters and setters etc;
  12.  
  13. }

请求对象

版本1

  1. class SomethingFromBRequest {
  2. String key;
  3. ... // getters and setters etc;
  4. }

版本2

  1. class SomethingFromBRequest {
  2. String key;
  3. BDate afterDate;
  4. BDate beforeDate;
  5. ... // getters and setters etc;
  6. }

失败方案

如果系统A版本1的客户端调用版本2的系统B服务,它可能会失败:

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

如果系统A版本2的客户端调用版本1的系统B服务,它可能会失败:

>未知类型在SomethingFromBRequest上的BDate(客户端使用B版本1无法识别的较新的B请求对象)
>如果System A客户端足够聪明地使用请求对象的版本1,则可能会在SystemBObject对象(getDate())上的缺少方法上失败

如果版本1的系统B客户端调用版本2的系统A服务,它可能会失败:

>在SystemAObject上键入missmatch或溢出(返回长但预期的整数)

如果版本2的系统B客户端调用版本1的系统A服务,则可能会失败:

>在SystemARequest上键入missmatch或溢出(请求Long而不是整数)
>如果请求通过某种方式转换问题(stub是Long,但服务返回一个整数在所有的WS实现中都不会非常兼容)

可能的解决方

>推进版本时使用数字:例如SystemAObject1,SystemBRequest2等,但是缺少一个用于匹配源/目标版本的API
>在签名中,传递XML而不是对象(yuck,以XML格式传递转义的XML,双重序列化,反序列化/解析,解析)
>其他:例如文件/文字/ WS-I有补救吗?

解决方法

我更喜欢Salesforce.com的版本控制方法。每个版本的Web服务都获得一个不同的URL,格式为:
  1. http://api.salesforce.com/{version}/{serviceName}

所以你会有一个Web服务URL:

  1. http://api.salesforce.com/14/Lead
  2.  
  3. http://api.salesforce.com/15/Lead

等等…

通过这种方法,您将获得以下好处:

>你总是知道你在说什么版本。>保持向后兼容性。>你不必担心依赖问题。每个版本都有完整的服务。您只需确保不要在呼叫之间混合版本(但这取决于服务的消费者,而不是您作为开发人员)。

猜你在找的HTML相关文章