Springboot 统一响应消息处理

最新推荐文章于 2024-09-12 08:13:29 发布
最新推荐文章于 2024-09-12 08:13:29 发布
阅读量1.2k 收藏 4
点赞数 1
分类专栏： Java框架 【SpringBoot】 文章标签： java http Springboot
原创声明：本文为博主 言小溪 的博文，未经博主允许不得转载！
本文链接：https://blog.csdn.net/qq_31254489/article/details/119772338
版权

目录

普通返回类型处理

  • 使用统一响应消息处理，我们可以不用在每个函数的返回值写上特殊的类型对象， 直接写基础类型，或者封装类型都可以。

直接上代码：
1.首先得使用 fastjson 作为统一消息转换器

@Configuration

public class GlobalConfigimplements WebMvcConfigurer {
    /**
     *  配置消息转换器
     *
     * @return: void
     */
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {

        FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
        // 设置默认编码
        converter.setDefaultCharset(StandardCharsets.UTF_8);
        // 设置类型
        converter.setSupportedMediaTypes(Collections.singletonList(MediaType.APPLICATION_JSON));
        // 清除所有转换器
        converters.clear();
        converters.add(converter);
    }
}

2.定义格式化返回类

@Data
@ApiModel("统一数据返回模型")
public class Result<T> {

    @ApiModelProperty(value = "响应值")
    private int status;

    @ApiModelProperty(value = "请求是否成功")
    private boolean success;

    @ApiModelProperty(value = "响应信息")
    private String msg;

    @ApiModelProperty(value = "响应数据")
    private T data;
}

3.创建统一响应处理注解

/**
 * 统一响应处理注解
 * @author: enncy
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ResponseHandler {
}

4.在你想要处理的类上面增加注解
在这里插入图片描述

5.使用 RestControllerAdvice环绕增强，同时继承 ResponseBodyAdvice，处理响应信息

@Slf4j
@RestControllerAdvice
public class ResponseInterceptor implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {

        Result<Object> result = new Result<>();
        // 设置响应码
        result.setStatus(200);
        Method method = methodParameter.getMethod();
        if (method == null) {
            return o;
        } else {
            // 如果存在 Api 注释，则返回注释和其他信息，否则返回简单的"请求" 描述 请求成功或者失败
            String preMsg = Optional.ofNullable(method.getAnnotation(ApiOperation.class)).map(ApiOperation::value).orElse("请求");
            //设置响应信息
            result.setMsg( preMsg + "成功");
            // 设置响应数据
            result.setData(o);
            result.setSuccess(o!=null);
            return result;
        }
    }
}

异常返回类型处理

  • 将一个空的 ErrorController 接口当做 Bean，以便可以覆盖 Spring boot 的默认异常处理
  • 然后在Spring 配置类中实现 ErrorPageRegistrar 接口将指定的异常信息传递到每个异常接口上。
  • 最后指定一个规则，如果函数的返回值是 Throwable 或者子类，我们当做异常信息处理

1.封装错误的请求响应码
复制粘贴这篇文章的工具类 HttpErrorStateConverter 即可
https://blog.csdn.net/qq_31254489/article/details/119772129

2.配置错误页面

@Configuration
public class GlobalConfig  implements ErrorPageRegistrar {
    /**
     * 配置错误页面
     *
     * @return: org.springframework.boot.web.servlet.error.ErrorController
     */
    @Override
    public void registerErrorPages(ErrorPageRegistry registry) {
        registry.addErrorPages(Arrays.stream(HttpErrorStateConverter.values())
                .map(c->c.status)
                .map(s->new ErrorPage(s, "/error?status=" + s.value()))
                .toArray(ErrorPage[]::new));
    }
}

**3.创建一个异常控制器 MyErrorController **

  • 只要实现了 ErrorController 接口， Springboot 的默认错误页面就会被移除。
@RestController
@ResponseHandler
public class MyErrorController implements ErrorController {

    @RequestMapping("/error")
    public String handle(@RequestParam("status") int status) {
  
        HttpStatus httpStatus = HttpStatus.resolve(status);
        if (httpStatus != null) {
            // 返回转换过的响应信息
            HttpErrorStateConverter resolver = HttpErrorStateConverter.resolve(httpStatus.value());
            return resolver == null ? httpStatus.toString() : resolver.description;
        } else {
            // 返回 404 信息
            return HttpErrorStateConverter.NOT_FOUND.description;
        }
    }
}

4.最后修改我们的 ResponseInterceplter

