SpringWebFlux处理null与异常技巧

来到golang学习网的大家，相信都是编程学习爱好者，希望在这里学习文章相关编程知识。下面本篇文章就来带大家聊聊《Spring WebFlux处理null与自定义异常技巧》，介绍一下，希望对大家的知识积累有所帮助，助力实战开发！

理解响应式流中的null值限制

在Project Reactor（Spring WebFlux底层使用的响应式库）以及更广泛的Reactive Streams规范中，null值是被明确禁止作为流中元素的。这意味着，一个Mono或Flux不应该发出null值。当一个操作符（如map）的映射函数返回null时，Reactor会将其视为一个无效的信号，并可能导致意外行为或运行时错误。因此，在响应式编程中，我们不能简单地让一个map操作返回null，然后期望后续的操作符能像处理空流一样处理它。

问题场景：条件性抛出异常

考虑以下Spring WebFlux中的响应式代码片段，其目标是从安全上下文中获取用户主体名称（userPrincipalName）：

ReactiveSecurityContextHolder.getContext()
        .map(SecurityContext::getAuthentication)
        .map(authentication -> (UserAuthenticationToken) authentication)
        .map(UserAuthenticationToken::getUserPrincipalName)
        // 在这里，如果getUserPrincipalName返回null，我们希望抛出自定义异常

如果UserAuthenticationToken::getUserPrincipalName方法可能返回null，并且我们希望在这种情况下抛出一个自定义的MissingPrincipalException，那么直接尝试使用switchIfEmpty或filter是无效的：

// 尝试1：使用switchIfEmpty - 无效
.map(UserAuthenticationToken::getUserPrincipalName)
.switchIfEmpty(Mono.error(new MissingPrincipalException("Missing email field in the JWT token")));

// 尝试2：使用filter结合switchIfEmpty - 无效
.map(UserAuthenticationToken::getUserPrincipalName)
.filter(Objects::nonNull) // 过滤掉null
.switchIfEmpty(Mono.error(new MissingPrincipalException("Missing email field in the JWT token")));

这些尝试之所以无效，是因为switchIfEmpty操作符是用来处理上游Publisher发出完成信号且未发出任何元素（即流为空）的情况。当map操作返回null时，它仍然会尝试将null作为元素发出，这违反了Reactive Streams规范。filter(Objects::nonNull)虽然可以过滤掉null，但如果map本身已经发出了null，在filter之前就已经违反了规范。更关键的是，即使filter成功过滤了null，switchIfEmpty也只会在整个流变为空时才触发，而不是在单个元素为null时触发。

解决方案一：使用flatMap操作符

flatMap操作符允许我们将流中的每个元素映射到一个新的Publisher（Mono或Flux）。这使得我们可以在映射过程中执行条件逻辑，并根据条件返回不同的Publisher，包括一个错误Publisher。

示例代码：

import org.springframework.security.core.context.ReactiveSecurityContextHolder;
import org.springframework.security.core.context.SecurityContext;
import reactor.core.publisher.Mono;

// 假设UserAuthenticationToken和MissingPrincipalException已定义
// class UserAuthenticationToken implements Authentication { ... public String getUserPrincipalName() { ... } }
// class MissingPrincipalException extends RuntimeException { ... }

public class PrincipalService {

    public Mono<String> getUserPrincipalNameSafely() {
        return ReactiveSecurityContextHolder.getContext()
                .map(SecurityContext::getAuthentication)
                .map(authentication -> (UserAuthenticationToken) authentication)
                .flatMap(token -> {
                    String principalName = token.getUserPrincipalName();
                    if (principalName == null) {
                        // 如果principalName为null，则返回一个包含错误的Mono
                        return Mono.error(new MissingPrincipalException("Missing email field in the JWT token"));
                    } else {
                        // 否则，返回一个包含非null principalName的Mono
                        return Mono.just(principalName);
                    }
                });
    }
}

代码解析：

