当前位置: 开发笔记 > 前端 > 正文

Java封装统一的ResultModel案例

作者：散場偂爱的擁菢_257 | 来源：互联网 | 2022-07-21 15:59

这篇文章主要介绍了Java封装统一的ResultModel案例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧

在开发过程中，有时候会需要使用错误码+错误信息的形式，来返回某些业务操作的错误结果信息，来代替效率较低的异常传递。

这样就需要封装一个统一的Result model作为返回值，代替直接返回数据等结果。

1.定义错误码 - 错误信息接口

错误码可能是String、Integer、Long 等类型，也可能是enum类型。因此这里使用泛型来代替，错误码类型，可以提高灵活性

。也可以通过枚举直接实现CodeMessage接口。

public interface CodeMessage{
  C getCode();
  String getMessage();
}

2.实现Result Model

这里定义的是service层的Result。有时候在controller层只会作一些简单的参数校验，在service层会作进一步的校验，

如果controller中需要统一返回一个JsonResult可以将ServiceResult作一个简单的转换器进行转换。

public class ServiceResult implements Serializable {

  public static final CodeMessage SUCCESS = new DefaultMessage<>("00000000", "success");

  private T data;
  private CodeMessage message;
  private boolean isSuccess;

  ServiceResult(T data, boolean isSuccess, CodeMessage message) {
    this.data = data;
    this.message = message;
    this.isSuccess = isSuccess;
  }

  public T getData() {
    return data;
  }

  public CodeMessage getCodeMessage() {
    return message;
  }

  public boolean isSuccess() {
    return isSuccess;
  }

  public static  ServiceResultBuilder success() {
    ServiceResultBuilder builder = builder();
    return builder.isSuccess(true);
  }

  public static  ServiceResultBuilder success(CodeMessage codeMessage) {
    ServiceResultBuilder builder = builder();
    return builder.isSuccess(true).code(codeMessage.getCode()).message(codeMessage.getMessage());
  }

  public static  ServiceResult success(D data) {
    ServiceResultBuilder success = success(SUCCESS);
    return success.data(data).build();
  }

  public static  ServiceResult error(CodeMessage codeMessage) {
    ServiceResultBuilder builder = builder();
    return builder.isSuccess(false).code(codeMessage.getCode()).message(codeMessage.getMessage()).build();
  }

  public static  ServiceResultBuilder error() {
    ServiceResultBuilder builder = builder();
    return builder.isSuccess(false);
  }


  static  ServiceResultBuilder builder() {
    return new ServiceResultBuilder<>();
  }

  public static class DefaultMessage implements CodeMessage, java.io.Serializable {

    private C code;
    private String message;

    public DefaultMessage(C code, String message) {
      this.code = code;
      this.message = message;
    }

    @Override
    public C getCode() {
      return code;
    }

    @Override
    public String getMessage() {
      return message;
    }

    @Override
    public String toString() {
      return "DefaultMessage{" +
          "code=" + code +
          ", message='" + message + '\'' +
          '}';
    }
  }

  public static class ServiceResultBuilder {

    private T data;
    private C code;
    private String message;
    private boolean isSuccess;

    ServiceResultBuilder() { //package private
    }

    public ServiceResultBuilder data(T data) {
      this.data = data;
      return this;
    }

    ServiceResultBuilder isSuccess(boolean isSuccess) {
      this.isSuccess = isSuccess;
      return this;
    }

    public ServiceResultBuilder code(C code) {
      this.code = code;
      return this;
    }

    public ServiceResultBuilder message(String message) {
      this.message = message;
      return this;
    }

    public ServiceResult build() {
      Objects.requireNonNull(code, "code");
      Objects.requireNonNull(code, "message");
      return new ServiceResult<>(data, isSuccess, new DefaultMessage<>(code, message));
    }
  }

  @Override
  public String toString() {
    return "ServiceResult{" +
        "data=" + data +
        ", message=" + message +
        ", isSuccess=" + isSuccess +
        '}';
  }
}

3.使用

定义枚举错误码