@Slf4j
@RestControllerAdvice
public class ResponseInterceptor implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }

    @Autowired
    HttpServletResponse response;

    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
    	// 通过相应码去判断是否为错误信息
        HttpStatus status = Optional.ofNullable(HttpStatus.resolve(response.getStatus())).orElse(HttpStatus.NOT_FOUND);

        Result<Object> result = new Result<>();
        // 设置响应码
        result.setStatus(response.getStatus());
        boolean error = status.isError();
        // 设置请求是否成功
        result.setSuccess(!error);
 
        if (error) {
            // 响应数据置空
            result.setData(null);
            // 响应错误信息
            result.setMsg(o.toString());
            return result;
        } else if (methodParameter.getDeclaringClass().isAnnotationPresent(ResponseHandler.class)) {

            Method method = methodParameter.getMethod();
            if (method == null) {
                return o;
            } else {
                // 如果存在 Api 注释，则返回注释和其他信息，否则返回简单的"请求" 描述 请求成功或者失败
                String preMsg = Optional.ofNullable(method.getAnnotation(ApiOperation.class)).map(ApiOperation::value).orElse("请求");
                //设置响应信息
                result.setMsg(preMsg + "成功");
                // 设置响应数据
                result.setData(o);

                System.out.println(result);

                return result;
            }

        } else {
            return o;
        }
    }
}

处理服务器内部错误

只要配置好之前的东西，做这个就很简单
只需要修改我们的 MyErrorController
添加一个 @RestControllerAdvice 环绕增强注解
然后添加 @ExceptionHandler 注解到我们的方法上去处理异常即可

@RestController
@ResponseHandler
@RestControllerAdvice
@Api(tags = "統一错误请求控制")
public class MyErrorController implements ErrorController {

    /**
     *  1.处理指定的抛出异常 ， 这里不要指定 Exception ， 范围太大， 很多东西不好处理
     *  2.设置响应码为 500  —— @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
     * @return: java.lang.String
     */
    @ExceptionHandler(value = {HttpMessageNotReadableException.class})
    @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
    public String error(HttpMessageNotReadableException e, HttpServletResponse response){
        return findCause(e).getMessage();
    }

    /*
     *  递归查找原因
     */
    public <T extends Throwable> Throwable findCause(T throwable){
        return throwable.getCause() != null ? findCause(throwable.getCause()) : throwable;
    }

    public <T extends Throwable> Throwable findCause(T throwable){
        return throwable.getCause() != null ? findCause(throwable.getCause()) : throwable;
    }


    @RequestMapping(value = "/error", method = {RequestMethod.GET, RequestMethod.POST})
    @ApiOperation("错误显示")
    public String handle(@RequestParam("status") int status) {

        HttpStatus httpStatus = HttpStatus.resolve(status);
        if (httpStatus != null) {
            // 返回转换过的响应信息
            HttpErrorStateConverter resolver = HttpErrorStateConverter.resolve(httpStatus.value());
            return resolver == null ? httpStatus.toString() : resolver.description;
        } else {
            // 返回 404 信息
            return HttpErrorStateConverter.NOT_FOUND.description;
        }
    }
}

测试

测试服务器内部错误
在这里插入图片描述

在这里插入图片描述

测试 404
在这里插入图片描述

测试请求方法不允许

在这里插入图片描述

