基于Spring Boot契约优先，复用公共XSD生成多客户端WSDL遇阻求助

我之前也碰到过几乎一模一样的场景——抽离公共XSD后要么服务端生成WSDL时抛出解析异常，要么客户端调用时出现类型不匹配的报错。结合Spring Web Services的实践经验，给你整理几个可落地的解决步骤：

1. 先规范XSD的命名空间与引用逻辑 #

重复类型冲突的核心原因往往是命名空间不明确或者引用方式错误。首先给common.xsd定义独立的专属命名空间，彻底和业务XSD划清界限：

common.xsd 示例 #

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            targetNamespace="http://your-domain.com/ws/common"
            xmlns:common="http://your-domain.com/ws/common"
            elementFormDefault="qualified">

    <!-- 定义公共复用类型，比如Credential -->
    <xsd:complexType name="Credential">
        <xsd:sequence>
            <xsd:element name="username" type="xsd:string"/>
            <xsd:element name="password" type="xsd:string"/>
        </xsd:sequence>
    </xsd:complexType>

</xsd:schema>

然后在entry.xsd和migration.xsd中，用<xsd:import>引入公共命名空间（注意用import而非include，因为属于不同命名空间）：

entry.xsd 示例 #

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            targetNamespace="http://your-domain.com/ws/entry"
            xmlns:entry="http://your-domain.com/ws/entry"
            xmlns:common="http://your-domain.com/ws/common"
            elementFormDefault="qualified">

    <!-- 引入公共XSD，指定命名空间和资源路径 -->
    <xsd:import namespace="http://your-domain.com/ws/common" schemaLocation="classpath:xsd/common.xsd"/>

    <!-- 使用公共类型时带上命名空间前缀 -->
    <xsd:element name="EntryRequest">
        <xsd:complexType>
            <xsd:sequence>
                <xsd:element name="credential" type="common:Credential"/>
                <!-- 其他业务字段 -->
                <xsd:element name="entryData" type="xsd:string"/>
            </xsd:sequence>
        </xsd:complexType>
    </xsd:element>

</xsd:schema>

2. 配置Spring Boot的WSDL生成器 #

在Spring配置类中，给每个业务WSDL（entry和migration）单独定义DefaultWsdl11Definition，必须把common.xsd加入到schema集合中，否则生成WSDL时无法解析公共类型：

@Configuration
public class WebServiceConfig extends WsConfigurerAdapter {

    // 配置Entry的WSDL生成器
    @Bean(name = "entry")
    public DefaultWsdl11Definition entryWsdl(XsdSchema entrySchema, XsdSchema commonSchema) {
        DefaultWsdl11Definition wsdl11Definition = new DefaultWsdl11Definition();
        wsdl11Definition.setPortTypeName("EntryPort");
        wsdl11Definition.setLocationUri("/ws/entry");
        wsdl11Definition.setTargetNamespace("http://your-domain.com/ws/entry");
        // 同时传入业务XSD和公共XSD，确保WSDL能解析所有类型
        wsdl11Definition.setSchemas(entrySchema, commonSchema);
        return wsdl11Definition;
    }

    // 配置Migration的WSDL生成器
    @Bean(name = "migration")
    public DefaultWsdl11Definition migrationWsdl(XsdSchema migrationSchema, XsdSchema commonSchema) {
        DefaultWsdl11Definition wsdl11Definition = new DefaultWsdl11Definition();
        wsdl11Definition.setPortTypeName("MigrationPort");
        wsdl11Definition.setLocationUri("/ws/migration");
        wsdl11Definition.setTargetNamespace("http://your-domain.com/ws/migration");
        wsdl11Definition.setSchemas(migrationSchema, commonSchema);
        return wsdl11Definition;
    }

    // 注册common.xsd的Schema Bean
    @Bean
    public XsdSchema commonSchema() {
        return new SimpleXsdSchema(new ClassPathResource("xsd/common.xsd"));
    }

    // 注册entry.xsd的Schema Bean
    @Bean
    public XsdSchema entrySchema() {
        return new SimpleXsdSchema(new ClassPathResource("xsd/entry.xsd"));
    }

    // 注册migration.xsd的Schema Bean
    @Bean
    public XsdSchema migrationSchema() {
        return new SimpleXsdSchema(new ClassPathResource("xsd/migration.xsd"));
    }
}

3. 解决代码生成时的重复类问题 #

如果用JAXB生成Java代码（比如jaxb2-maven-plugin或Gradle的jaxb插件），需要通过绑定文件指定公共类型的生成包，避免每个业务XSD都重复生成Credential类：

创建JAXB绑定文件（bindings.xjb） #

<?xml version="1.0" encoding="UTF-8"?>
<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="2.1">

    <!-- 给公共命名空间指定单独的包路径 -->
    <jaxb:bindings schemaLocation="classpath:xsd/common.xsd" node="/xsd:schema">
        <jaxb:package name="com.yourcompany.ws.common"/>
    </jaxb:bindings>

    <!-- 给entry业务命名空间指定包路径 -->
    <jaxb:bindings schemaLocation="classpath:xsd/entry.xsd" node="/xsd:schema">
        <jaxb:package name="com.yourcompany.ws.entry"/>
    </jaxb:bindings>

    <!-- 给migration业务命名空间指定包路径 -->
    <jaxb:bindings schemaLocation="classpath:xsd/migration.xsd" node="/xsd:schema">
        <jaxb:package name="com.yourcompany.ws.migration"/>
    </jaxb:bindings>
</jaxb:bindings>

然后在Maven插件配置中引入这个绑定文件：

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>jaxb2-maven-plugin</artifactId>
    <version>2.5.0</version>
    <executions>
        <execution>
            <id>xjc</id>
            <goals>
                <goal>xjc</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <schemaDirectory>${project.basedir}/src/main/resources/xsd</schemaDirectory>
        <bindingDirectory>${project.basedir}/src/main/resources/xsd</bindingDirectory>
        <bindingFiles>bindings.xjb</bindingFiles>
        <outputDirectory>${project.basedir}/src/main/java</outputDirectory>
        <clearOutputDir>false</clearOutputDir>
    </configuration>
</plugin>

4. 验证与客户端适配 #

• 服务端验证：启动Spring Boot后，访问http://localhost:8080/ws/entry.wsdl和http://localhost:8080/ws/migration.wsdl，检查WSDL中是否正确引用了common的schema，且所有类型都能正常显示。
• 客户端处理：如果是Java客户端，生成代码时要把common.xsd也加入到schema列表中，确保客户端能引用到公共类型的类；如果是其他语言客户端，要确保客户端能正确解析WSDL中的schema引用路径。

内容的提问来源于stack exchange，提问作者Robin Halder