正文

springboot无侵入式实现api接口统一json格式返回(代码片段)

编程指南针  编程指南针  2023-03-04  763

关键词：

无侵入式统一返回JSON格式

其实本没有没打算写这篇博客的，但还是要写一下写这篇博客的起因是因为，现在呆着的这家公司居然没有统一的API返回格式?，询问主管他居然告诉我用HTTP状态码就够用了（fxxk），天哪HTTP状态码真的够用吗？

在仔细的阅读了项目源码后发现，在API请求的是居然没有业务异常（黑人问好）。好吧居然入坑了只能遵照项目风格了，懒得吐槽了。

因为项目已经开发了半年多了, 要是全部接口都做修改工作量还是挺大的, 只能用这种无侵入式的方案来解决.

项目源代码: https://github.com/469753862/galaxy-blogs/tree/master/code/responseResult

定义JSON格式

定义返回JSON格式

后端返回给前端一般情况下使用JSON格式, 定义如下


    "code": 200,
    "message": "OK",
    "data":

code: 返回状态码
message: 返回信息的描述
data: 返回值

定义JavaBean字段

定义状态码枚举类

@ToString
@Getter
public enum ResultStatus 

    SUCCESS(HttpStatus.OK, 200, "OK"),
    BAD_REQUEST(HttpStatus.BAD_REQUEST, 400, "Bad Request"),
    INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, 500, "Internal Server Error"),;

    /** 返回的HTTP状态码,  符合http请求 */
    private HttpStatus httpStatus;
    /** 业务异常码 */
    private Integer code;
    /** 业务异常信息描述 */
    private String message;

    ResultStatus(HttpStatus httpStatus, Integer code, String message) 
        this.httpStatus = httpStatus;
        this.code = code;
        this.message = message;

状态码和信息以及http状态码就能一一对应了便于维护, 有同学有疑问了为什么要用到http状态码呀,因为我要兼容项目以前的代码, 没有其他原因, 当然其他同学不喜欢http状态码的可以吧源码中HttpStatus给删除了

定义返回体类

@Getter
@ToString
public class Result<T> 
    /** 业务错误码 */
    private Integer code;
    /** 信息描述 */
    private String message;
    /** 返回参数 */
    private T data;

    private Result(ResultStatus resultStatus, T data) 
        this.code = resultStatus.getCode();
        this.message = resultStatus.getMessage();
        this.data = data;
    

    /** 业务成功返回业务代码和描述信息 */
    public static Result<Void> success() 
        return new Result<Void>(ResultStatus.SUCCESS, null);
    

    /** 业务成功返回业务代码,描述和返回的参数 */
    public static <T> Result<T> success(T data) 
        return new Result<T>(ResultStatus.SUCCESS, data);
    

    /** 业务成功返回业务代码,描述和返回的参数 */
    public static <T> Result<T> success(ResultStatus resultStatus, T data) 
        if (resultStatus == null) 
            return success(data);
        
        return new Result<T>(resultStatus, data);
    

    /** 业务异常返回业务代码和描述信息 */
    public static <T> Result<T> failure() 
        return new Result<T>(ResultStatus.INTERNAL_SERVER_ERROR, null);
    

    /** 业务异常返回业务代码,描述和返回的参数 */
    public static <T> Result<T> failure(ResultStatus resultStatus) 
        return failure(resultStatus, null);
    

    /** 业务异常返回业务代码,描述和返回的参数 */
    public static <T> Result<T> failure(ResultStatus resultStatus, T data) 
        if (resultStatus == null) 
            return new Result<T>(ResultStatus.INTERNAL_SERVER_ERROR, null);
        
        return new Result<T>(resultStatus, data);

因为使用构造方法进行创建对象太麻烦了, 我们使用静态方法来创建对象这样简单明了

Result实体返回测试

