优雅使用枚举参数的Spring Boot

最新推荐文章于 2025-02-18 12:13:35 发布
最新推荐文章于 2025-02-18 12:13:35 发布
阅读量418 收藏
点赞数
CC 4.0 BY-SA版权
文章标签： spring boot python 后端 Spring_Boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/YmsNet/article/details/133675509
本文详细介绍了如何在Spring Boot应用中优雅地使用枚举参数，包括枚举类型的定义、在控制器中的使用、处理枚举参数的方法，以及这样做的优势，旨在提升代码可读性和可维护性。

Spring Boot 是一个流行的Java框架，可以帮助开发人员快速构建和部署应用程序。在Spring Boot中，枚举（Enum）参数的优雅使用可以提高代码的可读性和可维护性。本文将详细介绍如何在Spring Boot中优雅地使用枚举参数，并提供相应的源代码示例。

1. 枚举参数的定义

首先，我们需要定义一个枚举类型来表示参数的取值范围。假设我们的应用程序需要处理用户的角色信息，我们可以定义一个名为UserRole的枚举类型，如下所示：

public enum UserRole {
   
   
    ADMIN,
    USER,
    GUEST
}

在这个示例中，我们定义了三个角色：ADMIN、U

了解本专栏 订阅专栏 解锁全文
spring boot 优雅处理枚举映射(实现枚举类型自动转换)
专注于计算机研发知识和资讯分享
05-10 1337
EnumValue注解用于指定枚举类型字段的转换规则。mybatis-plus实现了对“实体类指定了枚举类型，查询时返回的是枚举值而非value值”，“插入数据时，实体赋值的是枚举类型，想入库时插入对应的value值”。通过在实体类枚举字段上添加 @EnumValue 注解，开发者可以轻松地实现枚举值与数据库字段的映射，避免了手动转换的繁琐步骤。注解是MyBatis Plus提供的一种注解,用于标识实体类中的枚举字段,指定枚举值与数据库字段之间的映射关系。是Mybatis-plus 下的枚举转换，要在。
spring boot 枚举使用的坑整理
08-25
Spring Boot 枚举使用的坑整理 Spring Boot 枚举使用的坑整理是指在使用 Spring Boot 枚举时可能出现的一些问题和解决方法的总结。枚举类型是一种特殊的数据类型，它具有固定的值，且这些值不会被修改。在 Java 中...
java enum 枚举的spring boot2.x完美实现demo源码
08-18
ava enum 枚举的spring boot2.x完美实现demo源码。java的枚举类型，可以理解为一种特殊的java类
SpringBoot 实战：优雅的使用枚举参数（原理篇）
沉潜飞动
08-16 4549
该图片由minka2507在Pixabay上发布 你好，我是看山。 SpringBoot 实战：优雅的使用枚举参数 中聊了怎么优雅的使用枚举参数，本文就来扒一扒 Spring 是如何找到对应转换器 Converter 的。 找入口 对 Spring 有一定基础的同学一定知道，请求入口是DispatcherServlet，所有的请求最终都会落到doDispatch方法中的ha.handle(processedRequest, response, mappedHandler.getHandler())逻..
springboot实现枚举参数
做一个有信仰de人的博客
07-17 884
是 Jackson JSON 处理库中的两个注解，它们用于在。过程中定制 Java 对象与 JSON 数据之间的映射。BaseEnum接口中。
SpringBoot 实战：优雅的使用枚举参数
沉潜飞动
08-10 6153
该图片由Sinousxl在Pixabay上发布 你好，我是看山。 接口开发过程中不免有表示类型的参数，比如 0 表示未知，1 表示男，2 表示女。通常有两种做法，一种是用数字表示，另一种是使用枚举实现。 使用数字表示就是通过契约形式，约定每个数字表示的含义，接口接收到参数，就按照约定对类型进行判断，接口维护成本比较大。 在 Spring 体系中，使用枚举表示，是借助 Spring 的 Converter 机制，可以将数字或字符串对应到枚举的序号或者 name，然后将前端的输入转换为枚举类型。 在场景..
SpringBoot 实战：优雅的使用枚举参数（原理篇）_springboot中枚举的使用
pCITv1C的博客
05-12 1569
就写到这了，也算是给这段时间的面试做一个总结，查漏补缺，祝自己好运吧，也希望正在求职或者打算跳槽的 程序员看到这个文章能有一点点帮助或收获，我就心满意足了。多思考，多问为什么。希望小伙伴们早点收到满意的offer!越努力越幸运！金九银十已经过了，就目前国内的面试模式来讲，在面试前积极的准备面试，复习整个 Java 知识体系将变得非常重要，可以很负责任的说一句，复习准备的是否充分，将直接影响你入职的成功率。
spring boot mybatis枚举映射示例代码
08-25
在Spring Boot集成MyBatis的项目中，我们经常会遇到实体类中的字段是枚举类型，而数据库中的对应字段是整型或字符串型的情况。这种情况下，我们需要进行枚举与数据库字段之间的映射处理，以便正确地保存和读取数据。...
SpringBoot绑定枚举参数
qq_25105163的博客
06-04 2019
一、概述 在利用Spring进行Web后台开发时，经常会遇到枚举类型的绑定问题。一般情况下，如果Spring接收到的参数值为字符串类型，Spring会根据枚举的值与传入的字符串进行对应。假设有如下枚举 清单1：枚举定义 public enum Season { Spring("春"),Summer("夏"),Autumn("秋"),Winter("冬"); } 那么，只要客户端在发送请求时，将参数的值设为MALE或FEMALE即可。请求类似如下形式： http://localhost:8080/hand
优雅地使用枚举参数，让项目Spring Boot项目更加优雅
java思维导图
02-18 1399
1.引言在开发 Spring Boot 应用时，我们常常需要使用枚举（Enum）类型来表示一组常量，比如状态、类型、角色等。Spring Boot 提供了多种方式来优雅地处理和使用枚举类型，尤其是当它们作为方法参数、请求参数或者返回值时。使用枚举的好处是可以避免魔法值（magic numbers）和硬编码字符串，同时使代码更加可读和易于维护。本文将深入探讨如何在 Spring Boot 项目...
SpringBoot 实战：在 RequestBody 中优雅的使用枚举参数（原理篇）
沉潜飞动
09-02 5148
该图片由Johnnys_pic在Pixabay上发布 你好，我是看山。 在优雅的使用枚举参数（原理篇）中我们聊过，Spring对于不同的参数形式，会采用不同的处理类处理参数，这种形式，有些类似于策略模式。将针对不同参数形式的处理逻辑，拆分到不同处理类中，减少耦合和各种if-else逻辑。本文就来扒一扒，RequestBody参数中使用枚举参数的原理。 找入口 对 Spring 有一定基础的同学一定知道，请求入口是DispatcherServlet，所有的请求最终都会落到doDispatch方法中的h..
SpringBoot枚举入参实战
还是要稳扎稳打
05-26 5709
前端使用枚举名进行参数传递比传统使用code[1,2,3,4,5]更具语义枚举是一个特殊的类，它表示一组有限的值。在Java中，枚举类型是用于定义命名常量的一种方式。枚举常量是静态的、最终的和公共的，它们可以在整个应用程序中使用，而且具有自己的名称和值。它是将常量分组为一组的一种方法。枚举可以作为常量池使用，这样可以提高代码的可读性和可维护性。枚举在Java中非常有用，因为它们可以减少代码中的硬编码，并使代码更加自然和易于理解。
SpringBoot自定义枚举类型参数校验
qq_35615632的博客
05-14 2036
String message() default "参数有误";Class
SpringBoot 实战：优雅的使用枚举参数（原理篇，最新JAVA面试合集
m0_58269520的博客
03-21 1040
看完美团、字节、腾讯这三家的面试问题，是不是感觉问的特别多，可能咱们又得开启面试造火箭、工作拧螺丝的模式去准备下一次的面试了。开篇有提及我可是足足背下了1000道题目，多少还是有点用的呢，我看了下，上面这些问题大部分都能从我背的题里找到的，所以今天给大家分享一下互联网工程师必备的面试1000题。注意不论是我说的互联网面试1000题，还是后面提及的算法与数据结构、设计模式以及更多的Java学习笔记等，皆可分享给各位朋友互联网工程师必备的面试1000题而且从上面三家来看，算法与数据结构是必备不可少的。
【Java】springboot 枚举参数
weixin_41979605的博客
11-30 2141
不过本次测试的是默认的springboot对枚举的处理逻辑，讨论未做额外处理的情况下，spring接口使用枚举的效果和问题。来实现 自定义转化逻辑，那么你想怎么处理参数就是你自己的事情了，可以做兼容处理，识别里面的值来转化成枚举而不限定name。然后手动调用接口，改变参数值，观察返回值和后台日志，打印出名称则表示获取到了对应的枚举，反之则未获取成功。默认spring的接口对枚举类型的接收处理逻辑比较简单，就是。测试非常简单，写一个接口三个枚举参数或三个接口三个枚举参数。
Spring Boot 使用枚举类型作为请求参数
热门推荐
weixin_41249041的博客
07-21 2万+
https://xkcoding.com/2019/01/30/spring-boot-request-use-enums-params.html 1. 场景 在我们实际开发中，枚举类型应用十分广泛，可以避免在项目中定义大量的『魔法值』变量。但是，在 web 开发中，如何将枚举对象作为请求参数传进 Controller，做到类型自动转换？直接使用@RequestParam和@Reques...
从零开始 Spring Boot 16：枚举
梦幻天空
08-05 2885
在开发Web应用时，无法避免的是会定义一些“离散值”，比如书籍类型，包含艺术、小说、工程书籍等。在数据库中，我们一般会使用整数来表示这些值，比如1代表小说，2代表艺术，3代表工程相关书籍等。但在代码中使用整数来表示类型可读性就很差了，以前一般使用类常量来表示这些值，但更好的做法是使用枚举。关于Java中枚举的基本知识，可以阅读。下面通过在我们的图书应用中引入枚举类型来说明如何在Spring Boot项目中使用枚举，以及相关的注意事项。下面的示例代码都将由中的最终代码修改而来，相关完整代码见。表的。...
springmvc 中model中放入枚举类型
baicp3的专栏
06-23 3555
我们直接看例子： Map mallMap = new HashMap(); mallMap.put(MallStatus.SELFMALL.toString(), MallStatus.SELFMALL.getValue()); mallMap.put(MallStatus.DELEGATIONMALL.toString(), MallStatus.DELEGATIONMALL.getV
spring boot枚举里使用ymal注入
最新发布
05-13
<think>好的，我现在需要解决用户的问题：如何在Spring Boot中通过YAML配置文件为枚举类型注入属性值。用户还希望有一个示例。 首先，我得回忆一下Spring Boot的配置注入机制。通常，我们会用@Value或者@ConfigurationProperties来注入配置值。不过枚举类型比较特殊，可能需要特别处理。 我记得@ConfigurationProperties可以将配置文件中的属性绑定到Java对象，包括嵌套的结构。对于枚举，可能需要将配置中的字符串映射到对应的枚举常量。比如，如果在YAML中配置了一个状态为"ACTIVE"，对应的枚举类中应该有一个ACTIVE的枚举实例。 接下来，我需要考虑如何将YAML中的值绑定到枚举字段。可能需要使用Spring的Relaxed Binding，或者自定义转换器。不过根据之前的经验，Spring Boot本身支持将字符串自动转换为枚举，只要字符串和枚举常量的名称匹配（不区分大小写）。比如，配置中的"active"会被转换为枚举类中的ACTIVE。 但用户可能希望注入的不只是枚举实例本身，可能还有枚举的其他属性。比如，枚举可能有额外的字段，比如code或description，这时候就需要在配置中指定这些字段的值，并通过构造函数或者setter方法注入。 例如，定义一个Status枚举，包含code和name字段，然后在YAML中配置某个键对应的code和name，如何将这些值注入到枚举实例中。这时候可能需要使用@ConfigurationProperties来绑定到一个POJO，其中包含这个枚举类型的属性，并设置相应的值。 不过，枚举在Java中是单例的，通常不能在运行时动态创建实例。所以，可能需要通过配置来选择一个已存在的枚举实例，而不是动态设置其属性。或者，如果枚举需要携带更多配置信息，可能需要将枚举与其他配置类结合使用。 比如，用户可能有一个枚举类型，比如LogLevel，包含DEBUG、INFO等，每个枚举实例有一个对应的颜色属性，需要在配置文件中指定每个LogLevel对应的颜色。这时候，可能需要一个配置类，将LogLevel与颜色映射起来，然后通过@ConfigurationProperties注入这个映射。 或者，用户希望根据配置的值来设置某个枚举类型的属性，比如在YAML中设置app.default-log-level: INFO，然后在Spring组件中使用这个值。这时候可以直接用@Value("${app.default-log-level}")来注入LogLevel类型的值，Spring会自动转换字符串到枚举。 现在，用户的具体需求可能是在配置文件中为枚举类型的属性赋值，或者为枚举实例本身的字段赋值。需要明确这两种情况的不同处理方式。 假设用户是想在配置中指定某个枚举实例，并将其注入到Bean中。例如： YAML配置： app: default-status: ACTIVE 枚举定义： public enum Status { ACTIVE, INACTIVE } 然后在Bean中使用@Value("${app.default-status}") private Status status; 这样是可以的，因为Spring会自动转换字符串到枚举。 如果用户是想给枚举实例的字段赋值，比如每个枚举实例有额外的属性，比如： public enum Status { ACTIVE(1, "Active"), INACTIVE(0, "Inactive"); private int code; private String label; // 构造函数、getters等 } 这时候，用户可能希望在配置文件中为每个枚举实例的code或label提供值。但枚举的实例是在编译时确定的，不能在运行时通过配置文件修改它们的属性值。因此，这种情况可能需要另一种处理方式，比如使用一个配置类来映射这些值，而不是直接修改枚举实例。 例如，可以在YAML中配置： status: active: code: 1 label: Active inactive: code: 0 label: Inactive 然后定义一个配置类StatusProperties，使用@ConfigurationProperties(prefix = "status")，其中包含active和inactive的属性，然后在需要的地方注入StatusProperties，并根据枚举实例获取对应的配置值。 不过这可能与用户的问题不完全吻合。用户可能希望直接将配置值注入到枚举的实例属性中，这在Java中是不可能的，因为枚举实例是单例且在初始化时就确定了属性值，无法在运行时通过Spring的依赖注入来修改。 因此，正确的做法可能是将配置中的字符串值转换为枚举实例，或者将枚举与配置中的其他属性进行映射，而不是直接修改枚举的字段。 回到用户的问题，用户可能只是想通过配置来选择某个枚举值，例如设置默认的枚举选项。这时候，使用@Value或@ConfigurationProperties直接注入即可。 如果需要更复杂的配置，比如每个枚举实例对应多个属性，可能需要将配置信息存储在一个Map中，键为枚举的名称，值为对应的属性，然后在代码中根据枚举实例获取对应的配置值。 例如，YAML配置： app: status-config: ACTIVE: code: 1 label: Active INACTIVE: code: 0 label: Inactive 然后定义一个配置类： @ConfigurationProperties(prefix = "app.status-config") public class StatusConfig { private Map<Status, StatusProps> config; // getters and setters } public class StatusProps { private int code; private String label; // getters and setters } 这样，在需要的地方注入StatusConfig，然后通过config.get(Status.ACTIVE)来获取对应的属性。 不过这种情况下，枚举的实例属性还是固定的，只是在配置中有额外的属性与之关联。这可能更符合用户的需求。 总结一下，用户的问题可能有以下两种情况： 1. 通过配置文件选择某个枚举值，注入到Spring管理的Bean中。 - 使用@Value或@ConfigurationProperties，Spring自动转换字符串到枚举。 2. 为枚举类型的每个实例配置额外的属性，这些属性在运行时被使用。 - 需要将配置信息与枚举实例关联，可能需要通过配置类来映射。 根据用户提供的示例，他们可能想要第一种情况，或者第二种情况。 现在，我需要给出一个示例，展示如何在Spring Boot中使用YAML配置文件为枚举类型注入属性值。 假设用户想要注入某个枚举值到Bean中，示例可以是： 1. 在application.yml中定义配置： app: default-role: ADMIN 2. 定义枚举类型： public enum Role { ADMIN, USER, GUEST } 3. 在Bean中注入： @Component public class MyBean { @Value("${app.default-role}") private Role defaultRole; // ... } 这样，当配置中的app.default-role是"ADMIN"时，Spring会自动将其转换为Role.ADMIN。 如果用户想要更复杂的配置，比如为每个枚举实例配置额外的属性，例如： 在YAML中配置每个角色的描述： app: roles: ADMIN: description: 系统管理员 USER: description: 普通用户 GUEST: description: 访客 这时候，可以创建一个配置类： @ConfigurationProperties(prefix = "app.roles") public class RoleConfig { private Map<Role, RoleInfo> roleInfoMap; // getters and setters public static class RoleInfo { private String description; // getters and setters } } 然后，在需要的地方注入RoleConfig，并通过roleInfoMap.get(Role.ADMIN).getDescription()获取对应的描述。 这种情况下，枚举本身的属性（如name()或ordinal()）并没有改变，而是通过配置额外关联了信息。 用户可能需要的是第一种情况，即注入枚举值本身。或者第二种情况，关联额外属性。 根据用户的问题描述，他们可能希望将配置中的值注入到枚举类型的属性中，这可能需要更详细的示例。 例如，用户有一个枚举： public enum Status { ACTIVE("A", "Active"), INACTIVE("I", "Inactive"); private String code; private String displayName; // 构造函数、getters } 然后，在YAML中配置每个枚举实例的displayName： status: active: displayName: 激活状态 inactive: displayName: 未激活状态 然后，在配置类中映射这些值，并在代码中使用。但枚举实例的属性是固定的，无法通过配置动态修改，所以这种情况下，可能需要在配置类中创建一个Map来保存这些显示名称，而不是直接修改枚举的属性。 因此，正确的做法是使用配置类来保存这些额外的属性，然后在代码中根据枚举值获取对应的配置。 综上所述，用户可能需要一个示例，展示如何通过YAML配置注入枚举值到Spring Bean中，或者如何将配置中的属性与枚举实例关联。 现在，我需要根据上述分析，编写一个清晰的回答，包含示例代码和步骤，并生成相关问题。</think>在Spring Boot中通过YAML配置文件为枚举类型注入属性值，可以通过以下两种方式实现： ### 方式一：直接注入枚举值 当需要根据配置文件选择具体的枚举实例时，Spring Boot支持自动将字符串转换为枚举类型。 1. **YAML配置** ```yaml app: security: default-role: ADMIN # 直接指定枚举名称 ``` 2. **枚举定义** ```java public enum UserRole { ADMIN, EDITOR, VISITOR } ``` 3. **注入枚举值** ```java @Component @ConfigurationProperties(prefix = "app.security") public class SecurityConfig { private UserRole defaultRole; // Spring会自动将"ADMIN"转为UserRole.ADMIN // Getter/Setter省略 } ``` ### 方式二：关联枚举扩展属性 当需要为枚举实例关联额外配置属性时，可通过Map结构建立映射关系。 1. **YAML配置** ```yaml app: roles-config: ADMIN: level: 10 description: 系统管理员 EDITOR: level: 5 description: 内容编辑 ``` 2. **配置类定义** ```java @ConfigurationProperties(prefix = "app.roles-config") public class RoleProperties { private Map<UserRole, RoleDetail> roles = new HashMap<>(); // 嵌套配置类 public static class RoleDetail { private int level; private String description; // Getter/Setter省略 } // Getter/Setter省略 } ``` 3. **使用配置** ```java @Service public class AuthService { private final RoleProperties roleProperties; public AuthService(RoleProperties roleProperties) { this.roleProperties = roleProperties; } public void checkPermission(UserRole role) { RoleProperties.RoleDetail detail = roleProperties.getRoles().get(role); System.out.println("权限级别：" + detail.getLevel()); } } ``` ### 自动类型转换说明 Spring Boot默认支持以下格式的枚举转换： - 全大写：`ADMIN` - 驼峰式：`admin` - 带连字符：`sys-admin`（对应枚举`SYS_ADMIN`） [^1]: Spring Boot支持通过@ConfigurationProperties实现复杂对象绑定 [^3]: YAML配置与Java对象的深度绑定示例
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符  | 博主筛选后可见
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值