SpringBoot(八) - 统一数据返回，统一分页工具，统一异常处理 ...

九天猎人  金牌会员 | 2022-10-19 15:32:01 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 759|帖子 759|积分 2277

1、统一数据返回

使用逆向工程来进行测试，实体，mapper等省略；
1.1 直接使用 RequestResoult

1.1.1 RequestResoult 请求结果返回实体
  1. //统一返回 实体 类
  2. @Data
  3. public class RequestResult<T> {
  5.     //状态码
  6.     private String code;
  8.     //状态说明,对code的说明
  9.     private String msg;
  11.     //接口数据
  12.     private T data;
  14. }
复制代码
1.1.2 service层

1.1.2.1 接口
  1. public interface EdocEntryService {
  3.     //按摘要查询
  4.     List<EdocEntry> getEdocEntriesBySummary(String summary);
  5.    
  6. }
复制代码
1.1.2.2 实现类

注意记得在 主启动类中添加 mapper接口扫描注解 ：@MapperScan("com.kgc.sbt.mapper")
  1. @Service
  2. public class EdocEntryServiceImpl implements EdocEntryService {
  4.     @Autowired(required = false)
  5.     private EdocEntryMapper edocEntryMapper;
  7.     @Override
  8.     public List<EdocEntry> getEdocEntriesBySummary(String summary) {
  10.         //使用逆向工程，封装查询条件
  12.         EdocEntryExample edocEntryExample = new EdocEntryExample();
  14.         //排序条件
  15.         edocEntryExample.setOrderByClause(" id desc ");
  17.         //根据摘要 模糊查询
  18.         edocEntryExample.createCriteria().andSummaryLike("%" + summary + "%");
  20.         //调用持久层 查询数据
  21.         return edocEntryMapper.selectByExample(edocEntryExample);
  23.     }
  24.    
  25. }
复制代码
1.1.3 测试请求
  1. @Slf4j
  2. @RestController
  3. public class EdocEntryController {
  5.     @Autowired
  6.     private EdocEntryService edocEntrieService;
  8.     //根据电子文档，查询文档列表,直接使用 RequestResult
  9.     @GetMapping("/edocEntries")
  10.     //指定请求返回类型 RequestResult<List<EdocEntry>>
  11.         //public RequestResult<List<EdocEntry>> edocEntries(@RequestParam(required = false) String summary){
  12.     //自适应请求返回类型 RequestResult<?>
  13.     public RequestResult<?> edocEntries(@RequestParam(required = false) String summary){
  14.         
  15.         //调用业务接口，获取文档列表，进行统一返回
  16.         //创建统一返回对象
  17.         //每次都需要创建返回对象，代码冗余，不利于维护
  18.         RequestResult<List<EdocEntry>> requestResult = new RequestResult<>();
  19.         requestResult.setCode("200");
  20.         requestResult.setMsg("success");
  21.         List<EdocEntry> edocEntriesBySummary = edocEntrieService.getEdocEntriesBySummary(summary);
  22.         log.info("{}",edocEntriesBySummary);
  23.         requestResult.setData(edocEntriesBySummary);
  24.         //接口统一返回查询结果
  25.         return requestResult;
  26.         
  27.     }
  29. }
复制代码
测试结果：

1.2 使用 ResultBuildUtil 结果对象构建工具

1.2.1 CommonConstant 常量类
  1. //Description: 系统常量类，统一管理项目中所有的常量
  2. public class CommonConstant {
  4.     /*
  5.      统一返回成功的状态码
  6.      */
  7.     public static final String UNIFY_RESULT_SUCCESS_CODE = "200";
  9.     /*
  10.      统一返回成功的信息
  11.      */
  12.     public static final String UNIFY_RESULT_SUCCESS_MSG = "SUCCESS";
  14.     /*
  15.    统一返回错误的状态码
  16.    */
  17.     public static final String UNIFY_RESULT_FAIL_CODE = "999";
  19.     /*
  20.      统一返回错误的信息
  21.      */
  22.     public static final String UNIFY_RESULT_FAIL_MSG = "FAIL";
  25.     /*
  26.         分页默认页吗
  27.      */
  28.     public static final int DEFAULT_INIT_PAGE_NO = 1;
  30.     /*
  31.         分页默认条数
  32.      */
  33.     public static final int DEFAULT_INIT_PAGE_SIZE = 3;
  35. }
复制代码
1.2.2 ResultBuildUtil结果对象构建工具列
  1. //Description: 结果构建工具类
  2. public class ResultBuildUtil {
  4.     //构建成功返回，支持任意类型参数
  5.     public static <T> RequestResult<T> success(T t) {
  6.         //创建统一返回成功结果对象
  7.         RequestResult<T> requestResult = new RequestResult<>();
  9.         requestResult.setCode(CommonConstant.UNIFY_RESULT_SUCCESS_CODE);
  10.         requestResult.setMsg(CommonConstant.UNIFY_RESULT_SUCCESS_MSG);
  11.         requestResult.setData(t);
  13.         return requestResult;
  15.     }
  17.     //构建成功返回，空参
  18.     public static <T> RequestResult<T> success() {
  19.         return success(null);
  20.     }
  22.     //构建 失败返回，支持任意类型参数,用户不便于归类的异常错误结果返回
  23.     public static <T> RequestResult<T> fail(T t) {
  24.         //创建统一返回失败结果对象
  25.         RequestResult<T> requestResult = new RequestResult<>();
  27.         requestResult.setCode(CommonConstant.UNIFY_RESULT_FAIL_CODE);
  28.         requestResult.setMsg(CommonConstant.UNIFY_RESULT_FAIL_MSG);
  29.         requestResult.setData(t);
  31.         return requestResult;
  33.     }
  35.     //构建 失败返回，空参
  36.     public static <T> RequestResult<T> fail() {
  37.         //创建统一返回失败结果对象
  38.         return fail(null);
  40.     }
  42.     //构建 失败返回，自定义错误码，和说明,支持任意类型参数
  43.     public static <T> RequestResult<T> fail(String errCode,String errMsg,T t) {
  44.         //创建统一返回失败结果对象
  45.         RequestResult<T> requestResult = new RequestResult<>();
  46.         requestResult.setCode(errCode);
  47.         requestResult.setMsg(errMsg);
  48.         requestResult.setData(t);
  49.         return requestResult;
  50.     }
  52.     //构建 失败返回，自定义错误码，和说明,无参
  53.     public static <T> RequestResult<T> fail(String errCode,String errMsg) {
  54.         //创建统一返回 失败结果对象
  55.         RequestResult<T> requestResult = new RequestResult<>();
  56.         requestResult.setCode(errCode);
  57.         requestResult.setMsg(errMsg);
  58.         return requestResult;
  59.     }
  61. }
复制代码
1.2.3 service层

service层不变；
1.2.4 请求测试
  1. @Slf4j
  2. @RestController
  3. public class EdocEntryController {
  5.     @Autowired
  6.     private EdocEntryService edocEntrieService;
  8.     //根据电子文档，查询文档列表, 使用结果构建工具
  9.     @GetMapping("/edocEntries")
  10.     public RequestResult<?> edocEntries(@RequestParam(required = false) String summary){
  12.         //使用结果构建工具，返回成功的结果
  13.         return ResultBuildUtil.success(edocEntrieService.getEdocEntriesBySummary(summary));
  15.     }
  17. }
复制代码
测试结果：

2、统一分页工具

2.1 PageSupport 统一分页工具类
  1. // 分页 结果返回类
  2. @Data
  3. public class  PageSupport<T> {
  5.     //当前页码
  6.     private int pageNo;
  8.     //页面条数
  9.     private int pageSize;
  11.    //总条数
  12.     private int totalCount;
  14.     //总页数
  15.     private int totalPage;
  17.     //分页数据
  18.     private Collection<T> PageData;
  20.     //当总条数确定时，总条数确定
  21.     public void setTotalCount(int totalCount) {
  22.         this.totalCount = totalCount;
  24.         totalPage = totalCount % this.pageSize == 0
  25.                 ? totalCount / this.pageSize
  26.                 : totalCount / this.pageSize + 1;
  28.     }
  30. }
复制代码
2.2 service 层

2.2.1 接口
  1. public interface EdocEntryService {
  3.     //条件分页查询
  4.     PageSupport<EdocEntry> getEdocEntriesBySummary(String summary,Integer pageNo,Integer pageSize);
  5.    
  6. }
