SpringBoot项目统一返回类

Java的继父

已于 2023-06-18 19:13:29 修改

阅读量700

点赞数

分类专栏： SpringBoot 文章标签： spring boot java servlet

于 2023-06-18 16:19:54 首次发布

本文链接：https://blog.csdn.net/wb980520/article/details/131272380

版权

前言

为了让后端更方便的返回数据，也为了让前端去响应统一的返回体，我们需要在项目中自己创建规范的返回类，具体步骤如下所示

一、创建返回类所需要的接口

package com.example.springbootdemo.common.response;

/**
 * @ClassName: IResultCode
 * @Description: 统一状态码接口
 * @Author: WangBin
 * @Date: 2023/6/18 15:29
 */
public interface IResultCode {
   
    /**
     * 获取状态码
     *
     * @return 状态码
     */
    Integer getCode();

    /**
     * 获取返回消息
     *
     * @return 返回消息
     */
    String getMessage();
}

二、创建实现返回类接口的枚举

package com.example.springbootdemo.common.response;

import lombok.Getter;

/**
 * @ClassName: ResultCode
 * @Description:
 * @Author: WangBin
 * @Date: 2023/6/18 15:30
 */
@Getter
public enum ResultCode implements IResultCode{
   

    /**
     * 成功
     */
    OK(200, "成功"),
    /**
     * 失败
     */
    ERROR(500, "失败"),
    SYSTEM_ERROR(501, "系统错误"),
    UNKNOWN_ERROR(502, "未知错误"),


    /* 参数错误：1000～1999 */
    PARAM_NOT_VALID(1001, "参数无效"),
    PARAM_IS_BLANK(1002, "参数为空"),
    PARAM_TYPE_ERROR(1003, "参数类型错误"),
    PARAM_NOT_COMPLETE(1004, "参数缺失"),
    PARAM_TYPE_REPEAT(1005,"参数重复"),

    /* 用户错误 */
    USER_NOT_LOGIN(2001, "用户未登录"),
    USER_ACCOUNT_EXPIRED(2002, "账号已过期"),
    USER_CREDENTIALS_ERROR(2003, "密码错误"),
    USER_CREDENTIALS_EXPIRED(2004, "密码过期"),
    USER_ACCOUNT_DISABLE(2005, "账号不可用"),
    USER_ACCOUNT_LOCKED(2006, "账号被锁定"),
    USER_ACCOUNT_NOT_EXIST(2007, "账号不存在"<