前言

《Spring Microservices in Action》
《Spring Cloud Alibaba 微服務(wù)原理與實(shí)戰(zhàn)》
《B站 尚硅谷 SpringCloud 框架開發(fā)教程 周陽》

JWT 為 OAuth2 令牌提供規(guī)范標(biāo)準(zhǔn)站宗，并且可以自定義 JWT 令牌阵具；

1. JWT 令牌存儲(chǔ)基礎(chǔ)知識

1.1 JSON Web Token

• OAuth2 是一個(gè)基于令牌的驗(yàn)證框架萍悴，但它并沒有為如何定義其規(guī)范中的令牌提供任何標(biāo)準(zhǔn)哮塞；
• 由此出現(xiàn)了 JSON Web Token ( JWT ）新標(biāo)準(zhǔn)；
• JWT 是因特網(wǎng)工程任務(wù)組（ Internet Engineering Task Force, IETF ）提出的開放標(biāo)準(zhǔn)（RFC-7519 ）趟径，旨在為 0Auth2令牌提供標(biāo)準(zhǔn)結(jié)構(gòu)
  • JWT 令牌的特點(diǎn)：小巧堕仔、密碼簽名、自包含早敬、可擴(kuò)展忌傻；
• Spring Cloud Security 為 JWT 提供了開箱即用的支持；

2. 構(gòu)建使用 JWT 令牌存儲(chǔ)的 OAuth2 服務(wù)器

2.1 引入 pom.xml 依賴文件

<!-- JWT OAuth2 庫 -->
<dependency> 
  <groupid>org.springframework.security</groupid> 
  <artifactid>spring-security-jwt</artifactid> 
</dependency>

<!--security 通用安全庫-->
<dependency> 
  <groupid>org.springframework.cloud</groupid> 
  <artifactid>spring-cloud-security</artifactid> 
</dependency> 
<!--oauth2.0-->
<dependency>
  <groupId>org.springframework.security.oauth</groupId>
  <artifactId>spring-security-oauth2</artifactId>
</dependency>

2.2 創(chuàng)建 JWT 令牌存儲(chǔ)

在 security 包或 config 包下搞监；

@Configration
public class JWTTokenStoreConfig{
    @Autowired
    private ServiceConfig serviceConfig;

    @Bean
    public TokenStore tokenStore(){
        return new JwtTokenStore(jwtAccessTokenConverter());
    }
 
    //用于從出示給服務(wù)的令牌中讀取數(shù)據(jù)
    @Bean
    @Primary  //用于告訴 Spring芯勘，如果有多個(gè)特定類型的 bean（本例中為 DefaultTokenService），那么使用 @Primary 標(biāo)注的 Bean 類型自動(dòng)注入
    public DefaultTikenServices tokenServices(){
        DefaultTokenServices defaultTokenServices = new DefaultTokenServices();
        defaultTokenServices.setTokenStore(tokenStore());
        defaultTokenServices.setSupportRefreshToken(true);
        return defaultTokenServices;
    }
    
    @Bean
    public JwtAccessTokenConverter jwtAccessTokenConverter(){
        //在 JWT 和 OAuth2 服務(wù)器之間充當(dāng)翻譯 
        JwtAccessTokenConverter conver = new JwtAccessTokenConverter();
        //定義將用于簽署令牌的簽名密鑰
        conver.setSigningKey(serviceConfig.getJwtSigningKey());
    } 

    @Bean
    public TokenEnhancer jwtTokenEnhancer(){
        return new JWTTokenEnhancer();
    }

}

• 該類用于定義 Spring 將如何管理 JWT 令牌的創(chuàng)建腺逛、簽名和翻譯；

2.3 將 JWT 掛載到驗(yàn)證服務(wù)中

@Configuration
public class JWTOAuth2Config extends AuthorizationServerConfigurerAdapter {

    @Autowired
    private AuthenticationManager authenticationManager;
    @Autowired
    private UserDetailsService userDetailsService;
    @Autowired
    private TokenStore tokenStore;
    @Autowired
    private DefaultTokenServices tokenServices;
    @Autowired
    private JwtAccessTokenConverter jwtAccessTokenConverter;
    @Autowired
    private TokenEnhancer jwtTokenEnhancer;

    @Override
    public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
        TokenEnhancerChain tokenEnhancerChain = new TokenEnhancerChain();
        tokenEnhancerChain.setTokenEnhancers(Arrays.asList(jwtTokenEnhancer, jwtAccessTokenConverter));

        endpoints.tokenStore(tokenStore)                             //JWT衡怀，5.2中定義的命令存儲(chǔ)將在這里注入
                .accessTokenConverter(jwtAccessTokenConverter)       //JWT棍矛，鉤子，用于告訴 Spring Security OAuth2 代碼使用 JWT
                .tokenEnhancer(tokenEnhancerChain)                   //JWT
                .authenticationManager(authenticationManager)
                .userDetailsService(userDetailsService);
    }

    @Override
    public void configure(ClientDetailsServiceConfigurer clients) throws Exception {

        clients.inMemory()
                .withClient("eagleeye")
                .secret("thisissecret")
                .authorizedGrantTypes("refresh_token", "password", "client_credentials")
                .scopes("webclient", "mobileclient");
    }
}

