（十三）springboot实战——springboot前后端分离方式项目集成spring securtity安全框架
前言
Spring Security 是一款强大且高度可定制的认证和访问控制框架，它是为了保护基于Spring的应用程序提供安全性支持。Spring Security提供了全面的安全服务，主要针对企业级应用程序的需求。其核心组件主要包含：Authentication（认证）、Authorization（授权）、Principal（主体）、Granted Authority（授予的权限）、Security Context（安全上下文），可提供方法级别的权限认证。其底层主要通过Filter拦截器实现，关于其实现原理，我们会在后面的章节内容中介绍。
本节内容主要是关于前后端分离的项目如何集成spring securtity安全框架，完成用户的认证与授权。也会详细介绍各个配置项及配置组件的使用。
正文
①创建一个springboot web项目，引入spring security的依赖，同时引入mysql和mybatis-plus依赖，用于实现一个数据库版本的spring security安全框架
com.alibaba
fastjson
2.0.22
com.baomidou
mybatis-plus-boot-starter
3.5.4
org.springframework.boot
spring-boot-starter-security
org.springframework.boot
spring-boot-starter-web
com.mysql
mysql-connector-j
runtime
org.projectlombok
lombok
true
②在application.yml中添加数据库配置，用于连接数据库
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://192.168.110.88:3306/ht-atp?characterEncoding=utf-8&serverTimezone=GMT%2B8&useAffectedRows=true&nullCatalogMeansCurrent=true
username: root
password: root
server:
port: 8080③ 创建一张用户数据库表auth_user，用于存储用户信息
CREATE TABLE `auth_user` (
`id` int NOT NULL AUTO_INCREMENT,
`username` varchar(50) COLLATE utf8mb4_general_ci DEFAULT NULL,
`password` varchar(500) COLLATE utf8mb4_general_ci DEFAULT NULL,
`enabled` tinyint(1) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;④创建用户实体AuthUser
@Data
public class AuthUser {
@TableId(value = "id", type = IdType.AUTO)
private Integer id;
private String username;
private String password;
private Boolean enabled;
}⑤创建用户持久层Mapper
package com.yundi.atp.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.yundi.atp.entity.AuthUser;
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface AuthUserMapper extends BaseMapper {
}
⑥统一响应请求返回定义
package com.yundi.atp.commom;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Builder;
import lombok.Data;
@Data
@Builder
public class ApiResponse {
@Schema(name = "code", description = "状态码")
private Integer code;
@Schema(name = "msg", description = "消息结果")
private String msg;
@Schema(name = "data", description = "数据")
private T data;
/**
* 成功统一响应格式
*
* @param
* @param
* @return
*/
public static ApiResponse success() {
ApiResponse apiResponse = new ApiResponse<>(200, "成功", null);
return apiResponse;
}
/**
* 成功统一响应格式
*
* @param
* @param
* @return
*/
public static ApiResponse success(String msg) {
ApiResponse apiResponse = new ApiResponse<>(200, msg, null);
return apiResponse;
}
/**
* 成功统一响应格式
*
* @param data
* @param
* @return
*/
public static ApiResponse success(T data) {
ApiResponse apiResponse = new ApiResponse<>(200, "成功", data);
return apiResponse;
}
/**
* 成功统一响应格式
*
* @param data
* @param
* @return
*/
public static ApiResponse success(String msg, T data) {
ApiResponse apiResponse = new ApiResponse<>(200, msg, data);
return apiResponse;
}
/**
* 失败统一响应格式
*
* @param code
* @param message
* @param
* @return
*/
public static ApiResponse fail(Integer code, String message) {
return new ApiResponse<>(code, message, null);
}
/**
* 失败统一响应格式
*
* @param errorCode
* @param
* @return
*/
public static ApiResponse fail(ErrorCode errorCode) {
return new ApiResponse<>(errorCode.getCode(), errorCode.getMsg(), null);
}
}
⑦ 统一错误码定义
package com.yundi.atp.commom;
public enum ErrorCode {
SYSTEM_ERROR(10000, "系统错误!"),
UN_AUTH(10001, "用户未认证，请先登录！"),
AUTH_FAILURE(10002, "认证失败，用户名或密码错误！"),
UN_ACCESS(10003, "该用户没有此操作权限！"),
METHOD_ARGS_VALID(10004, "方法参数验证失败！"),
TOKEN_VALID(10005, "token鉴权失败！"),
TOKEN_NOT_EXIST(10006, "token不存在！"),
;
private Integer code;
private String msg;
ErrorCode(Integer code, String message) {
this.code = code;
this.msg = message;
}
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
}
⑧创建DbUserDetailsManager类实现UserDetailsManager和UserDetailsPasswordService接口方法，用于实现数据库版本的认证权限管理，该类主要是实现用户数据和权限数据的获取，用于认证和授权使用
package com.yundi.atp.auth;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.yundi.atp.entity.AuthUser;
import com.yundi.atp.mapper.AuthUserMapper;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsPasswordService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import org.springframework.security.provisioning.UserDetailsManager;
import org.springframework.stereotype.Service;
import javax.annotation.Resource;
import java.util.ArrayList;
import java.util.Collection;
@Service
public class DbUserDetailsManager implements UserDetailsManager, UserDetailsPasswordService {
@Resource
private AuthUserMapper authUserMapper;
@Override
public UserDetails updatePassword(UserDetails user, String newPassword) {
return null;
}
@Override
public void createUser(UserDetails userDetails) {
AuthUser authUser = new AuthUser();
authUser.setUsername(userDetails.getUsername());
authUser.setPassword(userDetails.getPassword());
authUser.setEnabled(true);
authUserMapper.insert(authUser);
}
@Override
public void updateUser(UserDetails user) {
}
@Override
public void deleteUser(String username) {
}
@Override
public void changePassword(String oldPassword, String newPassword) {
}
@Override
public boolean userExists(String username) {
return false;
}
@Override
public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
//查询用户数据
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.eq("username", username);
AuthUser authUser = authUserMapper.selectOne(queryWrapper);
if (authUser == null) {
throw new UsernameNotFoundException(username);
} else {
//从数据库获取用户权限列表
Collection authorities = new ArrayList<>();
authorities.add(() -> "USER_LIST");
authorities.add(() -> "USER_ADD");
return new User(
//用户账号
authUser.getUsername(),
//用户密码
authUser.getPassword(),
//是否启用
authUser.getEnabled(),
//用户账号是否过期
true,
//用户凭证是否过期
true,
//用户是否未被锁定
true,
//权限列表
authorities);
}
}
}
⑨创建MyAuthenticationEntryPoint类实现AuthenticationEntryPoint接口，用于未认证的处理
package com.yundi.atp.auth;
import com.alibaba.fastjson.JSON;
import com.yundi.atp.commom.ApiResponse;
import com.yundi.atp.commom.ErrorCode;
import lombok.extern.slf4j.Slf4j;
import org.springframework.security.core.AuthenticationException;
import org.springframework.security.web.AuthenticationEntryPoint;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Slf4j
public class MyAuthenticationEntryPoint implements AuthenticationEntryPoint {
@Override
public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException authException) throws IOException {
log.info("未认证：" + authException);
//返回响应
response.setContentType("application/json;charset=UTF-8");
response.getWriter().println(JSON.toJSONString(ApiResponse.fail(ErrorCode.UN_AUTH)));
}
}
⑩创建MyAuthenticationSuccessHandler类实现AuthenticationSuccessHandler接口，用于认证成功的处理
package com.yundi.atp.auth;
import com.alibaba.fastjson.JSON;
import com.yundi.atp.commom.ApiResponse;
import com.yundi.atp.util.TokenUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.userdetails.User;
import org.springframework.security.web.authentication.AuthenticationSuccessHandler;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Slf4j
public class MyAuthenticationSuccessHandler implements AuthenticationSuccessHandler {
@Override
public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response, FilterChain chain, Authentication authentication) throws IOException, ServletException {
AuthenticationSuccessHandler.super.onAuthenticationSuccess(request, response, chain, authentication);
}
@Override
public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication) throws IOException {
//返回响应
response.setContentType("application/json;charset=UTF-8");
response.getWriter().println(JSON.toJSONString(ApiResponse.success("认证成功！")));
}
}
⑪创建MyAuthenticationFailureHandler类实现AuthenticationFailureHandler接口，用于认证失败的处理
package com.yundi.atp.auth;
import com.alibaba.fastjson.JSON;
import com.yundi.atp.commom.ApiResponse;
import com.yundi.atp.commom.ErrorCode;
import lombok.extern.slf4j.Slf4j;
import org.springframework.security.core.AuthenticationException;
import org.springframework.security.web.authentication.AuthenticationFailureHandler;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Slf4j
public class MyAuthenticationFailureHandler implements AuthenticationFailureHandler {
@Override
public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception) throws IOException {
response.setContentType("application/json;charset=UTF-8");
response.getWriter().println(JSON.toJSONString(ApiResponse.fail(ErrorCode.AUTH_FAILURE)));
}
}
⑫创建MyLogoutSuccessHandler类实现LogoutSuccessHandler接口，用于退出登录的处理
package com.yundi.atp.auth;
import com.alibaba.fastjson.JSON;
import com.yundi.atp.commom.ApiResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.security.core.Authentication;
import org.springframework.security.web.authentication.logout.LogoutSuccessHandler;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Slf4j
public class MyLogoutSuccessHandler implements LogoutSuccessHandler {
@Override
public void onLogoutSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication) throws IOException {
response.setContentType("application/json;charset=UTF-8");
response.getWriter().println(JSON.toJSONString(ApiResponse.success("注销成功！")));
}
}
⑬创建MyAccessDeniedHandler类实现AccessDeniedHandler接口，用于授权不通过的处理
package com.yundi.atp.auth;
import com.alibaba.fastjson.JSON;
import com.yundi.atp.commom.ApiResponse;
import com.yundi.atp.commom.ErrorCode;
import lombok.extern.slf4j.Slf4j;
import org.springframework.security.access.AccessDeniedException;
import org.springframework.security.web.access.AccessDeniedHandler;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Slf4j
public class MyAccessDeniedHandler implements AccessDeniedHandler {
@Override
public void handle(HttpServletRequest request, HttpServletResponse response, AccessDeniedException accessDeniedException) throws IOException {
response.setContentType("application/json;charset=UTF-8");
response.getWriter().println(JSON.toJSONString(ApiResponse.fail(ErrorCode.UN_ACCESS)));
}
}
⑭创建spring security的配置类，开启spring security认证以及方法级别的授权
package com.yundi.atp.config;
import com.yundi.atp.auth.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.authentication.AuthenticationManager;
import org.springframework.security.authentication.ProviderManager;
import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
import org.springframework.security.config.Customizer;
import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.crypto.factory.PasswordEncoderFactories;
import org.springframework.security.web.SecurityFilterChain;
@EnableMethodSecurity
@Configuration
public class SpringSecurityConfig {
@Autowired
private DbUserDetailsManager dbUserDetailsManager;
@Bean
public AuthenticationManager authenticationManager() {
DaoAuthenticationProvider authenticationProvider = new DaoAuthenticationProvider();
authenticationProvider.setUserDetailsService(dbUserDetailsManager);
authenticationProvider.setPasswordEncoder(PasswordEncoderFactories.createDelegatingPasswordEncoder());
return new ProviderManager(authenticationProvider);
}
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
//authorizeRequests()：开启授权保护
//anyRequest()：对所有请求开启授权保护
//authenticated()：已认证请求会自动被授权
http.authorizeRequests(authorize -> {
//放行路径
authorize.antMatchers("/webjars/**", "/v3/**", "/doc.html", "/favicon.ico", "/swagger-ui/**").permitAll();
//其它请求需要认证
authorize.anyRequest().authenticated();
});
//自定义登录
http.formLogin(formLogin -> {
formLogin.loginPage("/login").permitAll() //登录页面无需授权即可访问
.usernameParameter("username") //自定义表单用户名参数，默认是username
.passwordParameter("password");//自定义表单密码参数，默认是password
//登录认证成功
formLogin.successHandler(new MyAuthenticationSuccessHandler());
//登录认证失败
formLogin.failureHandler(new MyAuthenticationFailureHandler());
});
// 基本授权方式
http.httpBasic(Customizer.withDefaults());
//自定义注销
http.logout(logout -> {
logout.logoutUrl("/logout");
//删除授权信息
logout.clearAuthentication(true);
//删除cookie
logout.deleteCookies("JSESSIONID");
//设置session失效
logout.invalidateHttpSession(true);
//退出的处理
logout.addLogoutHandler(new MyLogoutHandler());
//退出成功的响应
logout.logoutSuccessHandler(new MyLogoutSuccessHandler());
});
//错误处理
http.exceptionHandling(exception -> {
//请求未认证的接口
exception.authenticationEntryPoint(new MyAuthenticationEntryPoint());
//未授权的接口异常处理：可能会不生效，被全局异常处理器拦截
exception.accessDeniedHandler(new MyAccessDeniedHandler());
});
// 跨域
http.cors(Customizer.withDefaults());
//关闭csrf攻击防御
http.csrf(csrf -> {
csrf.disable();
});
return http.build();
}
}
⑮spring security的配置说明
1.开启方法级别的权限验证
2.注入自定义的数据库版本的授权管理器
3.放行不需要认证的路径
4.配置登录的认证及认证处理
5.配置基本的授权方式
6.配置用户注销的处理
7.异常的处理
8.跨域的处理
9.关闭csrf攻击防御
⑯使用PasswordEncoderFactories工厂生成一个spring security的密码，创建一个用户用户测试
⑰访问未认证的请求
⑱使用正确的用户名和密码访问登录接口/login，注意这里必须是post请求
⑲使用错误的用户名和密码访问登录接口/login，注意这里必须是post请求
⑳测试接口授权，目前的权限包含USER_LIST、USER_ADD，在DbUserDetailsManager中查询的
㉑访问/logout注销接口，查看结果
结语
关于springboot前后端分离方式项目集成spring securtity安全框架的内容到这里就结束了，我们下期见。。。。。。