0Pricing
gRPC & High Performance APIs · 课时

状态码与错误处理

学习有效使用 gRPC 状态码，并在服务中正确传播和处理错误

状态码与错误处理 是 CoddyKit 上的免费 gRPC & High Performance APIs 课时。 这是第 1 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 gRPC & High Performance APIs 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 gRPC & High Performance APIs 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

Why Handle gRPC Errors?

In any robust application, errors are inevitable. How we handle them can make or break a system's reliability and user experience.

For distributed systems using gRPC, consistent error handling is crucial. It ensures that services can communicate problems clearly and clients can react appropriately.

Meet gRPC Status Codes

gRPC uses a standardized set of Status Codes to indicate the outcome of an RPC (Remote Procedure Call). These codes provide a universal way to understand why a call succeeded or failed.

Think of them like HTTP status codes, but specifically for gRPC. Some common ones include:

  • OK: The RPC completed successfully.
  • NOT_FOUND: Resource not found (e.g., a user ID doesn't exist).
  • INTERNAL: An unexpected error occurred on the server.
  • UNAUTHENTICATED: The request lacks valid authentication credentials.

Protobuf Service Definition

Before we look at error handling, let's define a simple service in a .proto file. This defines the structure of our messages and the RPC methods.

We'll create a UserService with a GetUser method that takes a UserRequest and returns a User.

syntax = "proto3";

option java_multiple_files = true;
option java_package = "com.coddykit.grpc.error";
option java_outer_classname = "ErrorProto";

package errorhandling;

message UserRequest {
  int32 id = 1;
}

message User {
  int32 id = 1;
  string name = 2;
  string email = 3;
}

service UserService {
  rpc GetUser (UserRequest) returns (User);
}

Server-Side Error Signaling

On the server, when an operation fails, you don't throw a regular exception. Instead, you create a gRPC Status object with an appropriate code and description, then convert it to a StatusRuntimeException.

This exception is then sent back to the client via the responseObserver.onError() method, ensuring the client receives the standardized gRPC error.

Server Error Implementation

Try running this example. The server will respond with a NOT_FOUND error if you request any user ID other than 1.

import io.grpc.Server;
import io.grpc.ServerBuilder;
import io.grpc.Status;
import io.grpc.stub.StreamObserver;

import com.coddykit.grpc.error.ErrorProto.User;
import com.coddykit.grpc.error.ErrorProto.UserRequest;
import com.coddykit.grpc.error.UserServiceGrpc;

public class ErrorServer {

  private static final int PORT = 50051;

  public static void main(String[] args) throws Exception {
    Server server = ServerBuilder.forPort(PORT)
        .addService(new UserServiceImpl())
        .build();

    server.start();
    System.out.println("Server started on port " + PORT);
    server.awaitTermination();
  }

  static class UserServiceImpl extends UserServiceGrpc.UserServiceImplBase {
    @Override
    public void getUser(UserRequest request, StreamObserver<User> responseObserver) {
      System.out.println("Received GetUser request for ID: " + request.getId());
      if (request.getId() == 1) {
        User user = User.newBuilder()
            .setId(1)
            .setName("Alice")
            .setEmail("alice@example.com")
            .build();
        responseObserver.onNext(user);
        responseObserver.onCompleted();
      } else {
        Status status = Status.NOT_FOUND.withDescription("User with ID " + request.getId() + " not found.");
        responseObserver.onError(status.asRuntimeException());
      }
    }
  }
}

Client-Side Error Handling

On the client side, gRPC errors are typically received as StatusRuntimeException. You should wrap your gRPC calls in try-catch blocks to gracefully handle these exceptions.

Inside the catch block, you can inspect the Status object from the exception to determine the error code and description, allowing your client to respond intelligently.

Client Error Handling Demo

Run this client code after starting the server from the previous scene. Observe how it handles both a successful user lookup and a 'not found' error.

import io.grpc.ManagedChannel;
import io.grpc.ManagedChannelBuilder;
import io.grpc.StatusRuntimeException;

import com.coddykit.grpc.error.ErrorProto.User;
import com.coddykit.grpc.error.ErrorProto.UserRequest;
import com.coddykit.grpc.error.UserServiceGrpc;

public class ErrorClient {

  private static final int PORT = 50051;
  private static final String HOST = "localhost";

  public static void main(String[] args) {
    ManagedChannel channel = ManagedChannelBuilder.forAddress(HOST, PORT)
        .usePlaintext() // For local testing without TLS
        .build();

    UserServiceGrpc.UserServiceBlockingStub blockingStub = UserServiceGrpc.newBlockingStub(channel);

    // Scenario 1: User found
    try {
      UserRequest foundRequest = UserRequest.newBuilder().setId(1).build();
      User user = blockingStub.getUser(foundRequest);
      System.out.println("User found: " + user.getName());
    } catch (StatusRuntimeException e) {
      System.err.println("Error calling GetUser (found scenario): " + e.getStatus().getCode() + " - " + e.getStatus().getDescription());
    }

    System.out.println("\n--- Trying to get a non-existent user ---");

    // Scenario 2: User not found (expected error)
    try {
      UserRequest notFoundRequest = UserRequest.newBuilder().setId(99).build();
      User user = blockingStub.getUser(notFoundRequest);
      System.out.println("User found (unexpected): " + user.getName()); // This line should not be reached
    } catch (StatusRuntimeException e) {
      System.err.println("Error calling GetUser (not found scenario):");
      System.err.println("  Status Code: " + e.getStatus().getCode());
      System.err.println("  Description: " + e.getStatus().getDescription());
    } finally {
      channel.shutdown();
    }
  }
}

Effective Error Propagation

Proper error propagation is vital. When a gRPC service calls another internal service and encounters an error, it's often best to:

  • Log the error with sufficient detail for debugging.
  • Translate the error into an appropriate gRPC Status code for the calling client. Don't expose internal system errors directly.
  • Avoid swallowing errors. Always handle them or re-throw them so they don't disappear silently.

Test Your Knowledge

You are building a gRPC service that performs a complex calculation. If the input data is invalid (e.g., negative numbers where only positive are allowed), which gRPC Status code is most appropriate to return?

Key Takeaways

You've learned the basics of gRPC error handling!

  • gRPC uses standardized Status Codes to communicate RPC outcomes.
  • Servers signal errors by creating a Status object and calling responseObserver.onError().
  • Clients handle errors by catching StatusRuntimeException and inspecting its Status object.
  • Always propagate errors clearly and translate them appropriately for clients.

This structured approach ensures reliable communication in your distributed systems.

常见问题解答

「状态码与错误处理」课时是免费的吗？

是的 — 「状态码与错误处理」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 gRPC & High Performance APIs 课程的其余内容，请升级到 CoddyKit PRO。 gRPC & High Performance APIs 课程共包含 4 节课。

「状态码与错误处理」这节课中我会学到什么？

学习有效使用 gRPC 状态码，并在服务中正确传播和处理错误 你通过在浏览器中直接运行的动手代码来练习 gRPC & High Performance APIs，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 gRPC & High Performance APIs 需要有经验吗？

无需任何先前经验。CoddyKit 上的 gRPC & High Performance APIs 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 1 节课，共 4 节。

「状态码与错误处理」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 gRPC & High Performance APIs 课中编写并运行代码吗？

能。每节 gRPC & High Performance APIs 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 状态码与错误处理
  2. 自定义元数据传输
  3. 上下文与截止期限
  4. 使用 google.rpc.Status 构建丰富的错误模型
← 返回 gRPC & High Performance APIs