言小溪
关注
专栏目录
【SpringBoot笔记18】SpringBoot实现统一异常处理、统一结果响应、统一参数校验
✅ Java 开发工程师，从事 Web 应用程序的研发，擅长 Spring、SpringBoot 等技术。 ✅ 热爱编程，业余时间学习新知识，通过 CSDN 记录学习心得和笔记内容。
10-29 1825
在实际的项目开发过程中，当应用程序发生异常时，用户可以接收到友好的错误提示信息，而不是直接出现一大堆看不懂的错误信息，这就需要对应用程序的所有异常进行统一的处理，SpringBoot框架提供了统一异常处理的注解，通过相应的注解就可以捕获所有可能出现的异常信息。此外，在前后端分离的模式下，数据的交互都是采用JSON格式来传递的，如果每一个方法都返回不同格式的数据，这显然不太合适，所以，实际开发中都会将响应结果统一处理，并且对前后端传递的参数进行统一的校验。下面具体介绍如何实现三个统一。
springboot项目统一响应结果封装
青春不散场的专栏
06-20 922
Springboot项目的统一响应结果封装
SpringBoot异常消息统一处理
weixin_48984179的博客
02-06 430
package com.yangho.utils; import com.baomidou.mybatisplus.extension.api.R; import com.yangho.Domain.Result; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice; /** * @Cla.
spring boot 统一响应三步曲
面朝大海，春暖花开
08-14 578
因为我们统一了响应结构， 所以在响应404时，包装了一层。然后又返回到 tomcat 容器中处理， 即。自定义 ResponseBodyAdvice。处理 spring mvc 响应中文乱码问题。那怎么去掉里面的结构呢,比如请求一个不存在的资源。,其实它是经过两次请求。
Spring Boot 统一响应
学习学习学习学习
08-02 1892
统一响应封装
springboot 统一结果响应，统一异常处理，统一请求参数非空校验，统一请求参数与响应结果日志打印
qq_41482600的博客
03-11 520
【代码】springboot 统一结果响应，统一异常处理，统一请求参数非空校验，统一请求参数与响应结果日志打印 1。
SpringBoot 通用功能（统一回复，统一异常处理，统一配置消息 eg:消息转换器）
geyu小屋
04-17 748
首先 定义统一回复对象，公用 package com.hangzhou.ad.vo; import java.io.Serializable; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; @Data @NoArgsConstructor @AllA...
详解SpringBoot统一响应体解决方案
08-25
详解 Spring Boot 统一响应体解决方案 本文主要介绍了 Spring Boot 统一响应体解决方案的详细实现方法，该方案主要解决了基于 Spring AOP 的统一响应体实现方案的局限性，提供了一种更加灵活和可扩展的解决方案。 ...
SpringBoot控制器统一的响应体加密与请求体解密的注解处理方式
08-08
在本主题中，我们将探讨如何利用自定义注解来实现SpringBoot中统一的响应体加密和请求体解密，支持MD5、SHA、AES、DES以及RSA等加密算法。 首先，我们需要创建自定义注解，用于标记哪些控制器方法需要执行加密和...
SpringBoot接口加密解密统一处理
08-25
在本文中，我们将深入探讨如何在SpringBoot中实现接口的加密解密统一处理，以及如何通过自定义注解来灵活控制加密解密的执行。 首先，我们创建两个自定义注解，`DecryptRequest`和`EncryptResponse`，用于标识哪些...
SpringBoot：SpringBoot统一响应和统一异常处理
永远保持随时离开的技术能力！
07-05 1288
SpringBoot统一响应和统一异常处理
SpringBoot统一异常处理
weixin_34054866的博客
05-08 186
BasicErrorController SpringBoot内置了一个BasicErrorController对异常进行统一的处理，当在页面发生异常的时候会自动把请求转到/error(Spring Boot提供的一个默认的映射) ，可以自定义页面内容，只需在classpath路径下新建error页面即可。当...
SpringBoot实战：统一响应和异常处理详细教程 (附git源码)
dingdingdandan
05-20 668
文章目录简介1. 依赖2. 封装响应体3. 全局异常处理4. 效果测试6. 源码分享 简介 我们通常接触的项目大多已经是前后端分离的项目，前后端的数据交互往往封装成统一的JSON格式。 { "code" : 20000, "message" : "操作成功", "data" : null } 统一的异常处理 我们使用@RestControllerAdvice结合@ExceptionHandler，并继承ResponseEntityExceptionHandler支持web类的错误处理。 .
SpringBoot全局处理系列--全局响应处理
IT利刃出鞘的博客
06-11 1124
说明 本文用实例介绍SpringBoot如何进行全局响应处理。 方案简述 全局响应处理（处理返回值）：@ControllerAdvice+实现ResponseBodyAdvice接口。 @ControllerAdvice所在类的beforBodyWrite方法将会在Controller方法执行之后执行。...............
SpringBoot项目接口统一响应处理、统一异常处理、统一配置、接口验证
IManiy的博客
05-05 1799
ResponseBodyAdvice 接口实现自定义返回数据类型 api接口中都是需要定义一个统一的响应头来返回json数据 一般方法是通过在返回时构造一个响应头对象如下： public class ApiR extends HashMap<String, Object> { private static final long serialVersionUID = 1L; pub...
SpringBoot中优雅地实现统一响应对象
zzcoder的博客
02-02 821
近日心血来潮想做一个开源项目，目标是做一款可以适配多端、功能完备的模板工程，包含后台管理系统和前台系统，开发者基于此项目进行裁剪和扩展来完成自己的功能开发。本项目为前后端分离开发，后端基于Java21和开发，后端使用JWT等技术栈，前端提供了vueangularreactuniapp微信小程序等多种脚手架工程。在前后端分离的项目开发过程中，我们通常会对数据返回格式进行统一的处理，这样可以方便前端人员取数据。但如果定义好响应对象R。
SpringBoot消息推送平台，统一发送多消息，对消息生命周期全链路追踪
04-14 1177
在打jar包前需要填写com.java3y.austin.stream.constants.AustinFlinkConstant中的redis和kafka的ip/port（注：日志的topic在application.properties中的austin.business.log.topic.name。6、检查apollo的app.id/apollo.bootstrap.namespaces，检查创建的消息队列topic：austin.business.topic.name。
探索高效消息处理：基于Spring Boot + RocketMQ的统一消息中心应用
最新发布
gitblog_01167的博客
09-12 475
探索高效消息处理：基于Spring Boot + RocketMQ的统一消息中心应用 rocketmq-message-center-demo 项目地址: https://gitcode.com/gh_mirrors/ro/ro...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值