如何创建可自动为Spring Boot应用生成Rest API端点的Jar库

这确实是Spring生态里非常常见的场景——做可复用的组件库时，我们完全可以通过Spring Boot的自动配置特性来实现这个需求，让应用引入Jar后直接拥有预设的Rest API，不用写任何额外的控制器代码。下面是具体的实现思路和步骤：

利用Spring Boot的**自动配置（AutoConfiguration）**机制，把我们预先写好的RestController类自动注册到Spring容器中。当应用引入Jar包时，Spring Boot会自动识别并加载这些配置，从而让接口直接生效，不需要应用方做任何额外操作。

1. 创建独立的库项目 #

首先新建一个Maven或Gradle项目，作为你的custom-oauth.jar库的载体：

• 对于Maven，设置打包方式为普通Jar：<packaging>jar</packaging>
• 引入必要的依赖，比如spring-boot-starter-web（用于编写RestController），建议通过Spring Boot的依赖管理来统一版本，避免和应用的依赖冲突：

<!-- Maven示例 -->
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.7.15</version> <!-- 选择合适的Spring Boot版本 -->
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

2. 编写预设的RestController #

直接写普通的Spring MVC控制器类，比如你的/token和/validate接口：

@RestController
public class TokenController {
    @PostMapping("/token")
    public ResponseEntity<TokenResponse> generateToken(@RequestBody TokenRequest request) {
        // 这里实现你的OAuth token生成逻辑
        TokenResponse response = new TokenResponse("sample-jwt-token");
        return ResponseEntity.ok(response);
    }
}

@RestController
public class ValidateController {
    @PostMapping("/validate")
    public ResponseEntity<ValidationResult> validateToken(@RequestParam String token) {
        // 这里实现你的token验证逻辑
        ValidationResult result = new ValidationResult(true, "Token is valid");
        return ResponseEntity.ok(result);
    }
}

// 对应的DTO类，按需定义
class TokenRequest {
    private String username;
    private String password;
    // getter/setter
}

class TokenResponse {
    private String token;
    // 构造方法、getter
}

class ValidationResult {
    private boolean valid;
    private String message;
    // 构造方法、getter
}

3. 创建自动配置类 #

编写一个配置类，用来告诉Spring要加载我们的控制器：

@Configuration
@ComponentScan(basePackages = "com.yourcompany.customoauth.controller") // 替换成你的控制器所在包
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET) // 仅在Web应用中生效
public class CustomOAuthAutoConfiguration {
    // 这里还可以注册其他需要的Bean，比如OAuth服务类、配置类等
}

如果不想用@ComponentScan，也可以手动注册控制器Bean：

@Configuration
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
public class CustomOAuthAutoConfiguration {
    @Bean
    public TokenController tokenController() {
        return new TokenController();
    }

    @Bean
    public ValidateController validateController() {
        return new ValidateController();
    }
}

4. 让Spring Boot自动识别配置 #

在库的resources/META-INF/spring目录下，创建一个名为org.springframework.boot.autoconfigure.AutoConfiguration.imports的文件，里面写入你的自动配置类的全限定名：

com.yourcompany.customoauth.config.CustomOAuthAutoConfiguration

如果是Spring Boot 2.7以下版本，改用resources/META-INF/spring.factories文件，格式为：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.yourcompany.customoauth.config.CustomOAuthAutoConfiguration

5. 打包并测试 #

把库项目打包成Jar，然后在你的Spring Boot应用的依赖中引入这个Jar。启动应用后，直接访问http://localhost:8080/token和http://localhost:8080/validate就能调用对应的接口了——应用方不需要写任何@RestController或者额外配置！

• 确保库的依赖版本和应用的Spring Boot版本兼容，最好通过依赖管理统一版本
• 如果控制器需要依赖其他服务类，也要把这些服务类注册到容器中（比如用@Component或在自动配置类中用@Bean注册）
• 可以添加更多条件注解，比如@ConditionalOnMissingBean，允许应用方自定义替换你的控制器逻辑

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