refactor: 公告类型适配字典数据

1.新增 <dict-tag> 自定义组件，用于回显字典标签
2.重构 useDict 方法，支持查询字典数据
3.优化部分字典相关数据类型

continew-admin-common/src/main/java/top/charles7c/cnadmin/common/model/vo/LabelValueVO.java

@@ -23,6 +23,8 @@
 
 import io.swagger.v3.oas.annotations.media.Schema;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
+
 /**
  * 键值对信息
  *
@@ -49,8 +51,21 @@ public class LabelValueVO<V> implements Serializable {
  @Schema(description = "值", example = "1")
  private V value;
 
+ /**
+ * 颜色
+ */
+ @Schema(description = "颜色", example = "#165DFF")
+ @JsonInclude(JsonInclude.Include.NON_NULL)
+ private String color;
+
  public LabelValueVO(String label, V value) {
  this.label = label;
  this.value = value;
  }
+
+ public LabelValueVO(String label, V value, String color) {
+ this.label = label;
+ this.value = value;
+ this.color = color;
+ }
 }

continew-admin-system/src/main/java/top/charles7c/cnadmin/system/mapper/DictItemMapper.java

@@ -16,7 +16,12 @@
 
 package top.charles7c.cnadmin.system.mapper;
 
+import java.util.List;
+
+import org.apache.ibatis.annotations.Param;
+
 import top.charles7c.cnadmin.common.base.BaseMapper;
+import top.charles7c.cnadmin.common.model.vo.LabelValueVO;
 import top.charles7c.cnadmin.system.model.entity.DictItemDO;
 
 /**
@@ -25,4 +30,14 @@
  * @author Charles7c
  * @since 2023/9/11 21:29
  */
-public interface DictItemMapper extends BaseMapper<DictItemDO> {}
+public interface DictItemMapper extends BaseMapper<DictItemDO> {
+
+ /**
+ * 根据字典编码查询
+ * 
+ * @param dictCode
+ * 字典编码
+ * @return 字典项列表
+ */
+ List<LabelValueVO> listByDictCode(@Param("dictCode") String dictCode);
+}

continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/entity/AnnouncementDO.java

@@ -23,7 +23,6 @@
 import com.baomidou.mybatisplus.annotation.TableName;
 
 import top.charles7c.cnadmin.common.base.BaseDO;
-import top.charles7c.cnadmin.system.enums.AnnouncementTypeEnum;
 
 /**
  * 公告实体
@@ -50,7 +49,7 @@ public class AnnouncementDO extends BaseDO {
  /**
  * 类型
  */
- private AnnouncementTypeEnum type;
+ private String type;
 
  /**
  * 生效时间

continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/request/AnnouncementRequest.java

@@ -27,7 +27,6 @@
 import org.hibernate.validator.constraints.Length;
 
 import top.charles7c.cnadmin.common.base.BaseRequest;
-import top.charles7c.cnadmin.system.enums.AnnouncementTypeEnum;
 
 /**
  * 创建或修改公告信息
@@ -57,11 +56,11 @@ public class AnnouncementRequest extends BaseRequest {
  private String content;
 
  /**
- * 类型
+ * 类型（取值于字典 announcement_type）
  */
- @Schema(description = "类型", type = "Integer", allowableValues = {"1", "2", "3"}, example = "1")
- @NotNull(message = "类型非法")
- private AnnouncementTypeEnum type;
+ @Schema(description = "类型（取值于字典 announcement_type）", example = "1")
+ @NotBlank(message = "类型不能为空")
+ private String type;
 
  /**
  * 生效时间

continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/vo/AnnouncementDetailVO.java

@@ -26,8 +26,6 @@
 import com.alibaba.excel.annotation.ExcelProperty;
 
 import top.charles7c.cnadmin.common.base.BaseDetailVO;
-import top.charles7c.cnadmin.common.config.easyexcel.ExcelBaseEnumConverter;
-import top.charles7c.cnadmin.system.enums.AnnouncementTypeEnum;
 
 /**
  * 公告详情信息
@@ -57,11 +55,11 @@ public class AnnouncementDetailVO extends BaseDetailVO {
  private String content;
 
  /**
- * 类型
+ * 类型（取值于字典 announcement_type）
  */
- @Schema(description = "类型", type = "Integer", allowableValues = {"1", "2", "3"}, example = "1")
- @ExcelProperty(value = "类型", converter = ExcelBaseEnumConverter.class)
- private AnnouncementTypeEnum type;
+ @Schema(description = "类型（取值于字典 announcement_type）", example = "1")
+ @ExcelProperty(value = "类型")
+ private String type;
 
  /**
  * 生效时间

continew-admin-system/src/main/java/top/charles7c/cnadmin/system/model/vo/AnnouncementVO.java

@@ -23,7 +23,6 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 
 import top.charles7c.cnadmin.common.base.BaseVO;
-import top.charles7c.cnadmin.system.enums.AnnouncementTypeEnum;
 
 /**
  * 公告信息
@@ -44,10 +43,10 @@ public class AnnouncementVO extends BaseVO {
  private String title;
 
  /**
- * 类型
+ * 类型（取值于字典 announcement_type）
  */
