Question

我尝试将HATEOAS与Spring HATEOAS一起使用，并且需要使用Spring HATEOAS公开enum作为REST API。

我尝试了以下三种方法：

@RestController
@RequestMapping(path = "/fruits")
public class FruitResourceController {

    @RequestMapping(method = RequestMethod.GET)
    public Fruit[] fruits() {
        return Fruit.values();
    }

    // NOTE: The `produces` attribute is only for browsers.
    @RequestMapping(path = "/with-resource", method = RequestMethod.GET,
            produces = MediaTypes.HAL_JSON_VALUE)
    public Resource<Fruit[]> fruitsWithResource() {
        Resource<Fruit[]> resource = new Resource<Fruit[]>(Fruit.values());
        Link selfLink = linkTo(methodOn(FruitResourceController.class).fruitsWithResource())
                .withSelfRel();
        resource.add(selfLink);
        return resource;
    }

    // NOTE: The `produces` attribute is only for browsers.
    @RequestMapping(path = "/with-resources", method = RequestMethod.GET,
            produces = MediaTypes.HAL_JSON_VALUE)
    public Resources<Fruit> fruitsWithResources() {
        Resources<Fruit> resources = new Resources<Fruit>(Arrays.asList(Fruit.values()));
        Link selfLink = linkTo(methodOn(FruitResourceController.class).fruitsWithResources())
                .withSelfRel();
        resources.add(selfLink);
        return resources;
    }

}

但我不知道哪种方式适合HATEOAS。任何建议或参考将不胜感激。

作为参考，我有以下Spring Data REST配置：

@Configuration
public class SpringDataRestConfig {

    @Bean
    public ResourceProcessor<RepositoryLinksResource> repositoryLinksResourceProcessor() {
        return new ResourceProcessor<RepositoryLinksResource>() {
            @Override
            public RepositoryLinksResource process(RepositoryLinksResource resource) {
                Link fruitsLink = linkTo(methodOn(FruitResourceController.class).fruitsWithResources())
                        .withRel("fruits");
                resource.add(fruitsLink);
                return resource;
            }
        };
    }

}

请参阅以下示例项目：

https://github.com/izeye/spring-boot-throwaway-branches/blob/data-jpa-and-rest/src/main/java/com/izeye/throwaway/SpringDataRestConfig.java https://github.com/izeye/spring-boot-throwaway-branches/blob/data-jpa-and-rest/src/main/java/com/izeye/throwaway/FruitResourceController.java

---更新于2016.01.04

使用ALPS（/profile）很容易获得枚举列表，但我不确定这是一种正确的方法。

Answer 1

HATEOAS 个人资料似乎是正确的地方。但是当你手里拿着锤子时，一切看起来都像钉子。

数据验证不是 HATEAOS 规范的一部分，您不应该尝试“用锤子粉刷墙壁”。

为此而设计的解决方案会让您受益匪浅；形式。我应该研究一下 JSON-Schema 和它的扩展 Json-Forms。

https://jsonforms.io/

这是通过 UI 定义数据条目的标准化解决方案。只是代码端点释义 HATEAOS 命名约定

/form/${entityname}

作为 /profile 的扩展/替代，您可以相当容易地修改 Spring 以将其包含到根和实体的 HATEOAS“_links”中。但这不是 HATEOAS！（或斯巴达！）

这将返回同名实体的硬编码 JSON 表单模式。您也可以使用交叉连接进行半自动，因此它只返回当前实体的匹配键/字段。因此，如果实体发生变化，它不会完全破坏您的 UI。然后，您可以使用大量代码实现完全自动化，这些代码通过反射读取实体类并自动为您的实体生成 JSON 表单架构定义。

喜欢这个 Java 风格的伪代码

entity.getFields().forEach(
  if (isEnumeration(field)) {
     sb.append( 
         field.getName() + ": {"
         + "type: string,"
         + "title: " + localize(field.getName() + ","
         + "enum: " Arrays.toString(field.values()) + ","
         + "required: " isNullable(field) 
         + "    },"
     );
    continue; 
  );
  if (isString(field)) {
    ...

约束你自己的数据模式是可行的。如果您的代码和 ER 干净且一致。您还可以添加更多 UI 验证信息，例如 regexp 验证。并且已经为 React、Angular 和 Vue 标准提供了现成的 UI 库和组件。 Materials UI 组件基于此，至少是它们的 Forms - 组件。

使用Spring HATEOAS将枚举作为REST API公开的正确方法是什么（通过Spring Data REST）

1 个答案: