统一响应结果vo 全局异常处理器 统一返回

最新推荐文章于 2024-06-02 14:06:36 发布
最新推荐文章于 2024-06-02 14:06:36 发布
阅读量277 收藏 1
点赞数
文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/tanwu1/article/details/134896286
版权

springboot2 项目 统一响应结果vo 返回类3个基础参数，一个code，一个msg，一个data，data就用来做具体返回的内容，用泛型，想返回啥就返回啥；

在 Spring Boot 项目中，你可以创建一个统一的响应结果类（VO），其中包含了三个基础参数：code、msg、data。你可以使用泛型来表示data字段的类型，以便实现灵活的数据返回。

以下是一个简单的示例代码：

public class ApiResponse<T> {
    private int code;
    private String msg;
    private T data;

    public ApiResponse() {
        // 默认构造函数
    }

    public ApiResponse(int code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    // 省略 getter 和 setter 方法

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

    public static <T> ApiResponse<T> error(int code, String msg) {
        return new ApiResponse<>(code, msg, null);
    }
}

在这个示例中，ApiResponse 类包含了一个带有泛型的data字段，用于表示具体的返回内容。类中提供了两个静态方法 success 和 error，用于创建成功和错误的响应对象。

在控制器（Controller）中，你可以使用这个响应对象来统一返回结果：

@RestController
@RequestMapping("/api")
public class MyController {

    @GetMapping("/example")
    public ApiResponse<String> getExample() {
        String exampleData = "Hello, World!";
        return ApiResponse.success(exampleData);
    }

    @GetMapping("/error")
    public ApiResponse<?> handleError() {
        return ApiResponse.error(500, "Internal Server Error");
    }
}

在这个例子中，getExample 方法返回一个成功的响应，包含了字符串类型的数据。handleError 方法返回一个错误的响应，不包含具体的数据。根据需要，你可以在不同的控制器方法中使用不同的泛型类型。
前端根据code写返回逻辑，正常code是0，不是0的全是异常

springboot2 用 ResponseBodyAdvice 实现统一响应数据格式ApiResponse

Spring MVC 切面 ResponseBodyAdvice 对响应/返回值增强、API接口数据统一格式返回-CSDN博客
https://blog.csdn.net/wangmx1993328/article/details/81054474/

在 Spring Boot 中，你可以使用 ResponseBodyAdvice 接口来实现统一响应数据格式，将响应的数据包装成 ApiResponse 对象。ResponseBodyAdvice 接口提供了在响应体写入之前和之后执行的方法，使你能够对响应进行处理。

以下是一个简单的示例，演示如何使用 ResponseBodyAdvice 实现统一响应数据格式：

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

@ControllerAdvice
public class ApiResponseAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        // 确保只有返回类型为 ApiResponse 时才执行 beforeBodyWrite 方法
        return !ResponseEntity.class.isAssignableFrom(returnType.getParameterType());
    }

    @Override
    public Object beforeBodyWrite(
            Object body,
            MethodParameter returnType,
            MediaType selectedContentType,
            Class selectedConverterType,
            ServerHttpRequest request,
            ServerHttpResponse response) {

        // 如果返回类型是 ApiResponse，则直接返回
        if (body instanceof ApiResponse) {
            return body;
        }

        // 对其他返回类型进行包装
        if (body instanceof String) {
            // 如果是字符串类型，则包装成 ApiResponse
            return ApiResponse.success(body);
        } else {
            // 对其他类型进行包装
            return ApiResponse.success(body);
        }
    }
}

在上述代码中，ApiResponseAdvice 类实现了 ResponseBodyAdvice 接口。supports 方法用于确定是否应该执行 beforeBodyWrite 方法。在 beforeBodyWrite 方法中，我们检查响应的数据类型，如果是 ApiResponse 类型则直接返回，否则将其包装成 ApiResponse 对象。

请注意，上述示例中的包装逻辑可能需要根据你的实际需求进行调整。你可以根据实际情况对不同类型的响应进行不同的包装处理。

ResponseBodyAdvice 2个方法的详细用法

ResponseBodyAdvice 接口是 Spring 框架提供的用于处理响应体的拦截器接口，主要用于在返回响应之前和之后对响应体进行修改或处理。该接口包含两个方法：supports 和 beforeBodyWrite。

1. supports 方法

boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType);

supports 方法用于判断是否应该执行 beforeBodyWrite 方法。通常，你可以在这个方法中根据条件判断是否需要对响应进行处理。如果返回 true，则执行 beforeBodyWrite 方法；如果返回 false，则不执行。

例如，你可以通过判断返回类型、请求头等条件来决定是否进行处理：

@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
    // 判断返回类型是否是需要处理的类型
    return returnType.getParameterType() == YourResponseType.class;
}

2. beforeBodyWrite 方法

T beforeBodyWrite(T body, MethodParameter returnType, MediaType selectedContentType,
    Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request,
    ServerHttpResponse response);

beforeBodyWrite 方法用于在将响应体写入到响应之前进行处理。你可以在这个方法中对响应体进行修改、包装或其他处理。该方法的返回值即为最终写入响应的响应体。

例如，你可以在这个方法中对响应体进行包装：

@Override
public ApiResponse<Object> beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
        Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request,
        ServerHttpResponse response) {

    // 对响应体进行包装
    ApiResponse<Object> apiResponse = new ApiResponse<>(200, "Success", body);
    return apiResponse;
}

在这个例子中，ApiResponse 类型用于包装响应体。

使用示例

下面是一个完整的使用示例，假设有一个统一的响应格式 ApiResponse：

@ControllerAdvice
public class ApiResponseAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        // 判断返回类型是否是需要处理的类型
        return returnType.getParameterType() == YourResponseType.class;
    }

    @Override
    public ApiResponse<Object> beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
            Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request,
            ServerHttpResponse response) {

        // 对响应体进行包装
        ApiResponse<Object> apiResponse = new ApiResponse<>(200, "Success", body);
        return apiResponse;
    }
}

在这个例子中，YourResponseType 是你希望进行处理的响应类型。如果返回的响应体类型是 YourResponseType，则在返回之前使用 ApiResponse 进行包装。这样可以实现全局的统一响应格式。

统一返回ResponseEntity 用法 示例

在 Spring Boot 中，你可以使用 ResponseEntity 类来实现统一的 HTTP 响应，该类提供了更灵活的方式来控制 HTTP 响应的状态码、头部信息和响应体。下面是一个简单的示例，演示如何使用 ResponseEntity 来实现统一的响应：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class MyController {

    @GetMapping("/example")
    public ResponseEntity<ApiResponse<String>> getExample() {
        try {
            // 执行业务逻辑
            String result = "Hello, World!";
            return ResponseEntity.ok(new ApiResponse<>(200, "Success", result));
        } catch (Exception e) {
            // 处理异常情况
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                    .body(new ApiResponse<>(500, "Internal Server Error", null));
        }
    }
}

在这个例子中，ApiResponse 是一个自定义的响应体类，用于表示统一的响应格式。MyController 类中的 getExample 方法返回一个 ResponseEntity<ApiResponse<String>> 类型的响应。

  • ResponseEntity.ok() 方法表示响应状态码为 200。
  • ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR) 方法表示响应状态码为 500。

你可以根据业务逻辑的成功与否选择不同的状态码，并根据需要设置响应头和响应体。

此外，如果你希望在全局处理异常并返回统一格式的响应，你可以使用全局异常处理器（@ControllerAdvice 和 @ExceptionHandler）。以下是一个简单的全局异常处理器的示例：

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(Exception.class)
    public ResponseEntity<ApiResponse<Object>> handleException(Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                .body(new ApiResponse<>(500, "Internal Server Error", null));
    }
}

这个全局异常处理器捕获所有的异常，并返回一个状态码为 500 的统一格式的响应。你可以根据实际需求进一步优化异常处理。

powerTan01
关注
通过切面注解方式处理返回实体类VO对象，实现数据类型空值转换目标数值方式
gaojian2213的博客
05-21 1039
有些时候我们在通过代码返回VO实体类的时候，可能需要的结果不是我们想要的，例如： String类型的null返回前端变为""; Integer或者BigDecimal等类型中null变为 -1； 那么这种我们如何处理，如何实现呢？ 我们可以通过在相应VO类中加注解的方式来进行数据类型判断，最终实现不同的数据类型转换不同的结果， 代码如下: 增加类注解接口 @Retention(RetentionPolicy.RUNTIME) @Target(value = {ElementType.TYPE}) @Docu
统一vo类
愿世界和平
08-11 372
统一vo类 package com.mmall.common; import org.codehaus.jackson.annotate.JsonIgnore; import org.codehaus.jackson.map.annotate.JsonSerialize; import java.io.Serializable; /** * Created by geely */ @J...
request和response
Zkuzma的博客
02-18 170
response&request 一、ServletContext 1. ServletContext介绍 讲解 ServletContext介绍 ServletContext：Servlet上下文对象。它是把一个web应用的信息对象。当Tomcat启动时，会把web应用的信息封装成一个ServletContext对象 ServletContext特性： 一个web应用里：只有一个Se...
响应ResponseVo
weixin_63164764的博客
06-02 187
ResponseVo 是统一返回前端封装VO类型结果集定义
系统返回值VO对象
weixin_50029329的博客
09-25 801
package com.jt.vo; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; import lombok.experimental.Accessors; import java.io.Serializable; /**系统返回值对象*/ @Data @Accessors(chain = true) //链式加载 @NoArgsConstructor @AllArgsCo
SpringBoot中通用响应VO类
fxtxz2的专栏
06-07 325
【代码】SpringBoot中通用响应类。
用SpringCloud Alibaba搭建属于自己的微服务(十)~基础搭建~自定义异常、统一结果集和全局异常处理器
theOldCaptain的博客
07-15 1012
一.自定义异常体系 1.背景 在业务代码的开发中,往往会有这种情况,代码逻辑走到某一步,通过if的判断发现程序的逻辑无法继续往下面走了,否则会有一定的问题,这时候我们需要抛出异常组织程序往下进行,快速响应这个请求,并且回滚事物,这就是我们的自定义异常体系. 2.设计 如何设计自定义异常体系,需要我们对自身系统的业务有一定的了解,例如一个商城,可能会有以下的自定义异常. 异常 场景 OrderException.class 订单业务发生异常 PayException.class 支付业务发
Springboot接口返回值的统一格式
码农米格的博客
10-12 1640
springboot 默认情况下的返回数据类型包括以下几种： String型 ：返回字符串 @GetMapping(value="/getstr/{id}") public String getstr(@PathVariable("id") Integer id){ ... return "index"; } Object型：返回一个Json表示对象 @GetMapping(value="/getObject") public UserVO getObject(){ U..
Day14-数据的自动填充+用户修改/回显/更新/删除操作+事务+全局异常的处理机制+商品分类业务
weixin_58678891的博客
08-12 876
1. 数据的自动填充 2 用户修改–数据回显 3 数据更新操作 4 用户删除 5 事务 6 全局异常的处理机制 7.商品分类业务实现 8.商品分类列表实现
SpringMVC之参数检验篇
pongandnoon的博客
09-17 1965
项目开发中我们经常需要对接口参数进行检验，有些参数必须有值，有些参数比如手机号，身份证号必须符合一定的格式规范。如果把参数检验都写在业务代码中，会造成业务代码又长又杂，且每个接口都得去校验，影响开发效率以及代码质量。有没有方法可以把参数检验统一在一个地方进行，不对我们的业务代码进行干扰呢？ SpringMVC给我们提供了一些支持数据校验的注解，如@NotNull,@NotBlank,@Lengt...
ApiResponseVo.java
04-15
public class ApiResponseVo { //响应的业务的状态码, SUCCESS 表示成功, ERROR 表示业务失败 private String code = ""; //状态码的描述 private String codeDesc = ""; //用来装具体数据 private Object data = "";
impulseest: 用Python进行非参数脉冲响应估计的软件包研究-圣卡塔琳娜州立大学和南里奥格兰德联邦大学.
HH∞软件X 15（2021）100761原始软件出版物impulseest：一个用于输入输出数据的非参数脉冲响应估计的Python包Luan Vinícius Fiorioa，Cheros，Chrystian Lenon Remesb，Yales Rômulo de Novaesaa圣卡塔琳娜州立...
通过SQL直接返回VO
Aozorai2的博客
12-15 536
ISjkSQLHelper参考http://blog.csdn.net/aozorai2/article/details/53580055 public static E[] getVosBySQL(String sql,Class c) throws Exception { ISjkSQLHelper helper = NCLocator.getInstance().lookup(I
Java编写的实体返回VO工具
dituirenwu的博客
01-22 445
所以我最近写了一个小工具 就是实体转换VO对象的一个小工具 说到这里 如果你的第一反应是 Spring的BeanUtils 那说明你肯定也有遇到过跟我一样的问题。现在有这样的一个需求 需要返回一个 List 如果你能想到用 java8的lambda表达式的去使用Spring的BeanUtils 那也是不错的。以上就是Java编写的实体返回VO工具的详细内容，更多关于Java 实体返回VO工具的资料请关注我们其它相关文章！BeanUtils 是有局限性的 你必须保证 实体的字段值和返回的VO字段值是一样的。
SpringBoot实现统一返回值+全局异常处理
weixin_60523038的博客
05-09 531
SpringBoot统一封装返回结果,SpringBoot封装全局异常处理
实体类转化为VO返回给前端的方法
吹灭读书灯 一身都是月的博客
04-07 5141
返回给前端的时候，我以前一直都是直接用实体类entity直接返回的。但是到后面我越来越发现这样子很不方便： 比如这个实体类中有许多属性我不想返回给前端，那我只好写个null； 我要一次查询多张表，返回许多数据的话，就肯定只能多去封装一个大类，也就是VO类 其实这里的方法有几种，最普通的及时一个个set了： 以遍历集合为例： ①遍历出来后取出每个元素，一个个set后再添加到新的集合里 //类型 List<PhoneCategory> phoneCategoryList = ph
SpringMVC中使用restful（返回ResponseVo）
shilihuakai的博客
10-19 4135
1，添加依赖:jackson负责实现Java对象和json字符串之间的相互转换。 <!--配置jackson依赖负责Java对象和json字符串之间的转换--> <dependency> <groupId>com.fasterxml.jackson.core</groupId> ...
request中参数转化成VO
东北很冷
03-10 3750
request中参数转化成VO public class JsonToBean { public static Object toBean(HttpServletRequest request,Class beanClass){ Map parameterMap = request.getParameterMap(); JSONObject json = new JSONObject(
Spring Boot 统一返回前端封装VO类型结果集定义
qq_44035485的博客
11-04 1463
现在大部分项目都是前后端分离的项目,为了统一管理,后端需要对数据进行封装对应的VO数据,什么是Vo我就不叙述了,这里贴出我自己的VO封装类,项目的故障码并没有定义太多,所以也没有定义枚举类型,供大家参考: import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import lombok.AllArgsConstructor; import lombok.Data; import lomb
springboot 返回Vo Long转String
最新发布
09-11
在Spring Boot项目中，返回Vo（Value Object）对象转为String通常是指将Java对象转换为JSON格式的字符串，以便于前端的调用和展示。 在Spring Boot中，通常会使用`@RestController`注解的控制器（Controller）方法...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值