草庐IT

java - 如何配置 Spring REST 服务来处理多个版本?

coder 2024-03-11 原文

几乎所有的 API 都处理不同的发布版本。您经常会看到这种版本控制:

但我还没有找到描述如何在 Spring 堆栈中组织它们的资源。我想在每个 Controller 上使用 /v1 前缀,如 @RequestMapping("/v1/questions") 并不是最好的方法。

假设当前版本(在我们的例子中是 V2)有一个 @Service 层。

我们的服务应该处理 V1 和 V2 的请求。唯一的变化是 V2 在问题实体上添加了一个新字段(这意味着 V1 问题可以轻松转换为 V2 问题)。

现在的问题是:

  • 如何从 java 包的角度组织不同的 ~.web.* @Controller
  • 如何注释他们知道自己版本的不同 ~.web.* @Controller?以 RequestMapping 的方式?或者是否可以在 V1 java 包中使用 context:component-scan 配置它们?
  • 如何组织转换器?放在哪里,如何命名? …像 QuestionsV1ToV2 Controller ?
  • 是否需要 DTO 层?因为我们的域必须同时处理多个版本?

一个示例可能如下所示(我在各处添加了包):

// on V1 Question look like this:
public class project.domain.Question
{
    private String question;
}

// on v2 Question looks like this:
public class project.domain.Question
{
    private String question;
    private Date creationDate;
}


@Service
public class project.service.QuestionService
{
    public long create(Question q) {...};
    public Question read(long id) {...};
    public void remove(long id) {...};
    public void update(Question qd) {...};

}


@Controller
@RequestMapping("/v2/question")
public class project.web.v2.QuestionController
{
    @Autowired
    project.service.QuestionService questionService;

    @RequestMapping(method = RequestMethod.POST)
    @ResponseBody
    public long create(Question q)
    {
        return questionService.create(q);
    }
}

@Controller
@RequestMapping("/v1/question")
public class project.web.v1.QuestionController
{
    @Autowired
    project.service.QuestionService questionService;

    @RequestMapping(method = RequestMethod.POST)
    @ResponseBody
    public long create(Question q)
    {
        // this will not work, because the v1 haven't had the 'creationDate' field.
        return questionService.create(q);
    }
}

最佳答案

对 REST API 进行版本控制是一个复杂的问题。首先,让我们确定一些高级版本控制方法:

  • URI 版本控制 - 资源被认为是不可变的,我们使用版本指示符在资源表示中创建新的 URI 空间变化
  • 语言扩展/版本控制——考虑到正在发生变化的是资源的表示,此解决方案将对表示本身进行版本控制,而不会影响 URI 空间

考虑到这一点,让我们考虑一些目标:(直接来自 API Evolution )

  • 保留名称中的兼容更改
  • 避免新的主要版本
  • 使更改向后兼容
  • 考虑向前兼容性

接下来,让我们考虑对 API 进行一些可能的更改:

1。添加到资源的表示

语言的设计应明确考虑向前兼容性,客户应忽略他们不理解的信息。

因此,向资源表示添加信息并不是不兼容的更改。

2。删除或更改现有表示

语言的此类扩展/更改可以利用 Accept header 和内容协商 - 表示使用自定义供应商 MIME 媒体类型进行版本控制。这些文章对此进行了更深入的探讨:API Versioning , Versioning REST Web Services .

因此,这确实代表了客户端的不兼容更改 - 客户端将不得不请求新的表示并理解新的语义,但 URI 空间将保持稳定并且不会受到影响。

3。标准不兼容的更改

这些是资源的含义和它们之间的关系的变化。 在这种情况下,我们可以看看更改 Resources 和 URI 结构之间的映射。但是,这并不一定意味着在 URI 中使用版本指示符。

REST API 应遵守HATEOAS 约束 - 大多数 URI 应由客户端发现,而不是硬编码。更改此类 URI 不应被视为不兼容的更改 - 新 URI 可以替换旧 URI,客户端将能够重新发现 URI 并且仍然可以正常工作。

4。主要不兼容的更改

对于此类彻底的更改,URI 中的版本指示符是最后的解决方案。

在技术方面,我发现:

  • DAO 和服务层不应该根据版本改变
  • 在服务层之上使用 Facade 层(和 DTO)意味着每个版本都有自己的 Facade 和 DTO
  • 为了清楚地分离两个版本,拥有两个带有两个 DispatcherServlets 的 Web 上下文可能是有意义的,因为它允许清晰地分离 URI 空间
  • 组件扫描应该是细粒度的,并且只挑选与该上下文中的特定版本相关的内容
  • @RequestMapping 新属性 - producesconsumes 也很有用

其他一些非常有用的资源:

希望这对您有所帮助。

关于java - 如何配置 Spring REST 服务来处理多个版本?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/17207453/

有关java - 如何配置 Spring REST 服务来处理多个版本?的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

    总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封,在我看来soap请求没有正确的命名空间。任何人都可以建议我

  4. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  5. ruby-on-rails - Rails 3 中的多个路由文件 - 2

    Rails2.3可以选择随时使用RouteSet#add_configuration_file添加更多路由。是否可以在Rails3项目中做同样的事情? 最佳答案 在config/application.rb中:config.paths.config.routes在Rails3.2(也可能是Rails3.1)中,使用:config.paths["config/routes"] 关于ruby-on-rails-Rails3中的多个路由文件,我们在StackOverflow上找到一个类似的问题

  6. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  7. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  8. ruby - 具有身份验证的私有(private) Ruby Gem 服务器 - 2

    我想安装一个带有一些身份验证的私有(private)Rubygem服务器。我希望能够使用公共(public)Ubuntu服务器托管内部gem。我读到了http://docs.rubygems.org/read/chapter/18.但是那个没有身份验证-如我所见。然后我读到了https://github.com/cwninja/geminabox.但是当我使用基本身份验证(他们在他们的Wiki中有)时,它会提示从我的服务器获取源。所以。如何制作带有身份验证的私有(private)Rubygem服务器?这是不可能的吗?谢谢。编辑:Geminabox问题。我尝试“捆绑”以安装新的gem..

  9. ruby-on-rails - 在 Ruby 中循环遍历多个数组 - 2

    我有多个ActiveRecord子类Item的实例数组,我需要根据最早的事件循环打印。在这种情况下,我需要打印付款和维护日期,如下所示:ItemAmaintenancerequiredin5daysItemBpaymentrequiredin6daysItemApaymentrequiredin7daysItemBmaintenancerequiredin8days我目前有两个查询,用于查找maintenance和payment项目(非排他性查询),并输出如下内容:paymentrequiredin...maintenancerequiredin...有什么方法可以改善上述(丑陋的)代

  10. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

随机推荐