复制代码
2.2.2  实现类
  1. @Service
  2. public class EdocEntryServiceImpl implements EdocEntryService {
  4.     @Override
  5.     public PageSupport<EdocEntry> getEdocEntriesBySummary(String summary, Integer pageNo, Integer pageSize) {
  7.         //创建统一返回分页对象
  8.         PageSupport<EdocEntry> pageSupport = new PageSupport<>();
  10.         //设置分页参数
  11.         pageSupport.setPageNo(pageNo < 1 ? CommonConstant.DEFAULT_INIT_PAGE_NO : pageNo);
  12.         pageSupport.setPageSize(pageNo < 3 ? CommonConstant.DEFAULT_INIT_PAGE_SIZE : pageSize);
  14.         //封装查询条件
  15.         EdocEntryExample edocEntryExample = new EdocEntryExample();
  17.         //排序条件
  18.         edocEntryExample.setOrderByClause(" id desc ");
  20.         //根据摘要 模糊查询
  21.         edocEntryExample.createCriteria().andSummaryLike("%" + summary + "%");
  23.         // 查询满足条件总条数
  24.         pageSupport.setTotalCount((int) edocEntryMapper.countByExample(edocEntryExample));
  26.         //增加分页参数
  27.         edocEntryExample.setOffset((long)(pageSupport.getPageNo()-1)*pageSupport.getPageSize());
  28.         edocEntryExample.setLimit(pageSupport.getPageSize());
  30.         //增加分页数据
  31.         pageSupport.setPageData(edocEntryMapper.selectByExample(edocEntryExample));
  33.         //返回分页对象
  34.         return pageSupport;
  35.     }
  36.   
  37. }
复制代码
2.3 commons-lang中  isEmpty 方法和idBlank区别

2.3.1 依赖
  1. <dependency>
  2.     <groupId>commons-lang</groupId>
  3.     <artifactId>commons-lang</artifactId>
  4.     <version>2.6</version>
  5. </dependency>
复制代码
2.3.2  isEmpty 方法和idBlank区别
  1. isEmpty 和 isBlank ，isEmpty 方法和idBlank区别：只包含空格字符串判断，isEmpty是false,isBlank是true;
复制代码
2.3.2.1 isEmpty
  1. * <pre>
  2. * StringUtils.isEmpty(null)      = true
  3. * StringUtils.isEmpty("")        = true
  4. * StringUtils.isEmpty(" ")       = false
  5. * StringUtils.isEmpty("bob")     = false
  6. * StringUtils.isEmpty("  bob  ") = false
  7. * </pre>
复制代码
2.3.2.2 isBlank
  1. * <pre>
  2. * StringUtils.isBlank(null)      = true
  3. * StringUtils.isBlank("")        = true
  4. * StringUtils.isBlank(" ")       = true
  5. * StringUtils.isBlank("bob")     = false
  6. * StringUtils.isBlank("  bob  ") = false
  7. * </pre>
复制代码
2.4 测试请求
  1. //根据电子文档，查询文档列表
  2. @GetMapping("/edocEntriesPage")
  3. public RequestResult<?> edocEntriesPage(@RequestParam(value = "summary",required = false) String summary,
  4.                                         @RequestParam(value = "pageNo",defaultValue = "1") Integer pageNo,
  5.                                         @RequestParam(value = "pageSize",defaultValue = "3") Integer pageSize){
  7.     if(StringUtils.isBlank(summary)){
  8.         return ResultBuildUtil.fail();
  9.     }
  11.     //调用业务接口，获取文档列表，进行统一返回
  12.     //使用结果构建工具，返回成功的结果
  13.     return ResultBuildUtil.success(edocEntrieService.getEdocEntriesBySummary(summary,pageNo,pageSize));
  14.    
  15. }
复制代码
测试结果：

3、统一异常处理

