springboot统一restful返回值及统一异常处理

最新推荐文章于 2024-10-15 16:28:50 发布

原创

最新推荐文章于 2024-10-15 16:28:50 发布

· 1.3k 阅读

0 ·

版权

文章标签：

#java #程序员 #互联网

本文介绍了如何在SpringBoot项目中实现RESTful接口的统一返回值格式，包括创建一个统一响应类`ResponseBean`，定义枚举类`UnicomResponseEnums`以存储常见错误信息，创建自定义异常`UnicomRuntimeException`，并实现全局异常处理类`SpringExceptionHandle`。此外，还展示了如何使用拦截器`LoginInterceptor`进行登录检查并返回统一的RESTful数据。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

统一返回restful数据：

首先确定需要返回的json数据的格式，定义一个统一返回类

package com.unicom.microservice.peixun.peixun_matb3.Response;

import com.unicom.microservice.peixun.peixun_matb3.enums.UnicomResponseEnums;

/**

* @program: 测试

* @description:返回的JSON数据结构标准

* @author: mtb

* @create: 2018-10-17 09:01

**/

public class ResponseBean <T>{

private boolean success;

private T data;

private String errCode;

private String errMsg;

public ResponseBean(){}

public ResponseBean(boolean success, T data) {

super();

this.success = success;

this.data = data;

}

@Override

public String toString() {

return "ResponseBean{" +

"success=" + success +

", data=" + data +

", errCode='" + errCode + '\'' +

", errMsg='" + errMsg + '\'' +

'}';

}

public ResponseBean(boolean success, T data, String errCode, String errMsg) {

super();

this.success = success;

this.data = data;

this.errCode = errCode;

this.errMsg = errMsg;

}

public ResponseBean(boolean success, String errCode, String errMsg) {

this.success = success;

this.errCode = errCode;

this.errMsg = errMsg;

}

public ResponseBean(boolean success,UnicomResponseEnums enums){

this.success=success;

this.errCode=enums.getCode();

this.errMsg=enums.getMsg();

}

public ResponseBean(boolean success,T data,UnicomResponseEnums enums){

this.success=success;

this.data=data;

this.errCode=enums.getCode();

this.errMsg=enums.getMsg();

}

public boolean isSuccess() {

return success;

}

public void setSuccess(boolean success) {

this.success = success;

}

public T getData() {

return data;

}

public void setData(T data) {

this.data = data;

}

public String getErrCode() {

return errCode;

}

public void setErrCode(String errCode) {

this.errCode = errCode;

}

public String getErrMsg() {

return errMsg;

}

public void setErrMsg(String errMsg) {

this.errMsg = errMsg;

}

}

新建一个枚举类，将常用提示信息及错误信息写入：

package com.unicom.microservice.peixun.peixun_matb3.enums;

/**

* @program: 测试

* @description:友好提示枚举

* @author: mtb

* @create: 2018-10-17 08:52

**/

public enum UnicomResponseEnums {

SYSTEM_ERROR("-001","系统异常"),

BAD_REQUEST("-002","错误的请求参数"),

NOT_FOUND("-003","找不到请求路径！"),

CONNECTION_ERROR("-004","网络连接请求失败！"),

METHOD_NOT_ALLOWED("-005","不合法的请求方式"),

DATABASE_ERROR("-004","数据库异常"),

BOUND_STATEMENT_NOT_FOUNT("-006","找不到方法！"),

REPEAT_REGISTER("001","重复注册"),

NO_USER_EXIST("002","用户不存在"),

INVALID_PASSWORD("003","密码错误"),

NO_PERMISSION("004","非法请求！"),

SUCCESS_OPTION("005","操作成功！"),

NOT_MATCH("-007","用户名和密码不匹配"),

FAIL_GETDATA("-008","获取信息失败"),

BAD_REQUEST_TYPE("-009","错误的请求类型"),

INVALID_MOBILE("010","无效的手机号码"),

INVALID_EMAIL("011","无效的邮箱"),

INVALID_GENDER("012","无效的性别"),

REPEAT_MOBILE

最低0.47元/天解锁文章