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

最新推荐文章于 2024-07-05 21:44:28 发布
最新推荐文章于 2024-07-05 21:44:28 发布
阅读量677 收藏 1
点赞数
文章标签： java json 数据库
原文链接：http://blog.51cto.com/14226273/2376121
版权

统一返回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("014","已存在此手机号"),

REPEAT_EMAIL("015","已存在此邮箱地址"),

NO_RECORD("016","没有查到相关记录"),

LOGIN_SUCCESS("017","登陆成功"),

LOGOUT_SUCCESS("018","已退出登录"),

SENDEMAIL_SUCCESS("019","邮件已发送，请注意查收"),

EDITPWD_SUCCESS("020","修改密码成功"),

No_FileSELECT("021","未选择文件"),

FILEUPLOAD_SUCCESS("022","上传成功"),

NOLOGIN("023","未登陆"),

ILLEGAL_ARGUMENT("024","参数不合法"),

ERROR_IDCODE("025","验证码不正确");

private String code;

private String msg;

private UnicomResponseEnums(String code, String msg) {

this.code = code;

this.msg = msg;

}

public String getCode() {

return code;

}

public void setCode(String code) {

this.code = code;

}

public String getMsg() {

return msg;

}

public void setMsg(String msg) {

this.msg = msg;

}

}

建立一个自定义异常继承 RuntimeException类，以便抛出自定义异常

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

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

/**

  • @program: 测试

  • @description:自定义异常

  • @author: mtb

  • @create: 2018-10-17 08:57

**/

public class UnicomRuntimeException extends RuntimeException {

private static final long serialVersionUID = 1L;

protected String code;

protected String msg;

protected String message;//打印出的日志信息

public UnicomRuntimeException(UnicomResponseEnums enums, String message) {

super();

this.code = enums.getCode();

this.msg = enums.getMsg();

this.message = message;

}

public UnicomRuntimeException(UnicomResponseEnums enums) {

super();

this.code = enums.getCode();

this.msg = enums.getMsg();

}

public String getCode() {

return code;

}

public void setCode(String code) {

this.code = code;

}

public String getMsg() {

return msg;

}

public void setMsg(String msg) {

this.msg = msg;

}

public String getMessage() {

return message;

}

public void setMessage(String message) {

this.message = message;

}

public UnicomRuntimeException() {

super();

}

public UnicomRuntimeException(String message, Throwable cause) {

super(message, cause);

}

public UnicomRuntimeException(String message) {

super(message);

}

}

新建一个异常处理类：

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

import javax.servlet.http.HttpServletRequest;

import com.unicom.microservice.peixun.peixun_matb3.Response.ResponseBean;

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

import org.apache.ibatis.binding.BindingException;

import org.omg.CosNaming.NamingContextPackage.NotFound;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.dao.DataAccessException;

import org.springframework.http.HttpStatus;

import org.springframework.stereotype.Controller;

import org.springframework.validation.BindException;

import org.springframework.web.bind.annotation.*;

import org.springframework.web.servlet.NoHandlerFoundException;

import java.net.ConnectException;

import java.sql.SQLException;

/**

  • @program: 测试

  • @description:全局的异常处理类

  • @author: mtb

  • @create: 2018-10-19 11:38

**/

@RestControllerAdvice(annotations={RestController.class,Controller.class})

public class SpringExceptionHandle {

private static final Logger logger = LoggerFactory.getLogger(SpringExceptionHandle.class);

/**

  • 请求参数类型错误异常的捕获

  • @param e

  • @return

*/

@ExceptionHandler(value={BindException.class})

@ResponseBody

@ResponseStatus(value=HttpStatus.BAD_REQUEST)

public ResponseBean<String> badRequest(BindException e){

logger.error("occurs error when execute method ,message {}",e.getMessage());

return new ResponseBean<>(false, UnicomResponseEnums.BAD_REQUEST);

}

/**

  • 404错误异常的捕获

  • @param e

  • @return

*/

@ExceptionHandler(value={NoHandlerFoundException.class})

@ResponseBody

@ResponseStatus(value=HttpStatus.NOT_FOUND)

public ResponseBean<String> badRequestNotFound(BindException e){

logger.error("occurs error when execute method ,message {}",e.getMessage());

return new ResponseBean<>(false,null, UnicomResponseEnums.NOT_FOUND);

}

/**

  • mybatis未绑定异常

  • @param e

  • @return

*/

@ExceptionHandler(BindingException.class)

@ResponseBody

@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR)

public ResponseBean<String> mybatis(Exception e){

logger.error("occurs error when execute method ,message {}",e.getMessage());

return new ResponseBean<>(false,UnicomResponseEnums.BOUND_STATEMENT_NOT_FOUNT);

}

/**

  • 自定义异常的捕获

  • 自定义抛出异常。统一的在这里捕获返回JSON格式的友好提示。

  • @param exception

  • @param request

  • @return

*/

@ExceptionHandler(value={UnicomRuntimeException.class})

@ResponseBody

@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR)

public <T> ResponseBean<T> sendError(UnicomRuntimeException exception,HttpServletRequest request){

String requestURI = request.getRequestURI();

logger.error("occurs error when execute url ={} ,message {}",requestURI,exception.getMsg());

return new ResponseBean<>(false,exception.getCode(),exception.getMsg());

}

/**

  • 数据库操作出现异常

  • @param e

  • @return

*/

@ExceptionHandler(value={SQLException.class,DataAccessException.class})

@ResponseBody

@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR)

public ResponseBean<String> systemError(Exception e){

logger.error("occurs error when execute method ,message {}",e.getMessage());

return new ResponseBean<>(false, UnicomResponseEnums.DATABASE_ERROR);

}

/**

  • 网络连接失败！

  • @param e

  • @return

*/

@ExceptionHandler(value={ConnectException.class})

@ResponseBody

@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR)

public ResponseBean<String> connect(Exception e){

logger.error("occurs error when execute method ,message {}",e.getMessage());

return new ResponseBean<>(false, UnicomResponseEnums.CONNECTION_ERROR);

}

@ExceptionHandler(value={Exception.class})

@ResponseBody

@ResponseStatus(value=HttpStatus.METHOD_NOT_ALLOWED)

public ResponseBean<String> notAllowed(Exception e){

logger.error("occurs error when execute method ,message {}",e.getMessage());

return new ResponseBean<>(false, UnicomResponseEnums.METHOD_NOT_ALLOWED);

}

}

建立一个测试controller类：

package com.unicom.microservice.peixun.peixun_matb3.web;/**

  • Created by matengbing on 2018/10/15.

*/

import com.unicom.microservice.peixun.peixun_matb3.Response.ResponseBean;

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

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiOperation;

import org.springframework.web.bind.annotation.*;

import springfox.documentation.annotations.ApiIgnore;

import java.util.HashMap;

import java.util.Map;

import java.util.Objects;

import java.util.StringJoiner;

/**

  • @program: 测试

  • @description:测试接口

  • @author: mtb

  • @create: 2018-10-15 11:26

**/

@RestController

@ApiIgnore

//@RequestMapping(value = "sayHello")

public class HelloController {

@CrossOrigin

@ApiOperation(value = "hello")

@RequestMapping(value = "/hello",method = RequestMethod.GET)

public ResponseBean<UnicomResponseEnums> sayHello(){

ResponseBean responseBean=new ResponseBean(true,UnicomResponseEnums.SUCCESS_OPTION);

return responseBean;

}

}

使用postman测试接口：

注意要配置springboot启动类，扫描controller等注解类被扫描到

@API等注解是swagger的注解，如果没有使用到可以删除

我们在实现数据库操作的方法中try，catch，捕捉到异常后，抛出一个自定义异常

@Transactional

@Override

public int addUser(User user) {

try {

user.setUserpwd(DigestUtils.md5DigestAsHex(user.getUserpwd().getBytes()));

userMapper.insertUser(user);

return user.getId();

}catch (Exception e){

throw new UnicomRuntimeException(UnicomResponseEnums.FAIL_INSERTUSER);

}

}

接着拦截404错误

package com.unicom.peixun.web;

import com.unicom.peixun.Response.ResponseBean;

import com.unicom.peixun.enums.UnicomResponseEnums;

import org.springframework.boot.autoconfigure.web.ErrorController;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;

/**

  • @program: peixun_matb3

  • @description:

  • @author: matengbing

  • @create: 2018-10-20 09:08

**/

@RestController

public class MyBasicErrorController implements ErrorController {

private static final String ERROR_PATH="/error";

@RequestMapping("/error")

public ResponseBean<Object> handleError(HttpServletRequest request){

//获取statusCode:401,404,500

Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");

if(statusCode==404){

return new ResponseBean<>(false,null,UnicomResponseEnums.NOT_FOUND);

}else {

return new ResponseBean<>(false,null,UnicomResponseEnums.METHOD_NOT_ALLOWED);

}

}

@Override

public String getErrorPath() {

return ERROR_PATH;

}

}

用于登录拦截的拦截器实现返回restful数据：

package com.unicom.peixun.inteceptor;

import com.alibaba.fastjson.JSON;

import com.unicom.peixun.Response.ResponseBean;

import com.unicom.peixun.domain.User;

import com.unicom.peixun.enums.UnicomResponseEnums;

import com.unicom.peixun.web.UserController;

import org.apache.log4j.Logger;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.stereotype.Component;

import org.springframework.web.servlet.HandlerInterceptor;

import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpSession;

import java.io.PrintWriter;

/**

  • @program: peixun_matb3

  • @description:

  • @author: matengbing

  • @create: 2018-10-18 10:40

**/

@Component

public class LoginInterceptor implements HandlerInterceptor {

private static Logger logger=Logger.getLogger(LoginInterceptor.class);

@Autowired

UserController userController;

// 在请求处理之前调用,只有返回true才会执行请求

@Override

public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {

HttpSession session=httpServletRequest.getSession();

User user=(User) session.getAttribute("user");

//登录过得用户直接通过

if(user!=null){

return true;

}

//未登录用户拦截，返回json数据

httpServletResponse.setCharacterEncoding("UTF-8");

httpServletResponse.setContentType("application/json; charset=utf-8");

PrintWriter out = httpServletResponse.getWriter() ;

try{

ResponseBean<Object> responseBean=new ResponseBean<>(false,null,UnicomResponseEnums.NOLOGIN);

out = httpServletResponse.getWriter();

out.append(JSON.toJSON(responseBean).toString());

return false;

}

catch (Exception e) {

e.printStackTrace();

httpServletResponse.sendError(500);

return false;

}

}

@Override

public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {

}

@Override

public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {

}

}

拦截器需要配置@configuration

package com.unicom.peixun.configuration;

import com.unicom.peixun.inteceptor.LoginInterceptor;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.servlet.config.annotation.InterceptorRegistry;

import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

/**

  • @program:

  • @description:

  • @author: mtb

  • @create: 2018-10-18 10:50

**/

@Configuration

public class LoginAdapter extends WebMvcConfigurerAdapter {

@Autowired

LoginInterceptor loginInterceptor;

@Override

public void addInterceptors(InterceptorRegistry registry) {

registry.addInterceptor(loginInterceptor)

.addPathPatterns("/**")

.excludePathPatterns("/login")

.excludePathPatterns("/swagger-resources/", "/webjars/", "/v2/", "/swagger-ui.html/");

super.addInterceptors(registry);

}

/**

  • 配置静态访问资源

  • @param registry

*/

@Override

public void addResourceHandlers(ResourceHandlerRegistry registry) {

registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");

registry.addResourceHandler("swagger-ui.html")

.addResourceLocations("classpath:/META-INF/resources/");

registry.addResourceHandler("/webjars/**")

.addResourceLocations("classpath:/META-INF/resources/webjars/");

super.addResourceHandlers(registry);

}

}

配置了拦截器拦截所有请求，不拦截/login，swagger的相关请求，静态资源的请求，

如果拦截了/login会出现循环重定向报错

如果拦截了swagger的相关请求，查看swagger文档时看不到相应资源

喜欢的点点关注，点点赞。

对Java技术，架构技术感兴趣的同学，欢迎加QQ群585550789，一起学习，相互讨论。

群内已经有小伙伴将知识体系整理好（源码，笔记，PPT，学习视频），欢迎加群领取。

转载于:https://blog.51cto.com/14226273/2376121

weixin_34062329
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
SpringBoot优雅的统一restful返回结果
浅汐
09-09 3081
1.为什么要定义通用返回对象： 项目开发中，一般情况下都会对数据返回的格式做一个统一的要求，一般会包括状态码、信息及数据三部分。定义通用返回对象可以在原返回的数据基础上封装一层，将状态码等信息包含进来。 2.案例如下： 1.通过枚举类自定义返回状态码： /** * API 统一返回状态码 */ public enum ResultCode { /* 成功状态码 */ ...
第七章：SpringBoot2.3.0 RESTful API常用GET、POST请求方式传参与统一返回值
p812438109的专栏
06-09 4912
一）RESTful简介 定义：RESTful是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。 RESTful特点： 1、每一个URI都是一个唯一资源标识符； 2、客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源； 3、资源的表现形式是XML或HTML或JSON； 4、客户端与服务端之间的交互在.
SpringBoot异常处理
KobeSacre的博客
02-07 271
异常处理
【Spring Boot】统一数据返回
最新发布
smile_sundays的博客
07-05 1978
其实统一数据返回非常简单，在实现时要加入类注解@ControllerAdvice(这是一个表示控制通知的注解，在接下来的统一异常处理也要运用到)，在添加类注解后还要在实现ResponseBodyAdvice接口，然后重写接口的responseAdvice接口和beforeBodyWriter方法即可实现。其实统一数据返回是运用了AOP（对某一类事情的集中处理）的思维，简单概括就是在我们进行前后端数据交互的时候，能够让后端的数据进行统一的打包封装，返回给前端，便于前后端的数据处理。
SpringBoot实现RESTful API返回统一数据格式
Crystalqy的博客
03-03 3万+
关于 Spring 的全局处理，有两方面要说: 统一数据返回格式 统一异常处理 通用返回值类定义： public class GlobalResponse<T> implements POJO { /** * */ private static final long serialVersionUID = 1L; @ApiModelPro...
springboot定义restful统一结果返回
只为成功找方法 不为失败找借口
06-21 558
http统一结果返回
SpringBoot restful返回值+统一异常处理+参数校验
sleetdream的博客
03-25 2511
SpringBoot restful返回值+统一异常处理+参数校验restful返回值自定义错误类型Restful接口返回值拦截统一异常处理自定义异常统一异常捕获示例参数校验hibernate validator配置使用hibernate validator注解示例自定义校验自定义校验注解校验实现校验异常捕获参数校验实体类校验参数定义示例代码示例参考 restful返回值 自定义错误类型 新建枚举...
一个干净的springboot项目,已集成集成代码生成器(plus),分页插件,Knife4j(swagger2),统一返回值
03-14
综上所述，这个项目提供了一个基础且完善的SpringBoot开发环境，包含了代码生成、数据库分页、API文档管理和统一返回值管理等功能，对于快速构建企业级应用非常有帮助。随着项目的进一步开发，还可以集成更多的基础...
SpringBootWeb 请求响应 分层解耦
02-14
- 自定义异常处理器，如`@ControllerAdvice`配合`@ExceptionHandler`，可以统一处理全局的异常。 10. **日志和监控**： - Spring Boot默认集成了Logback或Log4j进行日志记录，可以使用`@Slf4j`或`@Autowired`的...
SpringMVC的Restful风格Demo
04-21
7. **异常处理（Exception Handling）**：使用`@ExceptionHandler`注解处理可能出现的异常，返回合适的错误信息和状态码。 在实际开发中，我们通常会结合Spring Boot框架，其内置了对SpringMVC的支持，并提供了很多...
springboot448教学辅助系统pf.zip
06-01
- 自定义全局异常处理器，如`@ControllerAdvice`和`@ExceptionHandler`，统一处理程序中的异常。 9. **Maven/Gradle构建**： - 项目可能使用Maven或Gradle作为构建工具，管理依赖关系和构建流程。 10. **测试**...
SpringBoot_REST：Spring Boot REST API
03-04
以上是对Spring Boot REST API的基本介绍，实际项目中还需要考虑异常处理、API版本管理、跨域资源共享（CORS）、性能优化等更多细节。通过SpringBoot_REST-master这个项目，你可以深入学习如何构建和部署一个完整的...
java接口返回值报错,Springboot Restful接口及异常统一返回值实现
weixin_42297605的博客
03-22 914
为什么要统一返回值两点：1 为了制定规范提高工作效率(效率)2 统一异常处理给用户一个正确的提示(易用)实现原理使用@ControllerAdvice注解，该注解是Springmvc controller增强器。统一接口的返回值实现返回钱处理流程使用@ControllerAdvice注解，实现ResponseBodyAdvice的beforeBodyWrite方法，用于对@ResponseBody...
springboot 统一返回数据格式和统一异常处理
骐骥一跃，不能十步；驽马十驾，功在不舍。
12-03 1120
spring boot全局异常处理
已解决java.lang.IllegalArgumentException异常的正确解决方法，亲测有效！！！
小明的Java问道之路
01-07 3万+
IllegalArgumentException是由于传递给方法的参数非法或不正确而引发的，要解决这个问题，需要在调用方法前验证输入，并在方法内部使用断言来检查参数的有效性。
java.lang.IllegalArgumentException 异常报错完美解决
热门推荐
辰小白
07-12 15万+
目录 修改JDK使用版本 修改开发工具idea配置（eclipse的直接跳过这个看下面） 修改开发工具eclipse配置 学习spring依赖注入的时候碰到这个坑，折腾了许久，记录一下以防其他小伙伴入坑！ 该异常主要原因是因为JDK与Spring版本不一致。要么更换jdk，要么重新下载符合jdk的springjar包 我本地装了两个JDK版本，一个1.8，一个1.7，原本以为只要修改一...
【SpringBoot项目报错】org.springframework.web.bind.MissingPathVariableException
lilichalilicha的博客
08-04 5686
二、@GetMapping("/getInfo") 改为 @GetMapping("/getIn/{id}")一、@PathVariable 改为 @RequestParam 即可。
Java面试题
weixin_43718423的博客
07-24 830
java 面试题，通用
SpringBoot 2.0 实现RESTful API教程
"这篇博客文章主要讲解了如何在Spring Boot 2.0版本中实现RESTful API，并通过示例展示了GET、POST、PUT和DELETE四种HTTP方法的使用，以及如何利用RestTemplate处理JSON数据。文章内容包括项目配置、代码实现和测试...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值