Spring Boot 2中@RepositoryRestController在Spring Data REST下无法工作

我之前在Spring Boot 2环境下也碰到过@RepositoryRestController不生效的情况，大概率是依赖配置、扫描范围或者注解冲突这类常见问题导致的，咱们一步步来排查解决：

1. 先确认依赖是否正确引入 #

Spring Boot 2中推荐使用spring-boot-starter-data-rest starter包，它已经整合了Spring Data REST所需的所有依赖，不要单独引入spring-data-rest-webmvc（容易出现版本不兼容问题）。

• Maven依赖配置：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>

• Gradle依赖配置：

implementation 'org.springframework.boot:spring-boot-starter-data-rest'

2. 检查控制器的包扫描范围 #

确保你的@RepositoryRestController所在的包，被Spring Boot主类的扫描范围覆盖。如果控制器不在主类的同级或子包下，需要在主类上显式指定扫描包：

@SpringBootApplication
@ComponentScan(basePackages = {"com.yourproject.controller", "com.yourproject.repository"})
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

3. 避免注解冲突 #

@RepositoryRestController是Spring Data REST专门用来扩展Repository REST端点的注解，不要在同一个类上同时标注@RestController或@Controller。这会让Spring优先把它当成普通Web控制器处理，而非Repository REST的扩展控制器。

4. 验证请求映射与基础路径配置 #

Spring Data REST在Boot2中的默认基础路径是/api，如果你的控制器映射路径没有匹配这个前缀，可能会导致请求无法路由到自定义控制器。你可以：

• 调整控制器的@RequestMapping路径，比如：

  @RepositoryRestController
  @RequestMapping("/api/users") // 匹配默认基础路径+Repository路径
  public class UserCustomController {
      // ... 自定义方法
  }
  

• 或者在application.properties中修改默认基础路径：

  spring.data.rest.base-path=/your-custom-base-path
  

5. 检查控制器方法签名 #

自定义控制器要正确关联到对应的Repository端点，方法参数需要合理配置，比如：

@RepositoryRestController
@RequestMapping("/api/users")
public class UserCustomController {

    private final UserRepository userRepository;

    // 构造注入Repository
    public UserCustomController(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    @GetMapping("/{id}/custom-info")
    public ResponseEntity<User> getCustomUserInfo(@PathVariable Long id) {
        User user = userRepository.findById(id)
                .orElseThrow(() -> new RuntimeException("User not found"));
        // 自定义业务逻辑
        return ResponseEntity.ok(user);
    }
}

6. 开启调试日志排查 #

如果以上步骤都没解决问题，可以开启调试日志，查看Spring是否正确注册了你的控制器：

logging.level.org.springframework.data.rest=DEBUG
logging.level.org.springframework.web.servlet.mvc.method.annotation=DEBUG

启动应用后，查看日志中是否有你的@RepositoryRestController注册信息，以及请求进来时的路由匹配情况，能帮你定位具体问题。

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