使用枚举类

Python枚举类型详解

当我们需要定义常量时,一个办法是用大写变量通过整数来定义,例如月份:

JAN = 1
FEB = 2
MAR = 3
...
NOV = 11
DEC = 12
好处是简单,缺点是类型是int,并且仍然是变量。
更好的方法是为这样的枚举类型定义一个class类型,然后,每个常量都是class的一个唯一实例。Python提供了Enum类来实现这个功能:
from enum import Enum

Month = Enum('Month', ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'))
这样我们就获得了Month类型的枚举类,可以直接使用Month.Jan来引用一个常量,或者枚举它的所有成员:
for name, member in Month.__members__.items():
    print(name, '=>', member, ',', member.value)
value属性则是自动赋给成员的int常量,默认从1开始计数。
如果需要更精确地控制枚举类型,可以从Enum派生出自定义类:
from enum import Enum, unique

@unique
class Weekday(Enum):
    Sun = 0 # Sun的value被设定为0
    Mon = 1
    Tue = 2
    Wed = 3
    Thu = 4
    Fri = 5
    Sat = 6
@unique装饰器可以帮助我们检查保证没有重复值。
访问这些枚举类型可以有若干种方法:

>>> day1 = Weekday.Mon
>>> print(day1)
Weekday.Mon
>>> print(Weekday.Tue)
Weekday.Tue
>>> print(Weekday['Tue'])
Weekday.Tue
>>> print(Weekday.Tue.value)
2
>>> print(day1 == Weekday.Mon)
True
>>> print(day1 == Weekday.Tue)
False
>>> print(Weekday(1))
Weekday.Mon
>>> print(day1 == Weekday(1))
True
>>> Weekday(7)
Traceback (most recent call last):
  ...
ValueError: 7 is not a valid Weekday
>>> for name, member in Weekday.__members__.items():
...     print(name, '=>', member)
...
Sun => Weekday.Sun
Mon => Weekday.Mon
Tue => Weekday.Tue
Wed => Weekday.Wed
Thu => Weekday.Thu
Fri => Weekday.Fri
Sat => Weekday.Sat
可见,既可以用成员名称引用枚举常量,又可以直接根据value的值获得枚举常量。
小结
Enum可以把一组相关常量定义在一个class中,且class不可变,而且成员可以直接比较。
<think> 我们正在讨论Spring Boot中枚举类使用方法。根据之前的对话历史和引用内容,用户已经了解枚举类的基本写法,现在需要更深入的使用方法,特别是在Spring Boot框架中的集成技巧。 引用[1]提到使用Converter接口进行类型转换,引用[2]展示了在Controller中直接使用枚举作为参数,引用[3]则详细说明了枚举在请求DTO和实体对象中的映射处理,引用[4]给出了一个枚举实现的例子。 因此,我们可以从以下几个方面来回答: 1. 枚举在Controller参数中的自动转换(使用Spring的Converter) 2. 枚举在DTO中的使用(结合Validation) 3. 枚举在实体类中的持久化(JPA和Mybatis-plus的处理) 4. 枚举的序列化与反序列化(JSON处理) 此外,我们还可以提供一些最佳实践。 同时,根据用户之前的问题,我们需要生成相关问题。 注意:引用标识要自然添加。 </think> 在 Spring Boot 中使用枚举类主要涉及以下核心场景和实现方法,这些方法充分利用了 Spring 框架的特性来实现优雅的枚举处理: --- ### 一、枚举在请求参数中的自动转换 Spring 框架提供了 `Converter` 接口实现字符串到枚举的自动转换: ```java // 1. 定义枚举 public enum Priority { LOW(1), MEDIUM(2), HIGH(3); private final int code; Priority(int code) { this.code = code; } } // 2. 实现转换器 @Component public class PriorityConverter implements Converter<String, Priority> { @Override public Priority convert(String source) { return Arrays.stream(Priority.values()) .filter(p -> p.name().equalsIgnoreCase(source) || String.valueOf(p.getCode()).equals(source)) .findFirst() .orElseThrow(() -> new IllegalArgumentException("无效优先级")); } } // 3. Controller直接使用 @GetMapping("/tasks") public ResponseEntity<?> getTasks(@RequestParam Priority priority) { // 自动转换成功 return ResponseEntity.ok("Received: " + priority.name()); } ``` > 框架会自动注册转换器,实现 `?priority=HIGH` 或 `?priority=3` 的参数转换[^1][^2] --- ### 二、请求DTO中的枚举映射 结合 Validation 进行枚举校验: ```java // DTO定义 public class TaskRequest { @NotNull(message = "优先级不能为空") private Priority priority; @JsonFormat(shape = JsonFormat.Shape.OBJECT) // 完整序列化枚举 private Status status = Status.PENDING; // 默认值 } // Controller使用 @PostMapping("/create") public ResponseEntity<?> createTask(@Valid @RequestBody TaskRequest request) { // 自动转换JSON到枚举 } ``` --- ### 三、数据库枚举持久化 #### JPA 方案(推荐存储枚举名称): ```java @Entity public class Task { @Id @GeneratedValue private Long id; @Enumerated(EnumType.STRING) // 存储枚举名称 private Priority priority; } ``` #### MyBatis-Plus 方案: ```java // 1. 枚举类添加@EnumValue注解 public enum Status { @EnumValue // 标记存储到数据库的字段 PENDING(1), COMPLETED(2); Status(int code) { this.code = code; } private final int code; } // 2. 实体类配置 public class Task { @TableField(typeHandler = EnumOrdinalTypeHandler.class) private Status status; } // 3. 配置扫描包(application.yml) mybatis-plus: type-enums-package: com.example.enums ``` --- ### 四、最佳实践技巧 1. **统一异常处理** 转换失败时抛出 `IllegalArgumentException`,通过 `@ControllerAdvice` 统一处理 2. **枚举序列化控制** 使用 `@JsonFormat(shape = JsonFormat.Shape.OBJECT)` 返回完整枚举结构: ```json // 返回结果 { "status": { "code": 1, "name": "PENDING" } } ``` 3. **枚举文档化** 在 Swagger 中显式声明枚举: ```java @Schema(description = "任务状态", implementation = Status.class) private Status status; ``` 4. **避免魔法值** 使用枚举代替常量: ```java // 反例 if (status == 1) { ... } // 正例 if (status == Status.PENDING) { ... } ``` --- ### 枚举 vs 常量类对比 | 场景 | 枚举方案 | 常量类方案 | |--------------------|----------------------------------|-------------------------| | HTTP参数转换 | ⭐️⭐️⭐️⭐️⭐️ (自动转换) | ⭐️⭐️ (需手动解析) | | 数据库持久化 | ⭐️⭐️⭐️⭐️ (注解配置) | ⭐️⭐️ (易出错) | | 类型安全 | ⭐️⭐️⭐️⭐️⭐️ (编译时检查) | ⭐️⭐️ (运行时错误) | | 可读性 | ⭐️⭐️⭐️⭐️⭐️ (语义明确) | ⭐️⭐️⭐️ (需查文档) | > 📌 **结论**:在 Spring Boot 中优先使用枚举处理有限状态集,特别是涉及参数转换、持久化和状态流转的场景[^3][^4] ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值