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

为了进一步参考，以防其他人偶然发现这一点，我想通了：我在application.properties 中添加了一个条目，即

spring.jackson.default-property-inclusion=NON_NULL

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

Answer 2

正如 semiintel 所暗示的，问题在于您的 List 返回对象不是有效的 HAL 类型：

public List<Resource<User>> getAllUsers()

这可以通过将返回类型更改为 Resources 来轻松解决，如下所示：

public Resources<Resource<User>> getAllUsers()

然后，您可以简单地将您的 Resource 列表包装在 Resources 对象中，方法是更改​​您的 return 语句：

return userResources;

到：

return new Resources<>(userResources)

然后您应该像为单个对象所做的那样获得正确的链接序列化。

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

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

Answer 3

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

解决问题使用：

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

这将在 Spring HATEOAS 的未来版本中解决，其中 toResources(Iterable) 返回资源或使用SimpleResourceAssembler。

Answer 4

为了避免链接中的附加属性为"hreflang": null, "media": null, "title": null, ...，我构建了一个包装类，如：

@JsonInclude(JsonInclude.Include.NON_NULL)
public class OurCustomDtoLink extends Link {
    public OurCustomDtoLink(Link link) {
        super(link.getHref(), link.getRel());
    }
}

然后我将org.springframework.hateoas.Resource 扩展为覆盖add(Link link)：

public class OurCustomDtoResource<T extends OurCustomDto> extends Resource<T> {
    @Override
    public void add(Link link) {
        super.add(new OurCustomDtoLink(link));
    }

}

然后我扩展了org.springframework.data.web.PagedResourcesAssembler 来修复分页链接如下：

public class OurCustomDtoPagedResourceAssembler<T> extends PagedResourcesAssembler<T> {
    public OurCustomDtoPagedResourceAssembler(HateoasPageableHandlerMethodArgumentResolver resolver, UriComponents baseUri) {
        super(resolver, baseUri);
    }

    @Override
    public PagedResources<Resource<T>> toResource(Page<T> page, Link selfLink) {
        PagedResources<Resource<T>> resources = super.toResource(page, new OurCustomDtoLink(selfLink));
        exchangeLinks(resources);
        return resources;
    }

    @Override
    public <R extends ResourceSupport> PagedResources<R> toResource(Page<T> page, ResourceAssembler<T, R> assembler, Link link) {
        PagedResources<R> resources = super.toResource(page, assembler, new OurCustomDtoLink(link));
        exchangeLinks(resources);
        return resources;
    }

    @Override
    public PagedResources<?> toEmptyResource(Page<?> page, Class<?> type, Link link) {
        PagedResources<?> resources = super.toEmptyResource(page, type, new OurCustomDtoLink(link));
        exchangeLinks(resources);
        return resources;
    }

    private void exchangeLinks(PagedResources<?> resources) {
        List<Link> temp = new ArrayList<>(resources.getLinks()).stream()
            .map(OurCustomDtoLink::new)
            .collect(Collectors.toList());
        resources.removeLinks();
        resources.add(temp);
    }
}

但更好的解决方案是生成正确的媒体类型org.springframework.hateoas.MediaTypes.HAL_JSON_VALUE。在我的例子中，我们生成了org.springframework.http.MediaType.APPLICATION_JSON_VALUE，这是不正确的，但如果我们之后更改它会破坏客户端。

Answer 5

在你的 pom.xml 中添加这个依赖。 检查此链接： https://www.baeldung.com/spring-rest-hal

<dependency>
        <groupId>org.springframework.data</groupId>
        <artifactId>spring-data-rest-hal-browser</artifactId>
</dependency>

它会像这样改变你的反应。

"_links": {
    "next": {
        "href": "http://localhost:8082/mbill/user/listUser?extra=ok&page=11"
    }
}