@RestController
@RequestMapping("/hello")
public class HelloController 

    private static final HashMap<String, Object> INFO;

    static 
        INFO = new HashMap<>();
        INFO.put("name", "galaxy");
        INFO.put("age", "70");
    

    @GetMapping("/hello")
    public Map<String, Object> hello() 
        return INFO;
    

    @GetMapping("/result")
    @ResponseBody
    public Result<Map<String, Object>> helloResult() 
        return Result.success(INFO);

到这里我们已经简单的实现了统一JSON格式了, 但是我们也发现了一个问题了,想要返回统一的JSON格式需要返回Result<Object>才可以, 我明明返回Object可以了, 为什么要重复劳动, 有没有解决方法, 当然是有的啦, 下面我们开始优化我们的代码吧

统一返回JSON格式进阶-全局处理(@RestControllerAdvice)

我师傅经常告诉我的一句话: “你就是一个小屁孩, 你遇到的问题都已经不知道有多少人遇到过了, 你会想到的问题, 已经有前辈想到过了. 你准备解决的问题, 已经有人把坑填了”。是不是很鸡汤, 是不是很励志, 让我对前辈们充满着崇拜, 事实上他对我说的是: “自己去百度”, 这五个大字, 其实这五个大字已经说明上明的B话了, 通过不断的百度和Google发现了很多的解决方案.

我们都知道使用@ResponseBody注解会把返回Object序列化成JSON字符串,就先从这个入手吧, 大致就是在序列化前把Object赋值给Result<Object>就可以了, 大家可以观摩org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice和org.springframework.web.bind.annotation.ResponseBody

@ResponseBody继承类

我们已经决定从@ResponseBody注解入手了就创建一个注解类继承@ResponseBody, 很干净什么都没有哈哈,@ResponseResultBody 可以标记在类和方法上这样我们就可以跟自由的进行使用了

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE, ElementType.METHOD)
@Documented
@ResponseBody
public @interface ResponseResultBody

ResponseBodyAdvice继承类

@RestControllerAdvice
public class ResponseResultBodyAdvice implements ResponseBodyAdvice<Object> 

    private static final Class<? extends Annotation> ANNOTATION_TYPE = ResponseResultBody.class;

    /**
     * 判断类或者方法是否使用了 @ResponseResultBody
     */
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) 
        return AnnotatedElementUtils.hasAnnotation(returnType.getContainingClass(), ANNOTATION_TYPE) || returnType.hasMethodAnnotation(ANNOTATION_TYPE);
    

    /**
     * 当类或者方法使用了 @ResponseResultBody 就会调用这个方法
     */
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) 
        // 防止重复包裹的问题出现
        if (body instanceof Result) 
            return body;
        
        return Result.success(body);

RestControllerAdvice返回测试

@RestController
@RequestMapping("/helloResult")
@ResponseResultBody
public class HelloResultController 

    private static final HashMap<String, Object> INFO;

    static 
        INFO = new HashMap<String, Object>();
        INFO.put("name", "galaxy");
        INFO.put("age", "70");
    

    @GetMapping("hello")
    public HashMap<String, Object> hello() 
        return INFO;
    

    /** 测试重复包裹 */
    @GetMapping("result")
    public Result<Map<String, Object>> helloResult() 
        return Result.success(INFO);
    

    @GetMapping("helloError")
    public HashMap<String, Object> helloError() throws Exception 
        throw new Exception("helloError");
    

    @GetMapping("helloMyError")
    public HashMap<String, Object> helloMyError() throws Exception 
        throw new ResultException();

是不是很神奇, 直接返回Object就可以统一JSON格式了, 就不用每个返回都返回Result<T>对象了,直接让SpringMVC帮助我们进行统一的管理, 简直完美

只想看接口哦, helloError和helloMyError是会直接抛出异常的接口,我好像没有对异常返回进行统一的处理哦

统一返回JSON格式进阶-异常处理(@ExceptionHandler))

