Spring Boot实现多OpenAPI生成接口时重复默认方法问题求解

以下是几种可落地的解决方案，兼顾代码可维护性和避免生成代码被覆盖的问题：

1. 在生成配置中禁用默认方法生成 #

直接通过OpenAPI生成器的配置参数，阻止生成那些重复的默认方法（比如getRequest()）。以Maven插件为例，在openapi-generator-maven-plugin的配置里添加相关参数：

<plugin>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-maven-plugin</artifactId>
    <version>6.6.0</version> <!-- 使用最新稳定版本 -->
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <inputSpec>${project.basedir}/src/main/resources/openapi.yaml</inputSpec>
                <generatorName>spring</generatorName>
                <configOptions>
                    <!-- 跳过默认接口方法生成 -->
                    <skipDefaultInterfaceMethods>true</skipDefaultInterfaceMethods>
                    <!-- 仅生成接口，不生成默认实现类 -->
                    <interfaceOnly>true</interfaceOnly>
                </configOptions>
            </configuration>
        </execution>
    </executions>
</plugin>

这样生成的接口只会包含业务相关的抽象方法，不会自带重复的默认方法，控制器实现时无需处理冲突。

2. 自定义中间聚合接口 #

创建一个自定义接口，同时继承两个OpenAPI生成的接口，在这个中间接口里重写重复的默认方法，提供统一实现。后续控制器只需要实现这个中间接口即可，生成代码更新时不会影响自定义的中间接口：

import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;

// 自定义聚合接口，继承两个生成的API接口
public interface TreeNodesCombinedApi extends NodesApi, TreeApi {
    // 重写重复的getRequest方法，提供统一实现
    @Override
    default HttpServletRequest getRequest() {
        return ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
    }
}

// 控制器实现自定义聚合接口
@RestController
public class TreeController implements TreeNodesCombinedApi {
    // 实现所有业务接口的具体逻辑...
}

3. 合并OpenAPI规范中的接口 #

如果NodesApi和TreeApi的端点在业务逻辑上属于同一模块，可以直接修改OpenAPI的yaml/json规范，把两个接口的路径、操作合并成一个API定义。这样生成的接口只有一个，从根源上避免了重复方法的问题。

4. 使用自定义生成模板 #

如果需要保留部分默认方法但移除重复的getRequest()，可以自定义OpenAPI生成器的模板文件。步骤如下：

• 从OpenAPI生成器的官方仓库中复制spring生成器的api.mustache模板文件到项目的src/main/resources/templates目录
• 修改模板，删除生成getRequest()默认方法的代码块
• 在生成器配置中指定自定义模板路径：

<configuration>
    <!-- 其他配置 -->
    <templateDirectory>${project.basedir}/src/main/resources/templates</templateDirectory>
</configuration>

后续每次生成代码时，都会使用自定义模板，不会生成重复的默认方法。

内容的提问来源于stack exchange，提问作者JEINER ANDY JOSUE PINEDA CORLE