Springfox / Swagger忽略@XmlElement注释的嵌套对象

编程问答 2022-06-08

问题描述

我有以下架构。

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="sampleRequest">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Lookup" minOccurs="0">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="accountidtgroup">
                                <xs:complexType>
                                    <xs:sequence>
                                        <xs:element name="accountIDType" type="xs:string" />
                                        <xs:element name="accountIDValue" type="xs:string" />
                                    </xs:sequence>
                                </xs:complexType>
                            </xs:element>
                            <xs:element name="sysPlanID" type="xs:string"/>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="sampleResponse">
        <xs:complexType>
            <xs:sequence>
                    <xs:element name="Dummy" type="xs:string"/>
                <xs:element name="OriginalReq">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element ref="sampleRequest"/>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

我从中生成类，并且一切正常，只是在Swagger UI中将“ Lookup”元素的大小写转换为小写（从技术上来说，这是对象名称），而实际上应该是“ Lookup”。如果我只是在sampleRequest中删除/注释掉“ OriginalReq”元素，然后重新生成并重新启动我的应用程序，则“ Lookup”元素的情况在请求中看起来不错。这里要注意的重要一点是，“ OriginalReq”元素实际上是对“ sampleRequest”元素本身的引用，这是问题的根本原因。

这是我的pom依赖项

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

我进行了一些调查，springfox的早期版本在Jaxb批注中存在问题，但在更高版本中已修复。证明是“ Dummy”元素以正确的大小写出现，如果我在@XmlElement批注中手动将其更改为其他内容，则可以看到更新后的值，这意味着该批注得到了认可，但是对于Lookup元素却没有工作。因此，问题仅在嵌套元素具有公共元素的情况下出现。

是否有人在解决问题之前或是否遇到类似问题？

解决方法

为处于类似情况的任何人找出解决方法。

解决方法是将@JsonProperty批注添加到有问题的元素中。就是这样。 Swagger将识别出注释并显示正确的元素大小写/名称。

对于那些通过xsd模式生成类的人，还需要执行一些其他步骤。

  1. 将以下依赖项添加到pom.xml依赖项部分。
         <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.8.6</version>
        </dependency>
        <dependency>
            <groupId>org.jvnet.jaxb2_commons</groupId>
            <artifactId>jaxb2-basics-annotate</artifactId>
            <version>1.1.0</version>
        </dependency>
  1. 在配置用于生成类的maven插件的部分下，在执行配置内部，您必须再次添加以上两个依赖项和“ -Xannotate”参数。看起来像这样。
<build>
        <plugins>
            <plugin>
                <groupId>org.jvnet.jaxb2.maven2</groupId>
                <artifactId>maven-jaxb2-plugin</artifactId>
                <version>0.14.0</version>
                <executions>
                    <execution>
                        <id>xjc</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                        <configuration>
                            <schemaDirectory>${schema.src.dir}/abc</schemaDirectory>
                            <schemaIncludes>
                                <include>*.xsd</include>
                            </schemaIncludes>
                            <generatePackage>${generated.package.abc}</generatePackage>
                            <generateDirectory>${generated.dir}/abc</generateDirectory>
                            <cleanPackageDirectories>true</cleanPackageDirectories>
                            <bindings>
                                <binding>
                                    <fileset>
                                        <directory>${schema.binding.dir}/abc</directory>
                                        <includes>
                                            <include>bindings.xjb</include>
                                        </includes>
                                    </fileset>
                                </binding>
                            </bindings>
                            <extension>true</extension>
                            <args>
                                <arg>-Xannotate</arg>
                            </args>
                            <plugins>
                                <plugin>
                                    <groupId>org.jvnet.jaxb2_commons</groupId>
                                    <artifactId>jaxb2-basics</artifactId>
                                    <version>1.11.1</version>
                                </plugin>
                                <plugin>
                                    <groupId>org.jvnet.jaxb2_commons</groupId>
                                    <artifactId>jaxb2-basics-annotate</artifactId>
                                    <version>1.1.0</version>
                                </plugin>
                                <plugin>
                                    <groupId>com.fasterxml.jackson.core</groupId>
                                    <artifactId>jackson-annotations</artifactId>
                                    <version>2.8.6</version>
                                </plugin>
                            </plugins>
                        </configuration>
                    </execution>

看看参数部分和下面的插件部分。

  1. 现在在绑定文件中，您可以使用此插件并配置如下冲突的元素。
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE jaxb:bindings SYSTEM "../common/resources.dtd">
<jaxb:bindings version="2.0" xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns:annox="http://annox.dev.java.net"
        jaxb:extensionBindingPrefixes="annox">

 <jaxb:bindings schemaLocation="&ApiPath;/schema.xsd">
  <jaxb:bindings node="//xs:element[@name='Lookup']">
                <annox:annotate target="field">@com.fasterxml.jackson.annotation.JsonProperty("Lookup")</annox:annotate>
           </jaxb:bindings>

请密切注意顶部配置的名称空间“ annox”。

现在，如果您运行generate-resources，它将在您的成员变量之上创建@JsonProperty（“您的元素名称”），并且大摇大摆就可以了。

如果您想了解有关插件https://github.com/highsource/jaxb2-annotate-plugin的更多信息。这是一个非常广泛使用的优秀开源。 对于Springfox，我尝试使用2.9.0和3.0.0版本进行测试，但仍然是同一问题。在我撰写本文时，我认为这是springfox库中的错误，我在Github上提出了此错误，但尚未得到任何回复。这是链接https://github.com/springfox/springfox/issues/3605

restapispring-bootspringfoxswaggerswagger