深刻理解 WebSecurityConfigurerAdapter【源码篇】

时间  2020-07-30
标签 深刻 理解 websecurityconfigureradapter 源码篇 繁體版
原文   原文链接

咱们继续来撸 Spring Security 源码，今天来撸一个很是重要的 WebSecurityConfigurerAdapter。java

咱们的自定义都是继承自 WebSecurityConfigurerAdapter 来实现的，可是对于 WebSecurityConfigurerAdapter 内部的工做原理，配置原理，不少小伙伴可能都还不太熟悉，所以咱们今天就来捋一捋。web

咱们先来看一张 WebSecurityConfigurerAdapter 的继承关系图：安全

在这层继承关系中，有两个很是重要的类：session

  • SecurityBuilder
  • SecurityConfigurer

这两个类松哥在以前的文章中都和你们分享过了，具体参考：app

因此关于这两个类的介绍以及做用，松哥这里就不赘述了。我们直接从 WebSecurityConfigurer 开始看起。ide

1.WebSecurityConfigurer

WebSecurityConfigurer 实际上是一个空接口，可是它里边约束了一些泛型，以下：源码分析

public interface WebSecurityConfigurer<T extends SecurityBuilder<Filter>> extends
        SecurityConfigurer<Filter, T> {

}

这里边的泛型很关键，这关乎到 WebSecurityConfigurer 的目的是啥！post

  1. SecurityBuilder 中的泛型 Filter，表示 SecurityBuilder 最终的目的是为了构建一个 Filter 对象出来。
  2. SecurityConfigurer 中两个泛型，第一个表示的含义也是 SecurityBuilder 最终构建的对象。

同时这里还定义了新的泛型 T，T 须要继承自 SecurityBuilder<Filter>，根据 WebSecurityConfigurerAdapter 中的定义，咱们能够知道，T 就是 WebSecurity，咱们也大概能猜出 WebSecurity 就是 SecurityBuilder<Filter> 的子类。ui

因此 WebSecurityConfigurer 的目的咱们能够理解为就是为了配置 WebSecurity。this

2.WebSecurity

咱们来看下 WebSecurity 的定义：

public final class WebSecurity extends
        AbstractConfiguredSecurityBuilder<Filter, WebSecurity> implements
        SecurityBuilder<Filter>, ApplicationContextAware {
}

没错，确实是这样！WebSecurity 继承自 AbstractConfiguredSecurityBuilder<Filter, WebSecurity> 同时实现了 SecurityBuilder<Filter> 接口。

WebSecurity 的这些接口和继承类，松哥在前面的源码分析中都和你们介绍过了，可能有的小伙伴忘记了，我再来和你们复习一下。

AbstractConfiguredSecurityBuilder

首先 AbstractConfiguredSecurityBuilder 中定义了一个枚举类，将整个构建过程分为 5 种状态，也能够理解为构建过程生命周期的五个阶段，以下：

private enum BuildState {
    UNBUILT(0),
    INITIALIZING(1),
    CONFIGURING(2),
    BUILDING(3),
    BUILT(4);
    private final int order;
    BuildState(int order) {
        this.order = order;
    }
    public boolean isInitializing() {
        return INITIALIZING.order == order;
    }
    public boolean isConfigured() {
        return order >= CONFIGURING.order;
    }
}

五种状态分别是 UNBUILT、INITIALIZING、CONFIGURING、BUILDING 以及 BUILT。另外还提供了两个判断方法，isInitializing 判断是否正在初始化，isConfigured 表示是否已经配置完毕。

AbstractConfiguredSecurityBuilder 中的方法比较多，松哥在这里列出来两个关键的方法和你们分析：

