程序员求职经验分享与学习资料整理平台

网站首页 > 文章精选 正文

Spring Boot WebFlux中如何进行统一接口返回的封装?

balukai 2025-01-12 11:29:31 文章精选 12 ℃

Spring Boot WebFlux是Spring 5引入的一种基于响应式编程的Web框架,适用于构建高并发、非阻塞的Web应用。WebFlux使用了异步非阻塞的编程模型,支持响应式流操作,可以在低资源占用下支持大量并发请求。它是对传统Spring MVC的补充,更适合于I/O密集型的应用场景。

在Spring Boot WebFlux中,通过实现统一的接口返回封装,可以有效的帮助我们通过规范的API返回结构来实现方便的前端相应处理结果。一般情况下,我们会定义一个统一的响应数据结构,并使用过滤器、异常处理等方式来实现这一封装,而在WebFlux中可以通过同样的方式来实现相关操作。

定义统一返回结构

首先,我们定义一个统一的响应数据结构,如下所示,通过这个类来定义统一的数据响应结构。如下所示。

public class CommonResult<T> {
    private Integer code;
    private String message;
    private T data;

    public CommonResult() {}

    public CommonResult(Integer code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    public static <T> CommonResult<T> success(T data) {
        return new CommonResult<>(200, "Success", data);
    }

    public static <T> CommonResult<T> error(String message) {
        return new CommonResult<>(500, message, null);
    }

    // Getter & Setter
}

提供了success和error的静态方法,方便在控制器中构造不同的响应。

在 Controller 层使用封装的返回结构

在WebFlux中,我们可以通过Mono或Flux来实现响应参数的返回,所以我们可以在返回的时候直接对CommonResult进行封装,如下所示。

  • Mono:表示 0 或 1 个元素的异步序列,用于处理单个返回值的场景。
  • Flux:表示 0 到 N 个元素的异步序列,用于处理多个返回值的场景。
@RestController
@RequestMapping("/api")
public class UserController {

    @GetMapping("/user/{id}")
    public Mono<CommonResult<User>> getUserById(@PathVariable Long id) {
        return userService.findById(id)
                .map(CommonResult::success)
                .defaultIfEmpty(CommonResult.error("User not found"));
    }
}

这里的 map(CommonResult::success) 会将返回的用户对象包装成 CommonResult 的成功响应,而 defaultIfEmpty(CommonResult.error("User not found")) 用于处理用户未找到的情况。

全局异常处理

为了统一处理异常情况,可以通过WebFlux的@ControllerAdvice和@ExceptionHandler注解,捕获所有异常并返回统一的响应结构。

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public Mono<CommonResult<String>> handleException(Exception ex) {
        return Mono.just(CommonResult.error("Server Error: " + ex.getMessage()));
    }

    @ExceptionHandler(ResourceNotFoundException.class)
    public Mono<CommonResult<String>> handleResourceNotFoundException(ResourceNotFoundException ex) {
        return Mono.just(CommonResult.error("Not Found: " + ex.getMessage()));
    }
}

通过这个全局异常处理类,所有未捕获的异常都会返回一个封装好的错误响应。

使用WebFilter统一处理响应

当然,除了上面的方式之外,我们还可以通过WebFilter来统一的处理所有的响应操作,需要在过滤器中判断数据响应类型,然后根据具体的需求来封装成CommonResult并进行反馈,如下所示。

@Component
public class ResponseWrapperFilter implements WebFilter {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
        return chain.filter(exchange).flatMap(response -> {
            if (response instanceof CommonResult) {
                return Mono.just(response);
            }
            return Mono.just(CommonResult.success(response));
        });
    }
}

通过这种方式,在请求经过过滤器的时候,如果响应参数不是CommonResult类型的时候,就会自动进行参数的封装,从而完成统一的响应结果的处理。

总结

在Spring Boot WebFlux中通过以上方法进行统一接口返回封装,能够使API响应更加规范、易于维护,同时也有利于前端的处理。启动应用并通过 Postman 或浏览器访问接口,可以看到所有接口的响应都遵循统一的返回结构。

最近发表
标签列表