Spring Boot 2.0 利用 Spring Security 实现简单的OAuth2.0认证方式1

OAuth2.0是一种常用的认证授权机制，Spring Security是Spring框架中的安全模块，可以实现OAuth2.0认证。本文将介绍如何利用Spring Boot 2.0和Spring Security实现简单的OAuth2.0认证方式1。

1. 添加依赖

在项目的pom.xml文件中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.security.oauth</groupId>
    <artifactId>spring-security-oauth2</artifactId>
    <version>2.3.7.RELEASE</version>
</dependency>

其中，spring-boot-starter-security是Spring Boot中包含Spring Security的依赖，spring-security-oauth2是Spring Security中实现OAuth2.0的依赖。

2. 配置Spring Security

在Spring Boot应用中，可以通过application.properties或application.yml文件来配置Spring Security。在本文中，我们将使用application.yml文件来配置Spring Security。

spring:
  security:
    oauth2:
      client:
        registration:
          custom-client:
            client-id: custom-client-id
            client-secret: custom-client-secret
            authorization-grant-type: authorization_code
            redirect-uri: '{baseUrl}/login/oauth2/code/{registrationId}'
            scope:
              - read
              - write
        provider:
          custom-provider:
            authorization-uri: https://custom-provider.com/oauth2/auth
            token-uri: https://custom-provider.com/oauth2/token
            user-info-uri: https://custom-provider.com/userinfo
            user-name-attribute: sub

其中，我们定义了一个名为custom-client的OAuth2.0客户端，它的客户端ID和客户端密钥分别为custom-client-id和custom-client-secret，授权方式为authorization_code，重定向URI为{baseUrl}/login/oauth2/code/{registrationId}，授权范围为read和write。

同时，我们定义了一个名为custom-provider的OAuth2.0提供者，它的授权URI、令牌URI、用户信息URI和用户名属性分别为https://custom-provider.com/oauth2/auth、https://custom-provider.com/oauth2/token、https://custom-provider.com/userinfo和sub。

3. 配置OAuth2.0登录

在Spring Security中，可以通过配置HttpSecurity对象来定义登录、授权等行为。在本文中，我们将使用configure方法来配置HttpSecurity对象。

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
 
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/", "/home").permitAll()
                .anyRequest().authenticated()
                .and()
            .oauth2Login()
                .loginPage("/login")
                .defaultSuccessURL("/dashboard")
                .and()
            .logout()
                .logoutSuccessUrl("/")
                .permitAll();
    }
 
}

其中，我们使用了authorizeRequests方法来设置授权规则，任何请求都需要进行认证，除了根路径和home路径。我们还使用了oauth2Login方法来设置OAuth2.0登录的相关配置，包括登录页面、默认成功URL等。最后，我们使用了logout方法来设置登出的相关配置，包括成功URL等。

4. 配置用户信息

在OAuth2.0认证中，用户信息通常由OAuth2.0提供者来维护。在Spring Security中，可以通过实现UserInfoRestTemplateFactory接口来获取用户信息。

@Configuration
public class OAuth2Config {
 
    @Bean
    public OAuth2UserService<OAuth2UserRequest, OAuth2User> oAuth2UserService() {
        return new DefaultOAuth2UserService();
    }
 
    @Bean
    public UserInfoRestTemplateFactory userInfoRestTemplateFactory() {
        return new CustomUserInfoRestTemplateFactory();
    }
 
}

其中，我们使用了DefaultOAuth2UserService来获取用户信息，同时使用了CustomUserInfoRestTemplateFactory来创建RestTemplate对象。

5. 编写测试

最后，我们可以编写一个简单的测试来验证OAuth2.0认证是否生效。

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@AutoConfigureMockMvc
public class OAuth2Test {
 
    @Autowired
    private MockMvc mockMvc;
 
    @Test
    public void testOAuth2Login() throws Exception {
        mockMvc.perform(get("/login"))
            .andExpect(status().isOk())
            .andExpect(content().string(containsString("Login with custom-provider")))
            .andReturn();
    }
 
}

在测试中，我们使用MockMvc对象模拟访问/login路径，期望返回200状态码，并且页面内容中包含“Login with custom-provider”的字符串。

至此，我们已经成功地利用Spring Boot 2.0和Spring Security实现了简单的OAuth2.0认证方式1。