經過我翻來覆去的思想斗爭了一個月,最后做出了一個明智的決定
最近寫了幾個Spring Boot組件,項目用什么功能就引入對應的依賴,配置配置就能使用,香的很!那么Spring Security能不能也弄成模塊化,簡單配置一下就可以用上呢?JWT得有,RBAC動態權限更得有!花了小半天就寫了個組件,用了一個月感覺還不錯。是我一個人爽?還是放出來讓大家一起爽?經過我翻來覆去的思想斗爭了一個月,最后做出了一個明智的決定,放出來讓想直接上手的同學直接使用。源碼地址就在下面:
https://gitee.com/felord/security-enhance-spring-boot
用法
集成
這就是一個Spring Boot Starter,你自己打包、安裝。然后引用到項目:
- <dependency>
- <groupId>cn.felord.security</groupId>
- <artifactId>security-enhance-spring-boot-starter</artifactId>
- <version>${version}</version>
- </dependency>
另外你需要集成Spring Cache,比如Redis Cache:
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-cache</artifactId>
- </dependency>
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-data-redis</artifactId>
- </dependency>
- <dependency>
- <groupId>org.apache.commons</groupId>
- <artifactId>commons-pool2</artifactId>
- </dependency>
JWT會被緩存到以usrTkn為key的緩存中,如果你想定制的話,自行實現一個JwtTokenStorage并注入Spring IoC就可以覆蓋下面的配置了:
- @Bean
- @ConditionalOnMissingBean
- public JwtTokenStorage jwtTokenStorage() {
- return new SpringCacheJwtTokenStorage();
- }
你應該去了解如何自定義Spring Cache的過期時間。
數據庫表設計
然后是數據庫表設計,這里簡單點弄個RBAC的設計,僅供參考,你可以根據你們的業務改良。
用戶表:
user_id | username | password |
---|---|---|
1312434534 | felord | {noop}12345 |
角色表:
role_id | role_name | role_code |
---|---|---|
12343667867 | 管理員 | ADMIN |
用戶角色關聯表:
user_role_id | user_id | role_id |
---|---|---|
12354657777 | 1312434534 | 12343667867 |
一個用戶可以持有多個角色,一個角色在一個用戶持有的角色集合中是唯一的。
資源表:
resources_id | resources_name | resource_pattern | method |
---|---|---|---|
12543667867 | 根據ID獲取商品 | /goods/{goodsId} | GET |
資源其實就是我們寫的Spring MVC接口,這里支持ANT風格,但是盡量具體,為了靈活性考慮不推薦使用通配符。
角色資源表:
role_res_id | role_id | resources_id |
---|---|---|
4545466445 | 12343667867 | 12543667867 |
一個資源可以關聯多個角色,一個角色不能重復持有一個資源。
實現UserDetailsService
實現用戶加載服務接口UserDetailsService是Spring Security開發的必要步驟,跟我以前的教程差不多。
- @Override
- public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
- UserInfo userInfo = this.lambdaQuery()
- .eq(UserInfo::getUsername, username).one();
- if (Objects.isNull(userInfo)) {
- throw new UsernameNotFoundException("用戶:" + username + " 不存在");
- }
- String userId = userInfo.getUserId();
- boolean enabled = userInfo.getEnabled();
- Set<String> roles = iUserRoleService.getRolesByUserId(userId);
- roles.add(“"ANONYMOUS"”);
- Set<GrantedAuthority> roleSet = roles.stream()
- .map(role -> new SimpleGrantedAuthority("ROLE_" + role))
- .collect(Collectors.toSet());
- return new SecureUser(userId,
- username,
- userInfo.getSecret(),
- enabled,
- enabled,
- enabled,
- enabled,
- roleSet);
- }
這里要說一下里面為啥要內置一個ANONYMOUS角色給用戶。如果希望特定的資源對用戶全量開放,可配置對應的權限角色編碼為ANONYMOUS。當某個資源的角色編碼為ANONYMOUS時,即使不攜帶Token也可以訪問。一般情況下匿名能訪問的資源不匿名一定能訪問,當然你如果不希望這樣的規則存在干掉就是了。
查詢用戶的權限集
實現用戶角色權限方法Function
配置
最后就是配置了,跟我以前教程中的配置幾乎一樣,application.yaml的配置為:
- # jwt 配置
- jwt:
- cert-info:
- # keytool 密鑰的 alias
- alias: felord
- # 密匙密碼
- key-password: i6x123akg15v13
- # 路徑 這里是在resources 包下
- cert-location: jwt.jks
- claims:
- # jwt iss 字段值
- issuer: https://felord.cn
- # sub 字段
- subject: all
- # 過期秒數
- expires-at: 604800
最后別忘記弄個配置類并標記@EnableSpringSecurity以啟用配置:
- @EnableSpringSecurity
- @Configuration(proxyBeanMethods = false)
- public class SecurityConfiguration {
- /**
- * Function function.
- *
- * @param resourcesService the resources service
- * @return the function
- */
- @Bean
- Function<Set<String>, Set<AntPathRequestMatcher>> function(IResourcesService resourcesService){
- return resourcesService::matchers;
- }
- @Bean
- UserDetailsService userDetailsService(IUserInfoService userInfoService){
- return userInfoService::loadUserByUsername;
- }
- }
記得使用@EnableCaching開啟并配置緩存。
使用
登錄接口
- POST /login?username=felord&password=12345 HTTP/1.1
- Host: localhost:8080
然后會返回一對JWT,返回包含兩個token主體
- accessToken 用來日常進行請求鑒權,有過期時間。
- refreshToken 當accessToken過期失效時,用來刷新accessToken。
結構為:
- {
- "accessToken": {
- "tokenValue": "",
- "issuedAt": {
- "epochSecond": 1616827822,
- "nano": 393000000
- },
- "expiresAt": {
- "epochSecond": 1616831422,
- "nano": 393000000
- },
- "tokenType": {
- "value": "Bearer"
- },
- "scopes": [
- "ROLE_ADMIN",
- "ROLE_ANONYMOUS"
- ]
- },
- "refreshToken": {
- "tokenValue": "",
- "issuedAt": {
- "epochSecond": 1616827822,
- "nano": 393000000
- },
- "expiresAt": null
- },
- "additionalParameters": {}
- }
調用根據ID獲取商品接口時加入Token:
- GET /goods/234355451 HTTP/1.1
- Host: localhost:8080
- Authorization: Bearer eyJraWQImFsZyI6IlJTMjU2In0.eyJzdWIiOiJ1NzgsImlhdCI6MTYxNjkxODk3OCwianRpIjoiNThlOTQktNGVlYzc3MDU0ZDk3In0.ZQcN0FX7_taohqPiC1KnoF7
本文轉載自微信公眾號「碼農小胖哥」,可以通過以下二維碼關注。轉載本文請聯系碼農小胖哥公眾號。