springboot项目controller统一返回对象格式以及全局自定义异常方式

 更新时间:2025年11月03日 08:41:35   作者:0和1搭建网络世界  
本文介绍了在Web接口开发中,统一封装接口返回数据格式和处理运行时异常的重要性,通过使用@ControllerAdvice和ResponseBodyAdvice,可以实现全局拦截和封装,为了处理Swagger请求,提出了解决方案,包括对Swagger请求放行和自定义注解拦截特定接口

一、需求背景

1.在web接口开发时,每个模块接口返回数据格式需做封装,如果每个模块的返回格式不同,前端需要最不同数据格式的适配,使得整个项目很杂乱。如果对接口的返回数据做统一封装就解决此类问题。

2.项目的运行时异常,例如用户名错误此类的提示性异常,需要对此类异常做统一性封装。

二、方法

解决方法

问题一:使用@ControllerAdvice注解,以及实现ResponseBodyAdvice接口,从而实现拦截后再封装逻辑

问题二:使用@ControllerAdvice和@ExceptionHandler注解配合使用,从而捕获自定义异常类,实现逻辑的再处理。

三、具体实现

/**
*封装的接口统一返回对象
*/
@Data
public class ResultPo<T> {
    private int code;
    private String msg;
    private T data;

    public static<T> ResultPo<T> success(T t){
        ResultPo<T> resultPo = new ResultPo<>();
        resultPo.setCode(ResponseCodeEnum.SUCCESS.getCode());
        resultPo.setMsg(ResponseCodeEnum.SUCCESS.getMessage());
        resultPo.setData(t);
        return resultPo;
    }

    public static ResultPo error(int code,String msg){
        ResultPo resultPo = new ResultPo();
        resultPo.setCode(code);
        resultPo.setMsg(msg);
        return resultPo;
    }
}

// 自定义异常类
@Getter
public class BusinessException extends RuntimeException{
    private String msg;
    private int code;

    public  BusinessException(String msg){
        super(msg);
        this.msg =msg;
        this.code = ResponseCodeEnum.FAIL.getCode();
    }

    public  BusinessException(String msg,int code){
        super(msg);
        this.msg =msg;
        this.code = code;
    }
}


@ResponseBody
@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice<Object> {

    Logger log = LoggerFactory.getLogger(ResponseAdvice.class);

	// 自定义异常捕获
    @ExceptionHandler(BusinessException.class)
    public ResultPo customException(BusinessException bs){
        ResultPo resultPo = new ResultPo();
        resultPo.setCode(bs.getCode());
        resultPo.setMsg(bs.getMsg());
        resultPo.setData(null);
        return resultPo;
    }
	
	/**
	*return turn 代表此接口会进入beforeBodyWrite方法,进行逻辑处理
	*/
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return !returnType.getDeclaringClass().getName().contains("springfox");
//        return true;
    }

    @Nullable
    @Override
    public Object beforeBodyWrite(@Nullable Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
    	// 如果接口返回为string类型,则需要单独处理
        if(returnType.getGenericParameterType().equals(String.class)){
            ObjectMapper objectMapper = new ObjectMapper();
            try {
                HttpHeaders headers = response.getHeaders();
                headers.setContentType(MediaType.APPLICATION_JSON);
                return objectMapper.writeValueAsString(ResultPo.success(body));
            } catch (JsonProcessingException e) {
                e.printStackTrace();
            }
        }
        // 接口出现自定义异常,已被customException方法捕获,则无需再次封装
        if(returnType.getGenericParameterType().equals(ResultPo.class)){
            return body;
        }
        return ResultPo.success(body);
    }
}

四、遇到的问题

当项目中使用swagger时,会拦截swagger的相关请求

出现的原因:@ControllerAdvice注解会拦截@Controller以及@RestController标记的接口,而swagger的接口是web接口,也是带有@RestController相关接口

解决方法:

1.对swagger进行放行,就是上面代码中那样,放行带有springfox字样的接口

@Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return !returnType.getDeclaringClass().getName().contains("springfox");
//        return true;
    }

2.自定义一个注解,在需要统一返回值的接口上添加上自定义注解,然后@ControllerAdvice根据自定义注解进行拦截

// ResponseResult为自定义注解
@ControllerAdvice(annotations = ResponseResult.class)

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java基本类型与byte数组之间相互转换方法

    Java基本类型与byte数组之间相互转换方法

    下面小编就为大家带来一篇Java基本类型与byte数组之间相互转换方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-08-08
  • Java类和成员变量声明类详解

    Java类和成员变量声明类详解

    这篇文章主要介绍了Java类和成员变量声明类详解,类中的成员变量——这些被称为字段,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的朋友可以参考一下
    2022-08-08
  • debug模式迟迟不能启动问题及解决

    debug模式迟迟不能启动问题及解决

    在使用Debug模式进行代码测试时,由于设置了过多的断点,导致程序加载缓慢甚至无法启动,解决此问题的方法是取消不必要的断点,通过IDE的断点管理功能,检查并移除问题断点,从而优化调试效率,分享此经验希望能帮助遇到相同问题的开发者
    2022-11-11
  • 浅谈SpringMVC之视图解析器(ViewResolver)

    浅谈SpringMVC之视图解析器(ViewResolver)

    本篇文章主要介绍了浅谈SpringMVC之视图解析器(ViewResolver),具有一定的参考价值,有兴趣的可以了解一下
    2017-08-08
  • java编程进阶小白也能手写HashMap代码

    java编程进阶小白也能手写HashMap代码

    这篇文章是一篇java小白进阶篇本文教大家手写一个HashMap实现的示例代码,有需要的朋友可以借鉴参考下,希望对大家能够有所进益,祝大家早日升职加薪
    2021-10-10
  • Spring Bean生命周期之Bean元信息的配置与解析阶段详解

    Spring Bean生命周期之Bean元信息的配置与解析阶段详解

    这篇文章主要为大家详细介绍了Spring Bean生命周期之Bean元信息的配置与解析阶段,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • java中的AWT事件处理问题

    java中的AWT事件处理问题

    这篇文章主要介绍了java中的AWT事件处理问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-11-11
  • Spring集成MyBatis和PageHelper分页插件整合过程详解

    Spring集成MyBatis和PageHelper分页插件整合过程详解

    Spring 整合 MyBatis 是将 MyBatis 数据访问框架与 Spring 框架进行集成,以实现更便捷的开发和管理,在集成过程中,Spring 提供了许多特性和功能,如依赖注入、声明式事务管理、AOP 等,这篇文章主要介绍了Spring集成MyBatis和PageHelper分页插件整合,需要的朋友可以参考下
    2023-08-08
  • Java Resource路径整理总结

    Java Resource路径整理总结

    这篇文章主要介绍了 Java Resource路径整理总结的相关资料,需要的朋友可以参考下
    2017-03-03
  • 最新Spring Security的基于内存用户认证方式

    最新Spring Security的基于内存用户认证方式

    本文讲解SpringSecurity内存认证配置,适用于开发、测试等场景,通过代码创建用户及权限管理,支持密码加密,虽简单但不持久化,生产环境推荐使用数据库或JWT等认证方式,感兴趣的朋友一起看看吧
    2025-07-07

最新评论