【Java异常处理规范】抛异常和返回错误码的选择

异常处理规范之抛异常和返回错误码的选择

目录

• 该条规范是什么
• 为什么这么规定
• 多种主要用法及其代码示例

该条规范是什么

该规范指出在代码中，对于公司外的HTTP/API开放接口应使用“错误码”来表示错误，而在应用内部推荐使用异常抛出。对于跨应用间的RPC调用，优先考虑使用Result方式，封装了isSuccess()方法、错误码和错误简短信息。

为什么这么规定

以下是该规范的原因：

1. 错误处理标准化：使用错误码作为公司外的HTTP/API开放接口的错误表示方式，可以提供标准的错误码和错误信息，方便接口使用方进行错误处理。
2. 异常传递和处理：在应用内部使用异常抛出可以更好地传递和处理异常情况，提供更详细的错误信息和上下文。而直接返回错误码则可能会导致错误信息的丢失或不够具体。
3. RPC调用效率和可靠性：在跨应用间的RPC调用中，使用Result方式封装结果可以提供更清晰的调用结果和错误信息，避免了频繁的异常抛出和捕获所带来的性能损耗。

多种主要用法及其代码示例

公司外的HTTP/API开放接口使用错误码表示错误

// 正例：使用错误码表示错误
public Result<String> processRequest(Request request) {
    if (!validate(request)) {
        return Result.error(ErrorCode.INVALID_REQUEST);
    }
    // 处理请求...
    return Result.success(response);
}

应用内部推荐使用异常抛出

// 正例：应用内部使用异常抛出
public void processInternalRequest(Request request) throws CustomException {
    if (!validate(request)) {
        throw new CustomException("Invalid request");
    }
    // 处理请求...
}

// 调用处捕获异常并处理
try {
    processInternalRequest(request);
} catch (CustomException e) {
    // 异常处理逻辑
}

跨应用间RPC调用使用Result方式封装调用结果

// 正例：使用Result方式封装RPC调用结果
public Result<String> remoteMethod(Request request) {
    try {
        // 远程调用...
        return Result.success(response);
    } catch (RemoteException e) {
        return Result.error(ErrorCode.REMOTE_ERROR, "Remote call failed");
    }
}

通过在不同场景中选择合适的错误表示方式，可以提高错误处理的标准化、可读性和可靠性。