day16 团队空间模块
团队空间
一、需求分析
1、创建团队空间
用户最多只能创建一个团队空间,用户团队协作和资源共享,空间管理员拥有私有空间的所有能力,
包括上传图片,检索图片,管理类图片,分析图片
2、成员用户管理
- 邀请成员加入队伍:空间管理员可以邀请新成员加入团队
- 设置权限:空间管理员可以设置不同角色(如查看者、编辑者、管理员),控制成员的权限范围。
3、空间权限控制
仅特定成员可以访问或者操作空间图片
4、空间数据管理
考虑到团队空间图片的数量可能比较多,可以对旗舰版的团队空间的数据单独管理,而不是和公共图片、私有图片混在一起
二、方案设计
创建团队空间
给空间表增加一个字段spaceType,用于区分私有空间和团队空间
▼sql复制代码ALTER TABLE space ADD COLUMN spaceType int default 0 not null comment '空间类型:0-私有 1-团队'; CREATE INDEX idx_spaceType ON space (spaceType);
成员用户管理
分析:
为了减少对源代码的更改,我们约定只有团队空间从才有成员的概念
1)成员邀请:空间管理员可以直接输入成员 id 来添加新成员,无需该用户确认,这样可以提高开发效率。
2)设置权限:空间管理员可以为已加入成员设置不同的角色,控制成员的权限范围,类似于编辑成员信息。
库设计表
▼sql复制代码-- 空间成员表 create table if not exists space_user ( id bigint auto_increment comment 'id' primary key, spaceId bigint not null comment '空间 id', userId bigint not null comment '用户 id', spaceRole varchar(128) default 'viewer' null comment '空间角色:viewer/editor/admin', createTime datetime default CURRENT_TIMESTAMP not null comment '创建时间', updateTime datetime default CURRENT_TIMESTAMP not null on update CURRENT_TIMESTAMP comment '更新时间', -- 索引设计 UNIQUE KEY uk_spaceId_userId (spaceId, userId), -- 唯一索引,用户在一个空间中只能有一个角色 INDEX idx_spaceId (spaceId), -- 提升按空间查询的性能 INDEX idx_userId (userId) -- 提升按用户查询的性能 ) comment '空间用户关联' collate = utf8mb4_unicode_ci;
注意:
给spaceId和userId添加唯一索引,表示一个用户只能添加一次这个空间
这里就不用逻辑删除,因为添加了唯一索引,防止用户退出isDelect为1,但是库表还有这条数据,如果没有及时清理用户无法再次加入
成员用户管理
RBAC权限控制
对于复杂的权限控制场景,我们可以使用RBAC权限控制模型(基于角色的访问控制,Role-Based Accsee Control),核心概念包括:用户、角色、权限
我理解就是,一个用户多个角色,一个角色多个权限,不只是简简单单的权限逻辑
一般来说,标准的 RBAC 实现需要 5 张表:用户表、角色表、权限表、用户角色关联表、角色权限关联表,还是有一定开发成本的。由于我们的项目中,团队空间不需要那么多角色,可以简化 RBAC 的实现方式,比如将角色和权限直接定义到配置文件中。
角色和权限的定义
本项目的角色:
| 角色 | 描述 |
|---|---|
| 浏览者 | 仅可查看空间中的图片内容 |
| 编辑者 | 可查看、上传和编辑图片内容 |
| 管理员 | 拥有管理空间和成员的所有权限 |
本项目的权限:
| 权限键 | 功能名称 | 描述 |
|---|---|---|
| spaceUser:manage | 成员管理 | 管理空间成员,添加或移除成员 |
| picture:view | 查看图片 | 查看空间中的图片内容 |
| picture:upload | 上传图片 | 上传图片到空间中 |
| picture:edit | 修改图片 | 编辑已上传的图片信息 |
| picture:delete | 删除图片 | 删除空间中的图片 |
角色与权限映射:
| 角色 | 对应权限键 | 可执行功能 |
|---|---|---|
| 浏览者 | picture:view | 查看图片 |
| 编辑者 | picture:view, picture:upload, picture:edit, picture:delete | 查看图片、上传图片、修改图片、删除图片 |
| 管理员 | spaceUser:manage, picture:view, picture:upload, picture:edit, picture:delete | 成员管理、查看图片、上传图片、修改图片、删除图片 |
权限校验实现方案
1)自定义注解+AOP切面
2)使用第三方权限校验框架(Sa-Token)
空间数据管理
图片信息数据表
可以给每个团队空间单独创建一张图片表 picture_{spaceId},也就是分库分表中的 分表,而不是和公共图库、私有空间的图片混在一起。这样不仅查询空间内的图片效率更高,还便于整体管理和清理空间。但是要注意,仅对旗舰版空间生效,否则分表的数量会特别多,反而可能影响性能。
图片文件上传
已经对每个图片空间图片存到不同路径
三、后端开发
创建团队空间
1、数据模型
添加字段
▼java复制代码/** * 空间类型:0-私有 1-团队 */ private Integer spaceType;
设置枚举值
▼java复制代码/** * 空间类型枚举:0-私有空间 1-团队空间 */ @Getter public enum SpaceTypeEnum { PRIVATE(0, "私有空间"), TEAM(1, "团队空间"); private final Integer code; private final String description; SpaceTypeEnum(Integer code, String description) { this.code = code; this.description = description; } /** * 根据code获取描述 * * @param code * @return */ public static String getDescriptionByCode(Integer code) { for (SpaceTypeEnum type : SpaceTypeEnum.values()) { if (type.getCode().equals(code)) { return type.getDescription(); } } return null; } }
2、创建空间
dto
▼java复制代码/** * 空间类型:0-私有 1-团队 */ private Integer spaceType;
service
▼java复制代码Integer spaceLevel = space.getSpaceLevel(); if(spaceLevel == null){ space.setSpaceLevel(SpaceLevelEnum.COMMON.getKey()); } Integer spaceType = space.getSpaceType(); if(spaceType == null){ // 默认为普通版 space.setSpaceType(SpaceLevelEnum.COMMON.getKey()); } // 添加参数 this.fillSpaceBySpaceLevel(space);
修改校验参数
▼java复制代码public void validSpace(Space space, boolean isAdd) { ThrowUtils.throwIf(space==null, ErrorCode.PARAMS_ERROR); String spaceName = space.getSpaceName(); Integer spaceLevel = space.getSpaceLevel(); Integer spaceType = space.getSpaceType(); String spaceTypeEunm = SpaceTypeEnum.getDescriptionByCode(spaceType); SpaceLevelEnum spaceLevelEnum = SpaceLevelEnum.getEnumByKey(spaceLevel); // 要创建 if (isAdd) { if (StrUtil.isBlank(spaceName)) { throw new BusinessException(ErrorCode.PARAMS_ERROR, "空间名称不能为空"); } if (spaceLevel== null) { throw new BusinessException(ErrorCode.PARAMS_ERROR, "空间级别不能为空"); } if (spaceType == null) { throw new BusinessException(ErrorCode.PARAMS_ERROR, "空间类型不能为空"); } } // 修改数据时,如果要改空间级别 if (spaceLevel != null && spaceLevelEnum == null) { throw new BusinessException(ErrorCode.PARAMS_ERROR, "空间级别不存在"); } if (StrUtil.isNotBlank(spaceName) && spaceName.length() > 30) { throw new BusinessException(ErrorCode.PARAMS_ERROR, "空间名称过长"); } if(spaceTypeEunm == null && spaceType != null){ throw new BusinessException(ErrorCode.PARAMS_ERROR, "空间类型不存在"); } }
控制每个用户只能每类空间只能创建一个
▼java复制代码// 4、控制同一用户只能创建一个私有空间和团队空间 if (!userService.isAdmin(loginUser)) { boolean exists = this.lambdaQuery() .eq(Space::getUserId, loginUser.getId()) .eq(Space::getSpaceType, space.getSpaceType()) .exists(); ThrowUtils.throwIf(exists, ErrorCode.OPERATION_ERROR, "每个用户每类空间仅能创建一个"); } // 写入数据库 boolean result = save(space); ThrowUtils.throwIf(!result, ErrorCode.SYSTEM_ERROR, "添加空间失败"); return space.getId();
3、查询空间队伍
▼java复制代码// 查询条件 Long id = spaceQueryRequest.getId(); String spaceName = spaceQueryRequest.getSpaceName(); Integer spaceLevel = spaceQueryRequest.getSpaceLevel(); Long userId = spaceQueryRequest.getUserId(); Integer spaceType = spaceQueryRequest.getSpaceType(); String sortField = spaceQueryRequest.getSortField(); String sortOrder = spaceQueryRequest.getSortOrder(); // 拼接查询条件 queryWrapper.eq(ObjUtil.isNotEmpty(id), "id", id); queryWrapper.eq(ObjUtil.isNotEmpty(spaceType), "spaceType", spaceType); queryWrapper.like(StrUtil.isNotBlank(spaceName), "spaceName", spaceName); queryWrapper.eq(ObjUtil.isNotEmpty(spaceLevel), "spaceLevel", spaceLevel); queryWrapper.eq(ObjUtil.isNotEmpty(userId), "userId", userId);
空间成员管理
1、数据模型
略
2、基础服务开发
▼java复制代码package com.larly.larlypicturebackend.service; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import com.baomidou.mybatisplus.extension.service.IService; import com.larly.larlypicturebackend.model.domain.Space; import com.larly.larlypicturebackend.model.domain.SpaceUser; import com.larly.larlypicturebackend.model.domain.User; import com.larly.larlypicturebackend.model.dto.spaceuser.SpaceUserAddRequest; import com.larly.larlypicturebackend.model.dto.spaceuser.SpaceUserQueryRequest; import com.larly.larlypicturebackend.model.vo.SpaceUserVO; import java.util.List; /** * @author 许颢达 * @description 针对表【space_user(空间用户关联)】的数据库操作Service * @createDate 2025-06-13 14:22:45 */ public interface SpaceUserService extends IService<SpaceUser> { /** * 用户加入队伍 * * @param spaceUserAddRequest 用户加入队伍请求 * @param userLogin 用户 * @return 用户队伍id */ Long joinSpace(SpaceUserAddRequest spaceUserAddRequest, User userLogin); /** * 获取查询条件 * * @param spaceUserQueryRequest 查询条件 * @return 查询条件 */ QueryWrapper<SpaceUser> getQueryWrapper(SpaceUserQueryRequest spaceUserQueryRequest); /** * 获取空间用户信息 * * @param spaceUser 空间用户 * @param loginUser 用户 * @return 空间用户信息 */ SpaceUserVO getSpaceUserVO(SpaceUser spaceUser, User loginUser); /** * 获取空间用户信息列表 * * @param spaceUserList 空间用户列表 * @return 空间用户信息列表 */ List<SpaceUserVO> getSpaceUserVOPage(List<SpaceUser> spaceUserList); /** * 校验参数 * * @param spaceuser 空间 * @param isAdd 是否添加 */ void validSpaceUser(SpaceUser spaceuser, boolean isAdd); }
▼java复制代码package com.larly.larlypicturebackend.service.impl; import cn.hutool.core.util.ObjUtil; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl; import com.larly.larlypicturebackend.enums.SpaceRoleEnum; import com.larly.larlypicturebackend.exception.BusinessException; import com.larly.larlypicturebackend.exception.ErrorCode; import com.larly.larlypicturebackend.exception.ThrowUtils; import com.larly.larlypicturebackend.model.domain.Space; import com.larly.larlypicturebackend.model.domain.SpaceUser; import com.larly.larlypicturebackend.mapper.SpaceUserMapper; import com.larly.larlypicturebackend.model.domain.User; import com.larly.larlypicturebackend.model.dto.spaceuser.SpaceUserAddRequest; import com.larly.larlypicturebackend.model.dto.spaceuser.SpaceUserQueryRequest; import com.larly.larlypicturebackend.model.vo.SpaceUserVO; import com.larly.larlypicturebackend.model.vo.SpaceVO; import com.larly.larlypicturebackend.service.SpaceService; import com.larly.larlypicturebackend.service.SpaceUserService; import com.larly.larlypicturebackend.service.UserService; import org.springframework.beans.BeanUtils; import org.springframework.stereotype.Service; import javax.annotation.Resource; import java.util.*; import java.util.stream.Collectors; /** * @author 许颢达 * @description 针对表【space_user(空间用户关联)】的数据库操作Service实现 * @createDate 2025-06-13 14:22:45 */ @Service public class SpaceUserServiceImpl extends ServiceImpl<SpaceUserMapper, SpaceUser> implements SpaceUserService { @Resource private UserService userService; @Resource private SpaceService spaceService; /** * 加入空间 * * @param spaceUserAddRequest * @param userLogin * @return */ @Override public Long joinSpace(SpaceUserAddRequest spaceUserAddRequest, User userLogin) { // 参数校验 ThrowUtils.throwIf(spaceUserAddRequest == null, ErrorCode.PARAMS_ERROR); SpaceUser spaceUser = new SpaceUser(); BeanUtils.copyProperties(spaceUserAddRequest, spaceUser); validSpaceUser(spaceUser, true); // 数据库操作 boolean result = this.save(spaceUser); ThrowUtils.throwIf(!result, ErrorCode.OPERATION_ERROR); return spaceUser.getId(); } @Override public QueryWrapper<SpaceUser> getQueryWrapper(SpaceUserQueryRequest spaceUserQueryRequest) { QueryWrapper<SpaceUser> queryWrapper = new QueryWrapper<>(); if( spaceUserQueryRequest == null){ return queryWrapper; } // 获取所有字段 Long id = spaceUserQueryRequest.getId(); Long spaceId = spaceUserQueryRequest.getSpaceId(); Long userId = spaceUserQueryRequest.getUserId(); String spaceRole = spaceUserQueryRequest.getSpaceRole(); // 模糊查询 queryWrapper.eq(ObjUtil.isNotNull(id), "id", id); queryWrapper.eq(ObjUtil.isNotNull(spaceId), "spaceId", spaceId); queryWrapper.eq(ObjUtil.isNotNull(userId), "userId", userId); queryWrapper.eq(ObjUtil.isNotEmpty(spaceRole), "spaceRole", spaceRole); return queryWrapper; } @Override public SpaceUserVO getSpaceUserVO(SpaceUser spaceUser, User loginUser) { if(spaceUser == null){ return null; } SpaceUserVO spaceUserVO = SpaceUserVO.ObjToVO(spaceUser); Long spaceId = spaceUser.getSpaceId(); Space space = spaceService.getById(spaceId); spaceUserVO.setSpaceVO(spaceService.getSpaceVO(space, loginUser)); Long userId = spaceUser.getUserId(); User user = userService.getById(userId); spaceUserVO.setUserVO(userService.userToUserVo(user)); return spaceUserVO; } @Override public List<SpaceUserVO> getSpaceUserVOPage(List<SpaceUser> spaceUserList) { if (spaceUserList == null){ return new ArrayList<>(); } // 对象列表 => 封装对象列表 List<SpaceUserVO> spaceUserVOList = spaceUserList.stream().map(SpaceUserVO::ObjToVO).collect(Collectors.toList()); // 获取userId和spaceId的Set Set<Long> userIdSet = spaceUserList.stream().map(SpaceUser::getUserId).collect(Collectors.toSet()); Set<Long> spaceIdSet = spaceUserList.stream().map(SpaceUser::getSpaceId).collect(Collectors.toSet()); Map<Long, List<User>> userIdUserListMap = userService.listByIds(userIdSet).stream().collect(Collectors.groupingBy(User::getId)); Map<Long, List<Space>> spaceIdSpaceListMap = spaceService.listByIds(spaceIdSet).stream().collect(Collectors.groupingBy(Space::getId)); // 填充数据 spaceUserVOList.forEach(spaceUserVO -> { Long userId = spaceUserVO.getUserId(); // 填充用户信息 User user = null; if (userIdUserListMap.containsKey(userId)) { user = userIdUserListMap.get(userId).get(0); } spaceUserVO.setUserVO(userService.userToUserVo(user)); // 填充空间信息 Space space = null; if (spaceIdSpaceListMap.containsKey(space.getId())) { space = spaceIdSpaceListMap.get(space.getId()).get(0); } spaceUserVO.setSpaceVO(SpaceVO.ObjToVO(space)); }); return spaceUserVOList; } /** * 校验参数 * * @param spaceuser 空间 * @param isAdd 是否添加 */ @Override public void validSpaceUser(SpaceUser spaceuser, boolean isAdd) { ThrowUtils.throwIf(spaceuser == null, ErrorCode.PARAMS_ERROR); Long id = spaceuser.getId(); Long spaceId = spaceuser.getSpaceId(); Long userId = spaceuser.getUserId(); String spaceRole = spaceuser.getSpaceRole(); // 要创建 if (isAdd) { // 创建时候必须传递空间id和用户id ThrowUtils.throwIf(ObjUtil.hasEmpty(spaceId, userId), ErrorCode.PARAMS_ERROR); // 创建时,角色不能为空 User user = userService.getById(userId); ThrowUtils.throwIf(user == null, ErrorCode.PARAMS_ERROR); // 空间不能为空 Space space = spaceService.getById(spaceId); ThrowUtils.throwIf(space == null, ErrorCode.PARAMS_ERROR); } // 修改数据 String spaceRoleEunm = SpaceRoleEnum.getDescriptionByCode(spaceRole); if (id != null && spaceRoleEunm == null) { throw new BusinessException(ErrorCode.PARAMS_ERROR, "空间角色不存在"); } } }
3、接口开发
这里不需要权限校验
需要开发的接口包括:
- 添加成员到空间:仅拥有成员管理权限的用户可使用。
- 从空间移除成员:仅拥有成员管理权限的用户可使用。
- 查询某个成员在空间的信息:仅拥有成员管理权限的用户可使用。
- 查询空间成员列表:仅拥有成员管理权限的用户可使用。
- 编辑成员信息:仅拥有成员管理权限的用户可使用。
- 查询我加入的团队空间列表:所有已登录用户可使用。
▼java复制代码@RestController @RequestMapping("/spaceUser") public class SpaceUserConatroller { @Resource private SpaceUserService spaceUserService; @Resource private UserService userService; /** * 用户加入团队空间 * * @param spaceUserAddRequest * @param request * @return */ @PostMapping("/add") public BaseResponse<Long> addSpaceUser(@RequestBody SpaceUserAddRequest spaceUserAddRequest, HttpServletRequest request) { ThrowUtils.throwIf(spaceUserAddRequest == null, ErrorCode.PARAMS_ERROR); User loginUser = userService.getLoginUser(request); Long l = spaceUserService.joinSpace(spaceUserAddRequest, loginUser); return ResultUtils.success(l); } /** * 移除空间成员(管理员) * * @param deleteRequest * @param request * @return */ @PostMapping("/delete") public BaseResponse<Boolean> deleteSpaceUser(@RequestBody DeleteRequest deleteRequest, HttpServletRequest request) { ThrowUtils.throwIf(deleteRequest == null || deleteRequest.getId() <= 0, ErrorCode.PARAMS_ERROR); Long id = deleteRequest.getId(); // 判断有没有该数据 SpaceUser spaceUser = spaceUserService.getById(id); ThrowUtils.throwIf(spaceUser == null, ErrorCode.NOT_FOUND_ERROR,"没有该成员加入队伍信息"); // 操作数据库 boolean result = spaceUserService.removeById(id); ThrowUtils.throwIf(!result, ErrorCode.OPERATION_ERROR); return ResultUtils.success(true); } /** * 查询某个成员在空间的信息(管理员) * * @param id * @return */ @GetMapping("/get") public BaseResponse<SpaceUser> getSpaceUserById(long id) { ThrowUtils.throwIf(id <= 0, ErrorCode.PARAMS_ERROR); SpaceUser spaceUser = spaceUserService.getById(id); ThrowUtils.throwIf(spaceUser == null, ErrorCode.NOT_FOUND_ERROR); return ResultUtils.success(spaceUser); } /** * 获取用户空间列表(管理员) * * @param spaceUserQueryRequest * @return */ @PostMapping("/list") public BaseResponse<List<SpaceUserVO>> listSpaceUser(@RequestBody SpaceUserQueryRequest spaceUserQueryRequest) { ThrowUtils.throwIf(spaceUserQueryRequest == null, ErrorCode.PARAMS_ERROR); QueryWrapper<SpaceUser> queryWrapper = spaceUserService.getQueryWrapper(spaceUserQueryRequest); List<SpaceUser> spaceUserList = spaceUserService.list(queryWrapper); List<SpaceUserVO> result = spaceUserService.getSpaceUserList(spaceUserList); return ResultUtils.success(result); } /** * 编辑成员信息(设置权限) */ @PostMapping("/edit") public BaseResponse<Boolean> editSpaceUser(@RequestBody SpaceUserEditRequest spaceUserEditRequest, HttpServletRequest request) { if (spaceUserEditRequest == null || spaceUserEditRequest.getId() <= 0) { throw new BusinessException(ErrorCode.PARAMS_ERROR); } // 将实体类和 DTO 进行转换 SpaceUser spaceUser = new SpaceUser(); BeanUtils.copyProperties(spaceUserEditRequest, spaceUser); // 数据校验 spaceUserService.validSpaceUser(spaceUser, false); // 判断是否存在 long id = spaceUserEditRequest.getId(); SpaceUser oldSpaceUser = spaceUserService.getById(id); ThrowUtils.throwIf(oldSpaceUser == null, ErrorCode.NOT_FOUND_ERROR); // 操作数据库 boolean result = spaceUserService.updateById(spaceUser); ThrowUtils.throwIf(!result, ErrorCode.OPERATION_ERROR); return ResultUtils.success(true); } /** * 查询我加入的团队空间列表 */ @PostMapping("/list/my") public BaseResponse<List<SpaceUserVO>> listMyTeamSpace(HttpServletRequest request) { User loginUser = userService.getLoginUser(request); SpaceUserQueryRequest spaceUserQueryRequest = new SpaceUserQueryRequest(); spaceUserQueryRequest.setUserId(loginUser.getId()); List<SpaceUser> spaceUserList = spaceUserService.list( spaceUserService.getQueryWrapper(spaceUserQueryRequest) ); return ResultUtils.success(spaceUserService.getSpaceUserList(spaceUserList)); } }
4、修改创建空间逻辑
如果创建的是团队空间,创建人就是admin
▼java复制代码// 如果创建的是团队空间,默认角色为管理员 SpaceUser spaceUser = new SpaceUser(); if(space.getSpaceType().equals(SpaceTypeEnum.TEAM.getCode())){ spaceUser.setSpaceId(space.getId()); spaceUser.setUserId(loginUser.getId()); spaceUser.setSpaceRole(SpaceRoleEnum.ADMIN.getCode()); } boolean save = spaceUserService.save(spaceUser); ThrowUtils.throwIf(!save, ErrorCode.OPERATION_ERROR, "创建空间用户信息失败");
扩展
1)添加成员到空间时,可以支持发送邀请和审批。sOhs061JZxqyrARRaCJ4cm833ysiuDZnEJDv4hrxDjg=
实现思路:给空间成员表新增一个邀请确认状态的字段
2)由于空间管理员可能有多个,空间成员表可以补充添加成员至空间的邀请人字段(createUserId)
3)空间成员操作执行前可以补充一些校验,比如:iNKoDGqbIh805lN5ucH8qGFcOl4BY1c1X2HNtgHSLRs=
- 只有已经是空间成员,才能被移除或编辑
- 如果编辑后的角色跟之前一致,就不用更新
空间成员权限控制
1、定义权限
根据 RBAC 权限模型,需要定义角色和权限。
1)此处选用 JSON 配置文件来定义角色、权限、角色和权限之间的关系,相比从数据库表中获取,实现更方便,查询也更高效。
▼text复制代码{ "permissions": [ { "key": "spaceUser:manage", "name": "成员管理", "description": "管理空间成员,添加或移除成员" }, { "key": "picture:view", "name": "查看图片", "description": "查看空间中的图片内容" }, { "key": "picture:upload", "name": "上传图片", "description": "上传图片到空间中" }, { "key": "picture:edit", "name": "修改图片", "description": "编辑已上传的图片信息" }, { "key": "picture:delete", "name": "删除图片", "description": "删除空间中的图片" } ], "roles": [ { "key": "viewer", "name": "浏览者", "permissions": [ "picture:view" ], "description": "查看图片" }, { "key": "editor", "name": "编辑者", "permissions": [ "picture:view", "picture:upload", "picture:edit", "picture:delete" ], "description": "查看图片、上传图片、修改图片、删除图片" }, { "key": "admin", "name": "管理员", "permissions": [ "spaceUser:manage", "picture:view", "picture:upload", "picture:edit", "picture:delete" ], "description": "成员管理、查看图片、上传图片、修改图片、删除图片" } ] }
2)数据模型
▼java复制代码@Data public class SpaceUserAuthConfig implements Serializable { /** * 权限列表 */ private List<SpaceUserPermission> permissions; /** * 角色列表 */ private List<SpaceUserRole> roles; private static final long serialVersionUID = 1L; }
空间成员权限
▼java复制代码@Data public class SpaceUserPermission implements Serializable { /** * 权限键 */ private String key; /** * 权限名称 */ private String name; /** * 权限描述 */ private String description; private static final long serialVersionUID = 1L; }
空间成员角色
▼java复制代码@Data public class SpaceUserRole implements Serializable { /** * 角色键 */ private String key; /** * 角色名称 */ private String name; /** * 权限键列表 */ private List<String> permissions; /** * 角色描述 */ private String description; private static final long serialVersionUID = 1L; }
3)定义空间成员权限常量类,便于后续校验权限使用
▼java复制代码public interface SpaceUserPermissionConstant { /** * 空间用户管理权限 */ String SPACE_USER_MANAGE = "spaceUser:manage"; /** * 图片查看权限 */ String PICTURE_VIEW = "picture:view"; /** * 图片上传权限 */ String PICTURE_UPLOAD = "picture:upload"; /** * 图片编辑权限 */ String PICTURE_EDIT = "picture:edit"; /** * 图片删除权限 */ String PICTURE_DELETE = "picture:delete"; }
4)SpaceUserAuthManager,可加载配置文件到对象,并提供根据角色获取权限列表的方法。
▼java复制代码@Component public class SpaceUserAuthManager { @Resource private SpaceUserService spaceUserService; @Resource private UserService userService; public static final SpaceUserAuthConfig SPACE_USER_AUTH_CONFIG; static { String json = ResourceUtil.readUtf8Str("biz/spaceUserAuthConfig.json"); SPACE_USER_AUTH_CONFIG = JSONUtil.toBean(json, SpaceUserAuthConfig.class); } /** * 根据角色获取权限列表 */ public List<String> getPermissionsByRole(String spaceUserRole) { if (StrUtil.isBlank(spaceUserRole)) { return new ArrayList<>(); } // 找到匹配的角色 SpaceUserRole role = SPACE_USER_AUTH_CONFIG.getRoles().stream() .filter(r -> spaceUserRole.equals(r.getKey())) .findFirst() .orElse(null); if (role == null) { return new ArrayList<>(); } return role.getPermissions(); } }
2、Sa-Token
1)引入
▼xml复制代码<!-- Sa-Token 权限认证,在线文档:https://sa-token.cc --> <dependency> <groupId>cn.dev33</groupId> <artifactId>sa-token-spring-boot-starter</artifactId> <version>1.44.0</version> </dependency>
Sa-Token 默认将数据保存在内存中,此模式读写速度最快,且避免了序列化与反序列化带来的性能消耗,但是此模式也有一些缺点,比如:
- 重启后数据会丢失。
- 无法在分布式环境中共享数据。
为此,Sa-Token 提供了扩展接口,你可以轻松将会话数据存储在一些专业的缓存中间件上(比如 Redis), 做到重启数据不丢失,而且保证分布式环境下多节点的会话一致性。
Redis
▼xml复制代码<!-- Sa-Token 整合 RedisTemplate --> <dependency> <groupId>cn.dev33</groupId> <artifactId>sa-token-redis-template</artifactId> <version>1.44.0</version> </dependency> <!-- 提供 Redis 连接池 --> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-pool2</artifactId> </dependency>
需要配置redis
▼yml复制代码spring: # redis配置 redis: # Redis数据库索引(默认为0) database: 1 # Redis服务器地址 host: 127.0.0.1 # Redis服务器连接端口 port: 6379 # Redis服务器连接密码(默认为空) # password: # 连接超时时间 timeout: 10s lettuce: pool: # 连接池最大连接数 max-active: 200 # 连接池最大阻塞等待时间(使用负值表示没有限制) max-wait: -1ms # 连接池中的最大空闲连接 max-idle: 10 # 连接池中的最小空闲连接 min-idle: 0
▼java复制代码// 保存用户登陆态 // request.getSession().setAttribute(UserConstants.USER_LOGIN_STATE, user); StpUtil.login(user.getId()); StpUtil.getSession().set(UserConstants.USER_LOGIN_STATE, user);
2)基本用法
用户登录时候调用login
▼java复制代码StpUtil.login(10001);
还可以给会话保存信息
▼java复制代码StpUtil.getSession().set("user", user)
可以根据用户是否登录来获取信息
▼java复制代码// 检验当前会话是否已经登录, 如果未登录,则抛出异常:`NotLoginException` StpUtil.checkLogin(); // 获取用户信息 StpUtil.getSession().get("user");
也支持注解进行鉴权:
▼java复制代码// 登录校验:只有登录之后才能进入该方法 @SaCheckLogin @RequestMapping("info") public String info() { return "查询用户信息"; }
3、新建空间账号体系
有的时候,我们会在一个项目中设计两套账号体系,比如一个电商系统的 user表 和 admin表, 在这种场景下,如果两套账号我们都使用 StpUtil 类的API进行登录鉴权,那么势必会发生逻辑冲突。
假如说我们的 user表 和 admin表 都有一个 id=10001 的账号,它们对应的登录代码:StpUtil.login(10001) 是一样的, 那么问题来了:在StpUtil.getLoginId()获取到的账号id如何区分它是User用户,还是Admin用户?
你可能会想到为他们加一个固定前缀,比如StpUtil.login("User_" + 10001)、StpUtil.login("Admin_" + 10001),这样确实是可以解决问题的, 但是同样的:你需要在StpUtil.getLoginId()时再裁剪掉相应的前缀才能获取真正的账号id,这样一增一减就让我们的代码变得无比啰嗦。
对于我们的项目,有两套权限验证体系。对user表角色校验;另一套就是团队空间用户校验
为了更轻松地扩展项目,减少对原有代码的改动,我们原有的 user 表权限校验依然使用自定义注解 + AOP 的方式实现。而团队空间权限校验,采用 Sa-Token 来管理。
相当于我们不是整个项目都交给 Sa-Token,只是把 Sa-Token 当做实现团队空间权限管理的工具罢了
使用Sa-Token的多账号体系
1)Kit模式
每个 StpLogic 实例代表一个独立的账号体系,它们之间互不影响、互不干扰,因此: 每个账号体系都需要独立完成登录操作才能进行后续鉴权。
▼java复制代码/** * StpLogic 门面类,管理项目中所有的 StpLogic 账号体系 */ public class StpKit { public static final String SPACE_TYPE = "space"; /** * 默认原生会话对象, 原生的会话对象,默认使用 StpUtil.stpLogic */ public static final StpLogic DEFAULT = StpUtil.stpLogic; /** * Space 会话对象,管理 Space 表所有账号的登录、权限认证 */ public static final StpLogic SPACE = new StpLogic(SPACE_TYPE); }
▼java复制代码// 保存用户登陆态 request.getSession().setAttribute(UserConstants.USER_LOGIN_STATE, user); // StpUtil.login(user.getId()); // StpUtil.getSession().set(UserConstants.USER_LOGIN_STATE, user); // 每套账号体系都要登录,才能鉴权 StpKit.SPACE.login(user.getId()); StpKit.SPACE.getSession().set(UserConstants.USER_LOGIN_STATE, user); return result;
注意这里的session两个都要写的
前端cookie种下的是satoken和session,但是后端获取的时候不一样
session
▼java复制代码User loginUser = (User) request.getSession().getAttribute("yourKey");
satoken
▼java复制代码StpUtil.getSession().get("yourKey");
4、权限认证逻辑
Sa-Token有两种鉴权逻辑:
1、返回一个账号所拥有的权限码集合(通过权限)
2、返回一个账号所拥有的角色标识集合 (权限与角色可分开校验) (通过角色)
权限一般来说划分的更细,角色一般是用来权限校验不多
这里使用通过权限
▼java复制代码/** * 自定义权限加载接口实现类 */ @Component // 保证此类被 SpringBoot 扫描,完成 Sa-Token 的自定义权限验证扩展 public class StpInterfaceImpl implements StpInterface { /** * 返回一个账号所拥有的权限码集合 */ @Override public List<String> getPermissionList(Object loginId, String loginType) { // 本 list 仅做模拟,实际项目中要根据具体业务逻辑来查询权限 List<String> list = new ArrayList<String>(); list.add("101"); list.add("user.add"); list.add("user.update"); list.add("user.get"); // list.add("user.delete"); list.add("art.*"); return list; } /** * 返回一个账号所拥有的角色标识集合 (权限与角色可分开校验) */ @Override public List<String> getRoleList(Object loginId, String loginType) { // 本 list 仅做模拟,实际项目中要根据具体业务逻辑来查询角色 List<String> list = new ArrayList<String>(); list.add("admin"); list.add("super-admin"); return list; } }
观察上述代码我们会发现,getPermissionList 方法只提供了 loginId(登录用户 id)和 loginType(账号体系)两个参数。这会给我们造成很大的难度:
- 我们光有用户 id 是没办法进行权限校验的,因为我们要给图片操作和空间成员操作增加权限校验逻辑,还需要获取到空间 id,才知道用户是否具有某个团队空间的权限。那么如何获取到空间 id 呢?
- 如果要进行统一的权限校验,也包括了公共图库和私有空间,更要命的是,公共图库是没有空间 id 的!这就意味着要根据操作的图片情况动态判断。
所以我们要解决的关键问题有 2 个:
- 如何在 Sa-Token 中获取当前请求操作的参数?
- 如何编写一套权限校验逻辑,同时兼容公共图库、私有空间和团队空间?
