未找到 HATEOAS 方法答案

【问题标题】：HATEOAS methods not found未找到 HATEOAS 方法
【发布时间】：2014-08-17 19:15:52
【问题描述】：

我的控制器似乎找不到像“linkTo”这样的 HATEOAS 方法。

我错过了什么吗？

pom.xml

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.springframework</groupId>
    <artifactId>provider</artifactId>
    <version>0.1.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.1.5.RELEASE</version>
    </parent>

    <dependencies>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- Spring Security -->
        <!-- Auto configured, remove dependencies to disable. -->
        <dependency>
            <groupId>org.springframework.security</groupId>
            <artifactId>spring-security-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.security</groupId>
            <artifactId>spring-security-config</artifactId>
        </dependency>

        <!-- OAuth 2.0 -->
        <dependency>
            <groupId>org.springframework.security.oauth</groupId>
            <artifactId>spring-security-oauth2</artifactId>
            <version>2.0.1.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test-mvc</artifactId>
            <version>1.0.0.M2</version>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </dependency>

        <!-- Spring MongoDB -->
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-mongodb</artifactId>
        </dependency>

        <!-- Spring REST MVC -->
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-rest-webmvc</artifactId>
        </dependency>

        <!-- Dozer: DTO/Entity Mapper -->
        <dependency>
            <groupId>net.sf.dozer</groupId>
            <artifactId>dozer</artifactId>
            <version>5.3.2</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>

        <dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
        </dependency>

    </dependencies>

    <properties>
        <start-class>com.provider.core.Application</start-class>
    </properties>

    <build>
        <plugins>
            <plugin> 
                <artifactId>maven-compiler-plugin</artifactId> 
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>spring-snapshots</id>
            <url>http://repo.spring.io/libs-snapshot</url>
            <snapshots><enabled>true</enabled></snapshots>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-snapshots</id>
            <url>http://repo.spring.io/libs-snapshot</url>
            <snapshots><enabled>true</enabled></snapshots>
        </pluginRepository>
    </pluginRepositories>
</project>

控制器

package com.provider.core;

import org.dozer.DozerBeanMapper;
import org.dozer.Mapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

import com.provider.account.Account;
import com.provider.account.AccountDTO;

@Controller
public class AccountController
{
    private static final Logger logger = LoggerFactory.getLogger(AccountController.class);
    @Autowired private AccountRepository repo;

    @RequestMapping(value = "account", method = RequestMethod.POST)
    public @ResponseBody HttpEntity<AccountDTO> createAccount(@RequestBody AccountDTO accountDto) {
        logger.info("Start createAccount()");
        Mapper mapper = new DozerBeanMapper();
        Account account = mapper.map(accountDto, Account.class);
        Account savedAccount = repo.save(account);
        AccountDTO savedAccountDto = mapper.map(savedAccount, AccountDTO.class);

        // DOES NOT COMPILE "linkto" not defined.
        savedAccountDto.add(linkTo(AccountController.class).slash(savedAccountDto.getId()).withSelfRel());

        return new ResponseEntity<AccountDTO>(savedAccountDto, HttpStatus.OK);
    }
}

【问题讨论】：

首先将org.springframework.hateoas:spring-hateoas:0.15.0.RELEASE 添加到您的pom.xml，然后添加import static org.springframework.hateoas.mvc.ControllerLinkBuilder.*。
那行得通。我会发誓我的 pom.xml 中有 HATEOAS 依赖项。为什么不把它作为答案，我会接受的。谢谢。

标签： spring-boot spring-hateoas

【解决方案1】：

如果您使用的是 HATEOAS v1.0 及更高版本（Spring boot >= 2.2.0），请注意类名已更改。值得注意的是，以下类已重命名：

ResourceSupport 更改为 RepresentationModel
Resource改为EntityModel
Resources改为CollectionModel
PagedResources 更改为 PagedModel
ResourceAssembler改为RepresentationModelAssembler

更多信息请参见官方文档here。

使用 Spring boot starter 时，以下依赖项足以包含 HATEOAS：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-hateoas</artifactId>
</dependency>

希望这些信息能帮助像我这样搜索了几个小时以找到Resource 类没有得到解决的原因的人。

【讨论】：

谢谢！我以为我要疯了。每个教程都提到 Resource 作为导入，但我永远无法在我的类路径中找到该类。那么，截至 2019 年 12 月，所有教程似乎都已过时。
spring.io/guides/tutorials/rest 最近升级为使用此版本。
以及 import org.springframework.hateoas.hal.Jackson2HalModule 的新替代名称是什么；上课？
ResourceProcessor 怎么了？

【解决方案2】：

看起来您的 POM 缺少 spring-hateoas 依赖项。

所以首先将这个添加到 pom.xml：

<dependency>
    <groupId>org.springframework.hateoas</groupId>
    <artifactId>spring-hateoas</artifactId>
    <version>0.15.0.RELEASE</version>
</dependency>

然后你可以添加这个静态导入并且你的代码应该可以编译：

import static org.springframework.hateoas.mvc.ControllerLinkBuilder.*

【讨论】：