卧槽, 异常处理, 差点把这茬给忘了, 这个异常处理就有很多方法了,先看看我师傅的处理方式, 我刚拿到这个代码的时候很想吐槽, 对异常类的处理这么残暴的吗, 直接用PrintWriter直接输出结果, 果然是老师傅, 我要是有100个异常类, 不得要写100个 if else了. 赶紧改改睡吧

@Configuration
public class MyExceptionHandler implements HandlerExceptionResolver 

    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response,
                                         Object handler, Exception ex) 
        PrintWriter out = getPrintWrite(response);
        if (ex instanceof XXXException) 
            out.write(JsonUtil.formatJson(ResultEnum.PAY_ERROR.getCode(), ex.getMessage()));
         else 
            out.write(JsonUtil.formatJson(ResultEnum.FAIL.getCode(), "服务器异常"));
        
        if (null != out) 
            out.close();
        
        return mav;
    

    private PrintWriter getPrintWrite(HttpServletResponse response) 
        PrintWriter out = null;
        try 
            response.setHeader("Content-type", "text/html;charset=UTF-8");
            response.setCharacterEncoding("UTF-8");
            out = response.getWriter();
         catch (IOException e) 
            log.error("PrintWriter is exception", e);
        
        return out;

上面的代码看看还是没有问题的, 别学过去哦,

异常处理@ResponseStatus(不推荐)

@ResponseStatus用法如下,可用在Controller类和Controller方法上以及Exception类上但是这样的工作量还是挺大的

@RestController
@RequestMapping("/error")
@ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR, reason = "Java的异常")
public class HelloExceptionController 

    private static final HashMap<String, Object> INFO;

    static 
        INFO = new HashMap<String, Object>();
        INFO.put("name", "galaxy");
        INFO.put("age", "70");
    

    @GetMapping()
    public HashMap<String, Object> helloError() throws Exception 
        throw new Exception("helloError");
    

    @GetMapping("helloJavaError")
    @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR, reason = "Java的异常")
    public HashMap<String, Object> helloJavaError() throws Exception 
        throw new Exception("helloError");
    

    @GetMapping("helloMyError")
    public HashMap<String, Object> helloMyError() throws Exception 
        throw new MyException();
    


@ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR, reason = "自己定义的异常")
class MyException extends Exception

全局异常处理@ExceptionHandler(推荐)

把ResponseResultBodyAdvice类进行改造一下,代码有点多了

主要参考了org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler#handleException()方法, 有空可以看一下

@Slf4j
@RestControllerAdvice
public class ResponseResultBodyAdvice implements ResponseBodyAdvice<Object> 

    private static final Class<? extends Annotation> ANNOTATION_TYPE = ResponseResultBody.class;

    /** 判断类或者方法是否使用了 @ResponseResultBody */
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) 
        return AnnotatedElementUtils.hasAnnotation(returnType.getContainingClass(), ANNOTATION_TYPE) || returnType.hasMethodAnnotation(ANNOTATION_TYPE);
    

    /** 当类或者方法使用了 @ResponseResultBody 就会调用这个方法 */
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) 
        if (body instanceof Result) 
            return body;
        
        return Result.success(body);
    


    /**
     * 提供对标准Spring MVC异常的处理
     *
     * @param ex      the target exception
     * @param request the current request
     */
    @ExceptionHandler(Exception.class)
    public final ResponseEntity<Result<?>> exceptionHandler(Exception ex, WebRequest request) 
        log.error("ExceptionHandler: ", ex.getMessage());
        HttpHeaders headers = new HttpHeaders();
        if (ex instanceof ResultException) 
            return this.handleResultException((ResultException) ex, headers, request);
        
        // TODO: 2019/10/05 galaxy 这里可以自定义其他的异常拦截
        return this.handleException(ex, headers, request);
    

    /** 对ResultException类返回返回结果的处理 */
    protected ResponseEntity<Result<?>> handleResultException(ResultException ex, HttpHeaders headers, WebRequest request) 
        Result<?> body = Result.failure(ex.getResultStatus());
        HttpStatus status = ex.getResultStatus().getHttpStatus();
        return this.handleExceptionInternal(ex, body, headers, status, request);
    

    /** 异常类的统一处理 */
    protected ResponseEntity<Result<?>> handleException(Exception ex, HttpHeaders headers, WebRequest request) 
        Result<?> body = Result.failure();
        HttpStatus status = HttpStatus.INTERNAL_SERVER_ERROR;
        return this.handleExceptionInternal(ex, body, headers, status, request);
    

    /**
     * org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler#handleExceptionInternal(java.lang.Exception, java.lang.Object, org.springframework.http.HttpHeaders, org.springframework.http.HttpStatus, org.springframework.web.context.request.WebRequest)
     * <p>
     * A single place to customize the response body of all exception types.
     * <p>The default implementation sets the @link WebUtils#ERROR_EXCEPTION_ATTRIBUTE
     * request attribute and creates a @link ResponseEntity from the given
     * body, headers, and status.
     */
    protected ResponseEntity<Result<?>> handleExceptionInternal(
            Exception ex, Result<?> body, HttpHeaders headers, HttpStatus status, WebRequest request) 

        if (HttpStatus.INTERNAL_SERVER_ERROR.equals(status)) 
            request.setAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE, ex, WebRequest.SCOPE_REQUEST);
        
        return new ResponseEntity<>(body, headers, status);