1. flatMap(token -> { ... })：对于上游发出的每个UserAuthenticationToken，flatMap的函数体会被调用。
2. 在函数体内，我们首先获取principalName。
3. if (principalName == null)：如果principalName为null，我们通过Mono.error(new MissingPrincipalException(...))创建一个包含自定义异常的Mono并返回。这个错误Mono会立即向下游发出错误信号，终止当前流。
4. else { return Mono.just(principalName); }：如果principalName非null，我们通过Mono.just(principalName)创建一个包含该值的Mono并返回。这个Mono会正常向下游发出principalName。

flatMap的这种用法完美地解决了在特定条件（值null）下抛出异常的需求，因为它允许我们完全控制每个元素如何被转换为后续的响应式流。

解决方案二：使用handle操作符

handle操作符是一个功能非常强大的通用操作符，它结合了map和filter的功能，并且允许更复杂的条件逻辑，包括发出错误信号。它接收一个BiConsumer，其中包含当前元素和SynchronousSink，通过SynchronousSink可以发出零个、一个或一个错误信号。

示例代码：

import org.springframework.security.core.context.ReactiveSecurityContextHolder;
import org.springframework.security.core.context.SecurityContext;
import reactor.core.publisher.Mono;
import reactor.core.publisher.SynchronousSink;

// 假设UserAuthenticationToken和MissingPrincipalException已定义

public class PrincipalService {

    public Mono<String> getUserPrincipalNameSafelyWithHandle() {
        return ReactiveSecurityContextHolder.getContext()
                .map(SecurityContext::getAuthentication)
                .map(authentication -> (UserAuthenticationToken) authentication)
                .handle((token, sink) -> {
                    String principalName = token.getUserPrincipalName();
                    if (principalName == null) {
                        // 如果principalName为null，通过sink发出错误信号
                        sink.error(new MissingPrincipalException("Missing email field in the JWT token"));
                    } else {
                        // 否则，通过sink发出非null principalName
                        sink.next(principalName);
                    }
                });
    }
}

代码解析：

1. handle((token, sink) -> { ... })：对于上游发出的每个UserAuthenticationToken，handle的函数体会被调用。
2. 在函数体内，我们获取principalName。
3. if (principalName == null)：如果principalName为null，我们调用sink.error(new MissingPrincipalException(...))发出错误信号。这会立即终止流并向下游传递异常。
4. else { sink.next(principalName); }：如果principalName非null，我们调用sink.next(principalName)发出这个非null的值，流会继续正常处理。

handle操作符的优势在于其灵活性。它不仅可以用于条件性地发出错误，还可以用于过滤元素（不调用sink.next）、转换元素（调用sink.next一次）甚至将一个元素转换为零个或多个元素（尽管对于单值Mono来说，通常是零个或一个）。

总结与最佳实践

在Spring WebFlux响应式编程中处理可能为null的值并抛出自定义异常时，请记住以下几点：

1. Reactive Streams规范禁止null值：不要期望map操作返回null后能被后续操作符正常处理。
2. flatMap是处理条件性错误和转换的直接方式：当你需要根据元素的值来决定是继续传递一个值、传递一个空流还是传递一个错误流时，flatMap是首选。它将一个元素转换为一个新的Publisher。
3. handle提供更细粒度的控制：handle操作符非常强大，适用于更复杂的条件逻辑，包括过滤、转换和发出错误。它通过SynchronousSink提供了直接控制流发出的能力。
4. 避免switchIfEmpty和filter的误用：这些操作符主要用于处理流的空性，而不是流中单个元素的null值。
5. 自定义异常的合理使用：针对特定的业务错误场景定义和抛出自定义异常，有助于提高代码的可读性和错误处理的准确性。

根据具体的业务逻辑和代码的简洁性需求，可以选择flatMap或handle来实现对null值的健壮处理和异常抛出。在大多数需要根据元素内容进行条件性错误处理的场景中，flatMap通常是更直观和简洁的选择。

今天关于《SpringWebFlux处理null与异常技巧》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！