Skip to content

Commit 83514b9

Browse files
committed
feat: 重构 CRUD API 权限控制,新增 CrudApiPermissionPrefixCache 缓存权限前缀
- 新增 CrudApiPermissionPrefixCache 类用于缓存 CRUD API权限前缀 - 修改 SaTokenConfiguration,为使用 @CrudRequestMapping 注解的 Controller缓存权限前缀 - 重构 BaseController 中的权限校验逻辑,使用缓存的权限前缀 - 更新 SmsConfigController 和 SmsLogController 中的 @CrudRequestMapping 注解路径
1 parent 5fded43 commit 83514b9

File tree

5 files changed

+98
-12
lines changed

5 files changed

+98
-12
lines changed

continew-common/src/main/java/top/continew/admin/common/base/controller/BaseController.java

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,9 @@
2222
import cn.dev33.satoken.sign.template.SaSignTemplate;
2323
import cn.dev33.satoken.stp.StpUtil;
2424
import cn.hutool.core.annotation.AnnotationUtil;
25-
import cn.hutool.core.text.CharSequenceUtil;
2625
import top.continew.admin.common.base.service.BaseService;
27-
import top.continew.starter.core.constant.StringConstants;
26+
import top.continew.admin.common.config.crud.CrudApiPermissionPrefixCache;
2827
import top.continew.starter.extension.crud.annotation.CrudApi;
29-
import top.continew.starter.extension.crud.annotation.CrudRequestMapping;
3028
import top.continew.starter.extension.crud.controller.AbstractCrudController;
3129
import top.continew.starter.extension.crud.enums.Api;
3230

@@ -64,11 +62,9 @@ public void preHandle(CrudApi crudApi, Object[] args, Method targetMethod, Class
6462
return;
6563
}
6664
// 校验权限,例如:创建用户接口(POST /system/user) => 校验 system:user:create 权限
67-
CrudRequestMapping crudRequestMapping = targetClass.getDeclaredAnnotation(CrudRequestMapping.class);
68-
String path = crudRequestMapping.value();
69-
String prefix = String.join(StringConstants.COLON, CharSequenceUtil.splitTrim(path, StringConstants.SLASH));
65+
String permissionPrefix = CrudApiPermissionPrefixCache.get(targetClass);
7066
String apiName = getApiName(crudApi.value());
71-
StpUtil.checkPermission("%s:%s".formatted(prefix, apiName.toLowerCase()));
67+
StpUtil.checkPermission("%s:%s".formatted(permissionPrefix, apiName.toLowerCase()));
7268
}
7369

7470
/**
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
/*
2+
* Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package top.continew.admin.common.config.crud;
18+
19+
import cn.hutool.core.util.StrUtil;
20+
import top.continew.starter.core.constant.StringConstants;
21+
22+
import java.util.HashMap;
23+
import java.util.List;
24+
import java.util.Map;
25+
26+
/**
27+
* CRUD API 权限前缀缓存
28+
*
29+
* @author Charles7c
30+
* @since 2025/7/24 22:14
31+
*/
32+
public class CrudApiPermissionPrefixCache {
33+
34+
private static final Map<Class<?>, String> PERMISSION_PREFIX_CACHE = new HashMap<>();
35+
36+
/**
37+
* 存储CRUD API权限前缀
38+
*
39+
* @param controllerClazz 控制器类
40+
* @param path 路径
41+
*/
42+
public static void put(Class<?> controllerClazz, String path) {
43+
String permissionPrefix = parsePermissionPrefix(path);
44+
PERMISSION_PREFIX_CACHE.put(controllerClazz, permissionPrefix);
45+
}
46+
47+
/**
48+
* 获取CRUD API权限前缀
49+
*
50+
* @param controllerClazz 控制器类
51+
* @return 权限前缀
52+
*/
53+
public static String get(Class<?> controllerClazz) {
54+
return PERMISSION_PREFIX_CACHE.get(controllerClazz);
55+
}
56+
57+
/**
58+
* 清空缓存
59+
*/
60+
public static void clear() {
61+
PERMISSION_PREFIX_CACHE.clear();
62+
}
63+
64+
/**
65+
* 解析权限前缀(解析路径获取模块名和资源名)
66+
*
67+
* <p>
68+
* 例如:/system/user => system:user <br>
69+
* /system/dict/item => system:dictItem
70+
* </p>
71+
*
72+
* @param path 路径
73+
* @return 权限前缀
74+
*/
75+
private static String parsePermissionPrefix(String path) {
76+
List<String> pathSegmentList = StrUtil.splitTrim(path, StringConstants.SLASH);
77+
if (pathSegmentList.size() < 2) {
78+
throw new IllegalArgumentException("无效的 @CrudRequestMapping 路径配置:" + path);
79+
}
80+
String moduleName = pathSegmentList.get(0);
81+
String resourceName = StrUtil.toCamelCase(String.join(StringConstants.UNDERLINE, pathSegmentList
82+
.subList(1, pathSegmentList.size())));
83+
return "%s:%s".formatted(moduleName, resourceName);
84+
}
85+
}

