Micronaut Core 中自定义 HTTP 状态码的使用指南

在基于 Micronaut 框架开发 Web 应用时，开发者经常需要返回标准的 HTTP 状态码来指示请求的处理结果。虽然框架内置支持常见的状态码如 200、404 等，但在某些特殊业务场景下，开发者可能需要返回自定义的 HTTP 状态码。

Micronaut Core 从 3.x 版本开始提供了对自定义 HTTP 状态码的完整支持。这项功能允许开发者根据业务需求定义和使用非标准的 HTTP 状态码，为 API 设计提供了更大的灵活性。

自定义状态码的实现方式

在 Micronaut 中，控制器方法可以通过几种方式返回自定义状态码：

1. 使用 @Status 注解：这是最直接的方式，开发者可以在控制器方法上使用 @Status 注解指定返回的状态码。

2. 通过 HttpResponse 对象：在方法返回 HttpResponse 类型时，可以直接调用 status() 方法设置状态码。

3. 异常处理：通过自定义异常和异常处理器来返回特定的状态码。

实际应用示例

以下是一个完整的示例，展示如何在 Micronaut 应用中定义和使用自定义 HTTP 状态码：

import io.micronaut.http.annotation.*;
import io.micronaut.http.HttpResponse;
import io.micronaut.http.HttpStatus;

@Controller("/custom")
public class CustomStatusController {

    // 使用注解方式返回自定义状态码
    @Get("/annotated")
    @Status(499) // 自定义状态码
    public String annotated() {
        return "使用注解返回自定义状态码";
    }

    // 使用HttpResponse返回自定义状态码
    @Get("/response")
    public HttpResponse<String> response() {
        return HttpResponse.status(498, "自定义状态码说明")
                         .body("使用HttpResponse返回自定义状态码");
    }

    // 结合自定义异常使用
    @Get("/exception")
    public String exception() {
        throw new CustomBusinessException("业务异常示例");
    }
}

// 自定义异常类
class CustomBusinessException extends RuntimeException {
    public CustomBusinessException(String message) {
        super(message);
    }
}

// 异常处理器
@Produces
@Singleton
@Requires(classes = {CustomBusinessException.class})
public class CustomExceptionHandler implements ExceptionHandler<CustomBusinessException, HttpResponse<?>> {
    @Override
    public HttpResponse<?> handle(HttpRequest request, CustomBusinessException exception) {
        return HttpResponse.status(497) // 自定义状态码
                          .body(exception.getMessage());
    }
}

使用注意事项

1. 状态码范围：虽然可以定义任意数值的状态码，但建议遵循 HTTP 协议的规范，自定义状态码应在 400-599 范围内。

2. 客户端兼容性：不是所有 HTTP 客户端都能正确处理非标准状态码，使用前应确保客户端兼容性。

3. 文档说明：使用自定义状态码时，应在 API 文档中明确说明每个自定义状态码的含义和使用场景。

4. 适度使用：过度使用自定义状态码可能导致 API 难以理解，建议仅在标准状态码无法满足需求时使用。

最佳实践建议

1. 为自定义状态码定义枚举类或常量，避免在代码中直接使用魔法数字。

2. 在团队内部建立自定义状态码的使用规范，确保一致性。

3. 考虑为自定义状态码实现统一的错误响应格式。

4. 在自动化测试中特别验证自定义状态码的返回情况。

通过合理使用自定义 HTTP 状态码，开发者可以构建更加灵活和表达性强的 Web API，同时保持代码的清晰性和可维护性。Micronaut 提供的多种实现方式让这一功能可以轻松集成到现有应用中。