日韩无码专区无码一级三级片|91人人爱网站中日韩无码电影|厨房大战丰满熟妇|AV高清无码在线免费观看|另类AV日韩少妇熟女|中文日本大黄一级黄色片|色情在线视频免费|亚洲成人特黄a片|黄片wwwav色图欧美|欧亚乱色一区二区三区

RELATEED CONSULTING
相關(guān)咨詢
選擇下列產(chǎn)品馬上在線溝通
服務(wù)時間：8:30-17:00
你可能遇到了下面的問題
關(guān)閉右側(cè)工具欄

新聞中心

這里有您想知道的互聯(lián)網(wǎng)營銷解決方案
SpringBoot使用轉(zhuǎn)換器將前端參數(shù)轉(zhuǎn)換為枚舉

前言

最近遇到一個小伙伴問前端枚舉轉(zhuǎn)換問題，才意識到可以通過轉(zhuǎn)換器(Converter)自動將前端傳入的字段值使用枚舉接收。

我自己搗鼓了一番，現(xiàn)在記錄筆記分享一下!有興趣的小伙伴可以自己嘗試一下!

這里使用的是 MyBatis-Plus 和 SpringBoot 2.3.4.RELEASE

1實現(xiàn)過程

配置轉(zhuǎn)換器

 
 
 
 
    
  
  
  
  
  1. /**
    2. 
  
  
  
  
  2.  * @author liuzhihang
    3. 
  
  
  
  
  3.  * @date 2021/8/31 16:29
    4. 
  
  
  
  
  4.  */
    5. 
  
  
  
  
  5. @Configuration
    6. 
  
  
  
  
  6. public class WebConfig implements WebMvcConfigurer {
    7. 
  
  
  
  
  7. 
  
  
  
  
  8.     @Override
    9. 
  
  
  
  
  9.     public void addFormatters(FormatterRegistry registry) {
    10. 
  
  
  
  
  10. 
  
  
  
  
  11.         registry.addConverterFactory(new ConverterFactory() {
    12. 
  
  
  
  
  12.             @Override
    13. 
  
  
  
  
  13.             public  Converter getConverter(Class targetType) {
    14. 
  
  
  
  
  14. 
  
  
  
  
  15.                 T[] enums = targetType.getEnumConstants();
    16. 
  
  
  
  
  16. 
  
  
  
  
  17.                 return source -> {
    18. 
  
  
  
  
  18. 
  
  
  
  
  19.                     for (T e : enums) {
    20. 
  
  
  
  
  20.                         if (e.getCode().equals(source)) {
    21. 
  
  
  
  
  21.                             return e;
    22. 
  
  
  
  
  22.                         }
    23. 
  
  
  
  
  23.                     }
    24. 
  
  
  
  
  24. 
  
  
  
  
  25.                     throw new IllegalArgumentException("枚舉 Code 不正確");
    26. 
  
  
  
  
  26.                 };
    27. 
  
  
  
  
  27.             }
    28. 
  
  
  
  
  28.         });
    29. 
  
  
  
  
  29.     }
    30. 
  
  
  
  
  30. }
    31.

直接在 WebMvcConfigurer 里實現(xiàn) addFormatters 方法即可，然后 new 一個 ConverterFactory。

WebMvcConfigurer 相信大家都不陌生，一般添加一些攔截器，通用校驗 token、日志等等都會用到。具體可以參考這篇文章：幾行代碼輕松實現(xiàn)跨系統(tǒng)傳遞 traceId，再也不用擔(dān)心對不上日志了!，里面有一些其他的應(yīng)用。

就這些，很簡單的實現(xiàn)。下面介紹下項目的內(nèi)容和代碼，方便理解。