- @Schema(description = "类型", type = "Integer", allowableValues = {"1", "2", "3"}, example = "1")
- private AnnouncementTypeEnum type;
+ @Schema(description = "类型（取值于字典 announcement_type）", example = "1")
+ private String type;
 
  /**
  * 生效时间

continew-admin-system/src/main/java/top/charles7c/cnadmin/system/service/DictItemService.java

@@ -19,6 +19,7 @@
 import java.util.List;
 
 import top.charles7c.cnadmin.common.base.BaseService;
+import top.charles7c.cnadmin.common.model.vo.LabelValueVO;
 import top.charles7c.cnadmin.system.model.query.DictItemQuery;
 import top.charles7c.cnadmin.system.model.request.DictItemRequest;
 import top.charles7c.cnadmin.system.model.vo.DictItemDetailVO;
@@ -41,6 +42,15 @@ public interface DictItemService extends BaseService<DictItemVO, DictItemDetailV
  */
  List<DictItemDetailVO> listByDictId(Long dictId);
 
+ /**
+ * 根据字典编码查询
+ * 
+ * @param dictCode
+ * 字典编码
+ * @return 字典项列表
+ */
+ List<LabelValueVO> listByDictCode(String dictCode);
+
  /**
  * 根据字典 ID 列表删除
  *

continew-admin-system/src/main/java/top/charles7c/cnadmin/system/service/impl/DictItemServiceImpl.java

@@ -25,6 +25,7 @@
 
 import top.charles7c.cnadmin.common.base.BaseServiceImpl;
 import top.charles7c.cnadmin.common.model.query.SortQuery;
+import top.charles7c.cnadmin.common.model.vo.LabelValueVO;
 import top.charles7c.cnadmin.common.util.validate.CheckUtils;
 import top.charles7c.cnadmin.system.mapper.DictItemMapper;
 import top.charles7c.cnadmin.system.model.entity.DictItemDO;
@@ -73,6 +74,11 @@ public List<DictItemDetailVO> listByDictId(Long dictId) {
  return detailList;
  }
 
+ @Override
+ public List<LabelValueVO> listByDictCode(String dictCode) {
+ return baseMapper.listByDictCode(dictCode);
+ }
+
  @Override
  public void deleteByDictIds(List<Long> dictIds) {
  baseMapper.lambdaUpdate().in(DictItemDO::getDictId, dictIds).remove();

continew-admin-system/src/main/resources/mapper/DictItemMapper.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http:https://mybatis.org/dtd/mybatis-3-mapper.dtd" >
+<mapper namespace="top.charles7c.cnadmin.system.mapper.DictItemMapper">
+ <select id="listByDictCode" resultType="top.charles7c.cnadmin.common.model.vo.LabelValueVO">
+ SELECT t1.`label`, t1.`value`, t1.`color`
+ FROM `sys_dict_item` AS t1
+ LEFT JOIN `sys_dict` AS t2 ON t1.`dict_id` = t2.`id`
+ WHERE t2.`code` = #{dictCode}
+ ORDER BY t1.`sort` ASC
+ </select>
+</mapper>

continew-admin-ui/.eslintrc.js

@@ -66,5 +66,6 @@ module.exports = {
  'no-param-reassign': 0,
  'prefer-regex-literals': 0,
  'import/no-extraneous-dependencies': 0,
+ 'camelcase': 'off',
  },
 };

continew-admin-ui/src/api/common/index.ts

@@ -6,8 +6,10 @@ import { ListParam as RoleParam } from '@/api/system/role';
 import { TreeNodeData } from '@arco-design/web-vue';
 import { LabelValueState } from '@/store/modules/dict/types';
 
+const BASE_URL = '/common';
+
 export function listDeptTree(params: DeptParam) {
- return axios.get<TreeNodeData[]>('/common/tree/dept', {
+ return axios.get<TreeNodeData[]>(`${BASE_URL}/tree/dept`, {
  params,
  paramsSerializer: (obj) => {
  return qs.stringify(obj);
@@ -16,7 +18,7 @@ export function listDeptTree(params: DeptParam) {
 }
 
 export function listMenuTree(params: MenuParam) {
- return axios.get<TreeNodeData[]>('/common/tree/menu', {
+ return axios.get<TreeNodeData[]>(`${BASE_URL}/tree/menu`, {
  params,
  paramsSerializer: (obj) => {
  return qs.stringify(obj);
@@ -25,7 +27,7 @@ export function listMenuTree(params: MenuParam) {
 }
 
 export function listRoleDict(params: RoleParam) {
- return axios.get<LabelValueState[]>('/common/dict/role', {
+ return axios.get<LabelValueState[]>(`${BASE_URL}/dict/role`, {
  params,
  paramsSerializer: (obj) => {
  return qs.stringify(obj);
@@ -34,5 +36,9 @@ export function listRoleDict(params: RoleParam) {
 }
 
 export function listEnumDict(enumTypeName: string) {
- return axios.get<LabelValueState[]>(`/common/dict/enum/${enumTypeName}`);
+ return axios.get<LabelValueState[]>(`${BASE_URL}/dict/enum/${enumTypeName}`);
+}
+
+export function listDict(code: string) {
+ return axios.get<LabelValueState[]>(`${BASE_URL}/dict/${code}`);
 }

continew-admin-ui/src/api/system/announcement.ts

@@ -7,7 +7,7 @@ export interface DataRecord {
  id?: string;
  title?: string;
  content?: string;
- status?: string;
+ status?: number;
  type?: string;
  effectiveTime?: string;
  terminateTime?: string;
@@ -21,7 +21,7 @@ export interface DataRecord {
 
 export interface ListParam {
  title?: string;
- status?: string;
+ status?: number;
  type?: string;
  page?: number;
  size?: number;

continew-admin-ui/src/components/dict-tag/index.vue

@@ -0,0 +1,50 @@
+<template>
+ <span v-if="!dictItem"></span>
+ <span v-else-if="!dictItem.color">{{ dictItem.label }}</span>
+ <a-tag v-else-if="dictItem.color === 'primary'" color="arcoblue">{{
+ dictItem.label
+ }}</a-tag>
+ <a-tag v-else-if="dictItem.color === 'success'" color="green">{{
+ dictItem.label
+ }}</a-tag>
+ <a-tag v-else-if="dictItem.color === 'warning'" color="orangered">{{
+ dictItem.label
+ }}</a-tag>
+ <a-tag v-else-if="dictItem.color === 'error'" color="red">{{
+ dictItem.label
+ }}</a-tag>
+ <a-tag v-else-if="dictItem.color === 'default'" color="gray">{{
+ dictItem.label
+ }}</a-tag>
+ <a-tag v-else :color="dictItem.color">{{ dictItem.label }}</a-tag>
+</template>
+
+<script lang="ts" setup>
+ import { computed } from 'vue';
+ import { LabelValueState } from '@/store/modules/dict/types';
+
+ const props = defineProps({
+ dict: {
+ type: Array<LabelValueState>,
+ required: true,
+ },
+ value: {
+ type: [Number, String],
+ required: true,
+ },
+ });
+
+ const dictItem = computed(() =>
+ props.dict.find(
+ (d) => d.value === String(props.value) || d.value === Number(props.value)
+ )
+ );
+</script>
+
+<script lang="ts">
+ export default {
+ name: 'DictTag',
+ };
+</script>
+
+<style scoped lang="less"></style>

continew-admin-ui/src/components/index.ts

@@ -12,6 +12,7 @@ import {
 import Chart from './chart/index.vue';
 import Breadcrumb from './breadcrumb/index.vue';
 import DateRangePicker from './date-range-picker/index.vue';
+import DictTag from './dict-tag/index.vue';
 import RightToolbar from './right-toolbar/index.vue';
 import SvgIcon from './svg-icon/index.vue';
 import IconSelect from './icon-select/index.vue';
@@ -41,6 +42,7 @@ export default {
  Vue.component('Chart', Chart);
  Vue.component('Breadcrumb', Breadcrumb);
  Vue.component('DateRangePicker', DateRangePicker);
+ Vue.component('DictTag', DictTag);
  Vue.component('RightToolbar', RightToolbar);
  Vue.component('SvgIcon', SvgIcon);
  Vue.component('IconSelect', IconSelect);

continew-admin-ui/src/store/modules/dict/types.ts

@@ -1,6 +1,7 @@
 export interface LabelValueState {
  label: string;
  value: any;
+ color?: string;
 }
 
 export interface DictState {

continew-admin-ui/src/utils/dict.ts

@@ -1,25 +1,33 @@
 import { ref, toRefs } from 'vue';
-import { listEnumDict } from '@/api/common';
+import { listEnumDict, listDict } from '@/api/common';
 import { useDictStore } from '@/store';
 
 /**
  * 获取字典数据
  *
- * @param names 字典名列表
+ * @param dicts 字典列表
  */
-export default function useDict(...names: Array<string>) {
+export default function useDict(
+ ...dicts: Array<{ name: string; isEnum: boolean }>
+) {
  const res = ref<any>({});
  return (() => {
- names.forEach((name: string) => {
+ dicts.forEach((d) => {
+ const { name } = d;
  res.value[name] = [];
  const dict = useDictStore().getDict(name);
  if (dict) {
  res.value[name] = dict;
- } else {
+ } else if (d.isEnum) {
  listEnumDict(name).then((resp) => {
  res.value[name] = resp.data;
  useDictStore().setDict(name, res.value[name]);
  });
+ } else {
+ listDict(name).then((resp) => {
+ res.value[name] = resp.data;
+ useDictStore().setDict(name, res.value[name]);
+ });
  }
  });
  return toRefs(res.value);