网站建设与制作德州,好听的公司名字大全,网站建设商务合同范本,wordpress安装无法连接数据库rest api每个开发人员都以某种方式接触到API 。 要么为一家大公司集成一个主要系统#xff0c;或者使用最新的图形库生成一些精美的图表#xff0c;要么直接与他喜欢的编程语言进行交互。 事实是#xff0c;API无处不在#xff01; 它们实际上代表了当今Internet的基本构建… rest api 每个开发人员都以某种方式接触到API 。 要么为一家大公司集成一个主要系统或者使用最新的图形库生成一些精美的图表要么直接与他喜欢的编程语言进行交互。 事实是API无处不在 它们实际上代表了当今Internet的基本构建块在不同系统和设备之间发生的数据交换过程中扮演着重要角色。 从您手机上的简单天气小部件到您在网上商店中执行的信用卡付款如果这些系统无法通过调用彼此的API相互通信那么所有这些都是不可能的。 因此随着连接到互联网的异构设备生态系统的不断发展API提出了一系列严峻的挑战。 尽管它们必须继续以可靠和安全的方式运行但它们还必须与所有这些设备兼容从手表到数据中心中最先进的服务器。 REST来解救 用于构建此类API的最广泛使用的技术之一就是所谓的REST API。 这些API旨在提供异构系统之间通用且标准化的通信方式。 由于它们严重依赖于标准的通信协议和数据表示例如HTTPXML或JSON因此很容易在大多数编程语言上提供客户端实现从而使其与绝大多数系统和设备兼容。 因此尽管这些REST API可以与大多数设备和技术兼容但它们也必须不断发展。 演化的问题是有时您必须保持与旧客户端版本的复古兼容性。 让我们建立一个例子。 让我们想象一个约会系统在该系统中您具有一个用于创建和检索约会的API。 为简化起见让我们想象一下约会对象和日期以及来宾姓名。 像这样 public class AppointmentDTO {public Long id;public Date date;public String guestName;
} 一个非常简单的REST API如下所示 Path(/api/appointments)
public class AppointmentsAPI {GETPath(/{id})public AppointmentDTO getAppointment(PathParam(id) String id) { ... }POSTpublic void createAppointment(AppointmentDTO appointment) { ... }} 让我们假设这个简单的简单API可以正常工作并且可以在允许预订和显示约会的手机平板电脑和各种网站上使用。 到目前为止一切都很好。 在某个时候您认为开始收集有关约会系统的一些统计信息将非常有趣。 为了简单起见您只想知道谁是预订次数最多的人。 为此您需要将访客之间关联起来并决定需要为每个访客添加唯一的标识符。 让我们使用电子邮件。 因此现在您的对象模型将如下所示 public class AppointmentDTO {public Long id;public Date date;public GuestDTO guest;
}public class GuestDTO {public String email;public String name;
} 因此我们的对象模型稍有变化这意味着我们将不得不在api上调整业务逻辑。 问题 尽管使API适应存储和检索新对象类型应该是轻而易举的事但问题是您当前的所有客户端都在使用旧模型并且将继续这样做直到更新。 可以说您不必为此担心客户应该更新到较新的版本但事实是您不能真正地从头到尾进行更新。 始终会有一个时间窗口您必须保持两个模型都运行这意味着您的api必须是复古兼容的。 这是您的问题开始的地方。 回到我们的示例在这种情况下这意味着我们的API将必须处理两个对象模型并能够根据客户端存储和检索那些模型。 因此让我们将guestName添加回我们的对象中以保持与旧客户端的兼容性 public class AppointmentDTO {public Long id;public Date date;Deprecated //For retro compatibility purposespublic String guestName;public GuestDTO guest;
} 请记住关于API对象的一个好的经验法则是永远不要删除字段。 添加新字段通常不会破坏任何客户端实现假设它们遵循忽略新字段的良好经验法则但是删除字段通常是噩梦之路。 现在为了保持API兼容有几种不同的选择。 让我们看一些替代方案 复制 单纯。 为新客户创建一种新方法并让旧客户使用相同的方法。 查询参数 引入一个标志来控制行为。 诸如useGuests true之类的东西。 API版本控制 在您的URL路径中引入一个版本以控制要调用的方法版本。 因此所有这些替代方案都有其优缺点。 尽管复制很简单但是它可以轻松地将您的API类变成一碗重复的代码。 可以并且应该将查询参数用于行为控制例如将分页添加到列表中但是我们应避免将其用于实际的API演变因为这些参数通常是永久性的因此您不希望使用对于消费者来说是可选的。 版本控制似乎是个好主意。 它提供了一种开发API的干净方法它使旧客户端与新客户端保持隔离并为您在API使用寿命期间发生的各种更改提供了通用基础。 另一方面它也引入了一些复杂性特别是如果您在不同版本上有不同的调用时。 您的客户最终将不得不通过升级调用而不是API来自己管理API的演变。 就像您没有升级库到下一个版本而是只升级了该库的某个类。 这很容易变成版本梦night…… 为了克服这个问题我们必须确保我们的版本涵盖整个API。 这意味着我应该能够使用/ v2来调用/ v1上的每个可用方法。 当然如果v2上存在给定方法的较新版本则应在/ v2调用上运行它。 但是如果给定方法在v2中没有更改我希望可以无缝调用v1版本。 基于继承的API版本控制 为了实现这一点我们可以利用Java对象的多态功能。 我们可以以分层的方式构建API版本以便较新的版本可以覆盖较旧的版本而对未更改方法的较新版本的调用可以无缝地回退到较早的版本。 因此回到我们的示例我们可以构建一个新版本的create方法以便API如下所示 Path(/api/v1/appointments) //We add a version to our base path
public class AppointmentsAPIv1 { //We add the version to our API classesGETPath(/{id})public AppointmentDTO getAppointment(PathParam(id) String id) { ... }POSTpublic void createAppointment(AppointmentDTO appointment) { //Your old way of creating Appointments only with names}
}//New API class that extends the previous version
Path(/api/v2/appointments)
public class AppointmentsAPIv2 extends AppointmentsAPIv1 {POSTOverridepublic void createAppointment(AppointmentDTO appointment) { //Your new way of creating appointments with guests}
} 因此现在我们有2个工作版本的API。 尽管所有尚未升级到新版本的旧客户端将继续使用v1并且不会看到任何更改但您的所有新客户现在都可以使用最新的v2。 请注意所有这些调用均有效 呼叫 结果 GET /api/v1/appointments/123 将在v1类上运行getAppointment GET /api/v2/appointments/123 将在v1类上运行getAppointment POST /api/v1/appointments 将在v1类上运行createAppointment POST /api/v2/appointments 将在v2类上运行createAppointment 这样任何想要开始使用最新版本的使用者都只需将其基本URL更新为相应的版本并且所有API都将无缝转换到最新的实现同时保持旧的不变。 警告 出于敏锐的眼光这种方法立即引起了警告。 如果您的API由十分之几的不同类组成那么即使您实际上没有任何更改较新的版本也会暗示将它们全部复制为较高版本。 这是一些可以自动生成的样板代码。 仍然很烦。 尽管没有快速的方法可以解决此问题但是使用接口可能会有所帮助。 除了创建新的实现类之外您还可以创建一个新的带路径注释的接口并在当前的实现类中对其进行实现。 尽管您将不得不为每个API类创建一个接口但它有点干净。 它有一点帮助但仍然是一个警告。 最后的想法 API版本控制似乎是当前的热门话题。 存在许多不同的观点和意见但似乎缺乏标准的最佳实践。 尽管本文并非旨在提供这样的内容但我希望它有助于实现更好的API结构并有助于其可维护性。 最后要说的是罗伯托·科尔特斯 Roberto Cortez鼓励并允许将此帖子发布在他的博客上。 这实际上是我的第一篇博文因此请加载大炮并随意开火。 :) 翻译自: https://www.javacodegeeks.com/2015/03/rest-api-evolution.htmlrest api