項目代碼

  • 請求參數(shù)：
 
 
 
 
    
  
  
  
  
  1. POST http://localhost:8818/user/listByStatus
    2. 
  
  
  
  
  2. Content-Type: application/json
    3. 
  
  
  
  
  3. 
  
  
  
  
  4. {
    5. 
  
  
  
  
  5.   "orderStatus": 1
    6. 
  
  
  
  
  6. }
    7.
  • Controller
 
 
 
 
    
  
  
  
  
  1. /**
    2. 
  
  
  
  
  2.  * @author liuzhihang
    3. 
  
  
  
  
  3.  * @date 2021/8/30 11:08
    4. 
  
  
  
  
  4.  */
    5. 
  
  
  
  
  5. @Slf4j
    6. 
  
  
  
  
  6. @RestController
    7. 
  
  
  
  
  7. @RequestMapping("/user")
    8. 
  
  
  
  
  8. public class UserController {
    9. 
  
  
  
  
  9. 
  
  
  
  
  10.     @Autowired
    11. 
  
  
  
  
  11.     private OrderService orderService;
    12. 
  
  
  
  
  12. 
  
  
  
  
  13.     @PostMapping(value = "/listByStatus")
    14. 
  
  
  
  
  14.     public ResultVO listByStatus(@Validated @RequestBody UserRequest request)  {
    15. 
  
  
  
  
  15. 
  
  
  
  
  16.         log.info("請求參數(shù):{}", request);
    17. 
  
  
  
  
  17. 
  
  
  
  
  18.         List orderList = orderService.getByOrderStatus(request.getOrderStatus());
    19. 
  
  
  
  
  19. 
  
  
  
  
  20.         UserResponse response = new UserResponse();
    21. 
  
  
  
  
  21. 
  
  
  
  
  22.         response.setRecords(orderList);
    23. 
  
  
  
  
  23. 
  
  
  
  
  24.         log.info("返回參數(shù):{}", response);
    25. 
  
  
  
  
  25. 
  
  
  
  
  26.         return ResultVO.success(response);
    27. 
  
  
  
  
  27.     }
    28. 
  
  
  
  
  28. }
    29.
  • Entity
 
 
 
 
    
  
  
  
  
  1. @Data
    2. 
  
  
  
  
  2. public class UserRequest {
    3. 
  
  
  
  
  3. 
  
  
  
  
  4.     private OrderStatusEnum orderStatus;
    5. 
  
  
  
  
  5.     private ViewStatusEnum viewStatus;
    6. 
  
  
  
  
  6. }
    7. 
  
  
  
  
  7. 
  
  
  
  
  8. @Data
    9. 
  
  
  
  
  9. public class UserResponse {
    10. 
  
  
  
  
  10. 
  
  
  
  
  11.     private List records;
    12. 
  
  
  
  
  12. 
  
  
  
  
  13. }
    14.

Web 傳入 orderStatus 為 1，而后端接收對象是 UserRequest 的 orderStatus 字段是個 OrderStatusEnum 類型的枚舉。

這里就需要自動將數(shù)字類型的字段轉(zhuǎn)換為枚舉字段。這個枚舉會直接通過 MyBatis-Plus 查詢。

為什么要這么用呢?

