REST接口开发中怎么使用 Spring HATEOAS 构建超媒体接口

雨婷君_4029

雨婷君_4029

2026-09-25

882人浏览

原创

spring hateoas通过representationmodel封装资源并自动生成hal格式链接,提升api自描述性与可演进性;支持类型安全链接构建、动态状态关联操作链接及语义化扩展。

rest接口开发中怎么使用 spring hateoas 构建超媒体接口

在 REST 接口开发中使用 Spring HATEOAS,核心是让每个资源响应自带可操作的链接(links),而不是让客户端硬编码 URL。它不增加接口复杂度,但显著提升 API 的自描述性、可发现性和长期演进能力。

定义资源模型并继承 RepresentationModel

Spring HATEOAS 推荐用 RepresentationModel(或其子类如 EntityModel、CollectionModel)封装业务数据,而非直接返回原始实体。

  • 创建资源类时,继承 RepresentationModel<yourresourceclass></yourresourceclass>,例如:
    public class BookResource extends RepresentationModel<bookresource> { ... }</bookresource>
  • 这样自动获得 add(Link...) 方法,方便注入超媒体链接
  • 若需嵌套资源(如订单含多个商品),可用 CollectionModel<entitymodel>></entitymodel> 组织结构

用 ControllerLinkBuilder 生成类型安全链接

避免拼接字符串 URL,Spring 提供基于控制器方法的静态链接构建方式,支持编译期检查和重构安全。

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • 调用 linkTo(methodOn(BookController.class).getBookById(1L)).withSelfRel() 生成 self 链接
  • 用 slash("books").slash(1L).withRel("book") 构建非控制器路径链接(如关联资源)
  • 支持动态参数:用 methodOn(...).search(null) 占位,再通过 .expand(Map.of("q", "spring")) 补全

统一返回 HAL 格式并启用自动链接注入

Spring HATEOAS 默认输出 HAL(application/hal+json),需确保配置正确并启用自动资源装配。

  • 在 application.properties 中添加:
    spring.hateoas.use-hal-as-default-json-media-type=true
  • 添加依赖:spring-boot-starter-hateoas(Spring Boot 2.6+ 已内置)
  • 控制器方法返回 EntityModel<book></book> 或 CollectionModel<entitymodel>></entitymodel>,框架会自动注入 _links 字段
  • 如需自定义链接关系名,可用 @Relation(collectionRelation = "books", itemRelation = "book") 注解实体类

按业务语义添加操作型链接(非仅 self)

HATEOAS 的价值不仅在于“我能访问自己”,更在于“接下来我能做什么”。比如订单状态变化时,只暴露当前合法操作。

  • 根据资源状态动态添加链接:
    若订单为 PROCESSING,添加 cancel 和 payment 链接;若已 SHIPPED,则只保留 track
  • 用 Link.of("/orders/12345", "cancel").withType("application/json").withTitle("取消订单") 增强语义
  • 配合 HTTP 方法提示(虽非 HAL 标准,但可通过扩展字段或自定义 media type 支持)

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

2151

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

417

25

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

60

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

20

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

20

15

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

2026.09.22

20

12

Conan二进制包配置指南
Conan二进制包配置指南

本专题介绍Conan根据操作系统、编译器、架构和构建类型生成二进制包的方法,讲解Profile、Settings、Options及Package ID的作用,帮助管理不同平台和编译环境下的包版本。

2026.09.22

20

13

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

2026.09.22

20

19

loomy官网入口地址合集
loomy官网入口地址合集

本专题汇总了 Loomy 桌面 AI 助理的官方入口地址合集及使用指南。提供 macOS 与 Windows 客户端下载 。Loomy 是讯飞推出的桌面级 AI 工作搭子,支持文件整理、数据分析、网页操作及通过飞书/钉钉远程操控电脑,助你高效完成本地办公任务 。

2026.09.22

20

19

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习