pubilc enum CodeMessageEnum implements CodeMessage {
  some_error(1001, "错误信息。");
  Integer code;
  String message;

  CodeMessageEnum(Integer code, String message) {
    this.code = code;
    this.message = message;
  }

  @Override
  public Integer getCode() {
    return code;
  }

  @Override
  public String getMessage() {
    return message;
  }
}

//返回正确结果带返回值。

ServiceResult, String> s = ServiceResult.success(Arrays.asList("1", "2", "3"));
s.isSuccess(); //true
ServiceResult<&＃63;, Integer> e1 = ServiceResult.error(CodeMessageEnum.some_error);
e1.isSuccess(); //false
ServiceResult<&＃63;, Long> e2 = ServiceResult.error(new ServiceResult.DefaultMessage<>(1000L, "error"));
e2.isSuccess(); //false
//ServiceResult{data=[1, 2, 3], message=DefaultMessage{code=00000000, message='success'}, isSuccess=true}
System.out.println(s);
//ServiceResult{data=null, message=DefaultMessage{code=1001, message='错误信息。'}, isSuccess=false}
System.out.println(e1);
//ServiceResult{data=null, message=DefaultMessage{code=1000, message='error'}, isSuccess=false}
System.out.println(e2);

补充知识：java 封装返回结果实体类返回结果以及错误信息

我就废话不多说了，大家还是直接看代码吧~

public class ResponseMessage {
  private final static String STATUS_OK = "0";
  private final static String STATUS_ERROR = "1";

  private String status;   // 状态
  private Object data;  // 返回值
  private Exception e;  // 异常类捕获
  private String msg;  // 自定义信息

  public String getStatus() {
    return status;
  }
  public void setStatus(String status) {
    this.status = status;
  }
  public Object getData() {
    return data;
  }
  public void setData(Object data) {
    this.data = data;
  }
  public Exception getE() {
    return e;
  }
  public void setE(Exception e) {
    this.e = e;
  }
  public String getMsg() {
    return msg;
  }
  public void setMsg(String msg) {
    this.msg = msg;
  }
  public ResponseMessage() {
    super();
  }
  public ResponseMessage(String status, Object data, Exception e, String msg) {
    super();
    this.status = status;
    this.data = data;
    this.e = e;
    this.msg = msg;
  }

  /**
   * 成功的结果
   * @param data 返回结果
   * @param msg 返回信息
   */
  public static ResponseMessage newOkInstance(Object data, String msg) {
    return new ResponseMessage(ResponseMessage.STATUS_OK, data, null, msg);
  }

  /**
   * 成功的结果
   * @param data  返回结果
   */
  public ResponseMessage newOkInstance(Object data) {
    return new ResponseMessage(ResponseMessage.STATUS_OK, data, null, null);
  }

  /**
   * 失败的结果
   * @param msg 返回信息
   */
  public static ResponseMessage newErrorInstance(String msg) {
    return new ResponseMessage(ResponseMessage.STATUS_ERROR, null, null, msg);
  }

  /**
   * 失败的结果
   * @param e    异常对象
   * @param msg 返回信息
   */
  public static ResponseMessage newErrorInstance(Exception e, String msg) {
    return new ResponseMessage(ResponseMessage.STATUS_ERROR, null, e, msg);
  }
}

以上这篇Java封装统一的Result Model案例就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持。

json

推荐阅读

json
Ionic 5 APK打包与QRScanner插件优化：常见问题及解决方案

本文总结了在使用Ionic 5进行Android平台APK打包时遇到的问题，特别是针对QRScanner插件的改造。通过详细分析和提供具体的解决方法，帮助开发者顺利打包并优化应用性能。 ... [详细]

蜡笔小新 2024-12-27 12:10:17
json
PHP 中文 JSON 编码问题的解决方案

本文探讨了在 PHP 中处理 JSON 编码时中文字符显示为 Unicode 转义序列的问题，并提供了多种有效的解决方法，包括使用正则表达式替换、URL 编码以及利用 PHP 5.4 及以上版本提供的 JSON_UNESCAPED_UNICODE 选项。 ... [详细]

