百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程文章 > 正文

Spring Boot WebFlux中如何进行统一接口返回的封装?

qiyuwang 2024-11-26 08:01 106 浏览 0 评论

Spring Boot WebFlux是Spring 5引入的一种基于响应式编程的Web框架,适用于构建高并发、非阻塞的Web应用。WebFlux使用了异步非阻塞的编程模型,支持响应式流操作,可以在低资源占用下支持大量并发请求。它是对传统Spring MVC的补充,更适合于I/O密集型的应用场景。

在Spring Boot WebFlux中,通过实现统一的接口返回封装,可以有效的帮助我们通过规范的API返回结构来实现方便的前端相应处理结果。一般情况下,我们会定义一个统一的响应数据结构,并使用过滤器、异常处理等方式来实现这一封装,而在WebFlux中可以通过同样的方式来实现相关操作。

定义统一返回结构

首先,我们定义一个统一的响应数据结构,如下所示,通过这个类来定义统一的数据响应结构。如下所示。

public class CommonResult<T> {
    private Integer code;
    private String message;
    private T data;

    public CommonResult() {}

    public CommonResult(Integer code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    public static <T> CommonResult<T> success(T data) {
        return new CommonResult<>(200, "Success", data);
    }

    public static <T> CommonResult<T> error(String message) {
        return new CommonResult<>(500, message, null);
    }

    // Getter & Setter
}

提供了success和error的静态方法,方便在控制器中构造不同的响应。

在 Controller 层使用封装的返回结构

在WebFlux中,我们可以通过Mono或Flux来实现响应参数的返回,所以我们可以在返回的时候直接对CommonResult进行封装,如下所示。

  • Mono:表示 0 或 1 个元素的异步序列,用于处理单个返回值的场景。
  • Flux:表示 0 到 N 个元素的异步序列,用于处理多个返回值的场景。
@RestController
@RequestMapping("/api")
public class UserController {

    @GetMapping("/user/{id}")
    public Mono<CommonResult<User>> getUserById(@PathVariable Long id) {
        return userService.findById(id)
                .map(CommonResult::success)
                .defaultIfEmpty(CommonResult.error("User not found"));
    }
}

这里的 map(CommonResult::success) 会将返回的用户对象包装成 CommonResult 的成功响应,而 defaultIfEmpty(CommonResult.error("User not found")) 用于处理用户未找到的情况。

全局异常处理

为了统一处理异常情况,可以通过WebFlux的@ControllerAdvice和@ExceptionHandler注解,捕获所有异常并返回统一的响应结构。

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public Mono<CommonResult<String>> handleException(Exception ex) {
        return Mono.just(CommonResult.error("Server Error: " + ex.getMessage()));
    }

    @ExceptionHandler(ResourceNotFoundException.class)
    public Mono<CommonResult<String>> handleResourceNotFoundException(ResourceNotFoundException ex) {
        return Mono.just(CommonResult.error("Not Found: " + ex.getMessage()));
    }
}

通过这个全局异常处理类,所有未捕获的异常都会返回一个封装好的错误响应。

使用WebFilter统一处理响应

当然,除了上面的方式之外,我们还可以通过WebFilter来统一的处理所有的响应操作,需要在过滤器中判断数据响应类型,然后根据具体的需求来封装成CommonResult并进行反馈,如下所示。

@Component
public class ResponseWrapperFilter implements WebFilter {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
        return chain.filter(exchange).flatMap(response -> {
            if (response instanceof CommonResult) {
                return Mono.just(response);
            }
            return Mono.just(CommonResult.success(response));
        });
    }
}

通过这种方式,在请求经过过滤器的时候,如果响应参数不是CommonResult类型的时候,就会自动进行参数的封装,从而完成统一的响应结果的处理。

总结

在Spring Boot WebFlux中通过以上方法进行统一接口返回封装,能够使API响应更加规范、易于维护,同时也有利于前端的处理。启动应用并通过 Postman 或浏览器访问接口,可以看到所有接口的响应都遵循统一的返回结构。

相关推荐

基于Docker方式安装与部署Camunda流程引擎

1Camunda简介官网:https://docs.camunda.org/manual/7.19/installation/docker/Camunda是一个轻量级、开源且高度灵活的工作流和决策自...

宝塔Linux面板如何部署Java项目?(宝塔面板 linux)

通过宝塔面板部署Java还是很方便的,至少不需要自己输入tomcat之类的安装命令了。在部署java项目前,我还是先说下目前的系统环境,如果和我的系统环境不一样,导致部署不成功,那你可能需要去找其他资...

浪潮服务器如何用IPMI安装Linux系统

【注意事项】此处以浪潮服务器为例进行演示所需使用的软件:Chrome浏览器个人PC中需要预先安装java,推荐使用jdk-8u181-windows-x64.exe【操作步骤】1、在服务器的BIOS中...

Centos7环境Hadoop3集群搭建(hadoop集群环境搭建实验报告)

由于项目需要存储历史业务数据,经过评估数据量会达到100亿以上,在原有mongodb集群和ES集群基础上,需要搭建Hbase集群进行调研,所以首先总结一下Hadoop集群的搭建过程。一、三个节点的集群...

Hadoop高可用集群搭建及API调用(hadoop高可用原理)

NameNodeHA背景在Hadoop1中NameNode存在一个单点故障问题,如果NameNode所在的机器发生故障,整个集群就将不可用(Hadoop1中虽然有个SecorndaryNameNo...

使用Wordpress搭建一个属于自己的网站

现在开源的博客很多,但是考虑到wordpress对网站的seo做的很好,插件也多。并且全世界流量排名前1000万的网站有33.4%是用Wordpress搭建的!所以尝试用Wordpress搭建一个网站...

Centos 安装 Jenkins(centos 安装ssh)

1、Java安装查看系统是否已安装Javayumlistinstalled|grepjava...

Java教程:gitlab-使用入门(java中的git)

1导读本教程主要讲解了GitLab在项目的环境搭建和基本的使用,可以帮助大家在企业中能够自主搭建GitLab服务,并且可以GitLab中的组、权限、项目自主操作...

Dockerfile部署Java项目(docker部署java应用)

1、概述本文主要会简单介绍什么是Docker,什么是Dockerfile,如何安装Docker,Dockerfile如何编写,如何通过Dockerfile安装jar包并外置yaml文件以及如何通过do...

如何在Eclipse中搭建Zabbix源码的调试和开发环境

Zabbix是一款非常优秀的企业级软件,被设计用于对数万台服务器、虚拟机和网络设备的数百万个监控项进行实时监控。Zabbix是开放源码和免费的,这就意味着当出现bug时,我们可以很方便地通过调试源码来...

Java路径-02-Java环境配置(java环境搭建及配置教程)

1Window环境配置1.1下载...

35.Centos中安装python和web.py框架

文章目录前言1.Centos7python:2.Centos8python:3.进行下载web.py框架然后应用:4.安装好之后进行验证:5.总结:前言...

《我的世界》服务器搭建(我的世界服务器如何搭建)

1.CentOS7环境1.1更改YUM源#下载YUM源文件curl-o/etc/yum.repos.d/CentOS-Base.repohttps://mirrors.aliyun.com...

CentOS 7 升级 GCC 版本(centos7.4升级7.5)

1.GCC工具介绍GCC编译器:...

Linux安装Nginx详细教程(linux安装配置nginx)

环境准备1.因为Nginx依赖于gcc的编译环境,所以,需要安装编译环境来使Nginx能够编译起来。命令:yuminstallgcc-c++显示完毕,表示安装完成:2.Nginx的http模块需要...

取消回复欢迎 发表评论: