SpringCloud微服务实战——搭建企业级开发框架,七）：自定义通用响应消息及统一异常处理

• 礼包

技术SpringCloud微服务实战——搭建企业级开发框架,七）：自定义通用响应消息及统一异常处理 SpringCloud微服务实战——搭建企业级开发框架（七）：自定义通用响应消息及统一异常处理??平时

SpringCloud微服务实战——搭建企业级开发框架（七):自定义通用响应消息及统一异常处理

？平时开发过程中，无可避免我们需要处理各类异常，所以这里我们在公共模块中自定义统一异常，Spring Boot提供@RestControllerAdvice注解统一异常处理，我们在GitEgg_Platform中新建饭桶鸡蛋-平台引导子工程，此工程主要用于Spring Boot相关功能的自定义及扩展。

1、修改饭桶鸡蛋-平台引导的pom.xml，添加弹簧靴起动器腹板和时髦的依赖，设置可选择的为没错，让这个包在项目之间依赖不传递。

属国

groupidorg.springframework.boot/groupid

工件id spring-boot-starter-web/工件id

可选用户/可选用户

/依赖性

属国

groupidcom.gitegg.platform/groupid

artifact id git egg-platform-swag/artifact id

可选用户/可选用户

/依赖性

2、自定义通用响应消息类结果和页面结果，一个是普通响应消息，一个是分页响应消息。

结果类：

包裹。com。饭桶鸡蛋。站台。靴子。常见。基地；

进口。com。饭桶鸡蛋。站台。靴子。常见。埃努姆。resultcodeenum

导入io。赃物。注释。apimode

导入io。赃物。注释。apimodelproperty

导入朗博克岛.*;

/**

* @类名：结果

* @Description:自定义通用响应类

* @作者GitEgg

* @日期2020年年09月19日下午9:24:50

*/

@ApiModel(描述='通用响应类)

@Getter

@ToString

公共类结果

@ApiModelProperty(值='是否成功，必选=真)

私有布尔成功；

@ApiModelProperty(值='响应代码，必选=真)

私有（同Internationalorganizations）国际组织代码；

@ApiModelProperty(值='提示信息，必选=真)

私有字符串消息；

@ApiModelProperty(值='响应数据)

私人测试数据；

/**

*

* @param代码

* @param数据

* @param消息

*/

私有结果（内部代码、测试数据、字符串消息){ 0

this.success=ResultCodeEnum .SUCCESS.code==code

this.code=代码

this.msg=msg

this.data=数据；

}

/**

*

* @param resultCodeEnum

*/

私有结果（结果代码枚举)

这个(resultCodeEnum.code，null，resultCodeEnum。味精)；

}

/**

*

* @param resultCodeEnum

* @param消息

*/

私有结果（结果代码枚举结果代码枚举，字符串消息){ 0

这个(resultCodeEnum，null，msg)；

}

/**

*

* @param resultCodeEnum

* @param数据

*/

私有结果（结果代码

eEnum resultCodeEnum , T data) {
this(resultCodeEnum, data, resultCodeEnum.msg);
}
/**
*
* @param resultCodeEnum
* @param data
* @param msg
*/
private Result(ResultCodeEnum resultCodeEnum , T data, String msg) {
this(resultCodeEnum.code, data, msg);
}
/**
*
*
* @param data 数据
* @param t T 响应数据
* @
*/
public static t Resultt data(T data) {
return data(data, ResultCodeEnum.SUCCESS.msg);
}
/**
*
*
* @param data 数据
* @param msg 消息
* @param t T 响应数据
* @
*/
public static t Resultt data(T data, String msg) {
return data(ResultCodeEnum.SUCCESS.code, data, msg);
}
/**
*
*
* @param code 状态码
* @param data 数据
* @param msg 消息
* @param t T 响应数据
* @
*/
public static t Resultt data(int code, T data, String msg) {
return new Result(code, data, msg);
}
/**
* 返回Result
*
* @param
* @param t T 响应数据
* @返回Result
*/
public static t Resultt success() {
return new Result(ResultCodeEnum.SUCCESS);
}