3. 在受保護(hù)服務(wù)中使用 JWT

3.1 引入 pom.xml 依賴文件

• 同 OAuth2 服務(wù)器依賴抛杨；

<!-- JWT OAuth2 庫 -->
<dependency> 
    <groupid>org.springframework.security</groupid> 
    <artifactid>spring-security-jwt</artifactid> 
</dependency>

<!--security 通用安全庫-->
<dependency> 
    <groupid>org.springframework.cloud</groupid> 
    <artifactid>spring-cloud-security</artifactid> 
</dependency> 
<!--oauth2.0-->
<dependency>
    <groupId>org.springframework.security.oauth</groupId>
    <artifactId>spring-security-oauth2</artifactId>
</dependency>

3.2 在受保護(hù)服務(wù)中創(chuàng)建 JWTTokenStoreConfig 類

• 同本篇《5.2 創(chuàng)建 JWT 令牌存儲(chǔ)》够委；

@Configuration
public class JWTTokenStoreConfig {

    @Autowired
    private ServiceConfig serviceConfig;
    //JWT
    @Bean
    public TokenStore tokenStore() {
        return new JwtTokenStore(jwtAccessTokenConverter());
    }

    //JWT
    @Bean
    @Primary
    public DefaultTokenServices tokenServices() {
        DefaultTokenServices defaultTokenServices = new DefaultTokenServices();
        defaultTokenServices.setTokenStore(tokenStore());
        defaultTokenServices.setSupportRefreshToken(true);
        return defaultTokenServices;
    }

    //JWT
    @Bean
    public JwtAccessTokenConverter jwtAccessTokenConverter() {
        JwtAccessTokenConverter converter = new JwtAccessTokenConverter();
        converter.setSigningKey(serviceConfig.getJwtSigningKey());
        return converter;
    }

}

3.3 創(chuàng)建自定義的 RestTemplate 類以注入 JWT 令牌

可以在主程序類里，也可以在主程序類所在包及其子包里怖现；

@Primary
@Bean
public RestTemplate getCustomRestTemplate() {
    RestTemplate template = new RestTemplate();
    List interceptors = template.getInterceptors();
    if (interceptors == null) {
        //UserContextInterceptor 會(huì)將 Authorization 首部注入每個(gè) REST 調(diào)用
        template.setInterceptors(Collections.singletonList(new UserContextInterceptor()));
    } else {
        interceptors.add(new UserContextInterceptor());
        template.setInterceptors(interceptors);
    }
    return template;
}

3.4 UserContextInterceptor 將注入 JWT 令牌到 REST 調(diào)用

public class UserContextInterceptor implements ClientHttpRequestInterceptor {
    @Override
    public ClientHttpResponse intercept(
            HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
            throws IOException {

        HttpHeaders headers = request.getHeaders();
        headers.add(UserContext.CORRELATION_ID, UserContextHolder.getContext().getCorrelationId());
        //將授權(quán)令牌添加到 HTTP 首部
        headers.add(UserContext.AUTH_TOKEN, UserContextHolder.getContext().getAuthToken());

        return execution.execute(request, body);
    }
}

3.5 擴(kuò)展 JWT 令牌（也叫自定義茁帽、增強(qiáng)）

• 通過向被保護(hù)服務(wù)添加一個(gè) Spring OAuth2 令牌增強(qiáng)類，擴(kuò)展 JWT 令牌屈嗤；

//需要擴(kuò)展 TokenEnhancer 類
public class JWTTokenEnhancer implements TokenEnhancer {
    @Autowired
    private OrgUserRepository orgUserRepo;

