HATEOAS

HATEOAS（Hypermedia as the engine of application state）是 REST 架构风格中最复杂的约束，也是构建成熟 REST 服务的核心。它的重要性在于打破了客户端和服务器之间严格的契约，使得客户端可以更加智能和自适应，而 REST 服务本身的演化和更新也变得更加容易。在了解HATEOAS之前先来看看 REST 服务按照成熟度划分成 4 个层次：

• 第一个层次（Level 0）的 Web 服务只是使用 HTTP 作为传输方式，实际上只是远程方法调用（RPC）的一种具体形式。SOAP 和 XML-RPC 都属于此类。

• 第二个层次（Level 1）的 Web 服务引入了资源的概念。每个资源有对应的标识符和表达。

• 第三个层次（Level 2）的 Web 服务使用不同的 HTTP 方法来进行不同的操作，并且使用 HTTP 状态码来表示不同的结果。如 HTTP GET 方法来获取资源，HTTP DELETE 方法来删除资源。

• 第四个层次（Level 3）的 Web 服务使用 HATEOAS。在资源的表达中包含了链接信息。客户端可以根据链接来发现可以执行的动作。

   HATEOAS 的核心是链接，由 rel 和 href 两个属性组成。链接的存在使得客户端可以动态发现其所能执行的动作。其中属性 rel 表明了该链接所代表的关系含义

self	指向当前资源本身的链接的 rel 属性。每个资源的表达中都应该包含此关系的链接。
edit	指向一个可以编辑当前资源的链接。
item	如果当前资源表示的是一个集合，则用来指向该集合中的单个资源。
collection	如果当前资源包含在某个集合中，则用来指向包含该资源的集合。
related	指向一个与当前资源相关的资源。
rel 属性值	描述
search	指向一个可以搜索当前资源及其相关资源的链接。
first、last、previous、next	这几个 rel 属性值都有集合中的遍历相关，分别用来指向集合中的第一个、最后一个、上一个和下一个资源。

案例:

Maven依赖

<dependencies>
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>4.0.1</version>
    </dependency>

    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-web</artifactId>
        <version>5.3.22</version>
    </dependency>

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

    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.24</version>
    </dependency>

    <!-- HATEOAS 的依赖 -->
    <!-- https://mvnrepository.com/artifact/org.springframework.hateoas/spring-hateoas -->
    <dependency>
        <groupId>org.springframework.hateoas</groupId>
        <artifactId>spring-hateoas</artifactId>
        <version>1.4.5</version>
    </dependency>

    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.3.22</version>
    </dependency>

    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>5.3.22</version>
    </dependency>

    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis-spring</artifactId>
        <version>2.0.7</version>
    </dependency>

    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.9</version>
    </dependency>


</dependencies>

config层中的springMvc

@Configuration
@ComponentScan("edu.nf.demo")
@EnableWebMvc
public class SpringMvc {
}

WebInitializer

public class WebInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvc.class};
    }

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
}

entity

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    private Integer uid;
    private String  username;
}

vo

@Data
public class ResultVo<T> extends RepresentationModel {


    private Integer code;
    private T       data;
    private  String  message;

}

controller

@RestController
@RequestMapping("/api/v1")
public class Controller {


    @GetMapping("/users/{uid}")
    public ResultVo<User> getUser( @PathVariable("uid") int id){
        User use = new User(id,"user1");

        ResultVo<User> userResultVo = new ResultVo<>();

        userResultVo.setCode(HttpStatus.OK.value());
        userResultVo.setData(use);

        //添加HATEOAS
        //创建self的连接
        userResultVo.add(Link.of("http://localhost:8080/api/v1/users/uid"));
        //创建controller的连接,通过这个链接来访问所有的用户信息
        userResultVo.add(Link.of("http://localhost:8080/api/v1/users","controller"));
        return userResultVo;
    }

    @GetMapping("/users")
    public ResultVo<List<User>> listUser(){
       User user = new User(1,"user1");
       User user1 = new User(2,"ser2");
        List<User> users = Arrays.asList(user, user1);
        ResultVo<List<User>> vo= new ResultVo<>();
        vo.setCode(HttpStatus.OK.value());
        vo.setData(users);

        //添加Hateoas链接
        vo.add(Link.of("http://localhost:8080/api/v1/users"));
        //根据id,获取某个用户信息的链接
        vo.add(Link.of("http://localhost:8080/api/v1/users/uid","item"));
        //根据用户名搜索用户信息的链接
        vo.add(Link.of("http://localhost:8080/api/v1/users/name","search"));
        return vo;

    }


} 

结果:

这是第一个get中的链接的成功显示,还有一个就不一一演示了