Spring Hateoas ControllerLinkBuilder添加空字段

Question

我正在学习关于Spring REST的教程，并试图将HATEOAS链接添加到我的控制器结果中。

我有一个简单的User类和一个CRUD控制器。

class User {
    private int id;
    private String name;
    private LocalDate birthdate;
    // and getters/setters
}

服务：

@Component
class UserService {
    private static List<User> users = new ArrayList<>();
    List<User> findAll() {
        return Collections.unmodifiableList(users);
    }
    public Optional<User> findById(int id) {
        return users.stream().filter(u -> u.getId() == id).findFirst();
    }
    // and add and delete methods of course, but not important here
}

一切正常，除了在我的控制器中，我想将所有用户列表中的链接添加到单个用户：

import static org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo;
import static org.springframework.hateoas.mvc.ControllerLinkBuilder.methodOn;

@RestController
public class UserController {
    @Autowired
    private UserService userService;
    @GetMapping("/users")
    public List<Resource<User>> getAllUsers() {
        List<Resource<User>> userResources = userService.findAll().stream()
            .map(u -> new Resource<>(u, linkToSingleUser(u)))
            .collect(Collectors.toList());
        return userResources;
    }
    Link linkToSingleUser(User user) {
        return linkTo(methodOn(UserController.class)
                      .getById(user.getId()))
                      .withSelfRel();
    }

因此，对于结果列表中的每个用户，都会添加指向用户本身的链接。

链接本身创建得很好，但生成的JSON中有多余的条目：

[
    {
        "id": 1,
        "name": "Adam",
        "birthdate": "2018-04-02",
        "links": [
            {
                "rel": "self",
                "href": "http://localhost:8080/users/1",
                "hreflang": null,
                "media": null,
                "title": null,
                "type": null,
                "deprecation": null
            }
        ]
    }
]

空值字段（hreflang，media等）来自何处，为什么要添加这些字段？有没有办法摆脱它们？

在构建指向所有用户列表的链接时，它们不会出现：

@GetMapping("/users/{id}")
public Resource<User> getById(@PathVariable("id") int id) {
    final User user = userService.findById(id)
                                 .orElseThrow(() -> new UserNotFoundException(id));
    Link linkToAll = linkTo(methodOn(UserController.class)
                            .getAllUsers())
                            .withRel("all-users");
    return new Resource<User>(user, linkToAll);
}

Answer 1

根据Spring HATEOAS#493，“因为您的顶层结构不是有效的HAL结构，因此绕过了HAL序列化程序。”

要解决此问题，请使用：

return new Resources<>(assembler.toResources(sourceList));

Answer 2

正如semiintel所提到的，问题在于列表返回对象不是有效的HAL类型：

public List<Resource<User>> getAllUsers()

通过将返回类型更改为以下资源，可以轻松解决这一问题：

public Resources<Resource<User>> getAllUsers()

然后，您可以简单地包装您的资源

return userResources;

收件人：

return new Resources<>(userResources)

然后，您应该像对待单个对象那样获得适当的链接序列化。

此方法由这篇非常有用的文章提供，用于解决此问题：

https://www.logicbig.com/tutorials/spring-framework/spring-hateoas/multiple-link-relations.html

Answer 3

为了进一步参考，以防其他人偶然发现这一点，我找到了答案：我在应用程序中添加了一个条目。属性，即

spring.jackson.default-property-inclusion=NON_NULL

为什么这对于Link对象是必要的，但对于User我不知道（并且还没有深入研究）。