基於Springboot一個註解搞定數據字典的實踐方案

Posted on by

問題引出：

最近開瞭新項目，項目中用到瞭數據字典，列表查詢數據返回的時候需要手動將code轉換為name，到前臺展示。項目經理表示可以封裝一個統一的功能，避免程序員各自寫各自的，代碼混亂，風格不統一。

要求：

  • 基於微服務架構，數據字典通過服務獲取；
  • 簡化代碼，使用簡單；
  • 使用Redis；

方案

大致的方向是自定義註解，在序列化的時候進行數據處理； 考慮到微服務，需要將主要邏輯放到common中，然後對外提供接口，各業務服務實現接口以獲取字典數據； 考慮Redis，序列化處理數據時，首先通過Redis獲取，獲取不到在通過接口獲取，拿到數據後存到Redis中，然後再返回處理； 也可以多做一步，在新增、修改數據字典時，同步更新Redis內容，以保證數據有效性。

實現

  • 定義註解
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonSerialize(using = DictSerializer.class)
public @interface Dict {

    /** 字典類型 */
    String type();
}
  • 指定註解添加位置
  • 指定註解生效時間
  • 指定序列化處理類
  • 序列化處理類
public class DictSerializer extends StdSerializer<Object> implements ContextualSerializer {
    /** 字典註解 */
    private Dict dict;
    public DictSerializer() {
        super(Object.class);
    }
    public DictSerializer(Dict dict) {
        super(Object.class);
        this.dict = dict;
    }
    private String type;
    @Override
    public void serialize(Object value, JsonGenerator gen, SerializerProvider provider) throws IOException {
        if (Objects.isNull(value)) {
            gen.writeObject(value);
            return;
        }
        if (Objects.nonNull(dict)){
            type = dict.type();
        }
        // 通過數據字典類型和value獲取name

        gen.writeObject(value);
        gen.writeFieldName(gen.getOutputContext().getCurrentName()+"Name");
        gen.writeObject(label);
    }
    @Override
    public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty beanProperty) throws JsonMappingException {
        if (Objects.isNull(beanProperty)){
            return prov.findValueSerializer(beanProperty.getType(), beanProperty);
        }
        Dict dict = beanProperty.getAnnotation(Dict.class);
        if (Objects.nonNull(dict)){
            type = dict.type();
            return this;
        }
        return prov.findNullValueSerializer(null);
    }
}

這裡處理的邏輯是原先的字段內容不變，添加一個新的字段用來存儲轉化後的值；

  • 數據字典獲取
private static String changeLabel(String type,String code) {
    if(code.indexOf(",") > -1) {
        String[] strs = code.split(",");
        if (strs.length > 1) {
            StringBuilder sb = new StringBuilder();
            for (String str : strs) {
                // 從緩存中獲取字典。如果不行，通過SpringUtil.getBean(); 獲取服務處理
                sb.append(DictDataCache.getLabel(type, str)).append(separator);
            }
            return sb.substring(0, sb.length() - 1);
        }
    }
    // 從緩存中獲取字典。如果不行，通過SpringUtil.getBean(); 獲取服務處理
    return DictDataCache.getLabel(type, code);
}

考慮存在多選的情況，先判斷下是否是多選的，默認逗號拼接，後期添加入參控制；

@Override
public String getDictDataOptions(String typeCode,String value) {
    if (redisTemplate.hasKey("dict:"+typeCode+":"+value)){
        return (String) redisTemplate.opsForValue().get("dict:"+typeCode+":"+value);
    }
    List<DictDataOptions> dictDataList = getDictDataHandler().getDictDataOptions(typeCode);
    if(CollUtil.isNotEmpty(dictDataList)) {
        put(typeCode, dictDataList);
    }
    if (redisTemplate.hasKey("dict:"+typeCode+":"+value)){
        return (String) redisTemplate.opsForValue().get("dict:"+typeCode+":"+value);
    }
    return null;
}

根據key判斷Redis中是否存在，存在則直接獲取，不存在則通過接口獲取，獲取到直接放到Redis中，然後再次從Redis獲取。

protected void put(String typeCode, List<DictDataOptions> dataList) {
    if (CollUtil.isNotEmpty(dataList)){
        for (DictDataOptions dictDataOptions : dataList) {
            AbstractDictHandler.redisTemplate.opsForValue().set("dict:"+typeCode+":"+dictDataOptions.getDataLabel(),dictDataOptions.getDataValue());
        }
    }
}

循環放置數據字典值

@Override
public List<DictDataOptions> getDictDataOptions(String typeCode) {
    return iSysDictService.queryDictItemsByCode(typeCode).stream()
            .map(e -> DictDataOptions.builder().typeCode(typeCode).dataLabel(e.getValue()).dataValue(e.getText()).build())
            .collect(Collectors.toList());
}

根據數據字典類型，通過接口獲取數據；註意該實現類需要每個微服務實現一個；然後為瞭避免基礎數據服務掛掉，調用報錯，common中提供一個默認實現。

4.使用

@Dict(type = "inspectType")
private String checkType;

在返回前端的實體中，對應字段添加註解，並指定數據字典type值

      {
        "id": "1522492702905954306",
        "professionName": "專業名稱888",
        "checkCode": "檢測項編碼8",
        "checkProject": "rrrr檢測項目88",
        "checkDevice": "52",
        "checkStandard": "檢測項編碼88",
        "referenceStandard": "wq參考標準8",
        "checkType": "1",
        "checkTypeName": "尺寸",
        "remarks": "ef備註備註8"
      },

前端獲取的json會多一個字段：checkTypeName，內容為checkType 的中文值。

到此這篇關於基於Springboot一個註解搞定數據字典問題的文章就介紹到這瞭,更多相關Springboot數據字典內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：