RESTful Web 服务详解

RESTful Web 服务是一种基于 Representational State Transfer (REST) 架构风格的 Web 服务,它利用 HTTP 协议来传输数据,支持多种数据格式如 JSON 和 XML。在 Spring 框架中,通过简单配置和注解可以轻松实现 RESTful Web 服务。在本文中,我们将介绍如何创建 RESTful 控制器,使用 @RestController 注解,处理请求和响应格式,以及处理异常的最佳实践。

创建 RESTful 控制器

RESTful 控制器用于处理 HTTP 请求并返回相应的数据。Spring 提供了一套完整的注解和工具来帮助开发者快速创建 RESTful 控制器。

使用 @RestController 注解

@RestController 注解是 Spring 提供的一个方便的注解,它结合了 @Controller@ResponseBody,简化了控制器的开发。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/api/users")
public class UserController {@GetMappingpublic List<User> getAllUsers() {// 返回所有用户return userService.findAll();}@PostMappingpublic User createUser(@RequestBody User user) {// 创建并返回新用户return userService.save(user);}
}

在这个例子中,UserController 类使用 @RestController 注解标注,表明它是一个 RESTful 控制器。@RequestMapping 注解用于定义基础 URL 路径,@GetMapping@PostMapping 分别用于处理 GET 和 POST 请求。

请求和响应格式

RESTful Web 服务常使用 JSON 和 XML 作为数据格式。Spring Boot 默认使用 Jackson 库将对象转换为 JSON 格式,也支持其他格式如 XML。

返回 JSON 格式

JSON 是 RESTful 服务中最常用的数据格式。Spring Boot 默认配置了 Jackson 作为 JSON 处理库,控制器方法返回的对象会自动转换为 JSON。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/api/products")
public class ProductController {@GetMappingpublic List<Product> getAllProducts() {return productService.findAll();}
}

在这个例子中,getAllProducts 方法返回一个 List<Product> 对象,Spring Boot 会自动将其转换为 JSON 格式的响应。

返回 XML 格式

要支持 XML 格式,需要在依赖中添加 Jackson XML 扩展:

<dependency><groupId>com.fasterxml.jackson.dataformat</groupId><artifactId>jackson-dataformat-xml</artifactId>
</dependency>

然后,在控制器方法中设置返回的媒体类型为 XML:

import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/api/products")
public class ProductController {@GetMapping(produces = MediaType.APPLICATION_XML_VALUE)public List<Product> getAllProducts() {return productService.findAll();}
}

在这个例子中,getAllProducts 方法将返回的媒体类型设置为 XML,Spring Boot 会自动将对象转换为 XML 格式的响应。

处理异常

在 RESTful Web 服务中,处理异常是确保服务可靠性和用户体验的关键。Spring 提供了 @ExceptionHandler@ControllerAdvice 注解,用于全局处理控制器中的异常。

使用 @ExceptionHandler

@ExceptionHandler 注解用于在控制器中定义特定异常的处理方法。

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/api/orders")
public class OrderController {@GetMapping("/{id}")public Order getOrderById(@PathVariable Long id) {return orderService.findById(id).orElseThrow(() -> new OrderNotFoundException("Order not found with id " + id));}@ExceptionHandler(OrderNotFoundException.class)public ResponseEntity<String> handleOrderNotFoundException(OrderNotFoundException ex) {return new ResponseEntity<>(ex.getMessage(), HttpStatus.NOT_FOUND);}
}

在这个例子中,handleOrderNotFoundException 方法使用 @ExceptionHandler 注解处理 OrderNotFoundException 异常,并返回 404 状态码和错误消息。

使用 @ControllerAdvice

@ControllerAdvice 注解用于定义全局异常处理类,统一处理多个控制器中的异常。

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;@ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(OrderNotFoundException.class)public ResponseEntity<String> handleOrderNotFoundException(OrderNotFoundException ex) {return new ResponseEntity<>(ex.getMessage(), HttpStatus.NOT_FOUND);}@ExceptionHandler(Exception.class)public ResponseEntity<String> handleGeneralException(Exception ex) {return new ResponseEntity<>(ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);}
}

在这个例子中,GlobalExceptionHandler 类使用 @ControllerAdvice 注解标注,定义了两个异常处理方法,分别处理 OrderNotFoundException 和其他所有异常。

