Spring Security custom config supplement (#97 )

* 提交SpringSecurity模块

* 修改文档

* 修改文档

* Update SpringSecurity请求全过程解析.md

* Spring Security自定义用户认证

* 修改目录

* 修改图片路径

* Spring Security自定义认证补充讲解

2021-08-21 10:46:41 +08:00

22 KiB

Raw Blame History

Spring Security自定义用户认证

在Spring Boot中开启Spring Security一节中我们简单地搭建了一个Spring Boot + Spring Security的项目，其中登录页、用户名和密码都是由Spring Security自动生成的。Spring Security支持我们自定义认证的过程，如使用自定义的登录页替换默认的登录页，用户信息的获取逻辑、登录成功或失败后的处理逻辑等。这里将在上一节的源码基础上进行改造。

配置自定义登录页

为了方便起见，我们直接在src/main/resources/resources目录下创建一个login.html（不需要Controller跳转）：

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>登录</title>
    <link rel="stylesheet" href="css/login.css" type="text/css">
</head>
<body>
    <form class="login-page" action="/login" method="post">
        <div class="form">
            <h3>账户登录</h3>
            <input type="text" placeholder="用户名" name="username" required="required" />
            <input type="password" placeholder="密码" name="password" required="required" />
            <button type="submit">登录</button>
        </div>
    </form>
</body>
</html>

要怎么做才能让Spring Security跳转到我们自己定义的登录页面呢？很简单，只需要在BrowserSecurityConfig的configure中添加一些配置：

@Configuration
public class BrowserConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.formLogin() // 表单登录
                .loginPage("/login.html") // 自定义登录页
                .loginProcessingUrl("/login") // 登录认证路径
                .and()
                .authorizeRequests() // 授权配置
                .antMatchers("/login.html", "/css/</strong></i>", "/error").permitAll() // 无需认证
                .anyRequest().authenticated() // 除antMatchers中配置路径外其他所有请求都需要认证
                .and().csrf().disable();
    }
}

上面代码中.loginPage("/login.html")指定了跳转到登录页面的请求URL，.loginProcessingUrl("/login")对应登录页面form表单的action="/login"，.antMatchers("/login.html", "/css/", "/error").permitAll()表示跳转到登录页面的请求不被拦截。

这时候启动系统，访问http://localhost:8080/hello，会看到页面已经被重定向到了http://localhost:8080/login.html：

配置用户信息的获取逻辑

Spring Security默认会为我们生成一个用户名为user，密码随机的用户实例，当然我们也可以定义自己用户信息的获取逻辑，只需要实现Spring Security提供的UserDetailService接口即可，该接口只有一个抽象方法loadUserByUsername，具体实现如下：

@Service
public class UserDetailService implements UserDetailsService {
    @Autowired
    private PasswordEncoder passwordEncoder;
    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        return new User(username, passwordEncoder.encode("123456"), AuthorityUtils.createAuthorityList("admin"));
    }
}

通过以上配置，我们定义了一个用户名随机，密码统一为123456的用户信息的获取逻辑。这样，当我们启动项目，访问http://localhost:8080/login，只需要输入任意用户名以及123456作为密码即可登录系统。

源码解析

BrowserConfig配置解析

我们首先来梳理下BrowserConfig中的配置是如何被Spring Security所加载的。

首先找到调用BrowserConfig的configure()的地方，在其父类WebSecurityConfigurerAdapter的getHttp()中：

往上一步找到调用getHttp()的地方，在同个类的init()中：

往上一步找到调用init()的地方，在AbstractConfiguredSecurityBuilder的init()中：

在init()被调用时，它首先会遍历getConfigurers()返回的集合中的元素，调用其init()，点击getConfigurers()查看，发现其读取的是configurers属性的值，那么configurers是什么时候被赋值的呢？我们在同个类的add()中找到configurers被赋值的代码：

往上一步找到调用add()的地方，在同个类的apply()中：

往上一步找到调用apply()的地方，在WebSecurityConfiguration的setFilterChainProxySecurityConfigurer()中：