private <C extends SecurityConfigurer<O, B>> void add(C configurer) {
    Assert.notNull(configurer, "configurer cannot be null");
    Class<? extends SecurityConfigurer<O, B>> clazz = (Class<? extends SecurityConfigurer<O, B>>) configurer
            .getClass();
    synchronized (configurers) {
        if (buildState.isConfigured()) {
            throw new IllegalStateException("Cannot apply " + configurer
                    + " to already built object");
        }
        List<SecurityConfigurer<O, B>> configs = allowConfigurersOfSameType ? this.configurers
                .get(clazz) : null;
        if (configs == null) {
            configs = new ArrayList<>(1);
        }
        configs.add(configurer);
        this.configurers.put(clazz, configs);
        if (buildState.isInitializing()) {
            this.configurersAddedInInitializing.add(configurer);
        }
    }
}
private Collection<SecurityConfigurer<O, B>> getConfigurers() {
    List<SecurityConfigurer<O, B>> result = new ArrayList<>();
    for (List<SecurityConfigurer<O, B>> configs : this.configurers.values()) {
        result.addAll(configs);
    }
    return result;
}

第一个就是这个 add 方法，这至关因而在收集全部的配置类。将全部的 xxxConfigure 收集起来存储到 configurers 中，未来再统一初始化并配置，configurers 自己是一个 LinkedHashMap ，key 是配置类的 class，value 是一个集合，集合里边放着 xxxConfigure 配置类。当须要对这些配置类进行集中配置的时候，会经过 getConfigurers 方法获取配置类，这个获取过程就是把 LinkedHashMap 中的 value 拿出来，放到一个集合中返回。

另外一个方法就是 doBuild 方法。

@Override
protected final O doBuild() throws Exception {
    synchronized (configurers) {
        buildState = BuildState.INITIALIZING;
        beforeInit();
        init();
        buildState = BuildState.CONFIGURING;
        beforeConfigure();
        configure();
        buildState = BuildState.BUILDING;
        O result = performBuild();
        buildState = BuildState.BUILT;
        return result;
    }
}
private void init() throws Exception {
    Collection<SecurityConfigurer<O, B>> configurers = getConfigurers();
    for (SecurityConfigurer<O, B> configurer : configurers) {
        configurer.init((B) this);
    }
    for (SecurityConfigurer<O, B> configurer : configurersAddedInInitializing) {
        configurer.init((B) this);
    }
}
private void configure() throws Exception {
    Collection<SecurityConfigurer<O, B>> configurers = getConfigurers();
    for (SecurityConfigurer<O, B> configurer : configurers) {
        configurer.configure((B) this);
    }
}

在 AbstractSecurityBuilder 类中，过滤器的构建被转移到 doBuild 方法上面了，不过在 AbstractSecurityBuilder 中只是定义了抽象的 doBuild 方法，具体的实如今 AbstractConfiguredSecurityBuilder。

doBuild 方法就是一边更新状态，进行进行初始化。

beforeInit 是一个预留方法，没有任何实现。

init 方法就是找到全部的 xxxConfigure，挨个调用其 init 方法进行初始化。

beforeConfigure 是一个预留方法，没有任何实现。

configure 方法就是找到全部的 xxxConfigure，挨个调用其 configure 方法进行配置。

最后则是 performBuild 方法，是真正的过滤器链构建方法，可是在 AbstractConfiguredSecurityBuilder 中 performBuild 方法只是一个抽象方法，具体的实如今它的子类中，也就是 WebSecurityConfigurer。

SecurityBuilder<Filter>

SecurityBuilder 就是用来构建过滤器链的，在 HttpSecurity 实现 SecurityBuilder 时，传入的泛型就是 DefaultSecurityFilterChain，因此 SecurityBuilder#build 方法的功能很明确，就是用来构建一个过滤器链出来，可是那个过滤器链是 Spring Security 中的。在 WebSecurityConfigurerAdapter 中定义的泛型是 SecurityBuilder<Filter>，因此最终构建的是一个普通 Filter，其实就是 FilterChainProxy，关于 FilterChainProxy ，你们能够参考深刻理解 FilterChainProxy【源码篇】。

WebSecurity

WebSecurity 的核心逻辑集中在 performBuild 构建方法上，咱们一块儿来看下：

