Удалить _embedded в ссылке HATEOAS, используя spring-boot-2.2.1 - PullRequest
Новая
       24

Удалить _embedded в ссылке HATEOAS, используя spring-boot-2.2.1

1 голос
/ 24 января 2020

Я использую spring-boot-2.2.1 вместе с spring-HATEOAS. Гипермедиа-ссылки работают нормально, но я вижу атрибут _embedded при возврате ссылок. Пожалуйста, найдите приведенный ниже код для справки и проект в github здесь ,

Конечная точка:

a) Вернет CollectionModel => localhost: 8099 / api / v1 /ability / list / noembedded

и

b) Вернет List > localhost: 8099 / api / v1 /ability / list / 

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>spring-boot-unittest</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-boot-unittest</name>
    <description>Demo project for Spring Boot unit test</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-hateoas</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-mongodb</artifactId>
        </dependency>
        <dependency>
            <groupId>com.querydsl</groupId>
            <artifactId>querydsl-mongodb</artifactId>
            <version>4.1.4</version>
        </dependency>

        <dependency>
            <groupId>com.querydsl</groupId>
            <artifactId>querydsl-apt</artifactId>
            <version>4.1.4</version>
        </dependency>
        <!-- Embedded  MongoDB for Testing -->
        <dependency>
            <groupId>de.flapdoodle.embed</groupId>
            <artifactId>de.flapdoodle.embed.mongo</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-ui</artifactId>
            <version>1.2.21</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>com.mysema.maven</groupId>
                <artifactId>apt-maven-plugin</artifactId>
                <version>1.1.3</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>process</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>target/generated-sources/java</outputDirectory>
                            <!--<processor>com.querydsl.mongodb.morphia.MorphiaAnnotationProcessor</processor>-->
                            <processor>org.springframework.data.mongodb.repository.support.MongoAnnotationProcessor</processor>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

Контроллер. Java

@RestController
@RequestMapping(value = "/api/v1/capability")
@RequiredArgsConstructor
@CrossOrigin
public class CapabilityController {

    private final CapabilityService capabilityService;
    private final CapabilityResourceAssembler capabilityResourceAssembler;

    @GetMapping(value = "/list")
    public CollectionModel<EntityModel<Capability>> getAllCapabilities() {
       List<EntityModel<Capability>> capabilities = capabilityService.listCapabilities().stream()
               .map(capability -> new EntityModel<>(capability,
                       linkTo(methodOn(CapabilityController.class).getCapabilityById(capability.getId())).withRel("getThisCapability"),
                       linkTo(methodOn(CapabilityController.class).getAllCapabilities()).withRel("getAllCapabilities")
               )).collect(Collectors.toList());
        return new CollectionModel<>(capabilities);
    }
}

Фактический ответ 

{
  "_embedded": {
    "capabilityList": [
      {
        "id": "sample",
        "techStack": "Java",
        "numOfDevelopers": 25,
        "numOfAvailableDevelopers": 10,
        "_links": {
          "getThisCapability": {
            "href": "http://localhost:8099/api/v1/capability/sample"
          },
          "getAllCapabilities": {
            "href": "http://localhost:8099/api/v1/capability/list"
          },
          "deleteThisCapability": {
            "href": "http://localhost:8099/api/v1/capability/sample"
          },
          "createCapability": {
            "href": "localhost:8099/api/v1/capability"
          }
        }
      }
    ]
  }
}

Ожидаемый ответ : 

[
  {
    "id": "sample",
    "techStack": "Java",
    "numOfDevelopers": 25,
    "numOfAvailableDevelopers": 10,
    "_links": {
      "getThisCapability": {
        "href": "http://localhost:8099/api/v1/capability/sample"
      },
      "getAllCapabilities": {
        "href": "http://localhost:8099/api/v1/capability/list"
      }
    }
  }
]

Я пытался

spring.data.rest.defaultMediaType = application / json

spring.hateoas.use-hal-as- default- json -media-type = false