3.1 EdocExceptionEnum 自定义异常枚举
  1. //自定义异常枚举
  2. public enum EdocExceptionEnum {
  4.     /**
  5.      * 参数为空
  6.      */
  7.     EDOC_REQUEST_PARAM_EMPTY("201", "参数为空"),
  9.     /**
  10.      * 参数为非法
  11.      */
  12.     EDOC_REQUEST_PARAM_ILLEGAL("202", "参数非法"),
  14.     /**
  15.      * 网络异常
  16.      */
  17.     EDOC_NETWORK_ERROR("301", "网络异常"),
  19.     /**
  20.      * 数据库异常
  21.      */
  22.     EDOC_DATABASE_ERROR("401", "数据库异常"),
  24.     /**
  25.      * 数据库异常
  26.      */
  27.     EDOC_SYSTEM_ERROR("501", "系统异常");
  29.     /**
  30.      * 异常码
  31.      */
  32.     private String errCode;
  34.     /**
  35.      * 异常说明
  36.      */
  37.     private String errMsg;
  39.     /**
  40.      * 提供带有两个参数的构造方法
  41.      */
  42.     EdocExceptionEnum(String errCode, String errMsg){
  43.         this.errCode = errCode;
  44.         this.errMsg = errMsg;
  45.     }
  47.     public String getErrCode() {
  48.         return errCode;
  49.     }
  51.     public String getErrMsg() {
  52.         return errMsg;
  53.     }
  55. }
复制代码
3.2  EdocException 自定义异常类
  1. public class EdocException extends RuntimeException{
  3.     /*
  4.         异常枚举类型全局私有属性
  5.     */
  6.     private EdocExceptionEnum edocExceptionEnum;
  8.     //继承 RuntimeException  生成所有的构造方法
  9.     public EdocException() {
  10.     }
  12.     public EdocException(String message) {
  13.         super(message);
  14.     }
  16.     public EdocException(String message, Throwable cause) {
  17.         super(message, cause);
  18.     }
  20.     public EdocException(Throwable cause) {
  21.         super(cause);
  22.     }
  24.     public EdocException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
  25.         super(message, cause, enableSuppression, writableStackTrace);
  26.     }
  28.     //自定义枚举异常构造函数
  29.     public EdocException(EdocExceptionEnum edocExceptionEnum){
  30.         this.edocExceptionEnum = edocExceptionEnum;
  31.     }
  33.     //获取枚举异常属性
  34.     public EdocExceptionEnum getEdocExceptionEnum() {
  35.         return edocExceptionEnum;
  36.     }
  37. }
复制代码
3.3 EdocExceptionHandler 自定义异常统一处理类
  1. //自定义异常统一处理类
  2. @ControllerAdvice
  3. public class EdocExceptionHandler {
  5.     /**
  6.      * @author : huayu
  7.      * @date   : 19/10/2022
  8.      * @param  : [edocException]
  9.      * @return : requestResoult<?>
  10.      * @description : 系统自定义异常处理，对系统中所有抛出自定义的异常，都会进行统一拦截处理，实现统一返回
  11.      */
  12.     @ExceptionHandler(EdocException.class)  //指定对该自定义异常类 进行处理
  13.     @ResponseBody  //指定返回的数据 为 json类型
  14.     public RequestResult<?> handleEdocException(EdocException edocException){
  15.         //统一返回失败的结果(前提:抛出的必须是带枚举类型的异常)
  16.         return ResultBuildUtil.fail(edocException.getEdocExceptionEnum().getErrCode(),edocException.getEdocExceptionEnum().getErrMsg());
  18.     }
  20. }
复制代码
3.4 请求测试
  1. @GetMapping("/edocEntriesPage")
  2. public RequestResult<?> edocEntriesPage(@RequestParam(value = "summary",required = false) String summary,
  3.                                         @RequestParam(value = "pageNo",defaultValue = "1") Integer pageNo,
  4.                                         @RequestParam(value = "pageSize",defaultValue = "3") Integer pageSize){
  6.         //判断 summary参数是否为空
  7.     if(StringUtils.isBlank(summary)){
  8.         //抛出自定义异常：使用异常枚举
  9.         throw new EdocException(EdocExceptionEnum.EDOC_REQUEST_PARAM_EMPTY);
  10.     }
  12.     ////抛出自定义异常：使用异常枚举
  13.     try {
  14.         return ResultBuildUtil.success(edocEntrieService.getEdocEntriesBySummary(summary,pageNo,pageSize));
  15.     } catch (Exception e) {
  16.         //e.printStackTrace();
  17.          //抛出自定义异常：使用异常枚举
  18.         throw new EdocException(EdocExceptionEnum.EDOC_DATABASE_ERROR);
  19.     }
  21. }
复制代码
测试请求参数为空：

测试数据库密码错误：





免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

正序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

九天猎人

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

挺好的 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表