如何在 Spring REST 接口中安全校验字符串型枚举参数

冬静大大_3592

冬静大大_3592

2026-04-15

1017人浏览

原创

本文介绍如何对传入的字符串形式枚举值(如 "01"、"02")进行服务端校验,确保仅接受预定义的合法编码,拒绝非法输入(如 "09"),并提供基于 spring 的健壮实现方案。

本文介绍如何对传入的字符串形式枚举值(如 "01"、"02")进行服务端校验,确保仅接受预定义的合法编码,拒绝非法输入(如 "09"),并提供基于 spring 的健壮实现方案。

在 Spring Boot REST API 开发中,常需将外部传入的字符串(如 "01")映射为业务语义明确的枚举类型(如 Day.MONDAY)。但默认的 @RequestParam 或 @PathVariable 绑定无法自动识别自定义字符串值(如 "01" 对应 MONDAY),更无法拦截非法值(如 "09")——这会导致 IllegalArgumentException 或静默失败,存在严重校验漏洞。

✅ 正确做法:自定义反序列化 + 声明式校验

首先,修正原始枚举中的构造函数名错误(Event → Day),并补充静态查找方法:

public enum Day {
    MONDAY("01"),
    TUESDAY("02"),
    WEDNESDAY("03"),
    THURSDAY("04"),
    FRIDAY("05"),
    SATURDAY("06"),
    SUNDAY("07");

    private final String value;

    Day(String value) {  // 修正构造函数名
        this.value = value;
    }

    public String getValue() {
        return value;
    }

    // 安全查找:返回 Optional 避免 NPE
    public static Optional<day> fromValue(String value) {
        for (Day day : Day.values()) {
            if (day.value.equals(value)) {
                return Optional.of(day);
            }
        }
        return Optional.empty();
    }
}</day>

接着,在 Controller 层进行显式校验(推荐方式):

@RestController
@RequestMapping("/api")
public class DayController {

    @GetMapping("/schedule")
    public ResponseEntity<string> getSchedule(@RequestParam String dayCode) {
        // ✅ 强制校验:仅允许已定义的字符串值
        Optional<day> day = Day.fromValue(dayCode);
        if (day.isEmpty()) {
            return ResponseEntity.badRequest()
                .body("Invalid day code: '" + dayCode + "'. Allowed: 01-07");
        }

        // ✅ 后续业务逻辑使用 day.get()
        return ResponseEntity.ok("Scheduled for " + day.get());
    }
}</day></string>

⚠️ 注意事项与进阶建议

  • 不要依赖自动类型转换:Spring 默认不支持 String → Enum 按 value 字段匹配,盲目使用 @RequestParam Day day 会触发 MethodArgumentTypeMismatchException。
  • 避免 Integer.parseInt() 硬转:原答案建议“转成数字再校验”虽可行,但丢失了字符串前导零语义(如 "01" ≠ 1 在某些协议中),且增加冗余转换开销。
  • 增强可维护性:可结合 @Validated + 自定义 ConstraintValidator 实现注解驱动校验,适用于多处复用场景。
  • 统一错误响应:建议配合 @ControllerAdvice 全局捕获校验异常,返回结构化 JSON 错误(如 { "error": "INVALID_DAY_CODE", "details": "09 is not supported" })。

通过上述方式,你既能精准拦截非法输入(如 "09"),又能保持代码语义清晰、扩展性强,真正实现声明明确、校验可靠、错误友好的企业级 REST 参数验证。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9357

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6522

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5812

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1024

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

848

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1216

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2469

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19811

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1115

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习