前不久Spring Boot 2.7.0 剛剛發(fā)布统求,Spring Security 也升級到了5.7.1 检碗。升級后發(fā)現(xiàn)据块,原來一直在用的Spring Security配置方法,居然已經(jīng)被棄用了折剃。不禁感慨技術(shù)更新真快另假,用著用著就被棄用了!今天帶大家體驗下Spring Security的最新用法怕犁,看看是不是夠優(yōu)雅边篮!
SpringBoot實(shí)戰(zhàn)電商項目mall(50k+star)地址:github.com/macrozheng/…
基本使用
我們先對比下Spring Security提供的基本功能登錄認(rèn)證,來看看新版用法是不是更好因苹。
升級版本
首先修改項目的pom.xml
文件苟耻,把Spring Boot版本升級至2.7.0
版本。
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.0</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
舊用法
在Spring Boot 2.7.0 之前的版本中扶檐,我們需要寫個配置類繼承WebSecurityConfigurerAdapter
凶杖,然后重寫Adapter中的三個方法進(jìn)行配置;
/**
* SpringSecurity的配置
* Created by macro on 2018/4/26.
*/
@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class OldSecurityConfig extends WebSecurityConfigurerAdapter {
@Autowired
private UmsAdminService adminService;
@Override
protected void configure(HttpSecurity httpSecurity) throws Exception {
//省略HttpSecurity的配置
}
@Override
protected void configure(AuthenticationManagerBuilder auth) throws Exception {
auth.userDetailsService(userDetailsService())
.passwordEncoder(passwordEncoder());
}
@Bean
@Override
public AuthenticationManager authenticationManagerBean() throws Exception {
return super.authenticationManagerBean();
}
}
如果你在SpringBoot 2.7.0版本中進(jìn)行使用的話款筑,你就會發(fā)現(xiàn)WebSecurityConfigurerAdapter
已經(jīng)被棄用了智蝠,看樣子Spring Security要堅決放棄這種用法了!
新用法
新用法非常簡單奈梳,無需再繼承WebSecurityConfigurerAdapter
杈湾,只需直接聲明配置類,再配置一個生成SecurityFilterChain
Bean的方法攘须,把原來的HttpSecurity配置移動到該方法中即可漆撞。
/**
* SpringSecurity 5.4.x以上新用法配置
* 為避免循環(huán)依賴,僅用于配置HttpSecurity
* Created by macro on 2022/5/19.
*/
@Configuration
public class SecurityConfig {
@Bean
SecurityFilterChain filterChain(HttpSecurity httpSecurity) throws Exception {
//省略HttpSecurity的配置
return httpSecurity.build();
}
}
新用法感覺非常簡潔干脆于宙,避免了繼承WebSecurityConfigurerAdapter
并重寫方法的操作浮驳,強(qiáng)烈建議大家更新一波!
高級使用
升級 Spring Boot 2.7.0版本后捞魁,Spring Security對于配置方法有了大的更改至会,那么其他使用有沒有影響呢?其實(shí)是沒啥影響的谱俭,這里再聊聊如何使用Spring Security實(shí)現(xiàn)動態(tài)權(quán)限控制奉件!
基于方法的動態(tài)權(quán)限
首先來聊聊基于方法的動態(tài)權(quán)限控制,這種方式雖然實(shí)現(xiàn)簡單昆著,但卻有一定的弊端县貌。
- 在配置類上使用
@EnableGlobalMethodSecurity
來開啟它;
/**
* SpringSecurity的配置
* Created by macro on 2018/4/26.
*/
@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class OldSecurityConfig extends WebSecurityConfigurerAdapter {
}
- 然后在方法中使用
@PreAuthorize
配置訪問接口需要的權(quán)限凑懂;
/**
* 商品管理Controller
* Created by macro on 2018/4/26.
*/
@Controller
@Api(tags = "PmsProductController", description = "商品管理")
@RequestMapping("/product")
public class PmsProductController {
@Autowired
private PmsProductService productService;
@ApiOperation("創(chuàng)建商品")
@RequestMapping(value = "/create", method = RequestMethod.POST)
@ResponseBody
@PreAuthorize("hasAuthority('pms:product:create')")
public CommonResult create(@RequestBody PmsProductParam productParam, BindingResult bindingResult) {
int count = productService.create(productParam);
if (count > 0) {
return CommonResult.success(count);
} else {
return CommonResult.failed();
}
}
}
- 再從數(shù)據(jù)庫中查詢出用戶所擁有的權(quán)限值設(shè)置到
UserDetails
對象中去窃这,這種做法雖然實(shí)現(xiàn)方便,但是把權(quán)限值寫死在了方法上,并不是一種優(yōu)雅的做法杭攻。
/**
* UmsAdminService實(shí)現(xiàn)類
* Created by macro on 2018/4/26.
*/
@Service
public class UmsAdminServiceImpl implements UmsAdminService {
@Override
public UserDetails loadUserByUsername(String username){
//獲取用戶信息
UmsAdmin admin = getAdminByUsername(username);
if (admin != null) {
List<UmsPermission> permissionList = getPermissionList(admin.getId());
return new AdminUserDetails(admin,permissionList);
}
throw new UsernameNotFoundException("用戶名或密碼錯誤");
}
}
基于路徑的動態(tài)權(quán)限
其實(shí)每個接口對應(yīng)的路徑都是唯一的祟敛,通過路徑來進(jìn)行接口的權(quán)限控制才是更優(yōu)雅的方式。
- 首先我們需要創(chuàng)建一個動態(tài)權(quán)限的過濾器兆解,這里注意下
doFilter
方法馆铁,用于配置放行OPTIONS
和白名單
請求,它會調(diào)用super.beforeInvocation(fi)
方法锅睛,此方法將調(diào)用AccessDecisionManager
中的decide
方法來進(jìn)行鑒權(quán)操作埠巨;
/**
* 動態(tài)權(quán)限過濾器,用于實(shí)現(xiàn)基于路徑的動態(tài)權(quán)限過濾
* Created by macro on 2020/2/7.
*/
public class DynamicSecurityFilter extends AbstractSecurityInterceptor implements Filter {
@Autowired
private DynamicSecurityMetadataSource dynamicSecurityMetadataSource;
@Autowired
private IgnoreUrlsConfig ignoreUrlsConfig;
@Autowired
public void setMyAccessDecisionManager(DynamicAccessDecisionManager dynamicAccessDecisionManager) {
super.setAccessDecisionManager(dynamicAccessDecisionManager);
}
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
FilterInvocation fi = new FilterInvocation(servletRequest, servletResponse, filterChain);
//OPTIONS請求直接放行
if(request.getMethod().equals(HttpMethod.OPTIONS.toString())){
fi.getChain().doFilter(fi.getRequest(), fi.getResponse());
return;
}
//白名單請求直接放行
PathMatcher pathMatcher = new AntPathMatcher();
for (String path : ignoreUrlsConfig.getUrls()) {
if(pathMatcher.match(path,request.getRequestURI())){
fi.getChain().doFilter(fi.getRequest(), fi.getResponse());
return;
}
}
//此處會調(diào)用AccessDecisionManager中的decide方法進(jìn)行鑒權(quán)操作
InterceptorStatusToken token = super.beforeInvocation(fi);
try {
fi.getChain().doFilter(fi.getRequest(), fi.getResponse());
} finally {
super.afterInvocation(token, null);
}
}
@Override
public void destroy() {
}
@Override
public Class<?> getSecureObjectClass() {
return FilterInvocation.class;
}
@Override
public SecurityMetadataSource obtainSecurityMetadataSource() {
return dynamicSecurityMetadataSource;
}
}
- 接下來我們就需要創(chuàng)建一個類來繼承
AccessDecisionManager
现拒,通過decide
方法對訪問接口所需權(quán)限和用戶擁有的權(quán)限進(jìn)行匹配辣垒,匹配則放行;
/**
* 動態(tài)權(quán)限決策管理器印蔬,用于判斷用戶是否有訪問權(quán)限
* Created by macro on 2020/2/7.
*/
public class DynamicAccessDecisionManager implements AccessDecisionManager {
@Override
public void decide(Authentication authentication, Object object,
Collection<ConfigAttribute> configAttributes) throws AccessDeniedException, InsufficientAuthenticationException {
// 當(dāng)接口未被配置資源時直接放行
if (CollUtil.isEmpty(configAttributes)) {
return;
}
Iterator<ConfigAttribute> iterator = configAttributes.iterator();
while (iterator.hasNext()) {
ConfigAttribute configAttribute = iterator.next();
//將訪問所需資源或用戶擁有資源進(jìn)行比對
String needAuthority = configAttribute.getAttribute();
for (GrantedAuthority grantedAuthority : authentication.getAuthorities()) {
if (needAuthority.trim().equals(grantedAuthority.getAuthority())) {
return;
}
}
}
throw new AccessDeniedException("抱歉勋桶,您沒有訪問權(quán)限");
}
@Override
public boolean supports(ConfigAttribute configAttribute) {
return true;
}
@Override
public boolean supports(Class<?> aClass) {
return true;
}
}
- 由于上面的
decide
方法中的configAttributes
屬性是從FilterInvocationSecurityMetadataSource
的getAttributes
方法中獲取的,我們還需創(chuàng)建一個類繼承它侥猬,getAttributes
方法可用于獲取訪問當(dāng)前路徑所需權(quán)限值例驹;
/**
* 動態(tài)權(quán)限數(shù)據(jù)源,用于獲取動態(tài)權(quán)限規(guī)則
* Created by macro on 2020/2/7.
*/
public class DynamicSecurityMetadataSource implements FilterInvocationSecurityMetadataSource {
private static Map<String, ConfigAttribute> configAttributeMap = null;
@Autowired
private DynamicSecurityService dynamicSecurityService;
@PostConstruct
public void loadDataSource() {
configAttributeMap = dynamicSecurityService.loadDataSource();
}
public void clearDataSource() {
configAttributeMap.clear();
configAttributeMap = null;
}
@Override
public Collection<ConfigAttribute> getAttributes(Object o) throws IllegalArgumentException {
if (configAttributeMap == null) this.loadDataSource();
List<ConfigAttribute> configAttributes = new ArrayList<>();
//獲取當(dāng)前訪問的路徑
String url = ((FilterInvocation) o).getRequestUrl();
String path = URLUtil.getPath(url);
PathMatcher pathMatcher = new AntPathMatcher();
Iterator<String> iterator = configAttributeMap.keySet().iterator();
//獲取訪問該路徑所需資源
while (iterator.hasNext()) {
String pattern = iterator.next();
if (pathMatcher.match(pattern, path)) {
configAttributes.add(configAttributeMap.get(pattern));
}
}
// 未設(shè)置操作請求權(quán)限退唠,返回空集合
return configAttributes;
}
@Override
public Collection<ConfigAttribute> getAllConfigAttributes() {
return null;
}
@Override
public boolean supports(Class<?> aClass) {
return true;
}
}
- 這里需要注意的是鹃锈,所有路徑對應(yīng)的權(quán)限值數(shù)據(jù)來自于自定義的
DynamicSecurityService
;
/**
* 動態(tài)權(quán)限相關(guān)業(yè)務(wù)類
* Created by macro on 2020/2/7.
*/
public interface DynamicSecurityService {
/**
* 加載資源ANT通配符和資源對應(yīng)MAP
*/
Map<String, ConfigAttribute> loadDataSource();
}
- 一切準(zhǔn)備就緒瞧预,把動態(tài)權(quán)限過濾器添加到
FilterSecurityInterceptor
之前屎债;
/**
* SpringSecurity 5.4.x以上新用法配置
* 為避免循環(huán)依賴,僅用于配置HttpSecurity
* Created by macro on 2022/5/19.
*/
@Configuration
public class SecurityConfig {
@Autowired
private DynamicSecurityService dynamicSecurityService;
@Autowired
private DynamicSecurityFilter dynamicSecurityFilter;
@Bean
SecurityFilterChain filterChain(HttpSecurity httpSecurity) throws Exception {
//省略若干配置...
//有動態(tài)權(quán)限配置時添加動態(tài)權(quán)限校驗過濾器
if(dynamicSecurityService!=null){
registry.and().addFilterBefore(dynamicSecurityFilter, FilterSecurityInterceptor.class);
}
return httpSecurity.build();
}
}
- 如果你看過這篇僅需四步垢油,整合SpringSecurity+JWT實(shí)現(xiàn)登錄認(rèn)證 扔茅! 的話,就知道應(yīng)該要配置這兩個Bean了秸苗,一個負(fù)責(zé)獲取登錄用戶信息,另一個負(fù)責(zé)獲取存儲的動態(tài)權(quán)限規(guī)則运褪,為了適應(yīng)Spring Security的新用法惊楼,我們不再繼承
SecurityConfig
,簡潔了不少秸讹!
/**
* mall-security模塊相關(guān)配置
* 自定義配置檀咙,用于配置如何獲取用戶信息及動態(tài)權(quán)限
* Created by macro on 2022/5/20.
*/
@Configuration
public class MallSecurityConfig {
@Autowired
private UmsAdminService adminService;
@Bean
public UserDetailsService userDetailsService() {
//獲取登錄用戶信息
return username -> {
AdminUserDetails admin = adminService.getAdminByUsername(username);
if (admin != null) {
return admin;
}
throw new UsernameNotFoundException("用戶名或密碼錯誤");
};
}
@Bean
public DynamicSecurityService dynamicSecurityService() {
return new DynamicSecurityService() {
@Override
public Map<String, ConfigAttribute> loadDataSource() {
Map<String, ConfigAttribute> map = new ConcurrentHashMap<>();
List<UmsResource> resourceList = adminService.getResourceList();
for (UmsResource resource : resourceList) {
map.put(resource.getUrl(), new org.springframework.security.access.SecurityConfig(resource.getId() + ":" + resource.getName()));
}
return map;
}
};
}
}
效果測試
- 接下來啟動我們的示例項目
mall-tiny-security
,使用如下賬號密碼登錄璃诀,該賬號只配置了訪問/brand/listAll
的權(quán)限弧可,訪問地址:http://localhost:8088/swagger-ui/
- 然后把返回的token放入到Swagger的認(rèn)證頭中;
- 當(dāng)我們訪問有權(quán)限的接口時可以正常獲取到數(shù)據(jù)劣欢;
- 當(dāng)我們訪問沒有權(quán)限的接口時棕诵,返回沒有訪問權(quán)限的接口提示裁良。
總結(jié)
Spring Security的升級用法確實(shí)夠優(yōu)雅,夠簡單校套,而且對之前用法的兼容性也比較好价脾!個人感覺一個成熟的框架不太會在升級過程中大改用法,即使改了也會對之前的用法做兼容笛匙,所以對于絕大多數(shù)框架來說舊版本會用侨把,新版本照樣會用!