【Java】统一返回出参格式

末蓝、 2023-09-29 23:58 18阅读 0赞

--------------------

## 前言 ##

在前后端接口进行交互中，经常因为各种格式出参导致前端调用后台接口出参需要进行不同接口不同判断的问题。现在可以进行整合统一出参格式，通过data数据体区分不同业务数据，通过code以及message变量区分接口调用状态，使项目能够统一规范管理；

--------------------

## 一、导入pom ##

在项目pom.xml中引入FastJson依赖以及lombok依赖

<dependency>
                    <groupId>com.alibaba</groupId>
                    <artifactId>fastjson</artifactId>
                    <version>1.2.79</version>
                </dependency>
                
               <dependency>
    	            <groupId>org.projectlombok</groupId>
    	            <artifactId>lombok</artifactId>
              </dependency>

## 二、新建统一出参工具类 ##

### 1.新建ResponseCodeEnum出参异常枚举 ###

代码如下：

import lombok.AllArgsConstructor;
    import lombok.Getter;
    
    @Getter
    @AllArgsConstructor
    public enum ResponseCodeEnum {
        
    
        /**
         * 操作成功
         */
        SUCCESS(10000, "操作成功"),
    
        /**
         * 操作失败
         */
        FAIL(20000, "操作失败"),
    
        FAIL_NO_DATA(20001, "未找到相关数据");
    
    
        private final int code;
        private final String msg;
    
    }

### 2.新建一个ResultUtil工具类 ###

代码如下：

