脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → HATEOAS

SpringBoot中的HATEOAS详情

 更新时间：2022年05月17日 08:31:18   作者：​ 程序那些事   ​  
这篇文章主要介绍了SpringBoot中的HATEOAS详情，SpringBoot提供了HATEOAS的便捷使用方式，文章围绕主题展开详细介绍内容，需要的小伙伴可以参考一下

简介

SpringBoot提供了HATEOAS的便捷使用方式，本文详细讲解SpringBoot提供的这些基本方法。

链接Links

HATEOAS的一个非常重要的特征就是在resources资源中包含超媒体，而超媒体最简单的表示就是链接。

Spring HATEOAS为我们简化了封装Links的功能。

我们看一个HTML中的link标签的例子：

<head>
<link rel="stylesheet" type="text/css" href="theme.css" rel="external nofollow"  />
</head>

可以看到一个link有两个比较重要的属性，一个是href代表link的链接，还有一个属性是rel表示的当前文档与被链接文档之间的关系。

我们看下Link中的关键方法：

	public static Link of(String href) {
		return new Link(href);
	}

	public static Link of(String href, String relation) {
		return new Link(href, relation);
	}

	public static Link of(String href, LinkRelation relation) {
		return new Link(href, relation);
	}

可以传入href和relation来构建一个Link对象。

看下面的例子：

Link link = Link.of("/something");
link = Link.of("/something", "my-rel")

其中LinkRelation是关联关系的一个封装接口，注意，它是一个接口，我们可以使用IanaLinkRelations中的具体实现来对其赋值，如下所示：

LinkRelation REL_SELF = IanaLinkRelations.SELF;
LinkRelation REL_FIRST = IanaLinkRelations.FIRST;
LinkRelation REL_PREVIOUS = IanaLinkRelations.PREV;
LinkRelation REL_NEXT = IanaLinkRelations.NEXT;
LinkRelation REL_LAST = IanaLinkRelations.LAST;

URI templates

上面的例子中link是指定好的，是静态的。有时候我们希望link可以根据参数进行变换，那么这样的link就是动态的link，我们可以通过定义URI模板来实现。

所以Link还可以通过UriTemplate来构建：

	public static Link of(UriTemplate template, String relation) {
		return new Link(template, relation);
	}
    public static Link of(UriTemplate template, LinkRelation relation) {
		return new Link(template, relation);
	}

UriTemplate是对URI模板的封装，我们看一个使用的例子：

Link link = Link.of("/{segment}/something{?parameter}");

Map<String, Object> values = new HashMap<>();
values.put("segment", "path");
values.put("parameter", 42);

assertThat(link.expand(values).getHref()) 
    .isEqualTo("/path/something?parameter=42");

上面的例子中，通过string来构建一个link，然后调用expand传入参数对应的map，来构建真实的href值。

除了直接使用string之外，还可以传入UriTemplate：

UriTemplate template = UriTemplate.of("/{segment}/something")
  .with(new TemplateVariable("parameter", VariableType.REQUEST_PARAM);
assertThat(template.toString()).isEqualTo("/{segment}/something{?parameter}");

Link relations

Link relations指的是link中的ref属性。代表的是当前文档与被链接文档之间的关系。Spring HATEOAS中有一个LinkRelation类来表示。

IANA（Internet Assigned Numbers Authority）预定义了一些relations，可以通过IanaLinkRelations这个类来获取，如下所示：

Link link = Link.of("/some-resource"), IanaLinkRelations.NEXT);
assertThat(link.getRel()).isEqualTo(LinkRelation.of("next"));
assertThat(IanaLinkRelation.isIanaRel(link.getRel())).isTrue();

Representation models

我们需要访问的是一个个的资源，然后需要在一个个的资源中加入link，Spring HATEOAS为我们提供了一个简单的类叫做RepresentationModel。它包含了Links和一些很方便的方法来帮助我们创建带链接的资源。

最简单的使用方法就是创建一个RepresentationModel的子类：

public class BookModel extends RepresentationModel<BookModel> {
    private final Book content;

}

我们通过add方法来对其添加link：

bookModel.add(linkTo(methodOn(BookController.class).getBook(id)).withSelfRel());

注意：在这种情况下，我们的Accept类型应该是application/hal+json。

对于简单类型，我们可以直接使用EntityModel对其进行封装：

Person person = new Person("Dave", "Matthews");
EntityModel<Person> model = EntityModel.of(person);

对于集合，可以使用CollectionModel：

Collection<Person> people = Collections.singleton(new Person("Dave", "Matthews"));
CollectionModel<Person> model = CollectionModel.of(people);

总结

上讲解的Link，URI templates，Link relations和RepresentationModel就是Spring HATEOAS的基础，掌握了他们基本上就掌握了Spring HATEOAS。

到此这篇关于SpringBoot中的HATEOAS详情的文章就介绍到这了,更多相关HATEOAS内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Spring Boot集成Spring Cache过程详解

    Spring Boot集成Spring Cache过程详解

    这篇文章主要介绍了Spring Boot集成Spring Cache过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-10-10
  • 详细讲解Java中的main()方法

    详细讲解Java中的main()方法

    在java中main()方法是java应用程序的入口方法，由此可见main方法是很重要的，那么下面这篇文章就给大家详解介绍了Java中的main()方法,需要的朋友可以参考下。
    2016-09-09
  • java多线程编程之使用runnable接口创建线程

    java多线程编程之使用runnable接口创建线程

    实现Runnable接口的类必须使用Thread类的实例才能创建线程,通过Runnable接口创建线程分为以下两步
    2014-01-01
  • java实现打字游戏小程序

    java实现打字游戏小程序

    这篇文章主要为大家详细介绍了java实现打字游戏小程序，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2020-10-10
  • Java调用MySQL存储过程并获得返回值的方法

    Java调用MySQL存储过程并获得返回值的方法

    这篇文章主要介绍了Java调用MySQL存储过程并获得返回值的方法,实例分析了java实现MySQL存储过程的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07
  • ElasticSearch不停机重建索引延伸思考及优化详解

    ElasticSearch不停机重建索引延伸思考及优化详解

    这篇文章主要为大家介绍了ElasticSearch不停机重建索引延伸思考及优化详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2023-02-02
  • 老生常谈Java网络编程TCP通信(必看篇)

    老生常谈Java网络编程TCP通信(必看篇)

    下面小编就为大家带来一篇老生常谈Java网络编程TCP通信(必看篇)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05
  • 浅入浅出的讲解Spring循环依赖问题

    浅入浅出的讲解Spring循环依赖问题

    循环依赖其实就是循环引用,也就是两个或则两个以上的bean互相持有对方,最终形成闭环,下面这篇文章主要给大家介绍了关于Spring循环依赖问题的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2021-10-10
  • java链表数据结构LinkedList插入删除元素时间复杂度面试精讲

    java链表数据结构LinkedList插入删除元素时间复杂度面试精讲

    这篇文章主要为大家介绍了java LinkedList插入和删除元素的时间复杂度面试精讲,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-10-10
  • SpringBoot校园综合管理系统实现流程分步讲解

    SpringBoot校园综合管理系统实现流程分步讲解

    这篇文章主要介绍了SpringBoot+Vue实现校园综合管理系统流程分步讲解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧
    2022-09-09

最新评论