Spring Security学习
Spring Security学习
介绍
Spring Security是Spring家族中的一个安全管理框架。相比于另外一个安全框架Shiro,它提供了更丰富的功能,社区资源也比Shiro丰富。
一般Web应用都需要进行认证和授权。
认证:验证当前访问系统的是不是本系统的用户,并且要确认具体是哪个用户
授权: 经过认证后判断当前用户是否有权限进行某个操作
而认证和授权也是Spring Security作为安全框架的核心功能。
快速入门
准备工作
搭建SpringBoot工程
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.0</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
引入SpringSecurity
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
引入SpringSecurity的依赖后,再访问接口会自动跳转到SpringSecurity的默认登陆界面,默认用户名为user,密码会输出在控制台,必须登陆之后才能对接口进行访问
认证
前后端分离项目的登陆校验流程
token:可以理解为加密的字符串
SpringSecurity完整流程
SpringSecurity的原理其实就是一个过滤器链,内部包含了提供各种功能的过滤器
示例入门案例中的主要过滤器:
示例图中只展示了核心过滤器
UsernamePasswordAuthenticationFilter:负责处理我们在登录页面填写了用户名密码后的登录请求。入门案例的认证工作主要由它负责。
ExceptionTranslationFilter:处理过滤器链中抛出任何AccessDeniedException和AuthenticationException。
FilterSecurityInterceptor:负责权限校验的过滤器。
通过Debug查看SpringSecurity的过滤器:
入门案例认证流程
认证默认流程:
Authentication接口:它的实现类表示访问系统的用户,封装了用户相关信息。
AuthenticationManager接口:定义了认证Authentication的方法。
UserDetailsService接口:加载用户特定数据的核心接口。里面定义了一个根据用户名查询用户信息的方法。
UserDetails接口:提供核心用户信息。通过UserDetailsService根据用户名获取处理的用户信息要封装成UserDetails对象返回。然后将这些信息封装到Authentication对象中。
自定义流程思路:
根据SpringSecurity默认流程我们可以发现一个问题,当用户认证通过之后会响应回一个token被UsernamePasswordAuthenticationFilter拦截,而UsernamePasswordAuthenticationFilter没有办法响应token,因此我们需要自己定义登录接口,用户提交用户名密码到自己定义的Controller中,然后执行Security其他默认流程到UserDetailsService中。
如果数据是存储在非内存中比如数据库中,则需要自己自定义UserDetailsService实现类
校验:
思考:在完成认证之后我们应该如何校验用户呢?
解决:用户登陆完成之后,前端可以拿到token,携带token发送请求,自定义一个基于JWT的过滤器获取token、解析token、获取userId、封装Authentication对象存入SecurityContextHolder,而其他过滤器/资源都可以从SecurityContextHolder中获取当前请求的用户信息。
思考:JWT认证过滤器中获取到userId后怎么获取到完整的用户信息?
1、根据用户ID从数据库中进行查询
但是每登陆一次就要去数据库中进行查询,会增加数据库的压力 不推荐
2、将用户信息存储到redis中
在登入过程中,如果认证通过了,用userID作为key,用户信息作为value存入Redis,这样在前端携带token访问接口时,JWT认证过滤器就会解析token获取到userId然后去Redis中进行查询,从而减轻了数据库的压力
解决方案:
登录:
①自定义登陆接口
调用ProviderManager接口的方法进行认证,如果认证通过则生成jwt
把用户信息存储到Redis
②自定义UserDetailsService
在这个实现类中去查询数据库
校验:
①定义jwt认证过滤器
获取token
解析token获取userId
从Redis中获取用户信息
存入SecurityContextHolder
核心代码实现
准备工作
package com.example.utils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.BoundSetOperations;
import org.springframework.data.redis.core.HashOperations;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ValueOperations;
import org.springframework.stereotype.Component;
import java.util.*;
import java.util.concurrent.TimeUnit;
@SuppressWarnings(value = { "unchecked", "rawtypes" })
@Component
public class RedisCache
{
@Autowired
public RedisTemplate redisTemplate;
/**
* 缓存基本的对象,Integer、String、实体类等
*
* @param key 缓存的键值
* @param value 缓存的值
*/
public <T> void setCacheObject(final String key, final T value)
{
redisTemplate.opsForValue().set(key, value);
}
/**
* 缓存基本的对象,Integer、String、实体类等
*
* @param key 缓存的键值
* @param value 缓存的值
* @param timeout 时间
* @param timeUnit 时间颗粒度
*/
public <T> void setCacheObject(final String key, final T value, final Integer timeout, final TimeUnit timeUnit)
{
redisTemplate.opsForValue().set(key, value, timeout, timeUnit);
}
/**
* 设置有效时间
*
* @param key Redis键
* @param timeout 超时时间
* @return true=设置成功;false=设置失败
*/
public boolean expire(final String key, final long timeout)
{
return expire(key, timeout, TimeUnit.SECONDS);
}
/**
* 设置有效时间
*
* @param key Redis键
* @param timeout 超时时间
* @param unit 时间单位
* @return true=设置成功;false=设置失败
*/
public boolean expire(final String key, final long timeout, final TimeUnit unit)
{
return redisTemplate.expire(key, timeout, unit);
}
/**
* 获得缓存的基本对象。
*
* @param key 缓存键值
* @return 缓存键值对应的数据
*/
public <T> T getCacheObject(final String key)
{
ValueOperations<String, T> operation = redisTemplate.opsForValue();
return operation.get(key);
}
/**
* 删除单个对象
*
* @param key
*/
public boolean deleteObject(final String key)
{
return redisTemplate.delete(key);
}
/**
* 删除集合对象
*
* @param collection 多个对象
* @return
*/
public long deleteObject(final Collection collection)
{
return redisTemplate.delete(collection);
}
/**
* 缓存List数据
*
* @param key 缓存的键值
* @param dataList 待缓存的List数据
* @return 缓存的对象
*/
public <T> long setCacheList(final String key, final List<T> dataList)
{
Long count = redisTemplate.opsForList().rightPushAll(key, dataList);
return count == null ? 0 : count;
}
/**
* 获得缓存的list对象
*
* @param key 缓存的键值
* @return 缓存键值对应的数据
*/
public <T> List<T> getCacheList(final String key)
{
return redisTemplate.opsForList().range(key, 0, -1);
}
/**
* 缓存Set
*
* @param key 缓存键值
* @param dataSet 缓存的数据
* @return 缓存数据的对象
*/
public <T> BoundSetOperations<String, T> setCacheSet(final String key, final Set<T> dataSet)
{
BoundSetOperations<String, T> setOperation = redisTemplate.boundSetOps(key);
Iterator<T> it = dataSet.iterator();
while (it.hasNext())
{
setOperation.add(it.next());
}
return setOperation;
}
/**
* 获得缓存的set
*
* @param key
* @return
*/
public <T> Set<T> getCacheSet(final String key)
{
return redisTemplate.opsForSet().members(key);
}
/**
* 缓存Map
*
* @param key
* @param dataMap
*/
public <T> void setCacheMap(final String key, final Map<String, T> dataMap)
{
if (dataMap != null) {
redisTemplate.opsForHash().putAll(key, dataMap);
}
}
/**
* 获得缓存的Map
*
* @param key
* @return
*/
public <T> Map<String, T> getCacheMap(final String key)
{
return redisTemplate.opsForHash().entries(key);
}
/**
* 往Hash中存入数据
*
* @param key Redis键
* @param hKey Hash键
* @param value 值
*/
public <T> void setCacheMapValue(final String key, final String hKey, final T value)
{
redisTemplate.opsForHash().put(key, hKey, value);
}
/**
* 获取Hash中的数据
*
* @param key Redis键
* @param hKey Hash键
* @return Hash中的对象
*/
public <T> T getCacheMapValue(final String key, final String hKey)
{
HashOperations<String, String, T> opsForHash = redisTemplate.opsForHash();
return opsForHash.get(key, hKey);
}
/**
* 删除Hash中的数据
*
* @param key
* @param hkey
*/
public void delCacheMapValue(final String key, final String hkey)
{
HashOperations hashOperations = redisTemplate.opsForHash();
hashOperations.delete(key, hkey);
}
/**
* 获取多个Hash中的数据
*
* @param key Redis键
* @param hKeys Hash键集合
* @return Hash对象集合
*/
public <T> List<T> getMultiCacheMapValue(final String key, final Collection<Object> hKeys)
{
return redisTemplate.opsForHash().multiGet(key, hKeys);
}
/**
* 获得缓存的基本对象列表
*
* @param pattern 字符串前缀
* @return 对象列表
*/
public Collection<String> keys(final String pattern)
{
return redisTemplate.keys(pattern);
}
}
package com.example.utils;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.JwtBuilder;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;
import java.util.Base64;
import java.util.Date;
import java.util.UUID;
/**
* JWT工具类
*/
public class JwtUtil {
//有效期为
public static final Long JWT_TTL = 60 * 60 *1000L;// 60 * 60 *1000 一个小时
//设置秘钥明文
public static final String JWT_KEY = "nc";
public static String getUUID(){
String token = UUID.randomUUID().toString().replaceAll("-", "");
return token;
}
/**
* 生成jwt
* @param subject token中要存放的数据(json格式)
* @return
*/
public static String createJWT(String subject) {
JwtBuilder builder = getJwtBuilder(subject, null, getUUID());// 设置过期时间
return builder.compact();
}
/**
* 生成jwt
* @param subject token中要存放的数据(json格式)
* @param ttlMillis token超时时间
* @return
*/
public static String createJWT(String subject, Long ttlMillis) {
JwtBuilder builder = getJwtBuilder(subject, ttlMillis, getUUID());// 设置过期时间
return builder.compact();
}
private static JwtBuilder getJwtBuilder(String subject, Long ttlMillis, String uuid) {
SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;
SecretKey secretKey = generalKey();
long nowMillis = System.currentTimeMillis();
Date now = new Date(nowMillis);
if(ttlMillis==null){
ttlMillis=JwtUtil.JWT_TTL;
}
long expMillis = nowMillis + ttlMillis;
Date expDate = new Date(expMillis);
return Jwts.builder()
.setId(uuid) //唯一的ID
.setSubject(subject) // 主题 可以是JSON数据
.setIssuer("nc") // 签发者
.setIssuedAt(now) // 签发时间
.signWith(signatureAlgorithm, secretKey) //使用HS256对称加密算法签名, 第二个参数为秘钥
.setExpiration(expDate);
}
/**
* 创建token
* @param id
* @param subject
* @param ttlMillis
* @return
*/
public static String createJWT(String id, String subject, Long ttlMillis) {
JwtBuilder builder = getJwtBuilder(subject, ttlMillis, id);// 设置过期时间
return builder.compact();
}
/**
* 测试token
* @param args
* @throws Exception
*/
public static void main(String[] args) throws Exception {
String token = "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJhNjA4NDhlZDQ0MzE0MjJhYjlkZDVhMTVlM2Q0ZjAyMCIsInN1YiI6IjEiLCJpc3MiOiJuYyIsImlhdCI6MTY4MzY4MjAyMCwiZXhwIjoxNjgzNjg1NjIwfQ.mAM2P8DmzGdyoGPVTnDWYDnrVyPeqKThes2i-LJYdhk";
Claims claims = parseJWT(token);
String subject = claims.getSubject();
System.out.println(claims);
System.out.println(subject);
}
/**
* 生成加密后的秘钥 secretKey
* @return
*/
public static SecretKey generalKey() {
byte[] encodedKey = Base64.getDecoder().decode(JwtUtil.JWT_KEY);
SecretKey key = new SecretKeySpec(encodedKey, 0, encodedKey.length, "AES");
return key;
}
/**
* 解析
*
* @param jwt
* @return
* @throws Exception
*/
public static Claims parseJWT(String jwt) throws Exception {
SecretKey secretKey = generalKey();
return Jwts.parser()
.setSigningKey(secretKey)
.parseClaimsJws(jwt)
.getBody();
}
}
package com.example.config;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.util.TypeUtils;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.type.TypeFactory;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.SerializationException;
import com.alibaba.fastjson.parser.ParserConfig;
import org.springframework.security.core.authority.SimpleGrantedAuthority;
import org.springframework.util.Assert;
import java.nio.charset.Charset;
/**
* Redis使用FastJson序列化
* 基于FastJson的序列化器,如果使用StringRedisTemplate则不需要写配置类
* @author sg
*/
public class FastJsonRedisSerializer<T> implements RedisSerializer<T>
{
public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
private Class<T> clazz;
static
{
ParserConfig.getGlobalInstance().setAutoTypeSupport(true);
ParserConfig.getGlobalInstance().addAccept("org.springframework.security.core.authority.");
TypeUtils.addMapping("org.springframework.security.core.authority.SimpleGrantedAuthority", SimpleGrantedAuthority.class);
}
public FastJsonRedisSerializer(Class<T> clazz)
{
super();
this.clazz = clazz;
}
@Override
public byte[] serialize(T t) throws SerializationException
{
if (t == null)
{
return new byte[0];
}
return JSON.toJSONString(t, SerializerFeature.WriteClassName).getBytes(DEFAULT_CHARSET);
}
@Override
public T deserialize(byte[] bytes) throws SerializationException
{
if (bytes == null || bytes.length <= 0)
{
return null;
}
String str = new String(bytes, DEFAULT_CHARSET);
return JSON.parseObject(str, clazz);
}
protected JavaType getJavaType(Class<?> clazz)
{
return TypeFactory.defaultInstance().constructType(clazz);
}
}
自定义UserDetailsService实现类
package com.example.config;
import cn.hutool.core.util.ObjectUtil;
import com.baomidou.mybatisplus.core.conditions.update.LambdaUpdateWrapper;
import com.example.domain.SysUser;
import com.example.mapper.SysUserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import java.util.Collection;
/**
* 自定义UserDetailsService实现类
*/
@Component
public class MyUserDetailService implements UserDetailsService {
@Autowired
private SysUserMapper sysUserMapper;
@Override
public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
//查询用户信息
LambdaUpdateWrapper<SysUser> wrapper = new LambdaUpdateWrapper<>();
wrapper.eq(SysUser::getUserName,username);
SysUser sysUser = sysUserMapper.selectOne(wrapper);
if (ObjectUtil.isNull(sysUser)) {
throw new RuntimeException("用户名或密码不正确");
}
//todo 查询对应的权限信息
// 把当前登陆用户封装成userDetails返回
return new MyUserDetails(sysUser);
}
}
因为UserDetailsService方法的返回值是UserDetails类型,所以需要定义一个类,实现该接口,把用户信息封装在其中。
package com.example.config;
import com.example.domain.SysUser;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.userdetails.UserDetails;
import java.util.Collection;
/**
* 自定义UserDetails实现类
*/
public class MyUserDetails implements UserDetails {
private SysUser sysUser;
/**
* @return 返回权限信息
*/
@Override
public Collection<? extends GrantedAuthority> getAuthorities() {
return null;
}
/**
* SpringSecurity内部去调用MyUserDetails的getPassword方法获取当前用户的密码
* @return 返回密码
*/
@Override
public String getPassword() {
return sysUser.getPassword();
}
/**
* SpringSecurity内部去调用MyUserDetails的getUsername方法获取当前用户的用户名
* @return 返回用户名
*/
@Override
public String getUsername() {
return sysUser.getUserName();
}
/**
* @return 是否账户过期
*/
@Override
public boolean isAccountNonExpired() {
return true;
}
/**
* @return 是否账户未被锁
*/
@Override
public boolean isAccountNonLocked() {
return true;
}
/**
* @return 是否认证信息未过期
*/
@Override
public boolean isCredentialsNonExpired() {
return true;
}
/**
* 判断用户是否可用
* @return 是否可用
*/
@Override
public boolean isEnabled() {
return true;
}
@Override
public String toString() {
return "MyUserDetails{" +
"sysUser=" + sysUser +
'}';
}
public SysUser getSysUser() {
return sysUser;
}
public void setSysUser(SysUser sysUser) {
this.sysUser = sysUser;
}
public MyUserDetails() {
}
public MyUserDetails(SysUser sysUser) {
this.sysUser = sysUser;
}
}
注意:如果要测试,需要往用户表中写入用户数据,并且如果你想让用户的密码是明文存储,需要在密码前加{noop}。
SpringBoot往Redis中存储数据需要配置Redis的序列化器,如果不做配置,将默认使用JDK自带的序列化器,此时存入Redis中的数据会出现乱码;如果使用StringRedisTemplate则不需要进行配置
密码加密存储
实际项目中我们不会把密码明文存储在数据库中。
默认使用的PasswordEncoder要求数据库中的密码格式为:{id}password 。它会根据id去判断密码的加密方式。但是我们一般不会采用这种方式。所以就需要替换PasswordEncoder。
我们一般使用SpringSecurity为我们提供的BCryptPasswordEncoder。
我们只需要使用把BCryptPasswordEncoder对象注入Spring容器中,SpringSecurity就会使用该PasswordEncoder来进行密码校验。
我们可以定义一个SpringSecurity的配置类,SpringSecurity要求这个配置类要继承WebSecurityConfigurerAdapter。
注意:在高版本中WebSecurityConfigurerAdapter已为过时方法
/**
* WebSecurityConfigurerAdapter在高版本已被废弃
*/
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
// 将BCryptPasswordEncoder注入容器
@Bean
public PasswordEncoder getBCryptPasswordEncoder() {
return new BCryptPasswordEncoder();
}
}
新版本写法:
/**
* 由于WebSecurityConfigurerAdapter类已在Spring Security 5.7.0-M2中被弃用
* 所以在使用 5.7.0 以上版本的时候需要使用新的方式进行配置
*/
@Configuration
@EnableWebSecurity // 否则 http 报错 Could not autowire. No beans of 'HttpSecurity' type found.
public class NewSecurityConfig {
/**
* 将BCryptPasswordEncoder注入容器
* @return BCryptPasswordEncoder
*/
@Bean
public PasswordEncoder getBCryptPasswordEncoder() {
return new BCryptPasswordEncoder();
}
return http.build();
}
}
主要用到的BCryptPasswordEncoder方法有两个:encode(加密)、matches(解密适配)
BCryptPasswordEncoder的encode方法会在加密时在原文中添加随机生成的盐进行加密,因此即使原文一样,加密后的文本也会不一样。
登录接口实现
用户登录接口需要添加的配置:
注:此处配置和BCryptPasswordtEncoder配置为一个文件只是为了区分故分开写
/**
* WebSecurityConfigurerAdapter在高版本已被标记为过时方法
*/
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
/**
* 暴露AuthenticationManager,将其注入到Spring容器中
* @return AuthenticationManager
* @throws Exception
*/
@Bean
@Override
public AuthenticationManager authenticationManagerBean() throws Exception {
return super.authenticationManagerBean();
}
/**
* Http配置
* @param http 请求
* @throws Exception
*/
@Override
protected void configure(HttpSecurity http) throws Exception {
http
// 前后端分离项目关闭csrf
.csrf().disable()
// 前后端分离项目Session就没用了,不通过Session获取SecurityContext
.sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
.and()
.authorizeRequests()
// 对于登录接口,允许匿名访问
.antMatchers("/security/login").anonymous()
// 除上面外的所有请求全部需要鉴权认证
.anyRequest().authenticated();
}
}
新版本配置:
/**
* 由于WebSecurityConfigurerAdapter类已在Spring Security 5.7.0-M2中被弃用
* 所以在使用 5.7.0 以上版本的时候需要使用新的方式进行配置
*/
@Configuration
@EnableWebSecurity // 否则 http 报错 Could not autowire. No beans of 'HttpSecurity' type found.
public class NewSecurityConfig {
/**
* 获取AuthenticationManager(认证管理器),登录时认证使用
* @param authenticationConfiguration
* @return
* @throws Exception
*/
@Bean
public AuthenticationManager authenticationManager(AuthenticationConfiguration authenticationConfiguration) throws Exception {
return authenticationConfiguration.getAuthenticationManager();
}
/**
* Http配置
* @param http 请求
* @throws Exception
*/
@Bean
SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
http
// 前后端分离项目关闭csrf
.csrf().disable()
// 前后端分离项目Session就没用了,不通过Session获取SecurityContext
.sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
.and()
.authorizeRequests()
// 对于登录接口,允许匿名访问
.antMatchers("/security/login").anonymous()
// 除上面外的所有请求全部需要鉴权认证之后才能访问
.anyRequest().authenticated();
}
}
用户登陆实现的主要功能:
- 用户认证
- 创建token
- 将用户信息存入Redis
/**
* 用户登录
* @param sysUser 参数
* @return ResultApi
*/
@Override
public ResultApi login(SysUser sysUser) {
// AuthenticationManager authenticate进行用户认证
UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(sysUser.getUserName(),sysUser.getPassword());
// authenticate(Authentication authentication)使用Authentication的实现类之一UsernamePasswordAuthenticationToken做参数
Authentication authenticate = authenticationManager.authenticate(authenticationToken);
// 如果认证没通过,给出对应的提示
if (ObjectUtil.isNull(authenticate)) {
throw new RuntimeException("用户名或密码不正确");
}
// 如果认证通过,使用userId创建一个jwt,jwt存入ResultApi返回
MyUserDetails principal = (MyUserDetails) authenticate.getPrincipal();
SysUser user = principal.getSysUser();
String id = user.getId().toString();
String jwt = JwtUtil.createJWT(id);
Map<String,String> map = new HashMap<>();
map.put("token",jwt);
// 将完整的用户信息存入redis userId作为key
redisCache.setCacheObject(id,principal);
return new ResultApi(ApiCode.SUCCESS.getMessage(),ApiCode.SUCCESS.getCode(),map);
}
配置Jwt认证过滤器
/**
* Jwt认证过滤器
* 如果 implements Filter则在程序运行过程当中JwtAuthenticationTokenFilter可能会被执行多次
* 因此使用Spring实现的OncePerRequestFilter保证请求只经过过滤器一次
*/
@Component
public class JwtAuthenticationTokenFilter extends OncePerRequestFilter {
@Autowired
private RedisCache redisCache;
/*
* 重写的方法要是 protected 的
* 因为public中有SpringSecurity默认的配置
*/
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
// 获取token
String token = request.getHeader("token");
if (StrUtil.isEmpty(token)) {
// 如果没有token,SpringSecurity过滤器链中后续的过滤器会进行过滤,所以这里可以不进行处理直接放行
// FilterSecurityInterceptor会对认证状态进行判断,未进行认证会抛出相应异常
filterChain.doFilter(request,response);
// SpringSecurity是双向过滤,在请求和响应时都会经过 过滤器链
// 如果没有token就不需要进行以下针对token的操作,因此使用return
return;
}
// 解析token
try {
Claims claims = JwtUtil.parseJWT(token);
String userId = claims.getSubject();
if (StrUtil.isEmpty(userId)) {
throw new RuntimeException("token非法");
}
// 从Redis中获取用户信息
MyUserDetails cache = redisCache.getCacheObject(userId);
if (ObjectUtil.isNull(cache)) {
throw new RuntimeException("用户未登录");
}
// 存入SecurityContextHolder
// 使用三个参数的构造函数,会设置 用户为已认证状态 super.setAuthenticated(true)
// 后面过滤器再进行过滤时识别到状态为 已认证 就不需要再做其他处理
// 第一个参数为:用户的信息 第二个参数为:null 第三个参数: 权限集合
//todo 权限信息暂时没有,先标记为null
UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(cache,null,null);
SecurityContextHolder.getContext().setAuthentication(authenticationToken);
filterChain.doFilter(request,response);
} catch (Exception e) {
e.printStackTrace();
}
}
}
将自定义过滤器放进SpringSecurity过滤器链中
当我们写好自定义的过滤器后,并不能确定该过滤器执行的位置,因此我们需要将自定义的过滤器根据实现的功能与SpringSecurity框架的过滤器链结合,确定应该过滤的位置
我们自定义的 JwtAuthenticationTokenFilter 主要实现校验功能 在前端发送请求时从请求头中获取token信息,如果有token就解析token获取用户ID,根据用户Id从Redis中获取用户信息封装到 SecurityContextHolder 中;如果没有token就直接放行进行下步过滤处理最后抛异常或者提示信息。
JwtAuthenticationTokenFilter 放在 UsernamePasswordAuthenticationFilter之前( 进行认证操作之前),对所有的请求进行过滤
/**
*
* WebSecurityConfigurerAdapter在高版本已经过时
*/
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
@Autowired
private JwtAuthenticationTokenFilter jwtAuthenticationTokenFilter;
/**
* Http配置
* @param http 请求
* @throws Exception
*/
@Override
protected void configure(HttpSecurity http) throws Exception {
/**
* 将自定义过滤器添加到过滤器链中
*/
// 第一个参数: 自定义的过滤器 第二个参数: 要加在哪个过滤器之前
http.addFilterBefore(jwtAuthenticationTokenFilter, UsernamePasswordAuthenticationFilter.class);
}
}
新版本配置:
/**
* 由于WebSecurityConfigurerAdapter类已在Spring Security 5.7.0-M2中被弃用
* 所以在使用 5.7.0 以上版本的时候需要使用新的方式进行配置
*/
@Configuration
@EnableWebSecurity // 否则 http 报错 Could not autowire. No beans of 'HttpSecurity' type found.
public class NewSecurityConfig {
/**
* Jwt认证过滤器
*/
@Autowired
private JwtAuthenticationTokenFilter jwtAuthenticationTokenFilter;
/**
* Http配置
* @param http 请求
* @throws Exception
*/
@Bean
SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
// 将自定义过滤器添加到SpringSecurity过滤器链
http.addFilterBefore(jwtAuthenticationTokenFilter, UsernamePasswordAuthenticationFilter.class);
}
}
退出登录
- 获取SecurityContextHolder中的认证信息
- 删除Redis中该用户的信息
/**
* 退出登录
* @return
*/
@Override
public ResultApi logout() {
// 获取SecurityContextHolder中的用户ID
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
MyUserDetails principal = (MyUserDetails) authentication.getPrincipal();
SysUser sysUser = principal.getSysUser();
String id = sysUser.getId().toString();
// 删除redis中的该用户数据
redisCache.deleteObject(id);
return new ResultApi(ApiCode.SUCCESS.getMessage(),ApiCode.SUCCESS.getCode());
}
授权
权限系统的作用
让不同身份的用户可以使用不同的功能。
我们不能只依赖前端去判断用户的权限来选择显示哪些菜单哪些按钮。因为如果只是这样,如果有人知道了对应功能的接口地址就可以不通过前端,直接去发送请求来实现相关功能操作。
所以我们还需要在后台进行用户权限的判断,判断当前用户是否有相应的权限,必须具有所需权限才能进行相应的操作。
授权基本流程
在SpringSecurity中会使用默认的 FilterSecurityInterceptor 来进行权限校验。
在 FilterSecurityInteceptor 中会从 SecurityContextHolder 获取其中的Authentication,然后获取其中的权限信息。
授权实现
限制访问资源所需权限
SpringSecurity为我们提供了基于注解的权限控制方案,这也是我们项目中主要采用的方式。我们可以使用注解去指定访问对应的资源所需的权限。
但是要使用它我们需要在配置类上开启相关配置。
@EnableGlobalMethodSecurity(prePostEnabled = true)
/**
*
* WebSecurityConfigurerAdapter在高版本已被废弃
*/
@Configuration
// 开启注解功能
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class SecurityConfig extends WebSecurityConfigurerAdapter {
}
新版本写法:
/**
* 由于WebSecurityConfigurerAdapter类已在Spring Security 5.7.0-M2中被弃用
* 所以在使用 5.7.0 以上版本的时候需要使用新的方式进行配置
*/
@Configuration
@EnableWebSecurity // 否则 http 报错 Could not autowire. No beans of 'HttpSecurity' type found.
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class NewSecurityConfig {
}
然后就可以使用对应的注解。@PreAuthorize
注解解读
@PreAuthorize("hasAuthority('admin')")
SpringSecurity在运行时会读取注解中的属性值,读取到 hasAuthority('admin') 字符串之后,会把 hasAuthority('admin') 当作一个表达式来执行对应的方法;
@Override
public final boolean hasAuthority(String authority) {
return hasAnyAuthority(authority);
}
如果返回为true则执行标注@PreAuthorize注解的方法
封装权限信息
/**
* 自定义UserDetails实现类
*/
public class MyUserDetails implements UserDetails {
/**
* 用户信息
*/
private SysUser sysUser;
/**
* 权限集合
*/
private List<String> permissions;
private List<SimpleGrantedAuthority> authorities;
/**
* @return 返回权限信息
*/
@Override
public Collection<? extends GrantedAuthority> getAuthorities() {
// 功能优化:
// 将 List<SimpleGrantedAuthority> authorities = permissions.stream().map(permission -> new SimpleGrantedAuthority(permission)).collect(Collectors.toList());
// 提取至成员变量,减少 permissions 转换为 List<SimpleGrantedAuthority> authorities 的次数
if (ObjectUtil.isNull(authorities)) {
authorities = permissions.stream().map(SimpleGrantedAuthority::new)
.collect(Collectors.toList());
}
return authorities;
}
public List<String> getPermissions() {
return permissions;
}
public MyUserDetails(SysUser sysUser, List<String> permissions) {
this.sysUser = sysUser;
this.permissions = permissions;
}
public void setPermissions(List<String> permissions) {
this.permissions = permissions;
}
}
从数据库查询权限信息
RBAC权限模型
RBAC权限模型(Role-Based Access Control)即:基于角色的权限控制。这是目前最常被开发者使用也是相对易用、通用权限模型。
- 根据用户ID查询用户所拥有的权限:
SELECT
- 因为不同角色之间可能权限会有重复所以进行去重
DISTINCT sm.perms
FROM
sys_user su
- 通过user_id去 用户和角色表 中查询该用户所拥有的角色信息
INNER JOIN sys_user_role sur ON su.id = sur.user_id
- 获取到 角色Id 可以去 角色和权限表中 查询该用户所拥有的 权限ID
INNER JOIN sys_role_menu srm ON sur.role_id = srm.role_id
- 通过权限ID去权限表查询具体权限
INNER JOIN sys_menu sm ON srm.menu_id = sm.id
where su.`status` = 0
and su.id = 1
代码变化
/**
* 自定义UserDetailsService实现类
*/
@Component
public class MyUserDetailService implements UserDetailsService {
@Autowired
private SysUserMapper sysUserMapper;
@Autowired
private SysMenuMapper sysMenuMapper;
@Override
public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
//查询用户信息
LambdaUpdateWrapper<SysUser> wrapper = new LambdaUpdateWrapper<>();
wrapper.eq(SysUser::getUserName,username);
SysUser sysUser = sysUserMapper.selectOne(wrapper);
if (ObjectUtil.isNull(sysUser)) {
throw new RuntimeException("用户名或密码不正确");
}
/*******************************************************************/
// 查询对应的权限信息
List<String> permissionList = sysMenuMapper.getPermissionList(sysUser.getId());
// 把当前登陆用户封装成userDetails返回
return new MyUserDetails(sysUser,permissionList);
}
}
/**
* Jwt认证过滤器
* 如果 implements Filter则在程序运行过程当中JwtAuthenticationTokenFilter可能会被执行多次
* 因此使用Spring实现的OncePerRequestFilter保证请求只经过过滤器一次
*/
@Component
public class JwtAuthenticationTokenFilter extends OncePerRequestFilter {
@Autowired
private RedisCache redisCache;
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
// 获取token
String token = request.getHeader("token");
if (StrUtil.isEmpty(token)) {
// 如果没有token,SpringSecurity中后续的过滤器会进行过滤,所以这里可以不进行处理直接放行
// FilterSecurityInterceptor会对认证状态进行判断,未进行认证会抛出相应异常
filterChain.doFilter(request,response);
// SpringSecurity是双向过滤,在请求和响应时都会经过 过滤器链
// 如果没有token就不需要进行以下针对token的操作,因此使用return
return;
}
// 解析token
try {
Claims claims = JwtUtil.parseJWT(token);
String userId = claims.getSubject();
if (StrUtil.isEmpty(userId)) {
throw new RuntimeException("token非法");
}
// 从Redis中获取用户信息
MyUserDetails cache = redisCache.getCacheObject(userId);
if (ObjectUtil.isNull(cache)) {
throw new RuntimeException("用户未登录");
}
// 存入SecurityContextHolder
// 使用三个参数的构造函数,会设置 用户为已认证状态 super.setAuthenticated(true)
// 后面过滤器再进行过滤时识别到状态为 已认证 就不需要再做其他处理
// 第一个参数为:用户的信息 第二个参数为:null 第三个参数: 权限集合
/*************************修改第三个参数*****************************/
UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(cache,null,cache.getAuthorities());
SecurityContextHolder.getContext().setAuthentication(authenticationToken);
filterChain.doFilter(request,response);
} catch (Exception e) {
e.printStackTrace();
}
}
}
自定义失败处理
我们还希望在认证失败或者是授权失败的情况下也能和我们的接口一样返回相同结构的json,这样可以让前端能对响应进行统一的处理。要实现这个功能我们需要知道SpringSecurity的异常处理机制。
在SpringSecurity中,如果我们在认证或者授权的过程中出现了异常会被ExceptionTranslationFilter捕获到。在ExceptionTranslationFilter中会去判断是认证失败还是授权失败出现的异常。
如果是认证过程中出现的异常会被封装成AuthenticationException然后调用AuthenticationEntryPoint接口的 commence 方法去进行异常处理。
如果是授权过程中出现的异常会被封装成AccessDeniedException然后调用AccessDeniedHandler接口的 handle 方法去进行异常处理。
所以如果我们需要自定义异常处理,我们只需要自定义AuthenticationEntryPoint和AccessDeniedHandler然后配置给SpringSecurity即可。
工具类
public class WebUtils
{
/**
* 将字符串渲染到客户端
*
* @param response 渲染对象
* @param string 待渲染的字符串
* @return null
*/
public static String renderString(HttpServletResponse response, String string) {
try {
response.setStatus(200);
response.setContentType("application/json");
response.setCharacterEncoding("utf-8");
response.getWriter().print(string);
}
catch (IOException e) {
e.printStackTrace();
}
return null;
}
}
认证失败处理器
/**
* 自定义认证过程异常处理器
*/
@Component
public class AuthenticationEntryPointImpl implements AuthenticationEntryPoint {
@Override
public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException e) throws IOException, ServletException {
ResultApi result = new ResultApi(ApiCode.UNAUTHORIZED.getMessage(), ApiCode.UNAUTHORIZED.getCode());
String json = JSONObject.toJSONString(result);
// 处理异常
WebUtils.renderString(response,json);
}
}
授权失败处理器
/**
* 自定义授权过程异常处理器
*/
@Component
public class AccessDeniedHandlerImpl implements AccessDeniedHandler {
@Override
public void handle(HttpServletRequest request, HttpServletResponse response, AccessDeniedException e) throws IOException, ServletException {
ResultApi result = new ResultApi(ApiCode.NOT_PERMISSION.getMessage(), ApiCode.NOT_PERMISSION.getCode());
String json = JSONObject.toJSONString(result);
// 处理异常
WebUtils.renderString(response,json);
}
}
将自定义异常处理器配置给SpringSecurity
/**
* WebSecurityConfigurerAdapter在高版本已被废弃
*/
@Configuration
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class SecurityConfig extends WebSecurityConfigurerAdapter {
/**
* 认证失败处理器
*/
@Autowired
private AuthenticationEntryPoint authenticationEntryPoint;
/**
* 授权失败处理器
*/
@Autowired
private AccessDeniedHandler accessDeniedHandler;
/**
* Http配置
* @param http 请求
* @throws Exception
*/
@Override
protected void configure(HttpSecurity http) throws Exception {
// 配置失败异常处理器
http
.exceptionHandling()
.accessDeniedHandler(accessDeniedHandler)
.authenticationEntryPoint(authenticationEntryPoint);
}
}
新版本配置:
/**
* 由于WebSecurityConfigurerAdapter类已在Spring Security 5.7.0-M2中被弃用
* 所以在使用 5.7.0 以上版本的时候需要使用新的方式进行配置
*/
@Configuration
@EnableWebSecurity // 否则 http 报错 Could not autowire. No beans of 'HttpSecurity' type found.
public class NewSecurityConfig {
/**
* 认证失败处理器
*/
@Autowired
private AuthenticationEntryPoint authenticationEntryPoint;
/**
* 授权失败处理器
*/
@Autowired
private AccessDeniedHandler accessDeniedHandler;
/**
* Http配置
* @param http 请求
* @throws Exception
*/
@Bean
SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
// 配置失败异常处理器
http
.exceptionHandling()
.accessDeniedHandler(accessDeniedHandler)
.authenticationEntryPoint(authenticationEntryPoint);
return http.build();
}
}
跨域
浏览器出于安全的考虑,使用 XMLHttpRequest对象发起 HTTP请求时必须遵守同源策略,否则就是跨域的HTTP请求,默认情况下是被禁止的。 同源策略要求源相同才能正常进行通信,即协议、域名、端口号都完全一致。
前后端分离项目,前端项目和后端项目一般都不是同源的,所以肯定会存在跨域请求的问题。
所以我们就要处理一下,让前端能进行跨域请求。
SpringBoot配置允许跨域请求
/**
* 跨域配置
*/
@Configuration
public class CorsConfig implements WebMvcConfigurer {
@Override
public void addCorsMappings(CorsRegistry registry) {
// 设置允许跨域的路径
registry.addMapping("/**")
// 设置允许跨域请求的域名
// .allowedOrigins("*") //5.3版本之前
.allowedOriginPatterns("*") //自5.3版本开始使用
// 是否允许cookie
.allowCredentials(true)
// 设置允许的请求方式
.allowedMethods("GET", "POST", "DELETE", "PUT")
// 设置允许的header属性
.allowedHeaders("*")
// 跨域允许时间
.maxAge(3600);
}
}
SpringSecurity允许跨域
/**
* WebSecurityConfigurerAdapter在高版本已被废弃
*/
@Configuration
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class SecurityConfig extends WebSecurityConfigurerAdapter {
/**
* Http配置
* @param http 请求
* @throws Exception
*/
@Override
protected void configure(HttpSecurity http) throws Exception {
// 允许SpringSecurity执行跨域访问
http.cors();
}
}
新版本配置:
/**
* 由于WebSecurityConfigurerAdapter类已在Spring Security 5.7.0-M2中被弃用
* 所以在使用 5.7.0 以上版本的时候需要使用新的方式进行配置
*/
@Configuration
@EnableWebSecurity // 否则 http 报错 Could not autowire. No beans of 'HttpSecurity' type found.
public class NewSecurityConfig {
/**
* Http配置
* @param http 请求
* @throws Exception
*/
@Bean
SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
// 允许SpringSecurity执行跨域访问
http.cors();
return http.build();
}
}
其他权限校验方法
// 校验权限
hasAuthority(String authority)
hasAnyAuthority(String... authorities)
// 校验角色
hasRole(String role)
hasAnyRole(String... roles)
// 根据源码可以知道
// 校验权限和校验角色调用的都是 hasAnyAuthorityName 方法
// 区别是 校验角色时系统会加一个 ROLE_ 前缀,所以使用校验角色的相关方法时要将用户拥有的权限加上ROLE_前缀才能使用,比较麻烦,因此大多数使用权限校验的相关方法
private boolean hasAnyAuthorityName(String prefix, String... roles) {
Set<String> roleSet = getAuthoritySet();
for (String role : roles) {
String defaultedRole = getRoleWithDefaultPrefix(prefix, role);
if (roleSet.contains(defaultedRole)) {
return true;
}
}
return false;
}
自定义权限校验方法
我们也可以定义自己的权限校验方法,在@PreAuthorize注解中使用我们的方法。
/**
* 自定义权限校验方法
*/
@Component("el")
public class ElExpression {
public boolean check(String authority) {
// 获取当前用户的权限
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
MyUserDetails principal = (MyUserDetails) authentication.getPrincipal();
List<String> permissions = principal.getPermissions();
// 判断用户权限集合中是否存在authority
return permissions.contains(authority);
SPEL表达式语法:
@+bean的名字:获取bean对象
在SPEL表达式中使用 @el相当于获取容器中bean的名字为el的对象。然后再调用这个对象的check方法
// @PreAuthorize("hasAuthority('admin')")
// @PreAuthorize("hasAuthority('system:security:list')")
@PreAuthorize("@el.check('system:security:list')")
public String hello() {
return "hello";
}
基于配置的权限控制
也可以在配置类中使用配置的方式对资源进行权限控制
/**
* Http配置
* @param http 请求
* @throws Exception
*/
@Override
protected void configure(HttpSecurity http) throws Exception {
http
.authorizeRequests()
.antMatchers("/security/hello")
// .hasAnyRole()
// .hasRole()
.hasAuthority("system:security:list");
// .hasAnyAuthority();
}
CSRF
CSRF是指跨站请求伪造(Cross-site request forgery),是web常见的攻击之一。
https://blog.csdn.net/freeking101/article/details/86537087
SpringSecurity去防止CSRF攻击的方式就是通过csrf_token。后端会生成一个csrf_token,前端发起请求的时候需要携带这个csrf_token,后端会有过滤器进行校验,如果没有携带或者是伪造的就不允许访问。
我们可以发现CSRF攻击依靠的是cookie中所携带的认证信息。但是在前后端分离的项目中我们的认证信息其实是token,而token并不是存储中cookie中,并且需要前端代码去把token设置到请求头中才可以,所以CSRF攻击也就不用担心了,所以就可以关闭csrf防护了,并且必须得关闭csrf防护,否则后端还会去检测csrf_token从而导致项目无法访问。
自定义登录成功处理器
实际上在UsernamePasswordAuthenticationFilter进行登录认证的时候,如果登录成功了是会调用AuthenticationSuccessHandler的方法进行认证成功后的处理的。
AuthenticationSuccessHandler就是登录成功处理器。
使用认证成功处理器必须使用UsernamePasswordAuthenticationFilter进行登录认证(即:使用SpringSecurity默认的表单进行登录),使用自定义认证过滤器无法调用
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
@Autowired
private AuthenticationSuccessHandler successHandler;
@Override
protected void configure(HttpSecurity http) throws Exception {
http.formLogin().successHandler(successHandler);
http.authorizeRequests().anyRequest().authenticated();
}
}
/**
* 自定义认证成功处理器
*/
@Component
public class SGSuccessHandler implements AuthenticationSuccessHandler {
@Override
public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication) throws IOException, ServletException {
System.out.println("认证成功了");
}
}
自定义登录失败处理器
实际上在UsernamePasswordAuthenticationFilter进行登录认证的时候,如果认证失败了是会调用AuthenticationFailureHandler的方法进行认证失败后的处理的。 AuthenticationFailureHandler就是登录失败处理器。
我们也可以自己去自定义失败处理器进行失败后的相应处理。
使用登录失败处理器必须使用UsernamePasswordAuthenticationFilter进行登录认证(即:使用SpringSecurity默认的表单进行登录),使用自定义认证过滤器无法调用
@Component
public class SGFailureHandler implements AuthenticationFailureHandler {
@Override
public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception) throws IOException, ServletException {
System.out.println("认证失败了");
}
}
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
@Autowired
private AuthenticationSuccessHandler successHandler;
@Autowired
private AuthenticationFailureHandler failureHandler;
@Override
protected void configure(HttpSecurity http) throws Exception {
http.formLogin()
// 配置认证成功处理器
.successHandler(successHandler)
// 配置认证失败处理器
.failureHandler(failureHandler);
http.authorizeRequests().anyRequest().authenticated();
}
}
自定义登出成功处理器
使用自定义登出处理器必须使用SpringSecurity默认的表单(http://localhost:8080/logout)进行注销,使用自定义认证过滤器无法调用
@Component
public class SGLogoutSuccessHandler implements LogoutSuccessHandler {
@Override
public void onLogoutSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication) throws IOException, ServletException {
System.out.println("注销成功");
}
}
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
@Autowired
private AuthenticationSuccessHandler successHandler;
@Autowired
private AuthenticationFailureHandler failureHandler;
@Autowired
private LogoutSuccessHandler logoutSuccessHandler;
@Override
protected void configure(HttpSecurity http) throws Exception {
http.formLogin()
// 配置认证成功处理器
.successHandler(successHandler)
// 配置认证失败处理器
.failureHandler(failureHandler);
http.logout()
//配置注销成功处理器
.logoutSuccessHandler(logoutSuccessHandler);
http.authorizeRequests().anyRequest().authenticated();
}
}
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 阿里最新开源QwQ-32B,效果媲美deepseek-r1满血版,部署成本又又又降低了!
· SQL Server 2025 AI相关能力初探
· AI编程工具终极对决:字节Trae VS Cursor,谁才是开发者新宠?
· 开源Multi-agent AI智能体框架aevatar.ai,欢迎大家贡献代码
· Manus重磅发布:全球首款通用AI代理技术深度解析与实战指南