/**
* 返回Result
*
* @param msg 消息
* @param t T 响应数据
* @返回Result
*/
public static t Resultt success(String msg) {
return new Result(ResultCodeEnum.SUCCESS, msg);
}
/**
* 返回Result
*
* @param
* @param t T 响应数据
* @返回Result
*/
public static t Resultt success(ResultCodeEnum resultCodeEnum ) {
return new Result(resultCodeEnum);
}
/**
* 返回Result
*
* @param
* @param msg 提示信息
* @param t T 响应数据
* @返回Result
*/
public static t Resultt success(ResultCodeEnum resultCodeEnum , String msg) {
return new Result(resultCodeEnum, msg);
}

/**
* 返回Result
*
* @param t T 响应数据
* @返回Result
*/
public static t Resultt error() {
return new Result(ResultCodeEnum.ERROR, ResultCodeEnum.ERROR.msg);
}
/**
* 返回Result
*
* @param msg 消息
* @param t T 响应数据
* @返回Result
*/
public static t Resultt error(String msg) {
return new Result(ResultCodeEnum.ERROR, msg);
}
/**
* 返回Result
*
* @param code 状态码
* @param msg 消息
* @param t T 响应数据
* @返回Result
*/
public static t Resultt error(int code, String msg) {
return new Result(code, null, msg);
}
/**
* 返回Result
*
* @param
* @param t T 响应数据
* @返回Result
*/
public static t Resultt error(ResultCodeEnum resultCodeEnum ) {
return new Result(resultCodeEnum);
}
/**
* 返回Result
*
* @param
* @param msg 提示信息
* @param t T 响应数据
* @返回Result
*/
public static t Resultt error(ResultCodeEnum resultCodeEnum , String msg) {
return new Result(resultCodeEnum, msg);
}

/**
*
* @param t
* @param flag
* @return
*/
public static t Resultt result(boolean flag) {
return flag Result.success("操作成功") : Result.error("操作失败");
}
}

PageResult类：

package com.gitegg.platform.boot.common.base;
import java.util.List;
import com.gitegg.platform.boot.common.enums.ResultCodeEnum;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
/**
 * @ClassName: PageResult
 * @Description: 通用分页返回
 * @author GitEgg
 * @date
 * @param t
 */
@Data
@ApiModel("通用分页响应类")
public class PageResultt {
    @ApiModelProperty(value = "是否成功", required = true)
    private boolean success;
    @ApiModelProperty(value ="响应代码", required = true)
    private int code;
    @ApiModelProperty(value ="提示信息", required = true)
    private String msg;
    @ApiModelProperty(value ="总数量", required = true)
    private long count;
    @ApiModelProperty(value ="分页数据")
    private Listt data;
    public PageResult(long total, Listt rows) {
        this.count = total;
        this.data = rows;
        this.code = ResultCodeEnum.SUCCESS.code;
        this.msg = ResultCodeEnum.SUCCESS.msg;
    }
}

3、自定义通用响应消息枚举类ResultCodeEnum。

package com.gitegg.platform.boot.common.enums;
/**
 * @ClassName: ResultCodeEnum
 * @Description: 自定义返回码枚举
 * @author GitEgg
 * @date 2020年09月19日 下午11:49:45
 */