我们可以看到，在setFilterChainProxySecurityConfigurer()中，首先会实例化一个WebSecurity（AbstractConfiguredSecurityBuilder的实现类）的实例，遍历参数webSecurityConfigurers，将存储在其中的元素作为参数传递给WebSecurity的apply()，那么webSecurityConfigurers是什么时候被赋值的呢？我们根据@Value中的信息找到webSecurityConfigurers被赋值的地方，在AutowiredWebSecurityConfigurersIgnoreParents的getWebSecurityConfigurers()中：

我们重点看第二句代码，可以看到这里会提取存储在bean工厂中类型为WebSecurityConfigurer.class的bean，而BrowserConfig正是WebSecurityConfigurerAdapter的实现类。

解决完configurers的赋值问题，我们回到AbstractConfiguredSecurityBuilder的init()处，找到调用该方法的地方，在同个类的doBuild()中：

往上一步找到调用doBuild()的地方，在AbstractSecurityBuilder的build()中：

往上一步找到调用doBuild()的地方，在WebSecurityConfiguration的springSecurityFilterChain()中：

至此，我们分析完了BrowserConfig被Spring Security加载的过程。现在我们再来看看当我们自定义的配置被加载完后，http各属性的变化，在BrowserConfig的configure()末尾打上断点，当程序走到断点处时，查看http属性：

我们配置的.loginPage("/login.html")和.loginProcessingUrl("/login")在FormLoginConfigurer中：

配置的.antMatchers("/login.html", "/css/", "/error").permitAll()在ExpressionUrlAuthorizationConfigurer中：

这样，当我们访问除"/login.html", "/css/", "/error"以外的路径时，在AbstractSecurityInterceptor（FilterSecurityInterceptor的父类）的attemptAuthorization()中会抛出AccessDeniedException异常（最终由AuthenticationTrustResolverImpl的isAnonymous()进行判断）

当我们访问"/login.html", "/css/", "/error"这几个路径时，在AbstractSecurityInterceptor（FilterSecurityInterceptor的父类）的attemptAuthorization()中正常执行（最终由SecurityExpressionRoot的permitAll()进行判断）

login.html路径解析

当我们请求的资源需要经过认证时，Spring Security会将请求重定向到我们自定义的登录页，那么Spring又是如何找到我们自定义的登录页的呢？下面就让我们来解析一下：

我们首先来到DispatcherServlet中，DispatcherServlet是Spring Web处理请求的入口。当Spring Web项目启动后，第一次接收到请求时，会调用其initStrategies()进行初始化：

我们重点关注initHandlerMappings(context);这句，initHandlerMappings()用于初始化处理器映射器（处理器映射器可以根据请求找到对应的资源），我们来到initHandlerMappings()中：

可以看到，当程序走到initHandlerMappings()中时，会从bean工厂中找出HandlerMapping.class类型的bean，将其存储到handlerMappings属性中。这里看到一共找到5个，分别是：requestMappingHandlerMapping（将请求与标注了@RequestMapping的方法进行关联）、weclomePageHandlerMapping（将请求与主页进行关联）、beanNameHandlerMapping（将请求与同名的bean进行关联）、routerFunctionMapping（将请求与RouterFunction进行关联）、resourceHandlerMapping（将请求与静态资源进行关联），这5个bean是在WebMvcAutoConfiguration$EnableWebMvcConfiguration中配置的：

requestMappingHandlerMapping:

weclomePageHandlerMapping:

beanNameHandlerMapping、routerFunctionMapping、resourceHandlerMapping在EnableWebMvcConfiguration的父类（WebMvcConfigurationSupport）中配置：

beanNameHandlerMapping:

routerFunctionMapping:

resourceHandlerMapping:

我们将目光锁定在resourceHandlerMapping上，当resourceHandlerMapping被初始化时，会调用addResourceHandlers()为registry添加资源处理器，我们找到实际被调用的addResourceHandlers()，在DelegatingWebMvcConfiguration中：

可以看到这里实际调用的是configurers属性的addResourceHandlers()，而configurers是一个final类型的成员变量，其值是WebMvcConfigurerComposite的实例，我们来到WebMvcConfigurerComposite中：

可以看到这里实际调用的是delegates属性的addResourceHandlers()，delegates是一个final类型的集合，集合的元素由addWebMvcConfigurers()负责添加：

我们找到调用addWebMvcConfigurers()的地方，在DelegatingWebMvcConfiguration的setConfigurers()中：