总结

通过本文的讲解,我们了解了如何在 Spring 中创建 RESTful 控制器,使用 @RestController 注解,处理请求和响应格式(包括 JSON 和 XML),以及如何通过 @ExceptionHandler@ControllerAdvice 进行异常处理。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/863496.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

C语言中的基础指针操作

在C语言中&#xff0c;指针是一个非常重要的概念&#xff0c;它提供了直接访问内存地址的能力。指针变量用于存储内存地址&#xff0c;而不是数据值&#xff0c;在某种意义上和门牌号具有相似含义&#xff1a;指针是一个变量&#xff0c;其存储的是另一个变量的内存地址&#x…

java之动态代理

1 代理模式 代理模式提供了对目标对象额外的访问方式&#xff0c;即通过代理对象访问目标对象&#xff0c;这样可以在不修改原目标对象的前提下&#xff0c;提供额外的功能操作&#xff0c;扩展目标对象的功能。简言之&#xff0c;代理模式就是设置一个中间代理来控制访问原目标…

超级对齐是什么?

超级对齐是一个在人工智能&#xff08;AI&#xff09;领域中的概念&#xff0c;其定义和重要性可以从以下几个方面来清晰地阐述&#xff1a; 1. **定义**&#xff1a; - 超级对齐是指确保在所有领域都超越人类智能的超级人工智能&#xff08;AI&#xff09;系统按照人类的价值观…

C++标准模板(STL)- 迭代器库 - 流迭代器- 写入 std::basic_ostream 的输出迭代器(二)

迭代器库-流迭代器 迭代器库提供了五种迭代器的定义&#xff0c;同时还提供了迭代器特征、适配器及相关的工具函数。 迭代器分类 迭代器共有五 (C17 前)六 (C17 起)种&#xff1a;遗留输入迭代器 (LegacyInputIterator) 、遗留输出迭代器 (LegacyOutputIterator) 、遗留向前迭代…

网络io与select,poll,epoll

前言 网络 IO&#xff0c;会涉及到两个系统对象&#xff0c;一个是用户空间调用 IO 的进程或者线程&#xff0c;另一个是内核空间的内核系统&#xff0c;比如发生 IO 操作 read 时&#xff0c;它会经历两个阶段&#xff1a; 1. 等待数据准备就绪 2. 将数据从内核拷贝到进程或…

网络编程常见问题

1、TCP状态迁移图 2、TCP三次握手过程 2.1、握手流程 1、TCP服务器进程先创建传输控制块TCB&#xff0c;时刻准备接受客户进程的连接请求&#xff0c;此时服务器就进入了LISTEN&#xff08;监听&#xff09;状态&#xff1b; 2、TCP客户进程也是先创建传输控制块TCB&#xff…

WebSockets 完全指南:在 Postman 中测试实时通信

标题&#xff1a;WebSockets 完全指南&#xff1a;在 Postman 中测试实时通信 摘要 Postman 是 API 开发者广泛使用的工具&#xff0c;支持 RESTful API 的测试和调试。随着实时通信的兴起&#xff0c;WebSockets 协议变得日益重要。本文将详细介绍如何在 Postman 中测试 Web…

改进经验模态分解方法-通过迭代方式(IMF振幅加权频率,Python)

一种新颖的改进经验模态分解方法-通过迭代方式&#xff08;IMF振幅加权频率&#xff09;有效缓解了模态混叠缺陷&#xff0c;以后慢慢讲&#xff0c;先占坑。 import numpy as np import matplotlib.pyplot as plt import os import seaborn as sns from scipy import stats i…

【python学习】bytearray 数组

在Python中&#xff0c;bytearray 是一个可变序列&#xff0c;用于表示一个字节数组。与不可变的 bytes 类型相比&#xff0c;bytearray 允许你修改其内容。你可以通过索引来访问和修改 bytearray 中的元素&#xff0c;也可以添加或删除元素。 使用 bytearray 的一些示例&…

C语言图书管理系统控制台程序