springcloudopenfeign接口反序列化失效，该怎么解决？

...来源：blog.csdn.net/qq_34347620/article/details/1242953021.关于SpringBoot无侵入式API接口统一格式,，变得具有侵入性的那回事19年发布了《SpringBoot无侵入式实现API接口统一JSON格式返回》，得到的广泛的转载，同时也在查看详情

springboot2系列教程|实现声明式事务

前言如题，今天介绍SpringBoot的声明式事务。Spring的事务机制所有的数据访问技术都有事务处理机制，这些技术提供了API用于开启事务、提交事务来完成数据操作，或者在发生错误时回滚数据。而Spring的事务机制是用统一的机制... 查看详情

springboot接口项目利用aop记录日志

...志收集二、环境　　1.此随笔内容基于springboot项目　　2.数据库为mysql5.7.9版本　　3.jdk版本为1.8三、说明　　此版采用数据查看详情

@transactional（事务讲解）和springboot整合事务

概述事务在编程中分为两种：声明式事务处理和编程式事务处理编程式事务处理：编码方式实现事务管理,常与模版类TransactionTemplate（推荐使用）在业务代码中实现事务。可知编程式事务每次实现都要单独实现，但业务量大功能... 查看详情

springboot实现用户统一认证管理-前端实现

...课堂前言现在是：2022年6月2日15:43:51上篇文章讲述了springboot中实现用户统一认证的具体内容，主要从后端角度出发的，其实大部分功能还是前端与后端交互的比较多，上篇文章知识罗列了几个回调接口，我一... 查看详情

实现无入侵式c++代码mock工具

为了实现真正无侵入式的mock，我们基于开源Hook框架Frida-gum提供的API，利用C++模板进行封装，作者编写了一个简单实用的mock工具，在此开源分享（代码详见附录）。背景在单元测试中，往往需要... 查看详情

springboot+vue实现用户统一认证管理-前端实现

...堂”前言现在是：2022年6月2日15:43:51上篇文章讲述了springboot中实现用户统一认证的具体内容，主要从后端角度出发的，其实大部分功能还是前端与后端交互的比较多，上篇文章知识罗列了几个回调接口，我一... 查看详情

springboot2.x给controller的requestmapping添加统一前缀(代码片段)

...lication.yml文件中添加：servlet:context-path:/api#（不同SpringBoot版本会有区别，这里是采用2.x）但是这个其实是整个项目访问前缀，如果你有静态资源也需要增加/api这个前缀访问。2、通过nginx和你的网关层添加统一... 查看详情

springboot2.x给controller的requestmapping添加统一前缀(代码片段)

springboot实例:医院统一信息平台(apigateway)

