如何通过自定义Spring Data Rest Controller扩展现有资源链接

我之前在Spring Boot 1.5.x版本搭配Spring Data Rest开发时，也踩过自定义搜索端点不生效的坑，给你梳理几个关键排查点和解决办法：

1. 确认@RepositoryRestController的路径映射对齐 #

首先要保证自定义控制器的路径和Spring Data Rest的基础配置一致。如果你的Data Rest根端点配置是/api/v1，控制器上的@RequestMapping要匹配这个路径，同时指定对应的资源路径：

@RepositoryRestController
@RequestMapping("/api/v1/users") // 和Data Rest的用户资源路径保持一致
public class UserCustomSearchController {
    // ...
}

另外，自定义搜索方法的映射要以search/开头，确保拼接后路径正确：

@GetMapping("search/customQuery") // 完整访问路径：http://localhost:8080/api/v1/users/search/customQuery
public ResponseEntity<Resources<Resource<User>>> customSearch(...) {
    // ...
}

2. 返回类型必须符合HATEOAS规范 #

Spring Data Rest的端点默认返回HATEOAS格式响应，自定义方法不能直接返回POJO或普通List，必须返回Resource、Resources或PagedResources类型，同时要添加必要的HATEOAS链接。示例代码如下：

@Autowired
private UserRepository userRepository;

@GetMapping("search/findByStatus")
public Resources<Resource<User>> findUsersByStatus(@RequestParam String status) {
    List<User> users = userRepository.findByStatus(status);
    
    // 转换为HATEOAS资源格式
    List<Resource<User>> userResources = users.stream()
        .map(user -> new Resource<>(user,
            linkTo(methodOn(UserRepository.class).findOne(user.getId())).withRel("user"),
            linkTo(methodOn(UserCustomSearchController.class).findUsersByStatus(status)).withSelfRel()))
        .collect(Collectors.toList());
    
    return new Resources<>(userResources,
        linkTo(methodOn(UserCustomSearchController.class).findUsersByStatus(status)).withSelfRel());
}

3. 避免路径冲突 #

如果你的自定义端点路径和Spring Data Rest自动生成的搜索端点（比如仓库中findByUsername方法会自动生成/search/findByUsername）重复，自定义端点会被自动生成的覆盖，所以要确保自定义路径唯一。

4. 确认控制器被Spring扫描到 #

检查自定义控制器是否放在Spring Boot主应用类的同级包或子包下，如果不在，需要在主类上添加@ComponentScan指定扫描路径。

5. 开启调试日志排查请求流向 #

在application.properties中添加日志配置，查看请求是否真的到达了自定义控制器：

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

启动应用后访问自定义端点，通过日志里的请求映射信息，确认请求是否被正确路由到你的方法。

如果以上步骤都检查过还是没解决，可以把你的控制器代码贴出来，我再帮你进一步排查~

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