public enum ResultCodeEnum {
    /**
     * 成功
     */
    SUCCESS(200, "操作成功"),
    /**
     * 系统错误
     */
    ERROR(500, "系统错误"),
    /**
     * 操作失败
     */
    FAILED(101, "操作失败"),
    /**
     * 未登录/登录超时
     */
    UNAUTHORIZED(102, "登录超时"),
    /**
     * 参数错误
     */
    PARAM_ERROR(103, "参数错误"),
    /**
     * 参数错误-已存在
     */
    INVALID_PARAM_EXIST(104, "请求参数已存在"),
    /**
     * 参数错误
     */
    INVALID_PARAM_EMPTY(105, "请求参数为空"),
    /**
     * 参数错误
     */
    PARAM_TYPE_MISMATCH(106, "参数类型不匹配"),
    /**
     * 参数错误
     */
    PARAM_VALID_ERROR(107, "参数校验失败"),
    /**
     * 参数错误
     */
    ILLEGAL_REQUEST(108, "非法请求"),
    /**
     * 验证码错误
     */
    INVALID_VCODE(204, "验证码错误"),
    /**
     * 用户名或密码错误
     */
    INVALID_USERNAME_PASSWORD(205, "账号或密码错误"),
    /**
     *
     */
    INVALID_RE_PASSWORD(206, "两次输入密码不一致"),
    /**
     * 用户名或密码错误
     */
    INVALID_OLD_PASSWORD(207, "旧密码错误"),
    /**
     * 用户名重复
     */
    USERNAME_ALREADY_IN(208, "用户名已存在"),
    /**
     * 用户不存在
     */
    INVALID_USERNAME(209, "用户名不存在"),
    /**
     * 角色不存在
     */
    INVALID_ROLE(210, "角色不存在"),
    /**
     * 角色不存在
     */
    ROLE_USED(211, "角色使用中，不可删除"),
    /**
     * 没有权限
     */
    NO_PERMISSION(403, "当前用户无该接口权限");
    public int code;
    public String msg;
    ResultCodeEnum(int code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public int getCode() {
        return code;
    }
    public void setCode(int code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}

4、自定义异常类BusinessException和SystemException

package com.gitegg.platform.boot.common.exception;
import com.gitegg.platform.boot.common.enums.ResultCodeEnum;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.Getter;
import lombok.Setter;
/**
 * @ClassName: BusinessException
 * @Description: 业务处理异常
 * @author GitEgg
 * @date
 */
@Getter
@Setter
public class BusinessException extends RuntimeException {
    private int code;
    private String msg;
    public BusinessException() {
        this.code = ResultCodeEnum.FAILED.code;
        this.msg = ResultCodeEnum.FAILED.msg;
    }
    public BusinessException(String message) {
        this.code = ResultCodeEnum.FAILED.code;
        this.msg = message;
    }
    public BusinessException(int code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public BusinessException(Throwable cause) {
        super(cause);
    }
    public BusinessException(String message, Throwable cause) {
        super(message, cause);
    }
}

package com.gitegg.platform.boot.common.exception;
import com.gitegg.platform.boot.common.enums.ResultCodeEnum;
import lombok.Getter;
/**
 * @ClassName: SystemException
 * @Description: 系统处理异常
 * @author GitEgg
 * @date
 */
@Getter
public class SystemException extends RuntimeException {
    private int code;
    private String msg;
    public SystemException() {
        this.code = ResultCodeEnum.ERROR.code;
        this.msg = ResultCodeEnum.ERROR.msg;
    }
    public SystemException(String message) {
        this.code = ResultCodeEnum.ERROR.code;
        this.msg = message;
    }
    public SystemException(int code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public SystemException(Throwable cause) {
        super(cause);
    }
    public SystemException(String message, Throwable cause) {
        super(message, cause);
    }
}

5、自定义统一异常处理类GitEggControllerAdvice.java

package com.gitegg.platform.boot.common.advice;
import com.gitegg.platform.boot.common.base.Result;
import com.gitegg.platform.boot.common.enums.ResultCodeEnum;
import com.gitegg.platform.boot.common.exception.BusinessException;
import com.gitegg.platform.boot.common.exception.SystemException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.ui.Model;
import org.springframework.web.HttpMediaTypeNotAcceptableException;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingPathVariableException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
import org.springframework.web.servlet.NoHandlerFoundException;
import javax.annotation.PostConstruct;
import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolationException;
@Slf4j
@RestControllerAdvice
public class GitEggControllerAdvice {
    /**
     * 服务名
     */
    @Value("${spring.application.name}")
    private String serverName;
    /**
     * 微服务系统标识
     */
    private String errorSystem;
    @PostConstruct
    public void init() {
        this.errorSystem = new StringBuffer()
                .append(this.serverName)
                .append(": ").toString();
    }
    /**
     * 应用到所有@RequestMapping注解方法，在其执行之前初始化数据绑定器
     */
    @InitBinder
    public void initBinder(WebDataBinder binder) {
    }
    /**
     * 把值绑定到Model中，使全局@RequestMapping可以获取到该值
     */
    @ModelAttribute
    public void addAttributes(Model model) {
    }
    /**
     * 全局异常捕捉处理
     */
    @ExceptionHandler(value = {Exception.class})
    public Result handlerException(Exception exception, HttpServletRequest request) {
        log.error("请求路径uri={},系统内部出现异常:{}", request.getRequestURI(), exception);
        Result result = Result.error(ResultCodeEnum.ERROR, errorSystem + exception.toString());
        return result;
    }
    /**
     * 非法请求异常
     */
    @ExceptionHandler(value = {
            HttpMediaTypeNotAcceptableException.class,
            HttpMediaTypeNotSupportedException.class,
            HttpRequestMethodNotSupportedException.class,
            MissingServletRequestParameterException.class,
            NoHandlerFoundException.class,
            MissingPathVariableException.class,
            HttpMessageNotReadableException.class
    })
    public Result handlerSpringAOPException(Exception exception) {
        Result result = Result.error(ResultCodeEnum.ILLEGAL_REQUEST, errorSystem + exception.getMessage());
        return result;
    }
    /**
     * 非法请求异常-参数类型不匹配
     */
    @ExceptionHandler(value = MethodArgumentTypeMismatchException.class)
    public Result handlerSpringAOPException(MethodArgumentTypeMismatchException exception) {
        Result result = Result.error(ResultCodeEnum.PARAM_TYPE_MISMATCH, errorSystem + exception.getMessage());
        return result;
    }
    /**
     * 非法请求-参数校验
     */
    @ExceptionHandler(value = {MethodArgumentNotValidException.class})
    public Result handlerMethodArgumentNotValidException(MethodArgumentNotValidException methodArgumentNotValidException) {
        //获取异常字段及对应的异常信息
        StringBuffer stringBuffer = new StringBuffer();
        methodArgumentNotValidException.getBindingResult().getFieldErrors().stream()
                .map(t - t.getField()+"="+t.getDefaultMessage()+" ")
                .forEach(e - stringBuffer.append(e));
        String errorMessage = stringBuffer.toString();
        Result result = Result.error(ResultCodeEnum.PARAM_VALID_ERROR, errorSystem + errorMessage);
        return result;
    }
    /**
     * 非法请求异常-参数校验
     */
    @ExceptionHandler(value = {ConstraintViolationException.class})
    public Result handlerConstraintViolationException(ConstraintViolationException constraintViolationException) {
        String errorMessage = constraintViolationException.getLocalizedMessage();
        Result result = Result.error(ResultCodeEnum.PARAM_VALID_ERROR, errorSystem + errorMessage);
        return result;
    }
    /**
     * 自定义业务异常-BusinessException
     */
    @ExceptionHandler(value = {BusinessException.class})
    public Result handlerCustomException(BusinessException exception) {
        String errorMessage = exception.getMsg();
        Result result = Result.error(exception.getCode(), errorSystem + errorMessage);
        return result;
    }
    /**
     * 自定义系统异常-SystemException
     */
    @ExceptionHandler(value = {SystemException.class})
    public Result handlerCustomException(SystemException exception) {
        String errorMessage = exception.getMsg();
        Result result = Result.error(exception.getCode(), errorSystem + errorMessage);
        return result;
    }
}

6、重新将GitEgg-Platform进行install，在GitEgg-Cloud中的gitegg-service引入gitegg-platform-boot

!--xml version="1.0" encoding="UTF-8"--
project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
    parent
        artifactidGitEgg-Cloud/artifactid
        groupidcom.gitegg.cloud/groupid
        version1.0-SNAPSHOT/version
    /parent
    modelversion4.0.0/modelversion
    artifactidgitegg-service/artifactid
    packagingpom/packaging
    modules
        modulegitegg-service-base/module
        modulegitegg-service-bigdata/module
        modulegitegg-service-system/module
    /modules
    dependencies
        !-- gitegg Spring Boot自定义及扩展 --
        dependency
            groupidcom.gitegg.platform/groupid
            artifactidgitegg-platform-boot/artifactid
        /dependency
        !-- gitegg数据库驱动及连接池 --
        dependency
            groupidcom.gitegg.platform/groupid
            artifactidgitegg-platform-db/artifactid
        /dependency
        !-- gitegg mybatis-plus --
        dependency
            groupidcom.gitegg.platform/groupid
            artifactidgitegg-platform-mybatis/artifactid
        /dependency
        !-- gitegg swagger2-knife4j --
        dependency
            groupidcom.gitegg.platform/groupid
            artifactidgitegg-platform-swagger/artifactid
        /dependency
        !-- spring boot web核心包 --
        dependency
            groupidorg.springframework.boot/groupid
            artifactidspring-boot-starter-web/artifactid
        /dependency
        !-- spring boot 健康监控 --
        dependency
            groupidorg.springframework.boot/groupid
            artifactidspring-boot-starter-actuator/artifactid
        /dependency
    /dependencies
/project

7、修改SystemController.java、ISystemService.java和SystemServiceImpl.java增加异常处理的测试代码

SystemController.java:

package com.gitegg.service.system.controller;
import com.gitegg.platform.boot.common.base.Result;
import com.gitegg.platform.boot.common.exception.BusinessException;
import com.gitegg.service.system.service.ISystemService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.AllArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping(value = "system")
@AllArgsConstructor
@Api(tags = "gitegg-system")
public class SystemController {
    private final ISystemService systemService;
    @GetMapping(value = "list")
    @ApiOperation(value = "system list接口")
    public Object list() {
        return systemService.list();
    }
    @GetMapping(value = "page")
    @ApiOperation(value = "system page接口")
    public Object page() {
        return systemService.page();
    }
    @GetMapping(value = "exception")
    @ApiOperation(value = "自定义异常及返回测试接口")
    public Resultstring exception() {
        return Result.data(systemService.exception());
    }
}

ISystemService.java:

package com.gitegg.service.system.service;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.gitegg.service.system.entity.SystemTable;
import java.util.List;
public interface ISystemService {
    Listsystemtable list();
    Pagesystemtable page();
    String exception();
}

SystemServiceImpl.java:

package com.gitegg.service.system.service.impl;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.gitegg.platform.boot.common.exception.BusinessException;
import com.gitegg.service.system.entity.SystemTable;
import com.gitegg.service.system.mapper.SystemTableMapper;
import com.gitegg.service.system.service.ISystemService;
import lombok.AllArgsConstructor;
import org.springframework.stereotype.Service;
import java.util.List;
/**
 *
 */
@Service
@AllArgsConstructor
public class SystemServiceImpl implements ISystemService {
    private final SystemTableMapper systemTableMapper;
    @Override
    public Listsystemtable list() {
        return systemTableMapper.list();
    }
    @Override
    public Pagesystemtable page() {
        Pagesystemtable page = new Page(1, 10);
        Listsystemtable records = systemTableMapper.page(page);
        page.setRecords(records);
        return page;
    }
    @Override
    public String exception() {
        throw new BusinessException("自定义异常");
//        return "成功获得数据";
    }
}

8、运行GitEggSystemApplication，打开浏览器访问：http://127.0.0.1:8001/doc.html，然后点击左侧的异常处理接口，使用Swagger2进行测试，即可看到结果

本文源码在https://gitee.com/wmz1930/GitEgg 的chapter-07分支。

内容来源网络，如有侵权，联系删除，本文地址：https://www.230890.com/zhan/51626.html

赞 (0)

相关推荐

  • 第二篇Scrum冲刺博客

    技术第二篇Scrum冲刺博客 第二篇Scrum冲刺博客1
    1.1每天举行站立式会议
    由于我们是不同班而且有男生和女生，所以大家都很难抽出时间参加站立式会议，所以我们改为微信会议1.2昨天已完成工作成员

    礼包 2021年11月24日

  • Kubernetes gRPC负载均衡分析

    技术Kubernetes gRPC负载均衡分析本篇内容主要讲解“Kubernetes gRPC负载均衡分析”，感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷，实用性强。下面就让小编来带大家学习“Kubernetes

    攻略 2021年11月16日

  • sparkstreaming数据量(使用sparkstreaming的必要性)

    技术如何理解Spark Streaming的数据可靠性和一致性如何理解Spark Streaming的数据可靠性和一致性，相信很多没有经验的人对此束手无策，为此本文总结了问题出现的原因和解决方法，通过这篇文章希望你能解决

    攻略 2021年12月17日

  • 微服务的数据库设计是怎样的

    技术微服务的数据库设计是怎样的这篇文章给大家介绍微服务的数据库设计是怎样的，内容非常详细，感兴趣的小伙伴们可以参考借鉴，希望对大家能有所帮助。单独的数据库：微服务设计的一个关键是数据库设计，基本原则是每个服务都有自己单独

    攻略 2021年12月2日

  • 图书馆英语怎么写,“图书馆”用英语怎么说

    技术图书馆英语怎么写,“图书馆”用英语怎么说在图书馆用英语翻译过来是in the library.in表地点时图书馆英语怎么写，指在某一立体空间范围内。library的英式读法是[laɪbrəri]；美式读法是[laɪb

    生活 2021年10月22日

  • react中间事件怎么绑定(react事件绑定方法视频)

    技术怎么进行React事件绑定本篇文章给大家分享的是有关怎么进行React事件绑定，小编觉得挺实用的，因此分享给大家学习，希望大家阅读完这篇文章后可以有所收获，话不多说，跟着小编一起来看看吧。类组件事件绑定import

    攻略 2021年12月18日