其實原因很簡單，使用枚舉限制數(shù)據(jù)庫字段的類型，比如數(shù)據(jù)庫狀態(tài)只有 0、1、2，那就和代碼里的枚舉對應(yīng)起來。防止傳入其他值。

  • 枚舉
 
 
 
 
    
  
  
  
  
  1. public interface BaseEnum {
    2. 
  
  
  
  
  2.     Object getCode();
    3. 
  
  
  
  
  3. }
    4. 
 
 
 
 
 
 
 
 
    
  
  
  
  
  1. public enum OrderStatusEnum implements BaseEnum {
    2. 
  
  
  
  
  2. 
  
  
  
  
  3.     INIT(0, "初始狀態(tài)"),
    4. 
  
  
  
  
  4.     SUCCESS(1, "成功"),
    5. 
  
  
  
  
  5.     FAIL(2, "失敗");
    6. 
  
  
  
  
  6. 
  
  
  
  
  7.     @EnumValue
    8. 
  
  
  
  
  8.     @JsonValue
    9. 
  
  
  
  
  9.     private final int code;
    10. 
  
  
  
  
  10. 
  
  
  
  
  11.     private final String desc;
    12. 
  
  
  
  
  12. 
  
  
  
  
  13.     OrderStatusEnum(int code, String desc) {
    14. 
  
  
  
  
  14.         this.code = code;
    15. 
  
  
  
  
  15.         this.desc = desc;
    16. 
  
  
  
  
  16.     }
    17. 
  
  
  
  
  17. 
  
  
  
  
  18.     @Override
    19. 
  
  
  
  
  19.     public Integer getCode() {
    20. 
  
  
  
  
  20.         return code;
    21. 
  
  
  
  
  21.     }
    22. 
  
  
  
  
  22. 
  
  
  
  
  23.     public String getDesc() {
    24. 
  
  
  
  
  24.         return desc;
    25. 
  
  
  
  
  25.     }
    26. 
  
  
  
  
  26. }
    27.

這里先聲明接口 BaseEnum，所有的枚舉都繼承這個接口，并實現(xiàn) getCode 方法。

@EnumValue：MyBatis-Plus 的枚舉，和數(shù)據(jù)庫字段映射用的

@JsonValue：返回給前端時，這個枚舉字段序列化時，返回參數(shù)只顯示 code。

這樣就可以實現(xiàn)效果，請求參數(shù)為數(shù)字，接收對象字段為枚舉，返回字段也是 code。

效果

測試結(jié)果

測試結(jié)果經(jīng)過驗證，是可以勝任傳入數(shù)值和字符串的。

也可以結(jié)合異常處理器，返回通用異常。具體怎么用查一查 @ExceptionHandler 就知道了。

具體說明

在 addFormatters 方法中可以看到 registry.addConverterFactory() 接收的是一個 ConverterFactory 對象。

 
 
 
 
    
  
  
  
  
  1. public interface ConverterFactory {
    2. 
  
  
  
  
  2. 
  
  
  
  
  3.   Converter getConverter(Class targetType);
    4. 
  
  
  
  
  4. }
    5.
  • S 就是傳入的字段類型(數(shù)字，字符串)
  • R 是要轉(zhuǎn)換為的類型(枚舉)
  • T 繼承了 R，其實就是參數(shù)對象中字段的類型

在 ConverterFactory 的 getConverter 方法則需要返回一個實際的轉(zhuǎn)換器 Converter

 
 
 
 
    
  
  
  
  
  1. @FunctionalInterface
    2. 
  
  
  
  
  2. public interface Converter {
    3. 
  
  
  
  
  3. 
  
  
  
  
  4.  @Nullable
    5. 
  
  
  
  
  5.  T convert(S source);
    6. 
  
  
  
  
  6. 
  
  
  
  
  7. }
    8.

convert 方法的入?yún)⑹且粋€ source，就是要轉(zhuǎn)換為什么類型的，這里就是數(shù)字/字符串，然后返回一個枚舉即可。

注意這里加了 @FunctionalInterface 就意味著這里是可以用 lambda 表達(dá)式的。

2優(yōu)化

