Spring Cloud Feign如何实现JWT令牌中继以传递认证信息

r囧r小猫 2022-09-17 05:23 74阅读 0赞

![5c52a44fbf24690b56ecbf17f1684c80.png][]

在上一篇实现了Spring Cloud资源服务器的定制化，但是又发现了一个新的问题，Spring Cloud微服务调用的过程中需要令牌中继。只有令牌中继才能在调用链中保证用户认证信息的传递。今天就来分享一下如何在Feign中实现令牌中继。

### 令牌中继 ###

令牌中继(Token Relay)是比较正式的说法，说白了就是让Token令牌在服务间传递下去以保证资源服务器能够正确地对调用方进行鉴权。

#### 令牌难道不能在Feign自动中继吗？ ####

如果我们携带Token去访问A服务，A服务肯定能够鉴权，但是A服务又通过Feign调用B服务，这时候A的令牌是无法直接传递给B服务的。

这里来简单说下原因，服务间的调用通过Feign接口来进行。在调用方通常我们编写类似下面的Feign接口：

@FeignClient(name = "foo-service",fallback = FooClient.Fallback.class)
    public interface FooClient {
        @GetMapping("/foo/bar")
        Rest<Map<String, String>> bar();
    
        @Component
        class Fallback implements FooClient {
            @Override
            public Rest<Map<String, String>> bar() {
                return RestBody.fallback();
            }
        }
    }

当我们调用Feign接口后，会通过动态代理来生成该接口的代理类供我们调用。如果我们不打开熔断我们可以从Spring Security提供`SecurityContext`对象中提取到资源服务器的认证对象`JwtAuthenticationToken`，它包含了JWT令牌然后我们可以通过实现Feign的拦截器接口`RequestInterceptor`把Token放在请求头中，伪代码如下：

/**
     * 需要注入Spring IoC
     **/
    static class BearerTokenRequestInterceptor implements RequestInterceptor {
            @Override
            public void apply(RequestTemplate template) {
                final String authorization = HttpHeaders.AUTHORIZATION;
                Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
                
                if (authentication instanceof JwtAuthenticationToken){
                    JwtAuthenticationToken jwtAuthenticationToken = (JwtAuthenticationToken) authentication;
                    String tokenValue = jwtAuthenticationToken.getToken().getTokenValue();
                    template.header(authorization,"Bearer "+tokenValue);
                }
            }
        }

如果我们不开启熔断这样搞问题不大，为了防止调用链雪崩服务熔断基本没有不打开的。这时候从`SecurityContextHolder`就无法获取到`Authentication`了。因为这时Feign调用是在调用方的调用线程下又开启了一个子线程中进行的。由于我使用的熔断组件是**Resilience4J**,对应的线程源码在`Resilience4JCircuitBreaker`中：

Supplier<Future<T>> futureSupplier = () -> executorService.submit(toRun::get);

`SecurityContextHolder`保存信息是默认是通过`ThreadLocal`实现的，我们都知道这个是不能跨线程的，而Feign的拦截器这时恰恰在子线程中，**因此开启了熔断功能（circuitBreaker）的Feign无法直接进行令牌中继**。

> ❝
> 
> 熔断组件有过时的Hystrix、Resilience4J、还有阿里的哨兵Sentinel，它们的机制可能有小小的不同。

### 实现令牌中继 ###

虽然直接不能实现令牌中继，但是我从中还是找到了一些信息。在Feign接口代理的处理器`FeignCircuitBreakerInvocationHandler`中发现了下面的代码：

private Supplier<Object> asSupplier(final Method method, final Object[] args) {
      final RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
      return () -> {
       try {
        RequestContextHolder.setRequestAttributes(requestAttributes);
        return this.dispatch.get(method).invoke(args);
       }
       catch (RuntimeException throwable) {
        throw throwable;
       }
       catch (Throwable throwable) {
        throw new RuntimeException(throwable);
       }
       finally {
        RequestContextHolder.resetRequestAttributes();
       }
      };
     }

这是Feign代理类的执行代码，我们可以看到在执行前：

final RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();

这里是获得调用线程中请求的信息，包含了`ServletHttpRequest`、`ServletHttpResponse`等信息。紧接着又在lambda代码中把这些信息又Setter了进去：

RequestContextHolder.setRequestAttributes(requestAttributes);

如果这是一个线程中进行的简直就是吃饱了撑的，事实上`Supplier`返回值是在另一个线程中执行的。这样做的目的就是为了跨线程保存一些请求的元数据。

#### InheritableThreadLocal ####

`RequestContextHolder` 是如何做到跨线程了传递数据的呢？

public abstract class RequestContextHolder  {
     
     private static final ThreadLocal<RequestAttributes> requestAttributesHolder =
       new NamedThreadLocal<>("Request attributes");
    
     private static final ThreadLocal<RequestAttributes> inheritableRequestAttributesHolder =
       new NamedInheritableThreadLocal<>("Request context");
    // 省略
    }

`RequestContextHolder` 维护了两个容器，一个是不能跨线程的`ThreadLocal`，一个是实现了`InheritableThreadLocal`的`NamedInheritableThreadLocal`。`InheritableThreadLocal`是可以把父线程的数据传递到子线程的，基于这个原理`RequestContextHolder`把调用方的请求信息带进了子线程，借助于这个原理就能实现令牌中继了。

### 实现令牌中继 ###

把最开始的Feign拦截器代码改动了一下就实现了令牌的中继：

/**
         * 令牌中继
         */
        static class BearerTokenRequestInterceptor implements RequestInterceptor {
            private static final Pattern BEARER_TOKEN_HEADER_PATTERN = Pattern.compile("^Bearer (?<token>[a-zA-Z0-9-._~+/]+=*)$",
                    Pattern.CASE_INSENSITIVE);
    
            @Override
            public void apply(RequestTemplate template) {
                final String authorization = HttpHeaders.AUTHORIZATION;
                ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
                if (Objects.nonNull(requestAttributes)) {
                    String authorizationHeader = requestAttributes.getRequest().getHeader(HttpHeaders.AUTHORIZATION);
                    Matcher matcher = BEARER_TOKEN_HEADER_PATTERN.matcher(authorizationHeader);
                    if (matcher.matches()) {
                        // 清除token头 避免传染
                        template.header(authorization);
                        template.header(authorization, authorizationHeader);
                    }
                }
            }
        }

这样当你调用`FooClient.bar()`时，在`foo-service`中资源服务器(OAuth2 Resource Server)也可以获得调用方的令牌，进而获得用户的信息来处理资源权限和业务。

> ❝
> 
> 不要忘记将这个拦截器注入Spring IoC。

### 总结 ###

微服务令牌中继是非常重要的，保证了用户状态在调用链路的传递。而且这也是微服务的难点。今天借助于Feign的一些特性和`ThreadLocal`的特性实现了令牌中继供大家参考。原创不易，请大家多多点击再看、点赞、转发。

推荐关注本文作者：码农小胖哥

分享高质量编程知识，探讨IT人生

技术干货，实战技巧，面试技巧，前沿资讯一个都不能少

[5c52a44fbf24690b56ecbf17f1684c80.png]: /images/20220828/ca6679a1f3b54bd9a96590915c406d89.png