java SpringBoot（十九）SpringBoot API 状态码类以及返回信息工具类

小鱼儿 2022-10-06 00:53 9阅读 0赞

**在平时SpringBoot编写网络API接口代码的时候，难免需要用到返回状态码以及返回的数据、信息。**

**今天写一个万能的返回状态信息工具类。**

### **目录结构： ** ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzcxNTY3_size_16_color_FFFFFF_t_70][]

**IErrorCode 接口类：**

package com.zr.mall.demo.common.api;
    
    /**
     * 封装API的错误码
     */
    public interface IErrorCode {
    
        long getCode();
    
        String getMessage();
    }

**ResultCode 枚举类：**

**存放状态码以及对应的返回信息**

package com.zr.mall.demo.common.api;
    
    public enum ResultCode implements IErrorCode{
        SUCCESS(200, "操作成功"),
        FAILED(500, "操作失败"),
        VALIDATE_FAILED(404, "参数检验失败"),
        UNAUTHORIZED(401, "暂未登录或token已过期"),
        FORBIDDEN(403, "没有相关权限");
    
    
        /** 定义状态码 */
        private long code;
    
        /** 定义返回信息 */
        private String message;
    
        ResultCode() {
        }
    
        ResultCode(long code, String message) {
            this.code = code;
            this.message = message;
        }
    
        @Override
        public long getCode() {
            return code;
        }
    
        @Override
        public String getMessage() {
            return message;
        }
    }

**返回对象泛型类，用于返回**

package com.zr.mall.demo.common.api;
    
    /**
     * 通用返回对象
     * @param <T>
     */
    public class CommonResult<T> {
    
        private long code;
        private String message;
        private T data;
    
        public CommonResult() {
        }
    
        public CommonResult(long code, String message, T data) {
            this.code = code;
            this.message = message;
            this.data = data;
        }
    
        public long getCode() {
            return code;
        }
    
        public void setCode(long code) {
            this.code = code;
        }
    
        public String getMessage() {
            return message;
        }
    
        public void setMessage(String message) {
            this.message = message;
        }
    
        public T getData() {
            return data;
        }
    
        public void setData(T data) {
            this.data = data;
        }
    
        /**
         * 成功返回结果
         *
         * @param data 获取的数据
         */
        public static <T> CommonResult<T> success(T data){
            return new CommonResult<T>(ResultCode.SUCCESS.getCode(), ResultCode.SUCCESS.getMessage(), data);
        }
    
        /**
         * 成功返回结果
         *
         * @param data 获取的数据
         * @param  message 提示信息
         */
        public static <T> CommonResult<T> success(T data, String message) {
            return new CommonResult<T>(ResultCode.SUCCESS.getCode(), message, data);
        }
    
        /**
         * 失败返回结果
         * @param errorCode 错误码
         */
        public static <T> CommonResult<T> failed(IErrorCode errorCode) {
            return new CommonResult<T>(errorCode.getCode(), errorCode.getMessage(), null);
        }
    
        /**
         * 失败返回结果
         * @param message 提示信息
         */
        public static <T> CommonResult<T> failed(String message) {
            return new CommonResult<T>(ResultCode.FAILED.getCode(), message, null);
        }
    
        /**
         * 失败返回结果
         */
        public static <T> CommonResult<T> failed() {
            return failed(ResultCode.FAILED);
        }
    
        /**
         * 参数验证失败返回结果
         */
        public static <T> CommonResult<T> validateFailed() {
            return failed(ResultCode.VALIDATE_FAILED);
        }
    
        /**
         * 参数验证失败返回结果
         * @param message 提示信息
         */
        public static <T> CommonResult<T> validateFailed(String message) {
            return new CommonResult<T>(ResultCode.VALIDATE_FAILED.getCode(), message, null);
        }
    
        /**
         * 未登录返回结果
         */
        public static <T> CommonResult<T> unauthorized(T data) {
            return new CommonResult<T>(ResultCode.UNAUTHORIZED.getCode(), ResultCode.UNAUTHORIZED.getMessage(), data);
        }
    
        /**
         * 未授权返回结果
         */
        public static <T> CommonResult<T> forbidden(T data) {
            return new CommonResult<T>(ResultCode.FORBIDDEN.getCode(), ResultCode.FORBIDDEN.getMessage(), data);
        }
    
    }

**在Controller中进行测试：**

package com.zr.mall.demo.controller;
    
    import com.zr.mall.demo.common.api.CommonResult;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Api(tags = "MallController", description = "商品api")
    @Controller
    @RequestMapping("/mall")
    public class MallController {
    
        @ApiOperation("测试返回成功")
        @RequestMapping(value = "/testSuccess", method = RequestMethod.GET)
        @ResponseBody
        public CommonResult  returnSuccess(){
            return CommonResult.success("test");
        }
    
    }

查看结果：

![20210610145819668.png][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNzcxNTY3_size_16_color_FFFFFF_t_70]: /images/20221005/6ac708e63dfb46f9b29c90cdf81fbd78.png
[20210610145819668.png]: /images/20221005/aae7971445fa46b3ba0be39cfdfcba49.png