Spring Boot REST接口开发怎么定义 RESTful 风格 URL

阿辰大大_6360

阿辰大大_6360

2026-11-13

722人浏览

原创

定义 restful 风格 url 的核心在于使用名词复数表示资源集合,并通过 http 动词区分操作类型,同时利用路径参数或查询参数处理过滤与分页。具体做法是将控制器映射到如 /api/users 这样的资源端点,在方法上使用 @getmapping、@postmapping 等注解来明确语义,确保 url 结构清晰且符合标准规范。

Spring Boot REST接口开发怎么定义 RESTful 风格 URL

如何设计用户资源的 CRUD 端点

针对用户管理场景,RESTful 设计通常将 /users 作为根资源,通过不同的 HTTP 方法实现增删改查。创建用户时使用 POST 请求,获取列表时结合查询参数进行过滤,更新单个用户则指向 /users/{id} 路径。

Spring Boot REST接口开发怎么定义 RESTful 风格 URL

package com.example.demo;

import org.springframework.web.bind.annotation.*;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

@RestController
@RequestMapping("/api/users")
public class UserController {
    private final Map<long user> userStore = new ConcurrentHashMap();
    private long idCounter = 1;

    @GetMapping
    public List<user> getUsers(@RequestParam(required = false) String name) {
        if (name == null) return new ArrayList(userStore.values());
        return userStore.values().stream()
                .filter(u -> u.getName().contains(name))
                .toList();
    }

    @PostMapping
    public User createUser(@RequestBody User user) {
        user.setId(idCounter++);
        userStore.put(user.getId(), user);
        return user;
    }

    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        return userStore.get(id);
    }

    @PutMapping("/{id}")
    public User updateUser(@PathVariable Long id, @RequestBody User user) {
        user.setId(id);
        userStore.put(id, user);
        return user;
    }

    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable Long id) {
        userStore.remove(id);
    }
}

class User {
    private Long id;
    private String name;
    // Getters and Setters omitted for brevity
    public Long getId() { return id; }
    public void setId(Long id) { this.id = id; }
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
}</user></long>

预期结果:POST /api/users 返回包含新 ID 的用户对象;GET /api/users?name=John 返回匹配的用户列表;GET /api/users/1 返回特定 ID 的用户详情。

如何处理嵌套资源与关联数据

当需要访问属于某个父资源的子资源时,应在 URL 中体现层级关系,例如 /users/{userId}/posts。这种设计保持了资源的独立性,同时清晰地表达了所有权和归属关系,避免在 URL 中使用动词如 getPostsByUserId。

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载

Spring Boot REST接口开发怎么定义 RESTful 风格 URL

package com.example.demo;

import org.springframework.web.bind.annotation.*;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

@RestController
@RequestMapping("/api/users")
public class NestedResourceController {
    private final Map<long user> users = new ConcurrentHashMap();
    private final Map<long post> posts = new ConcurrentHashMap();
    private long postIdCounter = 1;

    @GetMapping("/{userId}/posts")
    public List<post> getUserPosts(@PathVariable Long userId) {
        if (!users.containsKey(userId)) return new ArrayList();
        return posts.values().stream()
                .filter(p -> p.getUserId().equals(userId))
                .toList();
    }

    @PostMapping("/{userId}/posts")
    public Post createPostForUser(@PathVariable Long userId, @RequestBody Post post) {
        if (!users.containsKey(userId)) return null;
        post.setId(postIdCounter++);
        post.setUserId(userId);
        posts.put(post.getId(), post);
        return post;
    }
}

class Post {
    private Long id;
    private Long userId;
    private String content;
    public Long getId() { return id; }
    public void setId(Long id) { this.id = id; }
    public Long getUserId() { return userId; }
    public void setUserId(Long userId) { this.userId = userId; }
    public String getContent() { return content; }
    public void setContent(String content) { this.content = content; }
}</post></long></long>

预期结果:POST /api/users/1/posts 创建归属于用户 1 的帖子并返回其 ID;GET /api/users/1/posts 仅返回该用户的帖子列表。

基于路径参数 ID 的查找行为

在 @GetMapping("/{id}") 的定义中,Spring Boot 会将 URL 中的数字部分绑定到 @PathVariable 参数。如果传入的 ID 在存储中不存在,默认行为是返回 404 Not Found 状态码,除非代码中显式处理了空值情况并返回自定义响应。

相关文章

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

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

下载

相关标签:

spring boot

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

相关专题

更多
spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.05

711

5

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

2023.10.12

1455

7

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

2025.08.19

5766

10

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

2025.12.22

436

5

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

2025.12.24

680

18

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

2026.02.11

405

24

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

2026.02.12

391

18

Spring Boot 项目开发与实战
Spring Boot 项目开发与实战

以 Spring Boot 为核心,讲解项目的快速初始化(Spring Initializr)、自动配置与 Starter 依赖原理、配置文件(application.yml)多环境管理、RESTful API 接口开发与参数校验、MyBatis / MyBatis-Plus / Spring Data JPA 数据持久层整合、Redis 缓存集成、统一异常处理与全局响应封装、Swagger / Knife4j 接口文档生成,以及 Ma

2026.04.17

366

21

Java Spring Boot多租户架构设计与数据隔离实战
Java Spring Boot多租户架构设计与数据隔离实战

本专题聚焦 Java 企业级系统中的多租户架构设计,讲解数据隔离策略、租户路由机制、数据库分库分表方案以及权限控制模型。通过真实 SaaS 系统案例,帮助开发者构建可扩展的多租户应用架构。

2026.06.29

576

13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习