Но, к счастью, я не вижу атрибута _embedded в ответе. Может кто-нибудь, пожалуйста, помогите мне определить проблему.

Я использовал spring-boot-1.5.10, прежде чем там я смогу правильно отобразить ссылки без _embedded, пожалуйста, обратитесь здесь .

Работает нормально после того, как я добавил аннотацию ниже в основной класс и если я возвращаю List

@ EnableHypermediaSupport (type = EnableHypermediaSupport.HypermediaType.HAL)

localhost : 9771 / api / v1 /ability / list

Это дает следующий результат: 

[
  {
    "capabilityId": "sample",
    "techStack": "Java",
    "numOfDevelopers": 25,
    "numOfAvailableDevelopers": 10,
    "_links": {
      "getThisCapability": {
        "href": "http://localhost:9771/api/v1/capability/sample"
      },
      "getAllCapabilities": {
        "href": "http://localhost:9771/api/v1/capability/list"
      }
    }
  }
]

К сожалению, он не работает в последней версии. Любая помощь будет очень признательна.

Ответы [ 2 ]

2 голосов
/ 28 января 2020

При использовании Spring Boot 1.5 вы полагались на ограничение Spring HATEOAS, которое привело к тому, что Jackson ObjectMapper, предназначенный для спецификации HAL c, использовался в качестве ObjectMapper для всего приложения. Это загрязнение означало, что форматирование HAL было применено к ответам, когда этого не должно было быть.

Ограничение было устранено в Spring HATEOAS 1.0, а его спецификация HAL c ObjectMapper больше не загрязняет все приложение. Если вы хотите, чтобы основное приложение ObjectMapper применило сериализацию в стиле HAL, вы можете отказаться от него, настроив его: 

@Bean
public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder,
                                 HypermediaMappingInformation mappingInformation) {
    ObjectMapper objectMapper = builder.build();
    mappingInformation.configureObjectMapper(objectMapper);
    return objectMapper;
}

Хотя я думаю, что вышеприведенное сработает, я повторю мысль о том, что Даниэль поднял в своем ответе о формате ответа и соответствии HAL спец. c.

2 голосов
/ 25 января 2020

Если я правильно понимаю спецификацию HAL , это будет недействительным HAL, поэтому Spring HATEOAS не будет выдавать этот результат, пока вы вернете CollectionModel в своем запросе. Помните, что для коллекции также могут быть ссылки, которые будут рядом со свойством _embedded в свойстве _links, как показано в этом примере документа .

In Если вы действительно хотите избавиться от свойства _embedded и создать список EntityModel<T> s, то это должно сработать, если вы измените свой код так, чтобы он возвращал List<EntityModel<Capability>>. После этого вы потеряете свойства _embedded и _links, созданные Spring HATEOAS. Вот ваш измененный фрагмент кода: 

@RestController
@RequestMapping(value = "/api/v1/capability")
@RequiredArgsConstructor
@CrossOrigin
public class CapabilityController {

    private final CapabilityService capabilityService;
    private final CapabilityResourceAssembler capabilityResourceAssembler;

    @GetMapping(value = "/list")
    public List<EntityModel<Capability>> getAllCapabilities() {
       List<EntityModel<Capability>> capabilities = capabilityService.listCapabilities().stream()
               .map(capability -> new EntityModel<>(capability,
                       linkTo(methodOn(CapabilityController.class).getCapabilityById(capability.getId())).withRel("getThisCapability"),
                       linkTo(methodOn(CapabilityController.class).getAllCapabilities()).withRel("getAllCapabilities")
               )).collect(Collectors.toList());
        return capabilities;
    }
}

Я настоятельно советую вам не делать этого, поскольку вы потеряете преимущества Spring HATEOAS.

Кроме того, я рекомендую использовать ваши CapabilityResourceAssembler и создайте EntityModel<Capability> экземпляры, используя capabilityResourceAssembler.toModel(...), чтобы вам не приходилось повторять код, который вы реализовали в функции .map(...).

...