.../huippatient/loadUser相当于http://localhost:8280/loadUser请求测试。SpringBoot实例:医院统一信息平台(服务间通讯)的访问流程改成用代理。查看详情

基于springboot轻量非侵入式数据库数据告警器(代码片段)

基于SpringBoot的轻量、非侵入式数据库数据告警器我的需求：需要写一个数据库数据监控的告警小工具，要求：非侵入式的，对监控的数据只有查询权限，没有写权限可以对数据表的部分数据状态，数据数... 查看详情

基于springboot轻量非侵入式数据库数据告警器(代码片段)

如何实现避免未定义行为的侵入式链表？

】如何实现避免未定义行为的侵入式链表？【英文标题】：Howtoimplementanintrusivelinkedlistthatavoidsundefinedbehavior?【发布时间】：2015-12-0713:35:48【问题描述】：几年来我第三次发现自己需要一个侵入式链表来处理一个不允许提升的项目... 查看详情

入坑了，公司居然没有统一的api返回格式？(代码片段)

...部”设为“星标”，和你一起掌握更多数据库知识无侵入式统一返回JSON格式其实本没有没打算写这篇博客的，但还是要写一下写这篇博客的起因是因为，现在呆着的这家公司居然没有统一的API返回格式？询问主管... 查看详情

入坑了，公司居然没有统一的api返回格式？(代码片段)

瞧瞧人家用springboot写的后端api接口，那叫一个优雅

...数校验，这样代码更加简洁，也方便统一管理。实际上，springboot有个validation的组件，我们可以拿来即用。引入这个包即可：引入包后，参数校验就非常简洁啦，如下：然后在UserParam参数对象中，加入@Validated注解哈，把错误信息... 查看详情

api接口统一管理(代码片段)

...夹，里面有一个index.js，以及多个根据模块划分的接口js文件。index.js是一个api的出口，其他js则用来管理各个模块的接口。例如下面的article.js:/***article模块接口列表*/importrequestfrom'@/network/http';//导入http中创建... 查看详情

springboot如何使用feign实现远程接口调用

参考技术A什么是Feign？与Ribbon⼀样，Feign也是由Netflflix提供的，Feign是⼀个声明式、模版化的WebService客户端，它简化了开发者编写Web服务客户端的操作，开发者可以通过简单的接⼝和注解来调⽤HTTPAPI，SpringCloudFeign... 查看详情

正文

springboot无侵入式实现api接口统一json格式返回(代码片段)

无侵入式 统一返回JSON格式

定义JSON格式

定义JavaBean字段

Result实体返回测试

统一返回JSON格式进阶-全局处理(@RestControllerAdvice)

@ResponseBody继承类

ResponseBodyAdvice继承类

RestControllerAdvice返回测试

统一返回JSON格式进阶-异常处理(@ExceptionHandler))

异常处理@ResponseStatus(不推荐)

全局异常处理@ExceptionHandler(推荐)

springcloudopenfeign接口反序列化失效，该怎么解决？

springboot2系列教程|实现声明式事务

springboot接口项目利用aop记录日志

@transactional（事务讲解）和springboot整合事务

springboot实现用户统一认证管理-前端实现

实现无入侵式c++代码mock工具

springboot+vue实现用户统一认证管理-前端实现

springboot2.x给controller的requestmapping添加统一前缀(代码片段)

springboot2.x给controller的requestmapping添加统一前缀(代码片段)

springboot实例:医院统一信息平台(apigateway)

基于springboot轻量非侵入式数据库数据告警器(代码片段)

基于springboot轻量非侵入式数据库数据告警器(代码片段)

如何实现避免未定义行为的侵入式链表？

入坑了，公司居然没有统一的api返回格式？(代码片段)

入坑了，公司居然没有统一的api返回格式？(代码片段)

瞧瞧人家用springboot写的后端api接口，那叫一个优雅

api接口统一管理(代码片段)

springboot如何使用feign实现远程接口调用

无侵入式统一返回JSON格式