From f5e8b0943c6076c476b7d78bb623707740fb452f Mon Sep 17 00:00:00 2001 From: Charles7c Date: Wed, 25 Oct 2023 23:12:03 +0800 Subject: [PATCH] =?UTF-8?q?style:=20=E6=9E=9A=E4=B8=BE=E6=8E=A5=E5=8F=A3?= =?UTF-8?q?=20BaseEnum=20=3D>=20IBaseEnum?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../base/{BaseEnum.java => IBaseEnum.java} | 6 ++---- .../easyexcel/ExcelBaseEnumConverter.java | 20 +++++++++---------- .../config/jackson/BaseEnumDeserializer.java | 12 +++++------ .../config/jackson/BaseEnumSerializer.java | 6 +++--- .../config/jackson/JacksonConfiguration.java | 6 +++--- .../cnadmin/common/enums/DataScopeEnum.java | 4 ++-- .../common/enums/DisEnableStatusEnum.java | 4 ++-- .../cnadmin/common/enums/GenderEnum.java | 4 ++-- .../cnadmin/common/enums/MenuTypeEnum.java | 4 ++-- .../cnadmin/common/enums/QueryTypeEnum.java | 4 ++-- .../enums/SuccessFailureStatusEnum.java | 4 ++-- .../GlobalResponseBodyAdviceHandler.java | 2 +- .../cnadmin/monitor/enums/LogStatusEnum.java | 4 ++-- .../system/enums/AnnouncementStatusEnum.java | 4 ++-- .../cnadmin/tool/enums/FormTypeEnum.java | 4 ++-- .../controller/common/CommonController.java | 6 +++--- 16 files changed, 46 insertions(+), 48 deletions(-) rename continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/{BaseEnum.java => IBaseEnum.java} (89%) diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/BaseEnum.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/IBaseEnum.java similarity index 89% rename from continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/BaseEnum.java rename to continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/IBaseEnum.java index 4fa14427..abe8c55f 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/BaseEnum.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/IBaseEnum.java @@ -21,16 +21,14 @@ import com.baomidou.mybatisplus.annotation.IEnum; /** - * 枚举基类 + * 枚举接口 * * @param * value 类型 - * @param - * description 类型 * @author Charles7c * @since 2023/2/5 20:44 */ -public interface BaseEnum extends IEnum { +public interface IBaseEnum extends IEnum { /** * 枚举描述 diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/easyexcel/ExcelBaseEnumConverter.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/easyexcel/ExcelBaseEnumConverter.java index a73dff63..3f111785 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/easyexcel/ExcelBaseEnumConverter.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/easyexcel/ExcelBaseEnumConverter.java @@ -26,7 +26,7 @@ import cn.hutool.core.convert.Convert; import cn.hutool.core.util.ClassUtil; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; import top.charles7c.cnadmin.common.constant.StringConsts; /** @@ -35,11 +35,11 @@ * @author Charles7c * @since 2023/2/5 19:29 */ -public class ExcelBaseEnumConverter implements Converter> { +public class ExcelBaseEnumConverter implements Converter> { @Override - public Class supportJavaTypeKey() { - return BaseEnum.class; + public Class supportJavaTypeKey() { + return IBaseEnum.class; } @Override @@ -51,16 +51,16 @@ public CellDataTypeEnum supportExcelTypeKey() { * 转换为 Java 数据（读取 Excel） */ @Override - public BaseEnum convertToJavaData(ReadCellData cellData, ExcelContentProperty contentProperty, + public IBaseEnum convertToJavaData(ReadCellData cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) { - return this.getEnum(BaseEnum.class, Convert.toStr(cellData.getData())); + return this.getEnum(IBaseEnum.class, Convert.toStr(cellData.getData())); } /** * 转换为 Excel 数据（写入 Excel） */ @Override - public WriteCellData convertToExcelData(BaseEnum value, ExcelContentProperty contentProperty, + public WriteCellData convertToExcelData(IBaseEnum value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) { if (null == value) { return new WriteCellData<>(StringConsts.EMPTY); @@ -77,11 +77,11 @@ public WriteCellData convertToExcelData(BaseEnum value, ExcelCo * 描述 * @return 对应枚举 ，获取不到时为 {@code null} */ - private BaseEnum getEnum(Class enumType, String description) { + private IBaseEnum getEnum(Class enumType, String description) { Object[] enumConstants = enumType.getEnumConstants(); for (Object enumConstant : enumConstants) { - if (ClassUtil.isAssignable(BaseEnum.class, enumType)) { - BaseEnum baseEnum = (BaseEnum)enumConstant; + if (ClassUtil.isAssignable(IBaseEnum.class, enumType)) { + IBaseEnum baseEnum = (IBaseEnum)enumConstant; if (baseEnum.getDescription().equals(description)) { return baseEnum; } diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/BaseEnumDeserializer.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/BaseEnumDeserializer.java index 65ab0465..2b05017e 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/BaseEnumDeserializer.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/BaseEnumDeserializer.java @@ -27,7 +27,7 @@ import cn.hutool.core.util.ClassUtil; import cn.hutool.core.util.ReflectUtil; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; /** * 通用枚举基类 BaseEnum 反序列化器 @@ -36,13 +36,13 @@ * @since 2023/1/8 13:56 */ @JacksonStdImpl -public class BaseEnumDeserializer extends JsonDeserializer { +public class BaseEnumDeserializer extends JsonDeserializer { /** 静态实例 */ public static final BaseEnumDeserializer SERIALIZER_INSTANCE = new BaseEnumDeserializer(); @Override - public BaseEnum deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) + public IBaseEnum deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException { Class targetClass = jsonParser.getCurrentValue().getClass(); String fieldName = jsonParser.getCurrentName(); @@ -61,13 +61,13 @@ public BaseEnum deserialize(JsonParser jsonParser, DeserializationContext deseri * 字段名 * @return 对应枚举实例 ，获取不到时为 {@code null} */ - private BaseEnum getEnum(Class targetClass, String value, String fieldName) { + private IBaseEnum getEnum(Class targetClass, String value, String fieldName) { Field field = ReflectUtil.getField(targetClass, fieldName); Class fieldTypeClass = field.getType(); Object[] enumConstants = fieldTypeClass.getEnumConstants(); for (Object enumConstant : enumConstants) { - if (ClassUtil.isAssignable(BaseEnum.class, fieldTypeClass)) { - BaseEnum baseEnum = (BaseEnum)enumConstant; + if (ClassUtil.isAssignable(IBaseEnum.class, fieldTypeClass)) { + IBaseEnum baseEnum = (IBaseEnum)enumConstant; if (baseEnum.getValue().equals(Integer.valueOf(value))) { return baseEnum; } diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/BaseEnumSerializer.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/BaseEnumSerializer.java index 37d8473b..c0a272ac 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/BaseEnumSerializer.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/BaseEnumSerializer.java @@ -23,7 +23,7 @@ import com.fasterxml.jackson.databind.SerializerProvider; import com.fasterxml.jackson.databind.annotation.JacksonStdImpl; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; /** * 通用枚举接口 BaseEnum 序列化器 @@ -32,13 +32,13 @@ * @since 2023/1/8 13:56 */ @JacksonStdImpl -public class BaseEnumSerializer extends JsonSerializer { +public class BaseEnumSerializer extends JsonSerializer { /** 静态实例 */ public static final BaseEnumSerializer SERIALIZER_INSTANCE = new BaseEnumSerializer(); @Override - public void serialize(BaseEnum value, JsonGenerator generator, SerializerProvider serializers) throws IOException { + public void serialize(IBaseEnum value, JsonGenerator generator, SerializerProvider serializers) throws IOException { generator.writeObject(value.getValue()); } } diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/JacksonConfiguration.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/JacksonConfiguration.java index fa2db8dc..0372aaea 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/JacksonConfiguration.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/JacksonConfiguration.java @@ -41,7 +41,7 @@ import cn.hutool.core.date.DatePattern; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; /** * Jackson 配置 @@ -83,10 +83,10 @@ public Jackson2ObjectMapperBuilderCustomizer customizer() { @Bean public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder) { SimpleModule simpleModule = new SimpleModule(); - simpleModule.addSerializer(BaseEnum.class, BaseEnumSerializer.SERIALIZER_INSTANCE); + simpleModule.addSerializer(IBaseEnum.class, BaseEnumSerializer.SERIALIZER_INSTANCE); SimpleDeserializersWrapper deserializers = new SimpleDeserializersWrapper(); - deserializers.addDeserializer(BaseEnum.class, BaseEnumDeserializer.SERIALIZER_INSTANCE); + deserializers.addDeserializer(IBaseEnum.class, BaseEnumDeserializer.SERIALIZER_INSTANCE); simpleModule.setDeserializers(deserializers); ObjectMapper objectMapper = builder.createXmlMapper(false).build(); diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/DataScopeEnum.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/DataScopeEnum.java index 88077dcc..feba5303 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/DataScopeEnum.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/DataScopeEnum.java @@ -19,7 +19,7 @@ import lombok.Getter; import lombok.RequiredArgsConstructor; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; /** * 数据权限枚举 @@ -29,7 +29,7 @@ */ @Getter @RequiredArgsConstructor -public enum DataScopeEnum implements BaseEnum { +public enum DataScopeEnum implements IBaseEnum { /** 全部数据权限 */ ALL(1, "全部数据权限"), diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/DisEnableStatusEnum.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/DisEnableStatusEnum.java index 47366be9..af7c6f26 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/DisEnableStatusEnum.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/DisEnableStatusEnum.java @@ -19,7 +19,7 @@ import lombok.Getter; import lombok.RequiredArgsConstructor; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; import top.charles7c.cnadmin.common.constant.UIConsts; /** @@ -30,7 +30,7 @@ */ @Getter @RequiredArgsConstructor -public enum DisEnableStatusEnum implements BaseEnum { +public enum DisEnableStatusEnum implements IBaseEnum { /** 启用 */ ENABLE(1, "启用", UIConsts.COLOR_SUCCESS), diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/GenderEnum.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/GenderEnum.java index 2faed158..28d140ea 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/GenderEnum.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/GenderEnum.java @@ -19,7 +19,7 @@ import lombok.Getter; import lombok.RequiredArgsConstructor; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; /** * 性别枚举 @@ -29,7 +29,7 @@ */ @Getter @RequiredArgsConstructor -public enum GenderEnum implements BaseEnum { +public enum GenderEnum implements IBaseEnum { /** 未知 */ UNKNOWN(0, "未知"), diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/MenuTypeEnum.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/MenuTypeEnum.java index 634f9b24..e87bbad6 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/MenuTypeEnum.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/MenuTypeEnum.java @@ -19,7 +19,7 @@ import lombok.Getter; import lombok.RequiredArgsConstructor; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; /** * 菜单类型枚举 @@ -29,7 +29,7 @@ */ @Getter @RequiredArgsConstructor -public enum MenuTypeEnum implements BaseEnum { +public enum MenuTypeEnum implements IBaseEnum { /** 目录 */ DIR(1, "目录"), diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/QueryTypeEnum.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/QueryTypeEnum.java index 5a69c1cc..8ba8b678 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/QueryTypeEnum.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/QueryTypeEnum.java @@ -19,7 +19,7 @@ import lombok.Getter; import lombok.RequiredArgsConstructor; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; /** * 查询类型枚举 @@ -29,7 +29,7 @@ */ @Getter @RequiredArgsConstructor -public enum QueryTypeEnum implements BaseEnum { +public enum QueryTypeEnum implements IBaseEnum { /** * 等值查询，例如：WHERE `age` = 18 diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/SuccessFailureStatusEnum.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/SuccessFailureStatusEnum.java index 5f12a913..a835b47d 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/SuccessFailureStatusEnum.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/SuccessFailureStatusEnum.java @@ -19,7 +19,7 @@ import lombok.Getter; import lombok.RequiredArgsConstructor; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; import top.charles7c.cnadmin.common.constant.UIConsts; /** @@ -30,7 +30,7 @@ */ @Getter @RequiredArgsConstructor -public enum SuccessFailureStatusEnum implements BaseEnum { +public enum SuccessFailureStatusEnum implements IBaseEnum { /** 成功 */ SUCCESS(1, "成功", UIConsts.COLOR_SUCCESS), diff --git a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/handler/GlobalResponseBodyAdviceHandler.java b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/handler/GlobalResponseBodyAdviceHandler.java index 5769ba31..0c291c35 100644 --- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/handler/GlobalResponseBodyAdviceHandler.java +++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/handler/GlobalResponseBodyAdviceHandler.java @@ -43,8 +43,8 @@ @RestControllerAdvice @RequiredArgsConstructor public class GlobalResponseBodyAdviceHandler implements ResponseBodyAdvice { - private static final String[] EXCLUDE = {"MultipleOpenApiWebMvcResource", "SwaggerConfigResource",}; + private static final String[] EXCLUDE = {"MultipleOpenApiWebMvcResource", "SwaggerConfigResource",}; private final ObjectMapper objectMapper; @Override diff --git a/continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/enums/LogStatusEnum.java b/continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/enums/LogStatusEnum.java index eb6a9448..35370e8e 100644 --- a/continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/enums/LogStatusEnum.java +++ b/continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/enums/LogStatusEnum.java @@ -19,7 +19,7 @@ import lombok.Getter; import lombok.RequiredArgsConstructor; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; /** * 操作状态枚举 @@ -29,7 +29,7 @@ */ @Getter @RequiredArgsConstructor -public enum LogStatusEnum implements BaseEnum { +public enum LogStatusEnum implements IBaseEnum { /** 成功 */ SUCCESS(1, "成功"), diff --git a/continew-admin-system/src/main/java/top/charles7c/cnadmin/system/enums/AnnouncementStatusEnum.java b/continew-admin-system/src/main/java/top/charles7c/cnadmin/system/enums/AnnouncementStatusEnum.java index 1dad2fd1..b67094d7 100644 --- a/continew-admin-system/src/main/java/top/charles7c/cnadmin/system/enums/AnnouncementStatusEnum.java +++ b/continew-admin-system/src/main/java/top/charles7c/cnadmin/system/enums/AnnouncementStatusEnum.java @@ -19,7 +19,7 @@ import lombok.Getter; import lombok.RequiredArgsConstructor; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; import top.charles7c.cnadmin.common.constant.UIConsts; /** @@ -30,7 +30,7 @@ */ @Getter @RequiredArgsConstructor -public enum AnnouncementStatusEnum implements BaseEnum { +public enum AnnouncementStatusEnum implements IBaseEnum { /** 待发布 */ PENDING_RELEASE(1, "待发布", UIConsts.COLOR_PRIMARY), diff --git a/continew-admin-tool/src/main/java/top/charles7c/cnadmin/tool/enums/FormTypeEnum.java b/continew-admin-tool/src/main/java/top/charles7c/cnadmin/tool/enums/FormTypeEnum.java index 72880642..51fee6d8 100644 --- a/continew-admin-tool/src/main/java/top/charles7c/cnadmin/tool/enums/FormTypeEnum.java +++ b/continew-admin-tool/src/main/java/top/charles7c/cnadmin/tool/enums/FormTypeEnum.java @@ -19,7 +19,7 @@ import lombok.Getter; import lombok.RequiredArgsConstructor; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; /** * 表单类型枚举 @@ -29,7 +29,7 @@ */ @Getter @RequiredArgsConstructor -public enum FormTypeEnum implements BaseEnum { +public enum FormTypeEnum implements IBaseEnum { /** * 文本框 diff --git a/continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/common/CommonController.java b/continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/common/CommonController.java index 4e2d1f5e..63ed876f 100644 --- a/continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/common/CommonController.java +++ b/continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/common/CommonController.java @@ -42,7 +42,7 @@ import cn.hutool.core.util.ClassUtil; import cn.hutool.core.util.StrUtil; -import top.charles7c.cnadmin.common.base.BaseEnum; +import top.charles7c.cnadmin.common.base.IBaseEnum; import top.charles7c.cnadmin.common.config.properties.LocalStorageProperties; import top.charles7c.cnadmin.common.config.properties.ProjectProperties; import top.charles7c.cnadmin.common.constant.CacheConsts; @@ -140,7 +140,7 @@ public List listOption(@Validated OptionQuery query) { * @return 枚举类型 */ private Optional> getEnumClassByName(String enumClassName) { - Set> classSet = ClassUtil.scanPackageBySuper(projectProperties.getBasePackage(), BaseEnum.class); + Set> classSet = ClassUtil.scanPackageBySuper(projectProperties.getBasePackage(), IBaseEnum.class); return classSet.stream() .filter( c -> StrUtil.equalsAnyIgnoreCase(c.getSimpleName(), enumClassName, StrUtil.toCamelCase(enumClassName))) @@ -157,7 +157,7 @@ private Optional> getEnumClassByName(String enumClassName) { private List listEnumDict(Class enumClass) { Object[] enumConstants = enumClass.getEnumConstants(); return Arrays.stream(enumConstants).map(e -> { - BaseEnum baseEnum = (BaseEnum)e; + IBaseEnum baseEnum = (IBaseEnum)e; return new LabelValueVO<>(baseEnum.getDescription(), baseEnum.getValue(), baseEnum.getColor()); }).collect(Collectors.toList()); }