自定义RestController中如何生成Spring Data Rest的正确资源链接？

问题分析 #

你当前代码里用linkTo(ProjectRepo.class).slash(clone.getId())生成的链接缺少/projects前缀，原因是直接通过WebMvcLinkBuilder指向Repository类时，无法自动识别Spring Data Rest为Repository设置的资源基础路径（默认是实体类名复数形式），同时也没考虑请求上下文路径或X-Forwarded系列头带来的外部访问路径。

解决方案 #

方法1：使用Spring Data Rest的RepositoryEntityLinks（推荐） #

这个类是Spring Data Rest专门用来生成符合HAL规范的资源链接的工具，能自动识别Repository的基础路径，还会自动适配请求的上下文路径、X-Forwarded头信息生成正确的外部链接。

修改后的代码如下：

@RestController
@RequestMapping(value = "/projects", produces = "application/hal+json")
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class ProjectCloneController {

    private final ProjectRepo projectRepo;
    // 注入RepositoryEntityLinks
    private final RepositoryEntityLinks entityLinks;

    @PostMapping("/{id}/clone")
    public EntityModel<Project> clone(@PathVariable String id) {
        Optional<Project> origOpt = projectRepo.findById(id);
        Project original = origOpt.get();
        Project clone = createClone(original);
        // 保存克隆后的实体到数据库，确保ID有效
        clone = projectRepo.save(clone);

        EntityModel<Project> result = EntityModel.of(clone);
        // 生成正确的self链接，自动带上/projects前缀
        Link selfLink = entityLinks.linkToItemResource(Project.class, clone.getId()).withSelfRel();
        result.add(selfLink);
        
        return result;
    }

    // 示例克隆属性的方法
    private Project createClone(Project original) {
        Project clone = new Project();
        // 复制除ID外的业务属性
        clone.setName(original.getName());
        // 其他属性复制逻辑...
        return clone;
    }
}

方法2：手动结合UriComponentsBuilder构建链接 #

如果不想依赖RepositoryEntityLinks，可以通过UriComponentsBuilder获取当前请求的完整基础路径，再手动拼接资源路径和ID：

@RestController
@RequestMapping(value = "/projects", produces = "application/hal+json")
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class ProjectCloneController {

    private final ProjectRepo projectRepo;

    @PostMapping("/{id}/clone")
    public EntityModel<Project> clone(@PathVariable String id, UriComponentsBuilder uriBuilder) {
        Optional<Project> origOpt = projectRepo.findById(id);
        Project original = origOpt.get();
        Project clone = createClone(original);
        clone = projectRepo.save(clone);

        EntityModel<Project> result = EntityModel.of(clone);
        // 构建完整的self链接：基础路径 + /projects + /id
        String selfUrl = uriBuilder.path("/projects/{id}").buildAndExpand(clone.getId()).toUriString();
        Link selfLink = Link.of(selfUrl).withSelfRel();
        result.add(selfLink);
        
        return result;
    }

    // createClone方法同上
}

支持X-Forwarded系列头 #

如果服务部署在反向代理后，需要处理X-Forwarded-Host、X-Forwarded-Proto等头生成正确的外部链接，只需开启forwarded header支持：

• 在application.properties中添加配置：

  server.forward-headers-strategy=native
  

• 或者在配置类中注册过滤器：

  @Configuration
  public class WebConfig {
      @Bean
      public ForwardedHeaderFilter forwardedHeaderFilter() {
          return new ForwardedHeaderFilter();
      }
  }
  

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