一般 WebConfig 中除了實現(xiàn) addFormatters 方法外，還會實現(xiàn) addInterceptors 等等，這樣寫難免會很長，所以可以改為下面這種。

 
 
 
 
    
  
  
  
  
  1. @Configuration
    2. 
  
  
  
  
  2. public class WebConfig implements WebMvcConfigurer {
    3. 
  
  
  
  
  3. 
  
  
  
  
  4.     @Autowired
    5. 
  
  
  
  
  5.     private LogInterceptor logInterceptor;
    6. 
  
  
  
  
  6. 
  
  
  
  
  7.     @Autowired
    8. 
  
  
  
  
  8.     private AppTokenInterceptor appTokenInterceptor;
    9. 
  
  
  
  
  9. 
  
  
  
  
  10. 
  
  
  
  
  11.     @Autowired
    12. 
  
  
  
  
  12.     private EnumConverterFactory enumConverterFactory;
    13. 
  
  
  
  
  13. 
  
  
  
  
  14.     @Override
    15. 
  
  
  
  
  15.     public void addInterceptors(InterceptorRegistry registry) {
    16. 
  
  
  
  
  16. 
  
  
  
  
  17.         // 日志
    18. 
  
  
  
  
  18.         registry.addInterceptor(logInterceptor)
    19. 
  
  
  
  
  19.                 .addPathPatterns("/**");
    20. 
  
  
  
  
  20. 
  
  
  
  
  21.         // app token校驗
    22. 
  
  
  
  
  22.         registry.addInterceptor(appTokenInterceptor)
    23. 
  
  
  
  
  23.                 .addPathPatterns("/app/**");
    24. 
  
  
  
  
  24. 
  
  
  
  
  25.     }
    26. 
  
  
  
  
  26. 
  
  
  
  
  27.     @Override
    28. 
  
  
  
  
  28.     public void addFormatters(FormatterRegistry registry) {
    29. 
  
  
  
  
  29.         
    30. 
  
  
  
  
  30.         // 枚舉轉(zhuǎn)換
    31. 
  
  
  
  
  31.         registry.addConverterFactory(enumConverterFactory);
    32. 
  
  
  
  
  32.     }
    33. 
  
  
  
  
  33. }
    34.

這種就需要咱們創(chuàng)建 EnumConverterFactory 類并實現(xiàn) ConverterFactory 接口了，還得注入到 Spring 容器中

 
 
 
 
    
  
  
  
  
  1. @Component
    2. 
  
  
  
  
  2. public class EnumConverterFactory implements ConverterFactory {
    3. 
  
  
  
  
  3. 
  
  
  
  
  4.     @Override
    5. 
  
  
  
  
  5.     public  Converter getConverter(Class targetType) {
    6. 
  
  
  
  
  6. 
  
  
  
  
  7.         return new EnumConverter<>(targetType);
    8. 
  
  
  
  
  8.     }
    9. 
  
  
  
  
  9. }
    10. 
  
  
  
  
  10. public class EnumConverter implements Converter {
    11. 
  
  
  
  
  11. 
  
  
  
  
  12.     private final Class targetType;
    13. 
  
  
  
  
  13. 
  
  
  
  
  14.     public EnumConverter(Class targetType) {
    15. 
  
  
  
  
  15.         this.targetType = targetType;
    16. 
  
  
  
  
  16.     }
    17. 
  
  
  
  
  17. 
  
  
  
  
  18.     @Override
    19. 
  
  
  
  
  19.     public T convert(Object source) {
    20. 
  
  
  
  
  20. 
  
  
  
  
  21.         for (T e : targetType.getEnumConstants()) {
    22. 
  
  
  
  
  22.             if (e.getCode().equals(source)) {
    23. 
  
  
  
  
  23.                 return e;
    24. 
  
  
  
  
  24.             }
    25. 
  
  
  
  
  25.         }
    26. 
  
  
  
  
  26. 
  
  
  
  
  27.         throw new IllegalArgumentException("枚舉 Code 不正確");
    28. 
  
  
  
  
  28.     }
    29. 
  
  
  
  
  29. }
    30.

3總結(jié)

當(dāng)然這里也有一些其他的優(yōu)化點，比如可以使用緩存將 Convert 緩存起來。

不過我也遇到一個其他的問題，就是我 debug 斷點竟然一直沒有斷到轉(zhuǎn)換器中，不知道有沒有小伙伴嘗試過?


網(wǎng)站欄目：SpringBoot使用轉(zhuǎn)換器將前端參數(shù)轉(zhuǎn)換為枚舉
文章出自：http://m.5511xx.com/article/djhchjs.html