可以看到当setConfigurers()被初始化时，Spring会往参数configurers中传入两个值，我们关注第一个值，是一个WebMvcAutoConfiguration$WebMvcAutoConfigurationAdapter的实例，注意它的属性resourceProperties，是一个WebProperties$Resources的实例，默认情况下，在实例化WebMvcAutoConfigurationAdapter时，由传入参数webProperties进行赋值：webProperties.getResources()：

我们进入参数webProperties的类中，可以看到getResources()是直接实例化了一个Resources，其属性staticLocations是一个含有4个值的final类型的字符串数组，这4个值正是Spring寻找静态文件的地方：

我们回到WebMvcAutoConfiguration的addResourceHandlers()中：

在addResourceHandlers()中，会为registry添加两个资源处理器，当请求路径是“/webjars/”时，会在”classpath:/META-INF/resources/webjars/“路径下寻找对应的资源，当请求路径是“/**”时，会在”classpath:/META-INF/resources/“、”classpath:/resources/“、”classpath:/static/“、”classpath:/public/“路径下寻找对应的资源。

现在我们通过访问http://localhost:8080/login.html来验证这个过程。

请求首先来到DispatcherServlet的doDispatch()中，由于是对静态资源的请求，当程序走到mappedHandler = getHandler(processedRequest);时，通过getHandler()返回SimpleUrlHandlerMapping（即resourceHandlerMapping的类型）的HandlerExecutionChain：

然后由实际的处理器进行处理：

程序一路调试，来到ResourceHttpRequestHandler的handleRequest()中，通过调用Resource resource = getResource(request);找到请求对应的资源：

而在getResource()中，实际是将请求路径（即login.html）与前面配置的路径进行拼接（组合成/resources/login.html这样的路径），再通过类加载器来寻找资源。

后面源码深入过深，就不一一展开了，只截取其中比较重要的几段代码：

PathResourceResolver中：

ClassPathResource中：

ClassLoader中：

URLClassLoader中：

最终，类加载器会在如上两个路径下找到登录页并返回。

UserDetailService配置解析

我们定义的用户信息的获取逻辑是如何被Spring Security应用的呢？让我们通过阅读源码来了解一下。

还记得前面我们讲BrowserConfig配置被加载的过程吗？UserDetailService也是在这个过程中被一起加载完成的，回到BrowserConfig配置解析的第一幅图中，如下：

在断点处位置，authenticationManager()会返回一个AuthenticationManager实例，我们进入authenticationManager()中:

在authenticationManager()中，AuthenticationManager转由AuthenticationConfiguration中获取，我们进入getAuthenticationManager()中：

程序来到AuthenticationConfiguration的getAuthenticationManager()中，AuthenticationManager转由AuthenticationManagerBuilder中获取，我们进入build()中：

程序来到AbstractConfiguredSecurityBuilder的doBuild()中，这里在构建AuthenticationManager实例时，需要初始化3个配置类，我们重点关注第3个配置类：org.springframework.security.config.annotation.authentication.configuration.InitializeUserDetailsBeanManagerConfigurer，这个配置类是在AuthenticationConfiguration中引入的：

我们来到InitializeUserDetailsBeanManagerConfigurer的init()中：

这里会新建一个InitializeUserDetailsManagerConfigurer实例添加到AuthenticationManagerBuilder中。我们回到doBuild()中：

可以看到配置类变成了5个，其中就有刚刚新建的InitializeUserDetailsManagerConfigurer，程序接下来会调用各个配置类的configure()进行配置，我们来到InitializeUserDetailsManagerConfigurer的configure()中：

可以看到在configure()中，就会去bean工厂中寻找UserDetailsService类型的bean，若是我们没有自定义UserDetailsService的实现类的话，Spring Security默认会生成一个InMemoryUserDetailsManager的实例：

InMemoryUserDetailsManager是在UserDetailsServiceAutoConfiguration类中配置的：

解决完UserDetailsService的加载问题，现在我们来看看Spring Security是如何通过UserDetailsService获取用户信息的。

通过Spring Boot中开启Spring Security一节的学习我们知道，登录判断的逻辑是在UsernamePasswordAuthenticationFilter中进行的，因此我们在UsernamePasswordAuthenticationFilter的attemptAuthenticatio()中打上断点，然后启动项目，访问登录页，输入用户名和密码点击登录后，程序来到UsernamePasswordAuthenticationFilter中：