superEb 是对的！仅供参考 - 在 gradle 中是：依赖项 { compile 'org.springframework.hateoas:spring-hateoas' }
Hateos1.0.m1有不少改动，参考这个link
那么 import org.springframework.hateoas.hal.Jackson2HalModule;班级？什么是新的更改名称？
如果你不知道哪个版本和你的spring boot版本兼容，就不要加上版本号（gradle例子：implementation 'org.springframework.hateoas:spring-hateoas'）。 Spring 会自己选择合适的。

【解决方案3】：

如果您在 eclipse 中使用 HATEOAS（版本：Oxygen.3a Release (4.7.3a)），请注意类名已更改。

Resource changed to EntityModel
Resources changed to CollectionModel

更多信息可在以下链接的官方文档中找到 ->

https://docs.spring.io/spring-hateoas/docs/current/reference/html/

使用 Spring boot starter 时，您必须使用以下依赖项来包含 HATEOAS：

 <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-hateoas</artifactId>
 </dependency>

演示代码：

EntityModel<Users> resource = new EntityModel<Users>(user);
        ControllerLinkBuilder linkTo = linkTo(methodOn(this.getClass()).retrieveAllUsers());
        resource.add(linkTo.withRel("all-users"));

注意：你必须导入

import static org.springframework.hateoas.server.mvc.ControllerLinkBuilder.*;

希望这些信息有助于找出 Resource 类没有得到解决的原因！！

【讨论】：

【解决方案4】：

在 pom.xml 中添加下面的依赖，它可以解决你的问题。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-hateoas</artifactId>
</dependency>

如果上述方法不起作用，那么使用旧版本的 hatos 可以轻松解决。

由于新版本的 Hateoas 已经完全改变，下面的链接可以帮助你。 https://docs.spring.io/spring-hateoas/docs/current/reference/html/

我提到了 Hateoas 方法的一些重大变化

ResourceSupport is now RepresentationModel

Resource is now EntityModel

Resources is now CollectionModel

PagedResources is now PagedModel

LinkDiscoverer API 已移至客户端包。

LinkBuilder 和 EntityLinks API 已移至服务器包。

ControllerLinkBuilder 已移至 server.mvc 中并已弃用以替换为 WebMvcLinkBuilder。

RelProvider 已重命名为 LinkRelationProvider 并返回 LinkRelation 实例而不是字符串。

VndError 已移至 mediatype.vnderror 包

【讨论】：

【解决方案5】：

    Add following dependency :-

    <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-hateoas</artifactId>
     <version>2.4.0</version>
    </dependency>
    
    Follow Sample Code :-
    import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.*;
   
    @GetMapping(path = "/users/{id}")
    public EntityModel<User> getUserInfo(@PathVariable int id) {
        User user = userDao.getUser(id);
        
        EntityModel<User> entityModel = EntityModel.of(user);
        Link link = WebMvcLinkBuilder.linkTo(methodOn(this.getClass()).getUserList()).withRel("user-list");
        entityModel.add(link);
        
        if(user == null) {
            throw new UserNotFoundException("User not found with id : "+id);
        }
        return entityModel;
    }

【讨论】：

【解决方案6】：

最近的版本（2.2.0 或 >）有一些命名变化。参考this document

【讨论】：

【解决方案7】：

我会把它留在这里，以防有人需要它：

ControllerLinkBuilder 已被弃用，您应该改用 WebMvcLinkBuilder（检查此 https://docs.spring.io/spring-hateoas/docs/1.0.0.M1/apidocs/org/springframework/hateoas/server/mvc/ControllerLinkBuilder.html）

所以如果：

import static org.springframework.hateoas.server.mvc.ControllerLinkBuilder.*;

使用这个：

import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.*;

【讨论】：

【解决方案8】：

这个问题发生在我的案例中，因为有两个 hatoas jar 一个具有资源接口，另一个具有具有相同 groupId 和 arifactId 的 implementationaion。解决这个问题 --> 如果您使用的是 4.*，请将您的 STS 降级为 3.* 如果您使用的是 Spring Boot，请添加以下依赖项

     <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-hateoas</artifactId>
    </dependency>

添加此依赖项后，在 pom.xml 所在的命令提示符下运行以下命令

mvn 全新安装包
mvn eclipse:eclipse

此步骤为我解决了问题。

【讨论】：

以下是How do I write a good answer? 的一些指南。提供的这个答案可能是正确的，但它可以从解释中受益。仅代码答案不被视为“好”答案。来自review。

【解决方案9】：

可能对某些人有帮助，我看到这里没有解决的一件事，几个 cmets 要求这样做：

Cannot resolve symbol 'hal'
Cannot resolve symbol 'Jackson2HalModule'

hal 模块现在在媒体下。所以

org.springframework.hateoas.hal.Jackson2HalModule

现在替换为

org.springframework.hateoas.mediatype.hal.Jackson2HalModule

【讨论】：

【解决方案10】：

需要以下导入

import org.springframework.hateoas.EntityModel;
import org.springframework.hateoas.Link;
import org.springframework.hateoas.server.mvc.WebMvcLinkBuilder;

从WebMvcLinkBuilder 静态导入所有方法

【讨论】：