@Override
protected Filter performBuild() throws Exception {
    Assert.state(
            !securityFilterChainBuilders.isEmpty(),
            () -> "At least one SecurityBuilder<? extends SecurityFilterChain> needs to be specified. "
                    + "Typically this done by adding a @Configuration that extends WebSecurityConfigurerAdapter. "
                    + "More advanced users can invoke "
                    + WebSecurity.class.getSimpleName()
                    + ".addSecurityFilterChainBuilder directly");
    int chainSize = ignoredRequests.size() + securityFilterChainBuilders.size();
    List<SecurityFilterChain> securityFilterChains = new ArrayList<>(
            chainSize);
    for (RequestMatcher ignoredRequest : ignoredRequests) {
        securityFilterChains.add(new DefaultSecurityFilterChain(ignoredRequest));
    }
    for (SecurityBuilder<? extends SecurityFilterChain> securityFilterChainBuilder : securityFilterChainBuilders) {
        securityFilterChains.add(securityFilterChainBuilder.build());
    }
    FilterChainProxy filterChainProxy = new FilterChainProxy(securityFilterChains);
    if (httpFirewall != null) {
        filterChainProxy.setFirewall(httpFirewall);
    }
    filterChainProxy.afterPropertiesSet();
    Filter result = filterChainProxy;
    if (debugEnabled) {
        logger.warn("\n\n"
                + "********************************************************************\n"
                + "**********        Security debugging is enabled.       *************\n"
                + "**********    This may include sensitive information.  *************\n"
                + "**********      Do not use in a production system!     *************\n"
                + "********************************************************************\n\n");
        result = new DebugFilter(filterChainProxy);
    }
    postBuildAction.run();
    return result;
}

先来讲一句，这里的 performBuild 方法只有一个功能，那就是构建 FilterChainProxy，若是你还不了解什么是 FilterChainProxy，能够参考松哥以前的介绍：深刻理解 FilterChainProxy【源码篇】。

把握住了这条主线，咱们再来看方法的实现就很容易了。

  1. 首先统计过滤器链的总条数，总条数包括两个方面，一个是 ignoredRequests，这是忽略的请求，经过 WebSecurity 配置的忽略请求，松哥以前介绍过，参见：Spring Security 两种资源放行策略，千万别用错了！，另外一个则是 securityFilterChainBuilders，也就是咱们经过 HttpSecurity 配置的过滤器链，有几个就算几个。
  2. 建立 securityFilterChains 集合，而且遍历上面提到的两种类型的过滤器链，并将过滤器链放入 securityFilterChains 集合中。
  3. 我在深刻理解 HttpSecurity【源码篇】一文中介绍过，HttpSecurity 构建出来的过滤器链对象就是 DefaultSecurityFilterChain，因此能够直接将 build 结果放入 securityFilterChains 中，而 ignoredRequests 中保存的则须要重构一下才能够存入 securityFilterChains。
  4. securityFilterChains 中有数据以后，接下来建立一个 FilterChainProxy。
  5. 给新建的 FilterChainProxy 配置上防火墙，防火墙的介绍参考松哥以前的：Spring Security 自带防火墙！你都不知道本身的系统有多安全！。
  6. 最后咱们返回的就是 FilterChainProxy 的实例。

从这段分析中，咱们能够看出来 WebSecurity 和 HttpSecurity 的区别：

  1. HttpSecurity 目的是构建过滤器链，一个 HttpSecurity 对象构建一条过滤器链，一个过滤器链中有 N 个过滤器，HttpSecurity 所作的事情实际上就是在配置这 N 个过滤器。
  2. WebSecurity 目的是构建 FilterChainProxy，一个 FilterChainProxy 中包含有多个过滤器链和一个 Firewall。

这就是 WebSecurity 的主要做用，核心方法是 performBuild，其余方法都比较简单，松哥就不一一解释了。

3.WebSecurityConfigurerAdapter

