1. 添加依赖
首先,在 pom.xml
中添加必要的依赖。除了 Spring Boot 和 Spring Security 外,我们还需要添加 JWT 的相关依赖:
<dependencies>
<!-- Spring Boot Starter Web -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Spring Boot Starter Security -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<!-- JWT 依赖 -->
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt</artifactId>
<version>0.11.5</version>
</dependency>
</dependencies>
2. 创建 JWT 工具类
JWT 用于生成和验证令牌。我们首先定义一个工具类来处理 JWT 的生成与解析。
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import java.util.Date;
public class JwtUtils {
// 密钥,可以用更安全的方式存储
private static final String SECRET_KEY = "secret_key";
// 生成 JWT
public static String generateToken(String username) {
return Jwts.builder()
.setSubject(username)
.setIssuedAt(new Date())
.setExpiration(new Date(System.currentTimeMillis() + 86400000)) // 设置过期时间为 24 小时
.signWith(SignatureAlgorithm.HS256, SECRET_KEY)
.compact();
}
// 从 JWT 中获取用户名
public static String getUsernameFromToken(String token) {
return Jwts.parser()
.setSigningKey(SECRET_KEY)
.parseClaimsJws(token)
.getBody()
.getSubject();
}
// 校验 JWT 是否有效
public static boolean validateToken(String token) {
try {
Jwts.parser().setSigningKey(SECRET_KEY).parseClaimsJws(token);
return true;
} catch (Exception e) {
return false;
}
}
}
3. 自定义 UserDetailsService
Spring Security 需要一个 UserDetailsService
来加载用户信息。在前后端分离的项目中,通常会从数据库中加载用户信息。这里简化示例,我们使用一个内存中的用户信息。
import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.stereotype.Service;
@Service
public class CustomUserDetailsService implements UserDetailsService {
@Override
public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
// 假设我们从数据库查询用户信息,这里简化为内存中的用户
if ("user".equals(username)) {
return User.withUsername("user")
.password("{noop}password") // 明文密码,实际项目中要加密
.roles("USER")
.build();
} else if ("admin".equals(username)) {
return User.withUsername("admin")
.password("{noop}admin")
.roles("ADMIN")
.build();
}
throw new UsernameNotFoundException("User not found: " + username);
}
}
4. 创建 JWT 认证过滤器
为了从 HTTP 请求中提取 JWT 并验证其有效性,我们创建一个 JwtAuthenticationFilter
。
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.web.authentication.WebAuthenticationDetailsSource;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
@Component
public class JwtAuthenticationFilter extends OncePerRequestFilter {
private final CustomUserDetailsService userDetailsService;
public JwtAuthenticationFilter(CustomUserDetailsService userDetailsService) {
this.userDetailsService = userDetailsService;
}
@Override
protected void doFilterInternal(HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
String token = request.getHeader("Authorization");
if (token != null && token.startsWith("Bearer ")) {
token = token.substring(7); // 去掉 "Bearer " 部分
if (JwtUtils.validateToken(token)) {
String username = JwtUtils.getUsernameFromToken(token);
CustomUserDetails userDetails = (CustomUserDetails) userDetailsService.loadUserByUsername(username);
// 设置 Spring Security 上下文,保存用户信息
SecurityContextHolder.getContext().setAuthentication(new UsernamePasswordAuthenticationToken(userDetails, null, userDetails.getAuthorities()));
}
}
filterChain.doFilter(request, response);
}
}
5. 配置 Spring Security
配置 Spring Security 来使用自定义的 JWT 认证过滤器,并全局保存当前登录的用户信息。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpMethod;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
private final JwtAuthenticationFilter jwtAuthenticationFilter;
public SecurityConfig(JwtAuthenticationFilter jwtAuthenticationFilter) {
this.jwtAuthenticationFilter = jwtAuthenticationFilter;
}
@Override
protected void configure(HttpSecurity http) throws Exception {
http.csrf().disable() // 禁用 CSRF
.authorizeRequests()
.antMatchers("/login", "/register").permitAll() // 登录和注册接口无需认证
.antMatchers(HttpMethod.GET, "/api/**").hasRole("USER") // 需要 USER 角色访问
.anyRequest().authenticated() // 其他请求需要认证
.and()
.addFilterBefore(jwtAuthenticationFilter, UsernamePasswordAuthenticationFilter.class); // 将 JWT 过滤器添加到 Spring Security 过滤器链中
}
}
6. 创建登录接口
前端在登录时会向后端发送用户名和密码,后端校验成功后返回 JWT。
import org.springframework.security.authentication.AuthenticationManager;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class AuthController {
private final AuthenticationManager authenticationManager;
public AuthController(AuthenticationManager authenticationManager) {
this.authenticationManager = authenticationManager;
}
@PostMapping("/login")
public String login(@RequestBody LoginRequest loginRequest) {
try {
// 认证用户
Authentication authentication = authenticationManager.authenticate(
new UsernamePasswordAuthenticationToken(loginRequest.getUsername(), loginRequest.getPassword())
);
// 设置 SecurityContext
SecurityContextHolder.getContext().setAuthentication(authentication);
// 生成 JWT
return JwtUtils.generateToken(loginRequest.getUsername());
} catch (Exception e) {
throw new RuntimeException("Invalid credentials", e);
}
}
}
7. 创建获取当前用户信息的接口
你可以创建一个接口,返回当前登录的用户信息,确保 Spring Security 中的 Authentication
已经保存了当前的用户信息。
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
@GetMapping("/current-user")
public String getCurrentUser() {
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
return authentication.getName(); // 返回当前用户名
}
}