今天主要介绍以下内容:
今日内容介绍,大约花费40分钟
图片
下图显示了我们如何实现用户注册、用户登录和授权流程的流程。
图片
如果客户端访问受保护的资源,则必须将合法的 JWT 添加到 HTTP 授权标头中。
您可以通过下图概述我们的Spring Boot项目:
图片
Spring Security介绍:
注意:WebSecurityConfigurerAdapter 从 SpringBoot 2.7.0 开始被弃用)
下图是Spring Boot项目的文件夹和文件结构:
图片
图片
根据Sql创建表,表间关系如下:
图片
SET FOREIGN_KEY_CHECKS=0;-- ------------------------------ Table structure for pe_permission-- ----------------------------DROP TABLE IF EXISTS `pe_permission`;CREATE TABLE `pe_permission` ( `id` varchar(40) NOT NULL COMMENT '主键', `name` varchar(255) DEFAULT NULL COMMENT '权限名称', `code` varchar(20) DEFAULT NULL, `description` text COMMENT '权限描述', PRIMARY KEY (`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;-- ------------------------------ Records of pe_permission-- ----------------------------INSERT INTO `pe_permission` VALUES ('1', '添加用户', 'user-add', null);INSERT INTO `pe_permission` VALUES ('2', '查询用户', 'user-find', null);INSERT INTO `pe_permission` VALUES ('3', '更新用户', 'user-update', null);INSERT INTO `pe_permission` VALUES ('4', '删除用户', 'user-delete', null);-- ------------------------------ Table structure for pe_role-- ----------------------------DROP TABLE IF EXISTS `pe_role`;CREATE TABLE `pe_role` ( `id` varchar(40) NOT NULL COMMENT '主键ID', `name` varchar(40) DEFAULT NULL COMMENT '权限名称', `description` varchar(255) DEFAULT NULL COMMENT '说明', PRIMARY KEY (`id`), UNIQUE KEY `UK_k3beff7qglfn58qsf2yvbg41i` (`name`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;-- ------------------------------ Records of pe_role-- ----------------------------INSERT INTO `pe_role` VALUES ('1', '系统管理员', '系统日常维护');INSERT INTO `pe_role` VALUES ('2', '普通员工', '普通操作权限');-- ------------------------------ Table structure for pe_role_permission-- ----------------------------DROP TABLE IF EXISTS `pe_role_permission`;CREATE TABLE `pe_role_permission` ( `role_id` varchar(40) NOT NULL COMMENT '角色ID', `permission_id` varchar(40) NOT NULL COMMENT '权限ID', PRIMARY KEY (`role_id`,`permission_id`), KEY `FK74qx7rkbtq2wqms78gljv87a0` (`permission_id`), KEY `FKee9dk0vg99shvsytflym6egxd` (`role_id`), CONSTRAINT `fk-p-rid` FOREIGN KEY (`role_id`) REFERENCES `pe_role` (`id`), CONSTRAINT `fk-pid` FOREIGN KEY (`permission_id`) REFERENCES `pe_permission` (`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;-- ------------------------------ Records of pe_role_permission-- ----------------------------INSERT INTO `pe_role_permission` VALUES ('1', '1');INSERT INTO `pe_role_permission` VALUES ('1', '2');INSERT INTO `pe_role_permission` VALUES ('2', '2');INSERT INTO `pe_role_permission` VALUES ('1', '3');INSERT INTO `pe_role_permission` VALUES ('1', '4');-- ------------------------------ Table structure for pe_user-- ----------------------------DROP TABLE IF EXISTS `pe_user`;CREATE TABLE `pe_user` ( `id` varchar(40) NOT NULL COMMENT 'ID', `username` varchar(255) NOT NULL COMMENT '用户名称', `password` varchar(255) DEFAULT NULL COMMENT '密码', PRIMARY KEY (`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;-- ------------------------------ Records of pe_user-- ----------------------------INSERT INTO `pe_user` VALUES ('1', 'zhangsan', '$2a$10$.fXoccJHJkb9KM1FYJd1Ve.2P0B0RgLvloBDPwGjRxcP2obt2NRkG');INSERT INTO `pe_user` VALUES ('2', 'lisi', '$2a$10$.fXoccJHJkb9KM1FYJd1Ve.2P0B0RgLvloBDPwGjRxcP2obt2NRkG');INSERT INTO `pe_user` VALUES ('3', 'wangwu', '$2a$10$.fXoccJHJkb9KM1FYJd1Ve.2P0B0RgLvloBDPwGjRxcP2obt2NRkG');-- ------------------------------ Table structure for pe_user_role-- ----------------------------DROP TABLE IF EXISTS `pe_user_role`;CREATE TABLE `pe_user_role` ( `role_id` varchar(40) NOT NULL COMMENT '角色ID', `user_id` varchar(40) NOT NULL COMMENT '权限ID', KEY `FK74qx7rkbtq2wqms78gljv87a1` (`role_id`), KEY `FKee9dk0vg99shvsytflym6egx1` (`user_id`), CONSTRAINT `fk-rid` FOREIGN KEY (`role_id`) REFERENCES `pe_role` (`id`), CONSTRAINT `fk-uid` FOREIGN KEY (`user_id`) REFERENCES `pe_user` (`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;-- ------------------------------ Records of pe_user_role-- ----------------------------INSERT INTO `pe_user_role` VALUES ('1', '1');
<?xml versinotallow="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <artifactId>spring-boot-starter-parent</artifactId> <groupId>org.springframework.boot</groupId> <version>2.7.15</version> </parent> <groupId>com.zbbmeta</groupId> <artifactId>spring-boot-backend-example</artifactId> <version>1.0-SNAPSHOT</version> <properties> <maven.compiler.source>8</maven.compiler.source> <maven.compiler.target>8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> </dependency> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.3</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.30</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.8.20</version> </dependency> <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-configuration-processor --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency> <dependency> <groupId>io.jsonwebtoken</groupId> <artifactId>jjwt</artifactId> <version>0.9.1</version> </dependency> </dependencies></project>
安装MyBatisX插件,这里就不过多介绍如何安装插件了,和其他插件安装相同 表生成代码步骤如下:
图片
图片
图片
Spring Security 将加载用户详细信息以执行身份验证和授权。所以它有 UserDetailsService 我们需要实现的接口。
在com.zbbmeta.service.impl包下创建UserDetailsService实现类UserDetailsServiceImpl
@Servicepublic class UserDetailsServiceImpl implements UserDetailsService { @Autowired private UserService userService; @Override public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { User user = userService.findByName(username); List<Role> roles = user.getRoles(); List<String> authorities = new ArrayList<>(); for (Role role : roles) { List<Permission> permissions = role.getPermissions(); List<String> collect = permissions.stream().map(x -> x.getCode()).distinct().collect(Collectors.toList()); authorities.addAll(collect); } List<String> collect1 = authorities.stream().distinct().collect(Collectors.toList()); return new org.springframework.security.core.userdetails.User(username, user.getPassword(), AuthorityUtils.createAuthorityList(collect1.toString())); }}
public interface UserMapper extends BaseMapper<User> { User findByUsername(String name);}
在User实体类中添加字段roles
@TableField(exist = false) private List<Role> roles = new ArrayList<>();//用户与角色 多对多
图片
并且在resultMap添加一对多根据用户查询对应角色
<?xml versinotallow="1.0" encoding="UTF-8"?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.zbbmeta.mapper.UserMapper"> <resultMap id="BaseResultMap" type="com.zbbmeta.entity.User"> <id property="id" column="id" jdbcType="VARCHAR"/> <result property="username" column="username" jdbcType="VARCHAR"/> <result property="password" column="password" jdbcType="VARCHAR"/> <!--一对多映射用这个 ofTyp是一对多的集合的所存放的实体类 javaType实体类的属性类型--> <collection property="roles" ofType="com.zbbmeta.entity.Role" select="com.zbbmeta.mapper.RoleMapper.queryRoleListByUserId" column="id"> <id property="id" column="id" jdbcType="VARCHAR"/> <result property="name" column="name" jdbcType="VARCHAR"/> <result property="description" column="description" jdbcType="VARCHAR"/> </collection> </resultMap> <sql id="Base_Column_List"> id,username,password </sql> <select id="findByUsername" resultMap="BaseResultMap"> select * from pe_user where username=#{name}; </select></mapper>
public interface RoleMapper extends BaseMapper<Role> { List<Role> queryRoleListByUserId(@Param("id") Long id);}
@TableField(exist = false) private List<Permission> permissions = new ArrayList<>();//用户与角色 多对多
图片
并且在resultMap添加一对多根据角色查询对应权限
<?xml versinotallow="1.0" encoding="UTF-8"?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.zbbmeta.mapper.RoleMapper"> <resultMap id="BaseResultMap" type="com.zbbmeta.entity.Role"> <id property="id" column="id" jdbcType="VARCHAR"/> <result property="name" column="name" jdbcType="VARCHAR"/> <result property="description" column="description" jdbcType="VARCHAR"/> <collection property="permissions" ofType="com.zbbmeta.entity.Permission" select="com.zbbmeta.mapper.PermissionMapper.queryPermissionList" column="id"> <id property="id" column="id" jdbcType="VARCHAR"/> <result property="name" column="name" jdbcType="VARCHAR"/> <result property="code" column="code" jdbcType="VARCHAR"/> <result property="description" column="description" jdbcType="VARCHAR"/> </collection> </resultMap> <sql id="Base_Column_List"> id,name,description </sql> <select id="queryRoleListByUserId" resultMap="BaseResultMap"> select distinct pr.* from pe_user_role pur inner join pe_role pr on pur.role_id =pr.id where pur.user_id =#{id} </select></mapper>
public interface PermissionMapper extends BaseMapper<Permission> { List<Permission> queryPermissionList(@Param("id") Long id);}
<?xml versinotallow="1.0" encoding="UTF-8"?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.zbbmeta.mapper.PermissionMapper"> <resultMap id="BaseResultMap" type="com.zbbmeta.entity.Permission"> <id property="id" column="id" jdbcType="VARCHAR"/> <result property="name" column="name" jdbcType="VARCHAR"/> <result property="code" column="code" jdbcType="VARCHAR"/> <result property="description" column="description" jdbcType="VARCHAR"/> </resultMap> <sql id="Base_Column_List"> id,name,code, description </sql> <select id="queryPermissionList" resultType="com.zbbmeta.entity.Permission"> select * from pe_permission pp inner join pe_role_permission prp on pp.id = prp.permission_id where prp.role_id=#{id} </select></mapper>
注意:不使用 WebSecurityConfigurerAdapter,因为WebSecurityConfigurerAdapter 从 Spring 2.7.0 中弃用
jwt: config: key: zbbmeta ttl: 3600
在com.zbbmeta.util包下创建JwtUtil类
package com.zbbmeta.util;import io.jsonwebtoken.*;import lombok.Data;import org.junit.platform.commons.logging.Logger;import org.junit.platform.commons.logging.LoggerFactory;import org.springframework.beans.factory.annotation.Value;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.security.core.Authentication;import org.springframework.stereotype.Component;import java.util.Date;import java.util.Map;/** * @author springboot葵花宝典 * @description: TODO */@Component@ConfigurationProperties("jwt.config")@Datapublic class JwtUtil { private String key; private long ttl; public String createJwt(String id, String subject, Map<String,Object> map){ long now = System.currentTimeMillis(); long exp = now+ttl*1000; JwtBuilder jwtBuilder =null; try { jwtBuilder = Jwts.builder().setId(id) .setSubject(subject) .setIssuedAt(new Date()) .signWith(SignatureAlgorithm.HS256, key); for (Map.Entry<String, Object> stringObjectEntry : map.entrySet()) { jwtBuilder.claim(stringObjectEntry.getKey(), stringObjectEntry.getValue()); } if (ttl > 0) { jwtBuilder.setExpiration(new Date(exp)); } }catch (Exception e){ System.err.println(e.getMessage()); } return jwtBuilder.compact(); } public Claims parseJWT(String token){ Claims claims = Jwts.parser() .setSigningKey(key) .parseClaimsJws(token).getBody(); return claims; }}
WebSecurityConfig类 是我们安全认证的关键。它为受保护的资源配置 cors、csrf、会话管理、规则。
package com.zbbmeta.config;import com.zbbmeta.filter.AuthTokenFilter;import com.zbbmeta.service.impl.UserDetailsServiceImpl;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.security.authentication.dao.DaoAuthenticationProvider;import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;import org.springframework.security.config.annotation.web.builders.HttpSecurity;import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;import org.springframework.security.config.http.SessionCreationPolicy;import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;import org.springframework.security.crypto.password.PasswordEncoder;import org.springframework.security.web.SecurityFilterChain;import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;/** * @author springboot葵花宝典 * @description: TODO */@Configuration@EnableWebSecuritypublic class WebSecurityConfig { @Autowired UserDetailsServiceImpl userDetailsService; @Autowired private AuthEntryPointJwt unauthorizedHandler; @Bean public AuthTokenFilter authTokenFilter() { return new AuthTokenFilter(); } @Bean public PasswordEncoder passwordEncoder() { return new BCryptPasswordEncoder(); } @Bean public DaoAuthenticationProvider authenticationProvider() { DaoAuthenticationProvider authProvider = new DaoAuthenticationProvider(); authProvider.setUserDetailsService(userDetailsService); authProvider.setPasswordEncoder(passwordEncoder()); return authProvider; } /** * 认证 * @param http * @return * @throws Exception */ @Bean public SecurityFilterChain filterChain(HttpSecurity http) throws Exception { http.cors().and().csrf().disable() .exceptionHandling().authenticationEntryPoint(unauthorizedHandler).and() .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS).and() .authorizeRequests().antMatchers("/api/auth/**").permitAll()//不需要通过登录验证就可以被访问的资源路径 .anyRequest().authenticated(); http.authenticationProvider(authenticationProvider()); http.addFilterBefore(authTokenFilter(), UsernamePasswordAuthenticationFilter.class); return http.build(); }}
注: 同样的在 Spring Security 5.8 后要把 antMatchers() 改为 requestMatchers()
在 com.zbbmeta.filter包下创建AuthTokenFilter类,对每个请求进行过滤。 AuthTokenFilter 集成 OncePerRequestFilter 和覆盖 doFilterInternal() 方法的类。
@Slf4jpublic class AuthTokenFilter extends OncePerRequestFilter { @Autowired private JwtUtil jwtUtil; @Autowired private UserDetailsService userDetailsService; @Override protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException { String requestURI = request.getRequestURI(); //登录或者注册放行 if(requestURI.contains("/api/auth")){ filterChain.doFilter(request, response); return ; } String authorization = request.getHeader("Authorization"); if(StrUtil.isNotBlank(authorization)){ String token = authorization.replace("Bearer ", ""); Claims claims = jwtUtil.parseJWT(token); String username = claims.get("username", String.class); UserDetails userDetails = userDetailsService.loadUserByUsername(username); UsernamePasswordAuthenticationToken authentication = new UsernamePasswordAuthenticationToken( userDetails, null, userDetails.getAuthorities()); authentication.setDetails(new WebAuthenticationDetailsSource().buildDetails(request)); SecurityContextHolder.getContext().setAuthentication(authentication); } filterChain.doFilter(request, response); }}
我们在里面 doFilterInternal() 做什么:
创建 AuthEntryPointJwt 实现接口的 AuthenticationEntryPoint 类。然后我们重写该 commence() 方法。每当未经身份验证的用户请求受保护的 HTTP 资源并 AuthenticationException 抛出时,都会触发此方法。
package com.zbbmeta.config;import com.fasterxml.jackson.databind.ObjectMapper;import lombok.extern.slf4j.Slf4j;import org.springframework.http.MediaType;import org.springframework.security.core.AuthenticationException;import org.springframework.security.web.AuthenticationEntryPoint;import org.springframework.stereotype.Component;import javax.servlet.ServletException;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import java.io.IOException;import java.util.HashMap;import java.util.Map;/** * @author springboot葵花宝典 * @description: TODO */@Slf4j@Componentpublic class AuthEntryPointJwt implements AuthenticationEntryPoint { @Override public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException authException) throws IOException, ServletException { log.error("Unauthorized error: {}", authException.getMessage()); response.setContentType(MediaType.APPLICATION_JSON_VALUE); response.setStatus(HttpServletResponse.SC_UNAUTHORIZED); final Map<String, Object> body = new HashMap<>(); body.put("code", HttpServletResponse.SC_UNAUTHORIZED); body.put("message", authException.getMessage()); body.put("path", request.getServletPath()); final ObjectMapper mapper = new ObjectMapper(); mapper.writeValue(response.getOutputStream(), body); }}
package com.zbbmeta.controller;import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;import com.zbbmeta.api.Result;import com.zbbmeta.api.ResultCode;import com.zbbmeta.dto.LoginDto;import com.zbbmeta.dto.SignupDto;import com.zbbmeta.entity.Permission;import com.zbbmeta.entity.Role;import com.zbbmeta.entity.User;import com.zbbmeta.entity.UserRole;import com.zbbmeta.service.RoleService;import com.zbbmeta.service.UserRoleService;import com.zbbmeta.service.UserService;import com.zbbmeta.util.JwtUtil;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.security.crypto.password.PasswordEncoder;import org.springframework.web.bind.annotation.PostMapping;import org.springframework.web.bind.annotation.RequestBody;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;import java.util.*;import java.util.stream.Collectors;/** * @author springboot葵花宝典 * @description: TODO */@RequestMapping("/api/auth")@RestControllerpublic class AuthController { @Autowired UserService userService; @Autowired RoleService roleService; @Autowired UserRoleService userRoleService; @Autowired PasswordEncoder passwordEncoder; @Autowired private JwtUtil jwtUtil; @PostMapping("/signin") public Result authenticateUser(@RequestBody LoginDto loginDto) { //根据用户名查找用户 User user = userService.findByName(loginDto.getUsername()); //不存在表示登录失败 if(Objects.isNull(user)){ return Result.FAIL(ResultCode.USERNOEXIT_ERROR); } //密码不同登录失败 if(!passwordEncoder.matches(loginDto.getPassword(),user.getPassword())){ return Result.FAIL(ResultCode.PASSWORD_ERROR); } List<String> collect = user.getRoles().stream().map(x -> x.getName()).collect(Collectors.toList()); StringBuilder builder = new StringBuilder(); List<Role> roles = user.getRoles(); for (Role role : roles) { List<Permission> permissions = role.getPermissions(); for (Permission permission : permissions) { builder.append(permission.getCode()).append(","); } } Map<String, Object> map = new HashMap<>(); map.put("username",user.getUsername()); map.put("permission",builder); String token = jwtUtil.createJwt(user.getId(), user.getUsername(), map); return Result.SUCCESS(token); } /** * 用户注册 * @param signupDto * @return */ @PostMapping("/signup") public Result registerUser( @RequestBody SignupDto signupDto){ //根据用户名获取用户 User user = userService.findByName(signupDto.getUsername()); //用户不是null表示用户已经存在 if(Objects.nonNull(user)){ return Result.FAIL(ResultCode.USER_ERROR); } //添加用户 User user1 = new User(); user1.setUsername(signupDto.getUsername()); user1.setPassword(signupDto.getPassword()); user1.setPassword(passwordEncoder.encode(signupDto.getPassword())); List<String> strRoles = signupDto.getRole(); List<Role> roles = new ArrayList<>(); //如果没有用户角色,默认添加普通员工 if (strRoles == null) { LambdaQueryWrapper<Role> wrapper = new LambdaQueryWrapper<>(); wrapper.eq(Role::getName,"普通员工"); Role role = roleService.getOne(wrapper); roles.add(role); }else { strRoles.forEach(role ->{ LambdaQueryWrapper<Role> wrapper = new LambdaQueryWrapper<>(); wrapper.eq(Role::getName,role); Role adminRole = roleService.getOne(wrapper); roles.add(adminRole); }); } //添加用户信息 boolean save = userService.save(user1); String id = user1.getId(); List<UserRole> userRolesList = new ArrayList<>(); for (Role role : roles) { UserRole userRoles = new UserRole(); userRoles.setUserId(id); userRoles.setRoleId(role.getId()); userRolesList.add(userRoles); } //添加用户和角色关系 userRoleService.saveBatch(userRolesList); return Result.SUCCESS("注册成功!"); }}
图片
注册后的pe_user表格数据如下所示:
图片
图片
因为我们没有登录,所以受保护的资源不能访问
图片
图片
今天,我们在Spring Boot示例中学到关于Spring Security和基于JWT令牌的身份验证的有趣知识。尽管我们写了很多代码,但我希望你能理解应用程序的整体架构,并轻松地将其应用到你的项目中。
## 代码地址https://github.com/bangbangzhou/spring-boot-backend-example.git
本文链接:http://www.28at.com/showinfo-26-40684-0.htmlSpring Boot Security + JWT Token 的简单应用
声明:本网页内容旨在传播知识,若有侵权等问题请及时与本网联系,我们将在第一时间删除处理。邮件:2376512515@qq.com