• springboot整合返回数据统一封装

    1、MagCode，错误码枚举类

    1. package com.mgx.common.enums;
    2.  
    3. import lombok.*;
    4. import lombok.extern.slf4j.Slf4j;
    5.  
    6. /**
    7.  * 错误码
    8.  * @author mgx
    9.  */
    10. @Slf4j
    11. @NoArgsConstructor
    12. @AllArgsConstructor
    13. public enum MsgCode {
    14.  
    15.     /**
    16.      * 枚举标识，根据业务类型进行添加
    17.      */
    18.      Code_200("操作成功",200)
    19.     ,Code_400("错误请求", 400)
    20.     ,Code_401("未授权", 401)
    21.     ,Code_402("权限不足，请联系管理员", 402)
    22.     ,Code_403("禁止请求", 403)
    23.     ,Code_404("找不到相关内容", 404)
    24.     ,Code_408("请求超时", 408)
    25.     ,Code_410("该资源已删除", 410)
    26.     ,Code_413("请求体过大", 413)
    27.     ,Code_414("请求URI过长", 414)
    28.     ,Code_415("不支持的媒体类型", 415)
    29.     ,Code_500("系统错误", 500)
    30.     ,Code_501("用户未登录", 501)
    31.     ,Code_502("错误网关", 502)
    32.     ,Code_503("服务不可用", 503)
    33.     ,Code_504("网关超时", 504)
    34.     ,Code_505("HTTP版本暂不支持", 505)
    35.     ,Code_506("时间格式错误", 506)
    36.  
    37.     //自定义提示
    38.     ,Code_2001("参数错误", 2001)
    39.     ,Code_2002("传入参数不符合条件", 2002)
    40.     ,Code_2003("缺少请求参数", 2003)
    41.     ,Code_2004("请求方式错误", 2004)
    42.     ,Code_2005("sql语法错误", 2005)
    43.     ,Code_2006("数据不存在", 2006)
    44.     ,Code_2007("同步失败", 2007)
    45.     ,Code_2008("添加失败", 2008)
    46.     ,Code_2009("修改失败", 2009)
    47.     ,Code_2010("删除失败", 2010)
    48.     ,Code_2011("查询失败", 2011)
    49.     ,Code_2012("评估失败", 2012)
    50.     ,Code_2013("移出黑名单失败",2013)
    51.     ,Code_2014("该车辆已在黑名单中",2014)
    52.     ,Code_2015("请输入正确的手机号",2015)
    53.     ,Code_2016("不支持的编码格式", 2016)
    54.     ,Code_2017("不支持的解码格式", 2017)
    55.     ,Code_2018("保存失败", 2018)
    56.  
    57.     ;
    58.  
    59.     @Getter
    60.     @Setter
    61.     private String msg;
    62.  
    63.     @Getter
    64.     @Setter
    65.     private Integer code;
    66.  
    67.     public static String getMessage(Integer code){
    68.         MsgCode msgCode;
    69.         try {
    70.             msgCode = Enum.valueOf(MsgCode.class, "Code_" + code);
    71.         } catch (IllegalArgumentException e) {
    72.             log.error("传入枚举code错误！code：{}",code);
    73.             return null;
    74.         }
    75.         return msgCode.getMsg();
    76.     }
    77.  
    78. }

    2、统一返回结果类

    1. package com.mgx.common.dto;
    2.  
    3. import com.mgx.common.enums.MsgCode;
    4. import lombok.AllArgsConstructor;
    5. import lombok.Getter;
    6. import lombok.NoArgsConstructor;
    7. import lombok.Setter;
    8.  
    9. import java.io.Serializable;
    10.  
    11. /**
    12.  * @author mgx
    13.  */
    14. @AllArgsConstructor
    15. @NoArgsConstructor
    16. public class Result implements Serializable {
    17.  
    18.     private static final long serialVersionUID = 1L;
    19.  
    20.     /** 成功与否 */
    21.     @Getter protected boolean success;
    22.  
    23.     /** 结果代码 */
    24.     @Getter protected Integer code;
    25.  
    26.     /** 消息 */
    27.     @Getter protected String message;
    28.  
    29.     /** 标识（方便接口调试） */
    30.     @Getter @Setter
    31.     protected String tag;
    32.  
    33.     /** 版本（方便接口调试） */
    34.     @Getter @Setter
    35.     protected String version;
    36.  
    37.     /** 结果数据 */
    38.     @Getter protected T data;
    39.  
    40.     /**
    41.      * 不需指定code和message
    42.      * @return SuccessBuilder
    43.      */
    44.     public static SuccessBuilder success() {
    45.         return new SuccessBuilder(Boolean.TRUE, MsgCode.Code_200.getCode(), MsgCode.Code_200.getMsg());
    46.     }
    47.  
    48.     /**
    49.      * 同时指定code和message
    50.      * @return FailBuilder
    51.      */
    52.     public static FailBuilder failure() {
    53.         return new FailBuilder(Boolean.FALSE);
    54.     }
    55.  
    56.     public static class SuccessBuilder {
    57.  
    58.         protected boolean success;
    59.         protected Integer code;
    60.         protected String message;
    61.         protected String tag = "mgx";
    62.         protected String version = "1.0";
    63.         protected Object data;
    64.  
    65.         protected SuccessBuilder(boolean success, Integer code, String message) {
    66.             this.success = success;
    67.             this.code = code;
    68.             this.message = message;
    69.         }
    70.  
    71.         public SuccessBuilder data(Object data) {
    72.             this.data = data;
    73.             return this;
    74.         }
    75.  
    76.         @SuppressWarnings("unchecked")
    77.         public  Result build() {
    78.             return new Result<>(success, code, message, tag, version, (T) data);
    79.         }
    80.     }
    81.  
    82.  
    83.     public static class FailBuilder {
    84.  
    85.         protected boolean success;
    86.         protected Integer code;
    87.         protected String message;
    88.         protected String tag = "mgx";
    89.         protected String version = "1.0";
    90.         protected Object data;
    91.  
    92.         protected FailBuilder(boolean success) {
    93.             this.success = success;
    94.         }
    95.  
    96.         public FailBuilder code(Integer code) {
    97.             this.code = code;
    98.             String message = MsgCode.getMessage(code);
    99.             if(message != null){
    100.                 this.message = message;
    101.             }
    102.             return this;
    103.         }
    104.  
    105.         //如果调用code再调用此message方法，此message方法会覆盖code方法中set的message
    106.         public FailBuilder message(String message) {
    107.             this.message = message;
    108.             return this;
    109.         }
    110.  
    111.         public FailBuilder data(Object data) {
    112.             this.data = data;
    113.             return this;
    114.         }
    115.  
    116.         @SuppressWarnings("unchecked")
    117.         public  Result build() {
    118.             return new Result<>(success, code, message, tag, version, (T) data);
    119.         }
    120.     }
    121.  
    122. }

    3、BooleanResult封装

    1. package com.mgx.common.dto;
    2.  
    3. import lombok.Data;
    4.  
    5. import java.io.Serializable;
    6.  
    7. /**
    8.  * @author mgx
    9.  */
    10. @Data
    11. public class BooleanResult implements Serializable {
    12.  
    13.     private Boolean result;
    14.  
    15.     private String reason;
    16.  
    17.     public static BooleanResult success(){
    18.         BooleanResult booleanResult = new BooleanResult();
    19.         booleanResult.setResult(true);
    20.         return booleanResult;
    21.     }
    22.  
    23.     public static BooleanResult fail(){
    24.         return fail(null);
    25.     }
    26.  
    27.     public static BooleanResult fail(String reason){
    28.         BooleanResult booleanResult = new BooleanResult();
    29.         booleanResult.setResult(false);
    30.         booleanResult.setReason(reason);
    31.         return booleanResult;
    32.     }
    33.  
    34. }

    4、结构展示

    5、类

    1. package com.mgx.controller;
    2.  
    3. import com.mgx.common.dto.BooleanResult;
    4. import com.mgx.common.dto.Result;
    5. import com.mgx.service.UnifyService;
    6. import com.mgx.vo.param.SaveInfoUserParam;
    7. import com.mgx.vo.result.InfoUserResult;
    8. import io.swagger.annotations.Api;
    9. import io.swagger.annotations.ApiOperation;
    10. import io.swagger.annotations.ApiParam;
    11. import org.apache.ibatis.annotations.Param;
    12. import org.springframework.web.bind.annotation.*;
    13.  
    14. import javax.annotation.Resource;
    15.  
    16. /**
    17.  * @author mgx
    18.  * @date 2023/9/18 3:36 PM
    19.  */
    20. @Api(tags = "springboot整合 统一类型结果集")
    21. @RestController
    22. @RequestMapping("/Unify")
    23. public class UnifyController {
    24.  
    25.     @Resource
    26.     private UnifyService unifyService;
    27.  
    28.     @ApiOperation("新增")
    29.     @PostMapping("/add")
    30.     public Result add(@RequestBody SaveInfoUserParam saveInfoUserParam) {
    31.         return Result.success().data(unifyService.add(saveInfoUserParam)).build();
    32.     }
    33.  
    34.     @ApiOperation("详情")
    35.     @GetMapping("/detail")
    36.     public Result detail(@ApiParam("用户信息的ID") @Param("id") Long id) {
    37.         return Result.success().data(unifyService.detail(id)).build();
    38.     }
    39.  
    40.     @ApiOperation("删除")
    41.     @DeleteMapping("/delete")
    42.     public Result delete(@ApiParam("用户信息的ID") @Param(value = "id") Long id){
    43.         return Result.success().data(unifyService.delete(id)).build();
    44.     }
    45.  
    46.     @ApiOperation("更新")
    47.     @PutMapping("/update")
    48.     public Result update(@RequestBody SaveInfoUserParam saveInfoUserParam){
    49.         return Result.success().data(unifyService.update(saveInfoUserParam)).build();
    50.     }
    51.  
    52. }
    1. package com.mgx.service;
    2.  
    3. import com.mgx.common.dto.BooleanResult;
    4. import com.mgx.vo.param.SaveInfoUserParam;
    5. import com.mgx.vo.result.InfoUserResult;
    6.  
    7. /**
    8.  * @author mgx
    9.  * @date 2023/9/18 3:38 PM
    10.  */
    11. public interface UnifyService {
    12.  
    13.     BooleanResult add(SaveInfoUserParam saveInfoUserParam);
    14.  
    15.     InfoUserResult detail(Long id);
    16.  
    17.     BooleanResult delete(Long id);
    18.  
    19.     BooleanResult update(SaveInfoUserParam saveInfoUserParam);
    20.  
    21. }
    1. package com.mgx.service.impl;
    2.  
    3. import com.mgx.common.dto.BooleanResult;
    4. import com.mgx.entity.InfoUser;
    5. import com.mgx.mapper.InfoUserMapper;
    6. import com.mgx.service.UnifyService;
    7. import com.mgx.utils.BeanUtil;
    8. import com.mgx.vo.param.SaveInfoUserParam;
    9. import com.mgx.vo.result.InfoUserResult;
    10. import org.springframework.stereotype.Service;
    11.  
    12. import javax.annotation.Resource;
    13. import java.util.Objects;
    14.  
    15. /**
    16.  * @author mgx
    17.  * @date 2023/9/18 3:38 PM
    18.  */
    19. @Service
    20. public class UnifyServiceImpl implements UnifyService {
    21.  
    22.     @Resource
    23.     private InfoUserMapper infoUserMapper;
    24.  
    25.     @Override
    26.     public BooleanResult add(SaveInfoUserParam saveInfoUserParam) {
    27.         InfoUser infoUser = BeanUtil.map(saveInfoUserParam,InfoUser.class);
    28.         int addRow = infoUserMapper.insert(infoUser);
    29.         if (addRow < 1){
    30.             return BooleanResult.fail();
    31.         }
    32.         return BooleanResult.success();
    33.     }
    34.  
    35.     @Override
    36.     public InfoUserResult detail(Long id) {
    37.         InfoUser infoUser = infoUserMapper.selectByPrimaryKey(id);
    38.         if (Objects.isNull(infoUser)){
    39.             throw new RuntimeException("数据不存在");
    40.         }
    41.         return BeanUtil.map(infoUser,InfoUserResult.class);
    42.     }
    43.  
    44.     @Override
    45.     public BooleanResult delete(Long id) {
    46.         InfoUser infoUser = infoUserMapper.selectByPrimaryKey(id);
    47.         if (Objects.isNull(infoUser)){
    48.             throw new RuntimeException("数据不存在");
    49.         }
    50.         int deleteRow = infoUserMapper.deleteByPrimaryKey(id);
    51.         if (deleteRow<1){
    52.             return BooleanResult.fail();
    53.         }
    54.         return BooleanResult.success();
    55.     }
    56.  
    57.     @Override
    58.     public BooleanResult update(SaveInfoUserParam saveInfoUserParam) {
    59.         InfoUser queryInfoUser = infoUserMapper.selectByPrimaryKey(saveInfoUserParam.getId());
    60.         if (Objects.isNull(queryInfoUser)){
    61.             throw new RuntimeException("数据不存在");
    62.         }
    63.         InfoUser infoUser = BeanUtil.map(saveInfoUserParam,InfoUser.class);
    64.         int updateRow = infoUserMapper.updateByPrimaryKeySelective(infoUser);
    65.         if (updateRow<1){
    66.             return BooleanResult.fail();
    67.         }
    68.         return BooleanResult.success();
    69.     }
    70. }
    1. package com.mgx.utils;
    2.  
    3. import org.apache.commons.collections4.MapUtils;
    4. import org.springframework.beans.BeanUtils;
    5. import org.springframework.beans.BeansException;
    6.  
    7. import java.beans.BeanInfo;
    8. import java.beans.Introspector;
    9. import java.beans.PropertyDescriptor;
    10. import java.lang.reflect.Method;
    11. import java.util.*;
    12.  
    13. /**
    14.  * @author mgx
    15.  */
    16. public class BeanUtil {
    17.  
    18.     public BeanUtil() {}
    19.  
    20.     public static  T map(Object source, Class target) {
    21.         if (null == source) {
    22.             return null;
    23.         } else {
    24.             T t = BeanUtils.instantiateClass(target);
    25.             BeanUtils.copyProperties(source, t);
    26.             return t;
    27.         }
    28.     }
    29.  
    30.     public static  List mapList(Collection sourceList, Class target) {
    31.         if (sourceList == null) {
    32.             return null;
    33.         } else {
    34.             List destinationList = new ArrayList<>();
    35.             for (Object sourceObject : sourceList) {
    36.                 T newObj = map(sourceObject, target);
    37.                 destinationList.add(newObj);
    38.             }
    39.             return destinationList;
    40.         }
    41.     }
    42.  
    43.     public static void copyProperties(Object source, Object target, String... ignoreProperties) {
    44.         if (null != source && null != target) {
    45.             BeanUtils.copyProperties(source, target, ignoreProperties);
    46.         }
    47.     }
    48.  
    49.     public static  T convert(Object source, Class targetClass) {
    50.         if (source == null) {
    51.             return null;
    52.         } else {
    53.             try {
    54.                 T result = targetClass.newInstance();
    55.                 copyProperties(source, result);
    56.                 return result;
    57.             } catch (IllegalAccessException | BeansException | InstantiationException var3) {
    58.                 throw new RuntimeException(var3);
    59.             }
    60.         }
    61.     }
    62.  
    63.     public static void copyProperties(Object source, Object target) throws BeansException {
    64.         BeanUtils.copyProperties(source, target);
    65.         if (target instanceof ConversionCustomizble) {
    66.             ((ConversionCustomizble) target).convertOthers(source);
    67.         }
    68.     }
    69.  
    70.     public interface ConversionCustomizble {
    71.         void convertOthers(Object var1);
    72.     }
    73.  
    74.     public static Map beanToMap(Object beanObj) {
    75.         if (Objects.isNull(beanObj)) {
    76.             return null;
    77.         }
    78.  
    79.         Map map = new HashMap<>();
    80.         try {
    81.             BeanInfo beanInfo = Introspector.getBeanInfo(beanObj.getClass());
    82.             PropertyDescriptor[] propertyDescriptors = beanInfo.getPropertyDescriptors();
    83.             for (PropertyDescriptor property : propertyDescriptors) {
    84.                 String key = property.getName();
    85.                 if (key.compareToIgnoreCase("class") == 0) {
    86.                     continue;
    87.                 }
    88.                 Method getter = property.getReadMethod();
    89.                 Object value = Objects.isNull(getter) ? null : getter.invoke(beanObj);
    90.                 map.put(key, value);
    91.             }
    92.             return map;
    93.         } catch (Exception ex) {
    94.             throw new RuntimeException(ex);
    95.         }
    96.     }
    97.  
    98.     public static  T mapToBean(Map map, Class beanClass) {
    99.         if (MapUtils.isEmpty(map)) {
    100.             return null;
    101.         }
    102.  
    103.         try {
    104.             T t = beanClass.newInstance();
    105.             BeanInfo beanInfo = Introspector.getBeanInfo(t.getClass());
    106.             PropertyDescriptor[] propertyDescriptors = beanInfo.getPropertyDescriptors();
    107.             for (PropertyDescriptor property : propertyDescriptors) {
    108.                 Method setter = property.getWriteMethod();
    109.                 if (Objects.nonNull(setter)) {
    110.                     setter.invoke(t, map.get(property.getName()));
    111.                 }
    112.             }
    113.             return t;
    114.         } catch (Exception ex) {
    115.             throw new RuntimeException(ex);
    116.         }
    117.     }
    118.  
    119. }

    6、测试

  • 相关阅读:
    Vue + Ant Design form表单的一些坑
    SpringBoot之@ConfigurationProperties和@Value用法详解
    前台自动化测试：基于敏捷测试驱动开发(TDD)的自动化测试原理
    基于SSM的校园预点餐网站
    分类预测 | MATLAB实现基于Isomap降维算法与改进蜜獾算法IHBA的Adaboost-SVM集成多输入分类预测
    Mac Catalina安装配置hadoop hive hbase
    解密Java多线程中的锁机制：CAS与Synchronized的工作原理及优化策略
    一天的忙碌，一路的飞翔，我的回家之旅
    （第六天）初识Spring框架-SSM框架的学习与应用(Spring + Spring MVC + MyBatis)-Java EE企业级应用开发学习记录
    .Net6 已知问题总结
  • 原文地址：https://blog.csdn.net/qq_42405688/article/details/132986351