在Java中定义错误代码/字符串的最佳方法？

Z时代
2024-01-10
分类：问答

我正在用Java编写Web服务，并且

。我需要将数字错误代码和错误字符串分组在一起。错误代码和错误字符串都将发送到访问Web服务的客户端。例如，当发生SQLException时，我可能要执行以下操作：

// Example: errorCode = 1, 
//          errorString = "There was a problem accessing the database."
throw new SomeWebServiceException(errorCode, errorString);

客户端程序可能会显示以下消息：

“发生了错误＃1：访问数据库时出现问题。”

我的第一个想法是使用一个Enum错误代码并重写toString方法以返回错误字符串。这是我想出的：

public enum Errors {
  DATABASE {
    @Override
    public String toString() {
      return "A database error has occured.";
    }
  },
  DUPLICATE_USER {
    @Override
    public String toString() {
      return "This user already exists.";
    }
  },
  // more errors follow
}

还有更好的方法吗？我希望使用代码中的解决方案，而不是从外部文件中读取。我正在为此项目使用Javadoc，并且能够内联记录错误代码并在文档中自动更新它们将很有帮助。

回答：

好吧，当然可以更好地实现枚举解决方案（通常非常不错）：

public enum Error {
  DATABASE(0, "A database error has occured."),
  DUPLICATE_USER(1, "This user already exists.");
  private final int code;
  private final String description;
  private Error(int code, String description) {
    this.code = code;
    this.description = description;
  }
  public String getDescription() {
     return description;
  }
  public int getCode() {
     return code;
  }
  @Override
  public String toString() {
    return code + ": " + description;
  }
}