最后咱们再来看 WebSecurityConfigurerAdapter，因为 WebSecurityConfigurer 只是一个空接口，WebSecurityConfigurerAdapter 就是针对这个空接口提供一个具体的实现，最终目的仍是为了方便你配置 WebSecurity。

WebSecurityConfigurerAdapter 中的方法比较多，可是根据咱们前面的分析，提纲挈领的方法就两个，一个是 init，还有一个 configure(WebSecurity web)，其余方法都是为这两个方法服务的。那咱们就来看下这两个方法：

先看 init 方法：

public void init(final WebSecurity web) throws Exception {
    final HttpSecurity http = getHttp();
    web.addSecurityFilterChainBuilder(http).postBuildAction(() -> {
        FilterSecurityInterceptor securityInterceptor = http
                .getSharedObject(FilterSecurityInterceptor.class);
        web.securityInterceptor(securityInterceptor);
    });
}
protected final HttpSecurity getHttp() throws Exception {
    if (http != null) {
        return http;
    }
    AuthenticationEventPublisher eventPublisher = getAuthenticationEventPublisher();
    localConfigureAuthenticationBldr.authenticationEventPublisher(eventPublisher);
    AuthenticationManager authenticationManager = authenticationManager();
    authenticationBuilder.parentAuthenticationManager(authenticationManager);
    Map<Class<?>, Object> sharedObjects = createSharedObjects();
    http = new HttpSecurity(objectPostProcessor, authenticationBuilder,
            sharedObjects);
    if (!disableDefaults) {
        // @formatter:off
        http
            .csrf().and()
            .addFilter(new WebAsyncManagerIntegrationFilter())
            .exceptionHandling().and()
            .headers().and()
            .sessionManagement().and()
            .securityContext().and()
            .requestCache().and()
            .anonymous().and()
            .servletApi().and()
            .apply(new DefaultLoginPageConfigurer<>()).and()
            .logout();
        // @formatter:on
        ClassLoader classLoader = this.context.getClassLoader();
        List<AbstractHttpConfigurer> defaultHttpConfigurers =
                SpringFactoriesLoader.loadFactories(AbstractHttpConfigurer.class, classLoader);
        for (AbstractHttpConfigurer configurer : defaultHttpConfigurers) {
            http.apply(configurer);
        }
    }
    configure(http);
    return http;
}
protected void configure(HttpSecurity http) throws Exception {
    logger.debug("Using default configure(HttpSecurity). If subclassed this will potentially override subclass configure(HttpSecurity).");
    http
        .authorizeRequests()
            .anyRequest().authenticated()
            .and()
        .formLogin().and()
        .httpBasic();
}

init 方法能够算是这里的入口方法了：首先调用 getHttp 方法进行 HttpSecurity 的初始化。HttpSecurity 的初始化，实际上就是配置了一堆默认的过滤器，配置完成后，最终还调用了 configure(http) 方法，该方法又配置了一些拦截器，不过在实际开发中，咱们常常会重写 configure(http) 方法，在松哥本系列前面的文章中，configure(http) 方法几乎都有重写。HttpSecurity 配置完成后，再将 HttpSecurity 放入 WebSecurity 中，保存在 WebSecurity 的 securityFilterChainBuilders 集合里，具体参见：深刻理解 HttpSecurity【源码篇】。

configure(WebSecurity web) 方法其实是一个空方法，咱们在实际开发中可能会重写该方法（参见 Spring Security 两种资源放行策略，千万别用错了！ 一文）：

public void configure(WebSecurity web) throws Exception {
}

4.小结

这即是 WebSecurityConfigurerAdapter，总体上来讲并不难，可是要和松哥前面几篇源码分析文章一块儿看，理解会更加深入一些。

传送门：

  1. 深刻理解 FilterChainProxy【源码篇】
  2. 深刻理解 SecurityConfigurer 【源码篇】
  3. 深刻理解 HttpSecurity【源码篇】
  4. 深刻理解 AuthenticationManagerBuilder 【源码篇】

好啦，小伙伴们要是有收获，记得点个在看鼓励下松哥哦～

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程