当前位置：首页 > Java > SpringBoot web开发-实体类属性为枚举的实践

SpringBoot web开发-实体类属性为枚举的实践

王发祥4个月前 (07-16)Java129

## SpringBoot web开发-实体类属性为枚举的实践

### 由前端到后端控制器

#### 情况一：当前端数据Content-Type为`application/form-data` 或`application/x-www-form-urlencoded`

1. 控制器

```java
      @PostMapping("saveUser")
       public UserDTO saveUser(UserDTO userDTO) {
           System.out.println(userDTO);
           return userDTO;
       }
   ```

2. 实体

实体类属性`gender`的类型直接使用枚举即可

```java
   @Data
   @NoArgsConstructor
   @AllArgsConstructor
   public class UserDTO {
       private String name;
       private Integer age;
       private UserGenderEnum gender;
   }
   ```

3. 枚举

枚举类使用`@JsonFormat`

该枚举类序列化给前端时想要把哪个属性给前端就给哪个属性加上` @JsonValue`

getEnumByCode()用于自定义转化

```java
   @ToString
   @AllArgsConstructor
   @JsonFormat(shape = JsonFormat.Shape.OBJECT)
   public enum UserGenderEnum {
       FEMALE(0, "女"),
       MALE(1, "男");
   
       @Getter
       @JsonValue
       private final Integer code;
   
       @Getter
       @EnumValue
       private final String desc;
   
       public static UserGenderEnum getEnumByCode(String code) {
           return Arrays.stream(values()).filter(e -> e.getCode().toString().equals(code)).findFirst().orElse(null);
       }
   }
   ```

4. 自定义转换器

收到前端的gender时此方法会被执行,通过上面枚举类的getEnumByCode()将字符串转为枚举类，这样实体的枚举类型的字段就生成了。

通过getEnumByCode()可以控制通过code还是desc生成UserGenderEnum。这种方式比较灵活

```java
   @Component
   public class StringToUserGenderEnumConverter implements Converter<String, UserGenderEnum> {
       @Override
       public UserGenderEnum convert(String source) {
           try {
               return UserGenderEnum.getEnumByCode(source.toUpperCase());
           } catch (IllegalArgumentException e) {
               return null; // 或者抛出自定义异常
           }
       }
   }
   ```

#### 情况二：当前端数据Content-Type为`application/json`时

1. 控制器

@RequestBody加在实体上

```java
       @PostMapping("saveUser")
       public UserDTO saveUser(@RequestBody UserDTO userDTO) {
           System.out.println(userDTO);
           return userDTO;
       }
   ```

2. 实体

实体没有变化

```java
   @Data
   @NoArgsConstructor
   @AllArgsConstructor
   public class UserDTO {
       private String name;
       private Integer age;
       private UserGenderEnum gender;
   }
   
   ```

3. 枚举类

不需要编写getEnumByCode()方法了

4. 前端只能通过code来传递gender,也就是只能是0或1，不能是男或女。

### 由后端到数据库

需要使用mybatis-plus

```xml
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.6</version>
</dependency>
```

1. 实体

```java
   @Data
   @TableName("user")
   @NoArgsConstructor
   @AllArgsConstructor
   public class UserDTO {
       @TableId(type = IdType.AUTO)
       private Integer id;
       private String name;
       private Integer age;
       private UserGenderEnum gender;
   }
   ```

2. 枚举类

`@EnumValue`通过mybatisplus提供的注解，会将标注注解的属性给到gender

```java
   import com.baomidou.mybatisplus.annotation.EnumValue;
   
   @AllArgsConstructor
   public enum UserGenderEnum {
       FEMALE(0, "女"),
       MALE(1, "男");
   
       @Getter
       @EnumValue
       private final Integer code;
   
       @Getter
       private final String desc;
   }
   ```

###  由数据库到后端

数据库中我们存储的是gender是0或1

|  id  | name | age  | gender |
| :--: | :--: | :--: | :----: |
|  1   |  zs  |  28  |   1    |

如果上面的部分已经完成，则可直接查询

```java
public UserDTO getUser(Long id) {
    UserDTO userDTO = userMapper.selectById(id);
    System.out.println(userDTO);
    return userDTO;
}
```

这里的userDTO打印为

UserDTO(id=1, name=zl, age=28, gender=UserGenderEnum.MALE(code=1, desc=男))

可以看到我们已经正确得到枚举类的gender了

打赏