使用带有契约优先方法的泽西岛WADL /生成XSD的麻烦

时间:2012-06-03 13:05:03

标签: java xsd jersey wadl contract-first

我几天来一直在使用Jersey的REST Web服务,并设法让所有CRUD操作都有效,有几种交换格式:XML,JSON,Google Protobuf。

但是我遇到了一些与自动生成的WADL和XSD相关的问题。


上下文

要定义以这三种格式交换的对象,我遵循“契约优先”方法

  • 从我写的XSD中,我使用JAXB生成了我的模型类;
  • 从我写的等效原型文件中,我生成了Google Protobuf类(并且内部有一种方法可以将这些转换为JAXB生成的对象,以便拥有一个独特的模型)。

但是,由于我希望我的用户能够生成他们的类,我想分享这些架构文件(.xsd和.proto)并让它们完全集成使用自动生成的WADL

为此,感谢this wiki页面:

  • 我已经公开了这两个文件
    • /schema/schema.xsd
    • /schema/schema.proto
  • 我添加了一个应用程序语法文件:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <grammars xmlns="http://wadl.dev.java.net/2009/02" 
              xmlns:xsd="http://www.w3.org/2001/XMLSchema"
              xmlns:xi="http://www.w3.org/1999/XML/xinclude">
        <include href="../schema/schema.xsd" />
    </grammars>
    
  • 我添加了一个自定义的WADL生成器:

     public class RichWadlGeneratorConfig extends WadlGeneratorConfig {
        @Override
        public List<WadlGeneratorDescription> configure() {
            return generator(WadlGeneratorApplicationDoc.class)
                .prop("applicationDocsStream", "application-doc.xml")
                .generator(WadlGeneratorGrammarsSupport.class)
                .prop("grammarsStream", "application-grammars.xml")
                .descriptions();
        }
     }
    

这样,当我点击/rest/application.wadl

时,WADL中会出现以下内容
<grammars>
     <include href="../schema/schema.xsd"/>
     <include href="application.wadl/xsd0.xsd">
          <doc title="Generated" xml:lang="en"/>
     </include>
</grammars>

问题

/rest/application.wadl/xsd0.xsd是从我的课程中自动生成的,但与我最初在schema.xsd中的 非常相似。 除此之外,在这个WADL上调用像wadl2java这样的工具失败了,大概是因为

  • /schema/schema.xsd
  • /rest/application.wadl/xsd0.xsd

现在是冲突的(相同对象的两个定义)。


问题

  1. 有没有办法禁用这个自动生成的XSD的生成和传播? (因为我不需要它,因为我遵循这种“契约优先”方法)

  2. 如果没有,是否有办法在/rest/application.wadl/xsd0.xsd被点击时使用我手动编写的XSD“覆盖”其内容? (我已经google了一下,发现了WadlResource,生成了定制的WADL,但没有发现XSD一代本身)


  3. 提前感谢您的帮助!

    微米。


    修改

    1)我向泽西岛队提出了问题并得到了答复: http://java.net/projects/jersey/lists/users/archive/2012-06/message/8

    2)根据帕维尔的指示,我提出了一张票(JERSEY-1230)。 我目前正在跟进自己提交修复或从泽西团队获得修复。

1 个答案:

答案 0 :(得分:1)

1.14-SNAPSHOT应该允许您这样做:

public class SampleWadlGeneratorConfig extends WadlGeneratorConfig {

    @Override
    public List<WadlGeneratorDescription> configure() {
        return generator( WadlGeneratorApplicationDoc.class )
                .prop( "applicationDocsStream", "application-doc.xml" )
                .generator( WadlGeneratorGrammarsSupport.class )
                .prop( "grammarsStream", "application-grammars.xml" )
                .prop("overrideGrammars", true)                               // !!!
                .generator( WadlGeneratorResourceDocSupport.class )
                .prop( "resourceDocStream", "resourcedoc.xml" )
                .descriptions();
    }

}

当overrideGrammars设置为true时,Jersey生成的语法不会包含在返回的WADL中。