    //基于用戶名查找用戶的組織 ID
    private String getOrgId(String userName){
        UserOrganization orgUser = orgUserRepo.findByUserName( userName );
        return orgUser.getOrganizationId();
    }

    //進(jìn)行這種增強(qiáng)潘拨，需要覆蓋 enhance() 方法
    @Override
    public OAuth2AccessToken enhance(OAuth2AccessToken accessToken, OAuth2Authentication authentication) {
        Map<String, Object> additionalInfo = new HashMap<>();
        String orgId =  getOrgId(authentication.getName());

        additionalInfo.put("organizationId", orgId);
        //所有附加屬性放在 HashMap 中，并設(shè)置在傳入該方法的 accessToken 變量上
        ((DefaultOAuth2AccessToken) accessToken).setAdditionalInformation(additionalInfo);
        return accessToken;
    }
}

3.6 告訴被保護(hù)服務(wù)使用 JWTTokenEnhancer 類

• 首先需要公開 TokenEnhancer 類饶号；

@Bean
public TokenEnhancer jwtTokenEnhancer() {
    return new JWTTokenEnhancer();
}

• 將 TokenEnhancer 類掛鉤在驗(yàn)證服務(wù)中铁追。類似《2.3 將 JWT 掛載到驗(yàn)證服務(wù)中》；

@Configuration
public class JWTOAuth2Config extends AuthorizationServerConfigurerAdapter {

    @Autowired
    private AuthenticationManager authenticationManager;
    @Autowired
    private UserDetailsService userDetailsService;
    @Autowired
    private TokenStore tokenStore;
    @Autowired
    private DefaultTokenServices tokenServices;
    @Autowired
    private JwtAccessTokenConverter jwtAccessTokenConverter;
    //自動(dòng)裝配 TokenEnhancer 類
    @Autowired
    private TokenEnhancer jwtTokenEnhancer;

    @Override
    public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
        //允許開發(fā)人員掛鉤多個(gè)令牌增強(qiáng)器
        TokenEnhancerChain tokenEnhancerChain = new TokenEnhancerChain();
        tokenEnhancerChain.setTokenEnhancers(Arrays.asList(jwtTokenEnhancer, jwtAccessTokenConverter));

        endpoints.tokenStore(tokenStore)                             //JWT
                .accessTokenConverter(jwtAccessTokenConverter)       //JWT
                .tokenEnhancer(tokenEnhancerChain)                   //JWT茫船，將令牌增強(qiáng)器鏈掛鉤到傳入 configure() 方法的 endpoints 參數(shù)
                .authenticationManager(authenticationManager)
                .userDetailsService(userDetailsService);
    }

    @Override
    public void configure(ClientDetailsServiceConfigurer clients) throws Exception {
        clients.inMemory()
                .withClient("eagleeye")
                .secret("thisissecret")
                .authorizedGrantTypes("refresh_token", "password", "client_credentials")
                .scopes("webclient", "mobileclient");
    }
}

3.7 使用 JJWT 庫在 Zuul 網(wǎng)關(guān)里解析 JWT 令牌中解析自定義字段

以下配置均在在 Zuul 網(wǎng)關(guān)服務(wù)里進(jìn)行琅束；

3.7.1 在 Zuul 網(wǎng)關(guān)里添加 pom.xml 依賴文件

<dependency>
  <groupId>io.jsonwebtoken</groupId>
  <artifactId>jjwt</artifactId>
  <version>0.7.0</version>
</dependency>

3.7.2 添加一個(gè)新方法，用來解析 serviceId

private String getOrganizationId(){
    String result="";
    if (filterUtils.getAuthToken()!=null){
        //從 HTTP 首部 Authorization 解析出令牌
        String authToken = filterUtils.getAuthToken().replace("Bearer ","");
        try {
            //傳入用于簽署令牌的簽名密鑰算谈，使用 JWTS 類解析令牌
            Claims claims = Jwts.parser()
                    .setSigningKey(serviceConfig.getJwtSigningKey().getBytes("UTF-8"))
                    .parseClaimsJws(authToken).getBody();
            //從令牌中提取 xxxId
            result = (String) claims.get("organizationId");
        }
        catch (Exception e){
            e.printStackTrace();
        }
    }
    return result;
}

最后