import com.alibaba.fastjson.JSONObject;
    import com.program.common.enums.ResponseCodeEnum;
    
    /**
     * @author 孤巷.
     * @description JSON公用回参工具类
     * @date 2020/11/9 11:11
     */
    public class ResultUtil {
        
    
        /**
         * 通用返回，带数据，自定义提示
         *
         * @param code    返回状态码
         * @param data    返回数据
         * @param message 提示信息
         * @return JSON
         */
        public static JSONObject toJson(int code, Object data, String message) {
        
            JSONObject jsonObject = new JSONObject();
            jsonObject.put("data", data);
            jsonObject.put("code", code);
            jsonObject.put("message", message);
            return jsonObject;
        }
    
        /**
         * 通用返回，自定义提示
         *
         * @param code    返回状态码
         * @param message 提示信息
         * @return JSON
         */
        public static JSONObject toJson(int code, String message) {
        
            return toJson(code, null, message);
        }
    
        public static JSONObject toJsonSuccess(Object data) {
        
            return toJson(ResponseCodeEnum.SUCCESS.getCode(), data, ResponseCodeEnum.SUCCESS.getMsg());
        }
    
        /**
         * 分页通用返回，带数据，自定义提示，总数量
         *
         * @param code    返回状态码
         * @param data    返回数据
         * @param message 提示信息
         * @param total   总数量
         * @return JSON
         */
        public static JSONObject toJson(int code, Object data, long total, String message) {
        
            JSONObject jsonObject = toJson(code, data, message);
            jsonObject.put("total", total);
            return jsonObject;
        }
    
        /**
         * 操作成功，不带数据
         *
         * @return JSON
         */
        public static JSONObject success() {
        
            return toJson(ResponseCodeEnum.SUCCESS.getCode(), null, ResponseCodeEnum.SUCCESS.getMsg());
        }
    
        /**
         * 操作成功，带数据
         *
         * @param data 返回数据
         * @return JSON
         */
        public static JSONObject success(Object data) {
        
            return toJson(ResponseCodeEnum.SUCCESS.getCode(), data, ResponseCodeEnum.SUCCESS.getMsg());
        }
    
        /**
         * 操作成功，不带数据，自定义提示
         *
         * @param message 自定义提示
         * @return JSON
         */
        public static JSONObject success(String message) {
        
            return toJson(ResponseCodeEnum.SUCCESS.getCode(), null, message);
        }
    
        /**
         * 操作成功，带数据，自定义提示
         *
         * @param data    返回数据
         * @param message 自定义提示
         * @return JSON
         */
        public static JSONObject success(Object data, String message) {
        
            return toJson(ResponseCodeEnum.SUCCESS.getCode(), data, message);
        }
    
        /**
         * 操作成功返回，分页用，带数据，自定义提示
         *
         * @param data    返回数据
         * @param total   总数量
         * @param message 自定义提示
         * @return JSON
         */
        public static JSONObject success(Object data, long total, String message) {
        
            return toJson(ResponseCodeEnum.SUCCESS.getCode(), data, total, message);
        }
    
    
        /**
         * 操作成功，带数据，自定义提示
         *
         * @param code    返回编码
         * @param data    返回数据
         * @param message 自定义提示
         * @return JSON
         */
        public static JSONObject success(int code, Object data, String message) {
        
            return toJson(code, data, message);
        }
    
        /**
         * 操作成功，带数据，自定义提示
         *
         * @param code    返回编码
         * @param data    返回数据
         * @param message 自定义提示
         * @return JSON
         */
        public static JSONObject success(int code, Object data, String message,Integer total) {
        
            return toJson(code, data, total,message);
        }
    
        /**
         * 操作成功返回，分页用，带数据
         *
         * @param data  返回数据
         * @param total 总数量
         * @return JSON
         */
        public static JSONObject success(Object data, long total) {
        
            return toJson(
                    ResponseCodeEnum.SUCCESS.getCode(), data, total, ResponseCodeEnum.SUCCESS.getMsg());
        }
    
        /**
         * 请求失败
         *
         * @return 默认失败code和msg
         */
        public static JSONObject fail() {
        
            return toJson(ResponseCodeEnum.FAIL.getCode(), null, ResponseCodeEnum.FAIL.getMsg());
        }
    
        /**
         * 操作失败返回，自定义提示
         *
         * @param message 提示消息
         * @return JSON
         */
        public static JSONObject fail(String message) {
        
            return toJson(ResponseCodeEnum.FAIL.getCode(), null, message);
        }
    
        /**
         * 操作失败返回，不带数据，自定义错误编码和提示
         *
         * @param code    返回code
         * @param message 提示消息
         * @return JSON
         */
        public static JSONObject fail(int code, String message) {
        
            return toJson(code, null, message);
        }
    
        /**
         * 操作失败返回，带数据
         *
         * @param data 返回数据
         * @return JSON
         */
        public static JSONObject fail(Object data) {
        
            return toJson(ResponseCodeEnum.FAIL.getCode(), data, ResponseCodeEnum.FAIL.getMsg());
        }
    
    
        /**
         * 操作失败,未找到相关数据返回
         *
         * @return JSON
         */
        public static JSONObject failNoData() {
        
            return toJson(ResponseCodeEnum.FAIL_NO_DATA.getCode(), null, ResponseCodeEnum.FAIL_NO_DATA.getMsg());
        }
    
    
        /**
         * 异常返回，提示信息，错误代码
         *
         * @param code    错误代码
         * @param message 提示信息
         * @return JSON
         */
        public static JSONObject error(int code, String message) {
        
            return toJson(code, null, message);
        }

### 3.调用工具类 ###

代码如下（示例）：

@PostMapping(value = "/interfaceTest")
        public JSONObject interfaceTest(){
        
            String value = "你好！这里是接口后台的接口";
            return ResJsonUtil.toJsonSuccess(value);
        }

接口成功返回的结果如下  
![在这里插入图片描述][466894a1bbed4d958f70ab7fb64d9b01.png]

## 总结 ##

接口中的code，success,message为外部第一条件判断参数，可根据实际情况进行修改，其中data参数为具体业务的出参

[466894a1bbed4d958f70ab7fb64d9b01.png]: https://img-blog.csdnimg.cn/466894a1bbed4d958f70ab7fb64d9b01.png