蜡笔小新 2024-12-26 20:41:16
html
解析猫鼬 findOne 方法返回 null 的原因

本文探讨了在通过 API 端点调用时，使用猫鼬（Mongoose）的 findOne 方法总是返回 null 的问题，并提供了详细的解决方案和建议。 ... [详细]

蜡笔小新 2024-12-25 17:40:33
html
VSCode 自定义代码片段配置：实现类似IDEA的快捷代码段（如sout或psvm）

本文详细介绍如何在VSCode中配置自定义代码片段，使其具备与IDEA相似的代码生成快捷键功能。通过具体的Java和HTML代码片段示例，展示配置步骤及效果。 ... [详细]

蜡笔小新 2024-12-25 17:10:13
html
优化页面加载性能

在网页开发中，页面加载速度是一个关键的用户体验因素。为了提升加载效率，避免在PageLoad事件中进行大量数据绑定操作，可以采用异步加载和特定控件来优化页面加载过程。 ... [详细]

蜡笔小新 2024-12-25 16:57:49
js
理解JavaScript中的异步$.post()回调函数执行时机

探讨在循环中调用$.post()时，回调函数为何会在循环结束后才开始执行，并提供解决方案和优化建议。 ... [详细]

蜡笔小新 2024-12-25 16:55:14
html
深入解析JMeter中的JSON提取器及其应用

本文详细介绍了如何在JMeter中使用JSON提取器来获取和处理API响应中的数据。特别是在需要将一个接口返回的数据作为下一个接口的输入时，JSON提取器是一个非常有用的工具。 ... [详细]

蜡笔小新 2024-12-25 16:34:37
json
Vue 2.0 中使用 Axios 获取数据时遇到错误的解决方案

本文探讨了在 Vue 2.0 项目中使用 Axios 获取数据时可能出现的错误，并提供详细的解决方案和最佳实践。 ... [详细]

蜡笔小新 2024-12-25 14:02:12
json
解决 Fetch API 传参问题

探讨如何正确使用 Fetch API 进行参数传递，分析不同写法的差异及解决方案。 ... [详细]

蜡笔小新 2024-12-25 13:58:23
json
谷粒商城统一返回对象R的泛型data获取异常及解决方案

在实现过程中遇到空指针错误，经过定位发现远程调用后使用泛型的统一返回对象R无法正确获取data值。本文详细分析问题原因并提供解决方案。 ... [详细]

蜡笔小新 2024-12-25 10:25:42
json
使用Python urllib模块实现POST请求并爬取百度翻译结果

本文详细解析了如何使用Python的urllib模块发起POST请求，并通过实例展示如何爬取百度翻译的翻译结果。 ... [详细]

蜡笔小新 2024-12-24 18:49:24
json
UC浏览器分享图片显示问题及解决方案

本文探讨了在UC浏览器中调用分享面板后，图片无法正常显示的问题，并提供了详细的解决方法和代码示例。 ... [详细]

蜡笔小新 2024-12-24 17:24:36
json
PostgreSQL中插入JSON数据的最佳实践

本文介绍如何在PostgreSQL数据库中正确插入和处理JSON数据类型，确保数据完整性和避免常见错误。 ... [详细]

蜡笔小新 2024-12-24 16:41:47
js
理解在 Ember.js 中加载 JSON 的最佳实践

作为一名 Ember.js 新手，了解如何在路由和模型中正确加载 JSON 数据是至关重要的。本文将探讨两者之间的差异，并提供实用的建议。 ... [详细]

蜡笔小新 2024-12-24 16:26:33
react
企业级项目中 Webpack 配置优化指南

本文详细介绍了在企业级项目中如何优化 Webpack 配置，特别是在 React 移动端项目中的最佳实践。涵盖资源压缩、代码分割、构建范围缩小、缓存机制以及性能优化等多个方面。 ... [详细]

蜡笔小新 2024-12-24 14:41:48

散場偂爱的擁菢_257

这个家伙很懒，什么也没留下！

Tags | 热门标签

RankList | 热门文章