如何从@RestController返回@RepositoryRestResource样式的响应

Question

使用@RepositoryRestResource生成路径并为 REST API 注入所有必要的 HATEOAS 链接，但是当我使用控制器从存储库返回相同的结果时，JSON 结构是不同的，并且没有 HATEOAS 链接。

我如何返回从控制器获得与RepositoryRestResource生成的路径相同的JSON结构？

// /accounts (RepositoryRestResource JSON structure)
{
    _embedded: {
        accounts: []
    },
    _links: {
        first: {},
        self: {},
        next: {},
        last: {},
        profile: {},
        search: {}
    },
    page: {
    size: 20,
    totalElements: 35,
    totalPages: 2,
    number: 0
    }
}

// /my-accounts (RestController JSON structure)
{
    content: [ ... ], // accounts
    pageable: {},
    totalPages: 1,
    totalElements: 2,
    last: true,
    size: 20,
    number: 0,
    sort: {},
    numberOfElements: 2,
    first: true
}

REST存储库:

@RepositoryRestResource(collectionResourceRel = "accounts", path = "accounts", itemResourceRel = "account")
public interface AccountRepository extends PagingAndSortingRepository<Account, Long> {

    @RestResource(path = "owner", rel = "owner")
    Page<Account> findByOwner(@Param("username") String owner,Pageable p);
}

REST控制器：

@RestController
public class AccountController {

    private AccountRepository repo;

    @Autowired
    public AccountController(AccountRepository repo) {
        this.repo = repo;
    }

    @RequestMapping(
        path = "/my-accounts",
        method = RequestMethod.GET,
        produces = "application/hal+json")
    public ResponseEntity<Page<Account>> getStatus(
        @RequestParam(value = "page", defaultValue = "0", required = false) int page,
        @RequestParam(value = "size", defaultValue = "20", required = false) int size,
        Authentication authentication) {

        String username =  authentication.getName();

        Page<Account> accounts = repo.findByOwner(username, PageRequest.of(page, size));

        return ResponseEntity.ok(accounts);
    }
}

Answer 1

不确定，但这可能有用:

return ResponseEntity.ok(new org.springframework.hateoas.Resource<>(accounts));

如果没有，则可以将帐户包装在扩展ResourceSupport的类中。因此，只需创建一些类AccountSupportextendsResourceSupport并在其中添加所需的链接。它有很多实用方法，比如

add(linkTo(AccountController.class).withSelfRel());

或个人帐户的链接：

add(linkTo(AccountController.class).slash(idOfYourAccountInstance).withSelfRel())

Answer 2

基本上，Spring Data REST只是一个样板代码（如控制器）的默认实现，人们通常通过REST和使用Spring HATEOAS来编写公开Spring Data存储库的代码，即试图用手写控制器复制完全相同的效果意味着只需自己编写整个Spring Data REST，因此，这是一个坏主意。幸运的是，有些部分很容易复制。

如果您只谈到将分页链接添加到控制器的输出中(而没有实现其他东西，如search controller，在您的示例Spring Data REST控制器输出中有一个到它的链接)，您可以看看Spring Data REST是如何做到这一点的。它使用Spring Data的PagedResourcesAssembler，它接受一个< code >页面并创建一个带有所需导航链接的HATEOAS资源。

因此，要添加分页链接，必须在控制器中注入PagedResourcesAssembler实例并使用它：

public ResponseEntity<PagedResources> getStatus(
    @RequestParam(value = "page", defaultValue = "0", required = false) int page,
    @RequestParam(value = "size", defaultValue = "20", required = false) int size,
    Authentication authentication,
    PagedResourcesAssembler assembler) {

    String username =  authentication.getName();

    Page<Account> accounts = repo.findByOwner(username, PageRequest.of(page, size));

    return ResponseEntity.ok(assembler.toResource(accounts));
}