springboot統一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，學習視頻），歡迎加群領取。
springboot統一restful返回值及統一異常處理