带有自定义方法实现的Spring Data Rest/HateOAS

Question

考虑到Spring数据存储库的自定义实现，我使用存储库上的@repositoryrestresource带来所有HATEOAS生成的Goodnes：

@RepositoryRestResource(collectionResourceRel = "people", path = "people")
public interface PersonRepository extends  PagingAndSortingRepository<PersonNode,Long>,
                                            PersonRepositoryCustom {


    List<PersonNode> findBySurname(@Param("0") String name);
}

现在，按照前面提到的文档，我已经用附加的简单方法创建了PersonRepositoryCustom，用于介绍目的：

public interface PersonRepositoryCustom {

    public String printPerson(PersonNode personNode);
}

实施方式是：

public class PersonRepositoryImpl implements PersonRepositoryCustom{

    @Override
    public String printPerson(PersonNode personNode) {
        return "It Works!";
    }
}

我希望默认的SDR自动生成endpoint保持，只添加新的自定义方法/新的实现。我应该如何将这个自定义方法与spring-data REST/HATEOAS一起使用？使用简单的@repositoryrestresource可以自动生成控制器endpoint。如果我想提供一些自定义方法呢？我想我必须手动创建控制器，但在这个示例中它应该是什么样子？

Answer 1

首先，像Public String printPerson（PersonNode PersonNode)这样的存储库方法是一种RPC样式的API，并且是一种已知的反模式，因此您应该以符合REST的方式设计API（例如，请参见如何为非CRUD“命令”设计REST API（如激活和停用资源？）

问题的解决方案如下所示：

>

创建一个自定义的@restcontroller（正如您所设想的那样），为自定义方法定义@requestmapping，这些方法调用相关的实现。

为您的实体创建一个新的ResourceProcessor并重写它的Process方法，添加一个指向资源的新链接，该链接指向您的自定义方法，如/people/{id}/printPerson或您的映射定义。

下面是我的项目中的一个示例(博客实体需要列出其类别):

@Component
public static class BlogResourceProcessor implements ResourceProcessor<Resource<Blog>> {
    @Override
    public Resource<Blog> process(Resource<Blog> blogResource) {
        UriComponents uriComponents = ServletUriComponentsBuilder.fromCurrentContextPath()
                .path("/blog/{id}/categories").buildAndExpand(Long.toString(blogResource.getContent().getId()));
        blogResource.add(new Link(uriComponents.toUriString(), "categories"));
        return blogResource;
    }
}