程序示例精选 C语言图书管理系统控制台程序 如需安装运行环境或远程调试&#xff0c;见文章底部个人QQ名片&#xff0c;由专业技术人员远程协助&#xff01; 前言 这篇博客针对《C语言图书管理系统控制台程序》编写代码&#xff0c;代码整洁&#xff0c;规则&#xff0c;易读…

740. 删除并获得点数(leetcode)

740. 删除并获得点数&#xff08;leetcode&#xff09; 题目描述 给你一个整数数组 nums &#xff0c;你可以对它进行一些操作。每次操作中&#xff0c;选择任意一个 nums[i] &#xff0c;删除它并获得 nums[i] 的点数。之后&#xff0c;你必须删除 所有 等于 nums[i] - 1 和 …

目标检测算法用一个案例详细讲解

学习目标&#xff1a; 目标检测算法用一个案例详细讲解 学习内容&#xff1a; 主要以YOLO为例 YOLO 工作流程 输入图像&#xff1a; 首先&#xff0c;输入一张图像&#xff0c;该图像将被调整为固定大小&#xff08;如 416x416&#xff09;。网格划分&#xff1a; 图像被划分…

加密与安全_三种方式实现基于国密非对称加密算法的加解密和签名验签

文章目录 国际算法基础概念常见的加密算法及分类签名和验签基础概念常见的签名算法应用场景 国密算法对称加密&#xff08;DES/AES⇒SM4&#xff09;非对称加密&#xff08;RSA/ECC⇒SM2&#xff09;散列(摘要/哈希)算法&#xff08;MD5/SHA⇒SM3&#xff09; Code方式一 使用B…

智慧园区综合平台解决方案PPT(75页)

## 智慧园区的理解 ### 从园区1.0到园区4.0的演进 1. 园区1.0&#xff1a;以土地经营为主&#xff0c;成本驱动&#xff0c;提供基本服务。 2. 园区2.0&#xff1a;服务驱动&#xff0c;关注企业成长&#xff0c;提供增值服务。 3. 园区3.0&#xff1a;智慧型园区&#xff…

机器学习引领教育革命:智能教育的新时代

&#x1f4dd;个人主页&#x1f339;&#xff1a;Eternity._ &#x1f339;&#x1f339;期待您的关注 &#x1f339;&#x1f339; ❀目录 &#x1f4d2;1. 引言&#x1f4d9;2. 机器学习在教育中的应用&#x1f31e;个性化学习&#x1f319;评估与反馈的智能化⭐教学资源的优…

spring-boot-configuration-processor注释处理器

开源项目SDK&#xff1a;https://github.com/mingyang66/spring-parent 个人文档&#xff1a;https://mingyang66.github.io/raccoon-docs/#/ spring-boot-configuration-processor是springboot提供的一个注释处理器&#xff08;annotation processor&#xff09;,它用于在编译…

Python多线程Concurrent

背景 从 Python3.2 开始&#xff0c;标准库为我们提供了 concurrent.futures 模块&#xff0c;它提供了 ThreadPoolExecutor 和 ProcessPoolExecutor两个类&#xff0c;实现了对 threading 和 multiprocessing 的进一步抽象&#xff08;这里主要关注线程池&#xff09;&#x…

STC89C52RC单片机设计的FM收音机+自动搜台+存储电台(程序+原理图+PCB)

资料下载地址&#xff1a;STC89C52RC单片机设计的FM收音机自动搜台存储电台&#xff08;程序原理图PCB) 1、实物图 2、部分程序 #include <reg52.h> #include "tea5767.h" #include "delay.h" #include "lcd1602.h" //K1:上一台 K2:下一…

mac电脑游戏推荐:NBA 2K24 街机版下载

NBA 2K24 街机版是一款由2K Sports开发并发行的篮球游戏&#xff0c;属于著名的NBA 2K系列。这款游戏为玩家提供了与NBA联赛中真实球员和球队互动的机会&#xff0c;体验篮球比赛的激情与紧张。街机版的NBA 2K24通常会在游戏厅、商场等公共场所设置&#xff0c;供玩家投币游玩。…

ubuntu server的安装

官网&#xff1a;https://ubuntu.com/ 点击 Get Ubuntu,选择Server&#xff0c;点击Get Ubuntu Server,下载iso到本地。 相关资料&#xff1a; Ubuntu Server 20.04详细安装教程虚拟机安装 Ubuntu