continew-server/src/main/java/top/continew/admin/config/satoken/SaTokenConfiguration.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
import org.springframework.context.annotation.Configuration;
3636
import org.springframework.context.event.EventListener;
3737
import org.springframework.core.annotation.AnnotationUtils;
38+
import top.continew.admin.common.config.crud.CrudApiPermissionPrefixCache;
3839
import top.continew.admin.common.context.UserContext;
3940
import top.continew.admin.common.context.UserContextHolder;
4041
import top.continew.admin.open.sign.OpenApiSignTemplate;
@@ -113,11 +114,15 @@ public void configureSaTokenExcludes() {
113114
if (AopUtils.isAopProxy(bean)) {
114115
clazz = AopProxyUtils.ultimateTargetClass(bean);
115116
}
116-
// 使用 @CrudRequestMapping 的 Controller,如果使用了 @SaIgnore 注解,则表示忽略校验
117+
// 使用 @CrudRequestMapping 的 Controller,如果使用了 @SaIgnore 注解,则表示忽略认证和权限校验
117118
CrudRequestMapping crudRequestMapping = AnnotationUtils.findAnnotation(clazz, CrudRequestMapping.class);
118119
SaIgnore saIgnore = AnnotationUtils.findAnnotation(clazz, SaIgnore.class);
119-
if (crudRequestMapping != null && saIgnore != null) {
120-
return crudRequestMapping.value() + StringConstants.PATH_PATTERN;
120+
if (crudRequestMapping != null) {
121+
if (saIgnore != null) {
122+
return crudRequestMapping.value() + StringConstants.PATH_PATTERN;
123+
}
124+
// 缓存权限前缀
125+
CrudApiPermissionPrefixCache.put(clazz, crudRequestMapping.value());
121126
}
122127
return null;
123128
}).filter(Objects::nonNull).toList();

continew-system/src/main/java/top/continew/admin/system/controller/SmsConfigController.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
*/
4242
@Tag(name = "短信配置管理 API")
4343
@RestController
44-
@CrudRequestMapping(value = "/system/smsConfig", api = {Api.PAGE, Api.GET, Api.CREATE, Api.UPDATE, Api.BATCH_DELETE})
44+
@CrudRequestMapping(value = "/system/sms/config", api = {Api.PAGE, Api.GET, Api.CREATE, Api.UPDATE, Api.BATCH_DELETE})
4545
public class SmsConfigController extends BaseController<SmsConfigService, SmsConfigResp, SmsConfigResp, SmsConfigQuery, SmsConfigReq> {
4646

4747
@Operation(summary = "设为默认配置", description = "设为默认配置")

continew-system/src/main/java/top/continew/admin/system/controller/SmsLogController.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@
3535
*/
3636
@Tag(name = "短信日志管理 API")
3737
@RestController
38-
@CrudRequestMapping(value = "/system/smsLog", api = {Api.PAGE, Api.GET, Api.BATCH_DELETE, Api.EXPORT})
38+
@CrudRequestMapping(value = "/system/sms/log", api = {Api.PAGE, Api.GET, Api.BATCH_DELETE, Api.EXPORT})
3939
public class SmsLogController extends BaseController<SmsLogService, SmsLogResp, SmsLogResp, SmsLogQuery, SmsLogReq> {
4040
}

0 commit comments

Comments
 (0)