# 字典包配置

目录结构这篇文章中字典配置文件涉及到字典配置，此篇文章详细介绍可配置项。

# 配置文档说明

::: tips

formatterRequest接收两个参数，第一个是 query，默认值为type，第二个是字典类型，多个时默认英文逗号隔开。此配置的目的就是将我们默认的传参格式，转化为后端接口想要的格式。

formatterDictList接收一个参数data，这个的值就是请求字典接口返回的最外层的数据，将后端返回的数据转化为我们包想要的格式，然后return回来即可。

V3.0.3版本开始 formatterDictList接收两个参数，第一个是data，第二个是query，data就是请求字典接口返回的最外层的数据，query就是请求的字典类型，将后端返回的数据转化为我们包想要的格式，然后return回来即可。

:::

// V3.0.3版本开始 支持接口只能请求一个字典类型时 的配置
import { getDicts } from "@/api/system/dict/data"
import localDictCodes from "@/assets/data/dict"
import elementUI from "element-ui"
export default {
  getDictCodeApi: getDicts, //必传 获取字典数据接口
  localDictCodes, //选填 项目写死的字典数据
  elementUI: elementUI,
  // 格式化请求参数，query为 配置项query的值， data为 请求传入的参数，也就是字典类型，多个字典时用英文逗号隔开
  formatterRequest: (query, data) => {
    return data
  },
  format: {
    value: "dictValue", label: "dictLabel"
  },
  formatterDictList: (data, query) => {
    return {
      [query]: data.data
    };
  },
  version: "0.0.1",
  // 项目无法实时返回版本时  返回和配置一样的版本号，避免版本号不一致 缓存被删除
  formatterDictVerssion: () => {
    return "0.0.1"
  }
}

# treesetting配置

# 常见问题

1. 后端无返回版本号时怎么办。

   /* 
   答：当后端无返回版本号时，可将版本号写死固定，如0.0.1，且使用formatterDictVerssion格式化返回版本号数据写死 0.0.1（必须和前面一致）。
   
   具体使用方法 如下：
   */
   
   //  src/api/modules/common-api.js
   //获取全局配置  包含版本号
   export function getGlobalConfigApi() {
     return new Promise((resolve, reject) => {
       resolve({verssion: "0.0.1"})
     })
   }
   
   // src/dict-setting.js 文件
   import {getDictCodeApi} from "@/api/module/common-api.js"
   import localDictCodes from "@/assets/data/dict.js"
   export default {
       getDictCodeApi, //必传 获取字典数据接口
       localDictCodes, //选填 项目写死的字典数据
       formatterDictVerssion: (data) => {
           //data为 经过 axios 响应处理后返回的 第一级数据
           return "0.0.1"
       }
   }
   
   //以上操作即可解决后端接口无返回版本号问题，实现方法很多，以上方法为遵循文档推荐代码的解决方式
   

2. 后端字典接口正常请求，但是返回数据与文档要求格式不一致怎么办？

   /*
   答：此包拥有诸多配置，面对后端人员不配合修改接口返回格式时，部门字典包无能为力。此包就针对这个问题，实现对接口返回数据进行操作。让各种各样的接口数据经过您优秀的数据操作，都能适配此字典包。
   
   具体如下：
   */
   
   // src/dict-setting.js 文件
   import {getDictCodeApi} from "@/api/module/common-api.js"
   import localDictCodes from "@/assets/data/dict.js"
   export default {
       getDictCodeApi, //必传 获取字典数据接口
       localDictCodes, //选填 项目写死的字典数据
       formatterDictList: (data) => {
           //data为 经过 axios 响应处理后返回的 第一级数据
           const dictCodeList = 一系列操作后 .....
           return dictCodeList
       }
   }
   

3. 后端请求格式与字典包要求的不一致怎么办？

   /*
   答：此包拥有诸多配置，面对后端人员不愿意修改请求参数来适配字典包，部门字典包无能为力。此包就针对这个问题，实现对请求参数数据进行操作。让请求参数能适配此字典包。
   
   具体如下：
   */
   
   // src/dict-setting.js 文件
   import {getDictCodeApi} from "@/api/module/common-api.js"
   import localDictCodes from "@/assets/data/dict.js"
   export default {
       getDictCodeApi, //必传 获取字典数据接口
       localDictCodes, //选填 项目写死的字典数据
       formatterRequest: (query, data) => {
           //query 为字典类型参数   如  type: "AAC004" 中的type
           //data  为字典类型数据   如  type: "AAC004" 中的AAC004
           const req = 一系列操作后 .....
           return req
       }
   }
   

4. 此字典组件使用后会调用多次接口且每个接口只请求一个字典类型的数据，能让他们在同个接口请求？

   /*
   答：针对这个问题，此包已经有预判到了，所以有个usuallyGetFileds配置项，用来配置经常请求的字典类型，这种情况下，这些字典数据就会在同个接口请求。当然如果在整个项目上或多或少 会有部分字典数据 不在usuallyGetFileds范畴内。不过此字段已经大大的解决了您的问题。
   如果是项目是供iframe作为单个功能页使用，可将页面上所有使用到的字典数据配置起来就能完全达到您的要求。
   */
   

5. 后端接口返回数据格式一致，但是字段名不一致，我该如何处理？

   /*
   答：format配置项可以解决您的问题。
   具体如下
   */
   
   // src/dict-setting.js 文件
   import {getDictCodeApi} from "@/api/module/common-api.js"
   import localDictCodes from "@/assets/data/dict.js"
   export default {
       getDictCodeApi, //必传 获取字典数据接口
       localDictCodes, //选填 项目写死的字典数据
       format: {value: "后端返回的value", label: "后端返回的label"}
   }