zayac/zayac-admin
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

style: 枚举接口 BaseEnum => IBaseEnum

Browse Source
This commit is contained in:
Charles7c 2023-10-25 23:12:03 +08:00
parent 43590bf66e
commit f5e8b0943c
16 changed files with 46 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/BaseEnum.java → continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/IBaseEnum.java
View File

@ -21,16 +21,14 @@ import java.io.Serializable;
import com.baomidou.mybatisplus.annotation.IEnum; import com.baomidou.mybatisplus.annotation.IEnum;
/** /**
* 枚举基类 * 枚举接口
* *
* @param <V> * @param <V>
* value 类型 * value 类型
* @param <D>
* description 类型
* @author Charles7c * @author Charles7c
* @since 2023/2/5 20:44 * @since 2023/2/5 20:44
*/ */
public interface BaseEnum<V extends Serializable> extends IEnum<V> { public interface IBaseEnum<V extends Serializable> extends IEnum<V> {
/** /**
* 枚举描述 * 枚举描述

20
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/easyexcel/ExcelBaseEnumConverter.java
View File

@ -26,7 +26,7 @@ import com.alibaba.excel.metadata.property.ExcelContentProperty;
import cn.hutool.core.convert.Convert; import cn.hutool.core.convert.Convert;
import cn.hutool.core.util.ClassUtil; 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; import top.charles7c.cnadmin.common.constant.StringConsts;
/** /**
@ -35,11 +35,11 @@ import top.charles7c.cnadmin.common.constant.StringConsts;
* @author Charles7c * @author Charles7c
* @since 2023/2/5 19:29 * @since 2023/2/5 19:29
*/ */
public class ExcelBaseEnumConverter implements Converter<BaseEnum<Integer>> { public class ExcelBaseEnumConverter implements Converter<IBaseEnum<Integer>> {
@Override @Override
public Class<BaseEnum> supportJavaTypeKey() { public Class<IBaseEnum> supportJavaTypeKey() {
return BaseEnum.class; return IBaseEnum.class;
} }
@Override @Override
@ -51,16 +51,16 @@ public class ExcelBaseEnumConverter implements Converter<BaseEnum<Integer>> {
* 转换为 Java 数据（读取 Excel） * 转换为 Java 数据（读取 Excel）
*/ */
@Override @Override
public BaseEnum convertToJavaData(ReadCellData<?> cellData, ExcelContentProperty contentProperty, public IBaseEnum convertToJavaData(ReadCellData<?> cellData, ExcelContentProperty contentProperty,
GlobalConfiguration globalConfiguration) { GlobalConfiguration globalConfiguration) {
return this.getEnum(BaseEnum.class, Convert.toStr(cellData.getData())); return this.getEnum(IBaseEnum.class, Convert.toStr(cellData.getData()));
} }
/** /**
* 转换为 Excel 数据（写入 Excel） * 转换为 Excel 数据（写入 Excel）
*/ */
@Override @Override
public WriteCellData<String> convertToExcelData(BaseEnum<Integer> value, ExcelContentProperty contentProperty, public WriteCellData<String> convertToExcelData(IBaseEnum<Integer> value, ExcelContentProperty contentProperty,
GlobalConfiguration globalConfiguration) { GlobalConfiguration globalConfiguration) {
if (null == value) { if (null == value) {
return new WriteCellData<>(StringConsts.EMPTY); return new WriteCellData<>(StringConsts.EMPTY);
@ -77,11 +77,11 @@ public class ExcelBaseEnumConverter implements Converter<BaseEnum<Integer>> {
* 描述 * 描述
* @return 对应枚举 ，获取不到时为 {@code null} * @return 对应枚举 ，获取不到时为 {@code null}
*/ */
private BaseEnum<Integer> getEnum(Class<?> enumType, String description) { private IBaseEnum<Integer> getEnum(Class<?> enumType, String description) {
Object[] enumConstants = enumType.getEnumConstants(); Object[] enumConstants = enumType.getEnumConstants();
for (Object enumConstant : enumConstants) { for (Object enumConstant : enumConstants) {
if (ClassUtil.isAssignable(BaseEnum.class, enumType)) { if (ClassUtil.isAssignable(IBaseEnum.class, enumType)) {
BaseEnum<Integer> baseEnum = (BaseEnum<Integer>)enumConstant; IBaseEnum<Integer> baseEnum = (IBaseEnum<Integer>)enumConstant;
if (baseEnum.getDescription().equals(description)) { if (baseEnum.getDescription().equals(description)) {
return baseEnum; return baseEnum;
} }

12
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/BaseEnumDeserializer.java
View File

@ -27,7 +27,7 @@ import com.fasterxml.jackson.databind.annotation.JacksonStdImpl;
import cn.hutool.core.util.ClassUtil; import cn.hutool.core.util.ClassUtil;
import cn.hutool.core.util.ReflectUtil; import cn.hutool.core.util.ReflectUtil;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
/** /**
* 通用枚举基类 BaseEnum 反序列化器 * 通用枚举基类 BaseEnum 反序列化器
@ -36,13 +36,13 @@ import top.charles7c.cnadmin.common.base.BaseEnum;
* @since 2023/1/8 13:56 * @since 2023/1/8 13:56
*/ */
@JacksonStdImpl @JacksonStdImpl
public class BaseEnumDeserializer extends JsonDeserializer<BaseEnum> { public class BaseEnumDeserializer extends JsonDeserializer<IBaseEnum> {
/** 静态实例 */ /** 静态实例 */
public static final BaseEnumDeserializer SERIALIZER_INSTANCE = new BaseEnumDeserializer(); public static final BaseEnumDeserializer SERIALIZER_INSTANCE = new BaseEnumDeserializer();
@Override @Override
public BaseEnum deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) public IBaseEnum deserialize(JsonParser jsonParser, DeserializationContext deserializationContext)
throws IOException { throws IOException {
Class<?> targetClass = jsonParser.getCurrentValue().getClass(); Class<?> targetClass = jsonParser.getCurrentValue().getClass();
String fieldName = jsonParser.getCurrentName(); String fieldName = jsonParser.getCurrentName();
@ -61,13 +61,13 @@ public class BaseEnumDeserializer extends JsonDeserializer<BaseEnum> {
* 字段名 * 字段名
* @return 对应枚举实例 ，获取不到时为 {@code null} * @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); Field field = ReflectUtil.getField(targetClass, fieldName);
Class<?> fieldTypeClass = field.getType(); Class<?> fieldTypeClass = field.getType();
Object[] enumConstants = fieldTypeClass.getEnumConstants(); Object[] enumConstants = fieldTypeClass.getEnumConstants();
for (Object enumConstant : enumConstants) { for (Object enumConstant : enumConstants) {
if (ClassUtil.isAssignable(BaseEnum.class, fieldTypeClass)) { if (ClassUtil.isAssignable(IBaseEnum.class, fieldTypeClass)) {
BaseEnum baseEnum = (BaseEnum)enumConstant; IBaseEnum baseEnum = (IBaseEnum)enumConstant;
if (baseEnum.getValue().equals(Integer.valueOf(value))) { if (baseEnum.getValue().equals(Integer.valueOf(value))) {
return baseEnum; return baseEnum;
} }

6
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/BaseEnumSerializer.java
View File

@ -23,7 +23,7 @@ import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider; import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.annotation.JacksonStdImpl; import com.fasterxml.jackson.databind.annotation.JacksonStdImpl;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
/** /**
* 通用枚举接口 BaseEnum 序列化器 * 通用枚举接口 BaseEnum 序列化器
@ -32,13 +32,13 @@ import top.charles7c.cnadmin.common.base.BaseEnum;
* @since 2023/1/8 13:56 * @since 2023/1/8 13:56
*/ */
@JacksonStdImpl @JacksonStdImpl
public class BaseEnumSerializer extends JsonSerializer<BaseEnum> { public class BaseEnumSerializer extends JsonSerializer<IBaseEnum> {
/** 静态实例 */ /** 静态实例 */
public static final BaseEnumSerializer SERIALIZER_INSTANCE = new BaseEnumSerializer(); public static final BaseEnumSerializer SERIALIZER_INSTANCE = new BaseEnumSerializer();
@Override @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()); generator.writeObject(value.getValue());
} }
} }

6
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/config/jackson/JacksonConfiguration.java
View File

@ -41,7 +41,7 @@ import com.fasterxml.jackson.datatype.jsr310.ser.LocalTimeSerializer;
import cn.hutool.core.date.DatePattern; import cn.hutool.core.date.DatePattern;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
/** /**
* Jackson 配置 * Jackson 配置
@ -83,10 +83,10 @@ public class JacksonConfiguration {
@Bean @Bean
public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder) { public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder) {
SimpleModule simpleModule = new SimpleModule(); SimpleModule simpleModule = new SimpleModule();
simpleModule.addSerializer(BaseEnum.class, BaseEnumSerializer.SERIALIZER_INSTANCE); simpleModule.addSerializer(IBaseEnum.class, BaseEnumSerializer.SERIALIZER_INSTANCE);
SimpleDeserializersWrapper deserializers = new SimpleDeserializersWrapper(); SimpleDeserializersWrapper deserializers = new SimpleDeserializersWrapper();
deserializers.addDeserializer(BaseEnum.class, BaseEnumDeserializer.SERIALIZER_INSTANCE); deserializers.addDeserializer(IBaseEnum.class, BaseEnumDeserializer.SERIALIZER_INSTANCE);
simpleModule.setDeserializers(deserializers); simpleModule.setDeserializers(deserializers);
ObjectMapper objectMapper = builder.createXmlMapper(false).build(); ObjectMapper objectMapper = builder.createXmlMapper(false).build();

4
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/DataScopeEnum.java
View File

@ -19,7 +19,7 @@ package top.charles7c.cnadmin.common.enums;
import lombok.Getter; import lombok.Getter;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
/** /**
* 数据权限枚举 * 数据权限枚举
@ -29,7 +29,7 @@ import top.charles7c.cnadmin.common.base.BaseEnum;
*/ */
@Getter @Getter
@RequiredArgsConstructor @RequiredArgsConstructor
public enum DataScopeEnum implements BaseEnum<Integer> { public enum DataScopeEnum implements IBaseEnum<Integer> {
/** 全部数据权限 */ /** 全部数据权限 */
ALL(1, "全部数据权限"), ALL(1, "全部数据权限"),

4
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/DisEnableStatusEnum.java
View File

@ -19,7 +19,7 @@ package top.charles7c.cnadmin.common.enums;
import lombok.Getter; import lombok.Getter;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
import top.charles7c.cnadmin.common.constant.UIConsts; import top.charles7c.cnadmin.common.constant.UIConsts;
/** /**
@ -30,7 +30,7 @@ import top.charles7c.cnadmin.common.constant.UIConsts;
*/ */
@Getter @Getter
@RequiredArgsConstructor @RequiredArgsConstructor
public enum DisEnableStatusEnum implements BaseEnum<Integer> { public enum DisEnableStatusEnum implements IBaseEnum<Integer> {
/** 启用 */ /** 启用 */
ENABLE(1, "启用", UIConsts.COLOR_SUCCESS), ENABLE(1, "启用", UIConsts.COLOR_SUCCESS),

4
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/GenderEnum.java
View File

@ -19,7 +19,7 @@ package top.charles7c.cnadmin.common.enums;
import lombok.Getter; import lombok.Getter;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
/** /**
* 性别枚举 * 性别枚举
@ -29,7 +29,7 @@ import top.charles7c.cnadmin.common.base.BaseEnum;
*/ */
@Getter @Getter
@RequiredArgsConstructor @RequiredArgsConstructor
public enum GenderEnum implements BaseEnum<Integer> { public enum GenderEnum implements IBaseEnum<Integer> {
/** 未知 */ /** 未知 */
UNKNOWN(0, "未知"), UNKNOWN(0, "未知"),

4
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/MenuTypeEnum.java
View File

@ -19,7 +19,7 @@ package top.charles7c.cnadmin.common.enums;
import lombok.Getter; import lombok.Getter;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
/** /**
* 菜单类型枚举 * 菜单类型枚举
@ -29,7 +29,7 @@ import top.charles7c.cnadmin.common.base.BaseEnum;
*/ */
@Getter @Getter
@RequiredArgsConstructor @RequiredArgsConstructor
public enum MenuTypeEnum implements BaseEnum<Integer> { public enum MenuTypeEnum implements IBaseEnum<Integer> {
/** 目录 */ /** 目录 */
DIR(1, "目录"), DIR(1, "目录"),

4
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/QueryTypeEnum.java
View File

@ -19,7 +19,7 @@ package top.charles7c.cnadmin.common.enums;
import lombok.Getter; import lombok.Getter;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
/** /**
* 查询类型枚举 * 查询类型枚举
@ -29,7 +29,7 @@ import top.charles7c.cnadmin.common.base.BaseEnum;
*/ */
@Getter @Getter
@RequiredArgsConstructor @RequiredArgsConstructor
public enum QueryTypeEnum implements BaseEnum<Integer> { public enum QueryTypeEnum implements IBaseEnum<Integer> {
/** /**
* 等值查询，例如：WHERE `age` = 18 * 等值查询，例如：WHERE `age` = 18

4
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/enums/SuccessFailureStatusEnum.java
View File

@ -19,7 +19,7 @@ package top.charles7c.cnadmin.common.enums;
import lombok.Getter; import lombok.Getter;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
import top.charles7c.cnadmin.common.constant.UIConsts; import top.charles7c.cnadmin.common.constant.UIConsts;
/** /**
@ -30,7 +30,7 @@ import top.charles7c.cnadmin.common.constant.UIConsts;
*/ */
@Getter @Getter
@RequiredArgsConstructor @RequiredArgsConstructor
public enum SuccessFailureStatusEnum implements BaseEnum<Integer> { public enum SuccessFailureStatusEnum implements IBaseEnum<Integer> {
/** 成功 */ /** 成功 */
SUCCESS(1, "成功", UIConsts.COLOR_SUCCESS), SUCCESS(1, "成功", UIConsts.COLOR_SUCCESS),

2
continew-admin-common/src/main/java/top/charles7c/cnadmin/common/handler/GlobalResponseBodyAdviceHandler.java
View File

@ -43,8 +43,8 @@ import top.charles7c.cnadmin.common.model.vo.R;
@RestControllerAdvice @RestControllerAdvice
@RequiredArgsConstructor @RequiredArgsConstructor
public class GlobalResponseBodyAdviceHandler implements ResponseBodyAdvice<Object> { public class GlobalResponseBodyAdviceHandler implements ResponseBodyAdvice<Object> {
private static final String[] EXCLUDE = {"MultipleOpenApiWebMvcResource", "SwaggerConfigResource",};
private static final String[] EXCLUDE = {"MultipleOpenApiWebMvcResource", "SwaggerConfigResource",};
private final ObjectMapper objectMapper; private final ObjectMapper objectMapper;
@Override @Override

4
continew-admin-monitor/src/main/java/top/charles7c/cnadmin/monitor/enums/LogStatusEnum.java
View File

@ -19,7 +19,7 @@ package top.charles7c.cnadmin.monitor.enums;
import lombok.Getter; import lombok.Getter;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
/** /**
* 操作状态枚举 * 操作状态枚举
@ -29,7 +29,7 @@ import top.charles7c.cnadmin.common.base.BaseEnum;
*/ */
@Getter @Getter
@RequiredArgsConstructor @RequiredArgsConstructor
public enum LogStatusEnum implements BaseEnum<Integer> { public enum LogStatusEnum implements IBaseEnum<Integer> {
/** 成功 */ /** 成功 */
SUCCESS(1, "成功"), SUCCESS(1, "成功"),

4
continew-admin-system/src/main/java/top/charles7c/cnadmin/system/enums/AnnouncementStatusEnum.java
View File

@ -19,7 +19,7 @@ package top.charles7c.cnadmin.system.enums;
import lombok.Getter; import lombok.Getter;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
import top.charles7c.cnadmin.common.constant.UIConsts; import top.charles7c.cnadmin.common.constant.UIConsts;
/** /**
@ -30,7 +30,7 @@ import top.charles7c.cnadmin.common.constant.UIConsts;
*/ */
@Getter @Getter
@RequiredArgsConstructor @RequiredArgsConstructor
public enum AnnouncementStatusEnum implements BaseEnum<Integer> { public enum AnnouncementStatusEnum implements IBaseEnum<Integer> {
/** 待发布 */ /** 待发布 */
PENDING_RELEASE(1, "待发布", UIConsts.COLOR_PRIMARY), PENDING_RELEASE(1, "待发布", UIConsts.COLOR_PRIMARY),

4
continew-admin-tool/src/main/java/top/charles7c/cnadmin/tool/enums/FormTypeEnum.java
View File

@ -19,7 +19,7 @@ package top.charles7c.cnadmin.tool.enums;
import lombok.Getter; import lombok.Getter;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import top.charles7c.cnadmin.common.base.BaseEnum; import top.charles7c.cnadmin.common.base.IBaseEnum;
/** /**
* 表单类型枚举 * 表单类型枚举
@ -29,7 +29,7 @@ import top.charles7c.cnadmin.common.base.BaseEnum;
*/ */
@Getter @Getter
@RequiredArgsConstructor @RequiredArgsConstructor
public enum FormTypeEnum implements BaseEnum<Integer> { public enum FormTypeEnum implements IBaseEnum<Integer> {
/** /**
* 文本框 * 文本框

6
continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/common/CommonController.java
View File

@ -42,7 +42,7 @@ import cn.hutool.core.lang.tree.Tree;
import cn.hutool.core.util.ClassUtil; import cn.hutool.core.util.ClassUtil;
import cn.hutool.core.util.StrUtil; 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.LocalStorageProperties;
import top.charles7c.cnadmin.common.config.properties.ProjectProperties; import top.charles7c.cnadmin.common.config.properties.ProjectProperties;
import top.charles7c.cnadmin.common.constant.CacheConsts; import top.charles7c.cnadmin.common.constant.CacheConsts;
@ -140,7 +140,7 @@ public class CommonController {
* @return 枚举类型 * @return 枚举类型
*/ */
private Optional<Class<?>> getEnumClassByName(String enumClassName) { private Optional<Class<?>> getEnumClassByName(String enumClassName) {
Set<Class<?>> classSet = ClassUtil.scanPackageBySuper(projectProperties.getBasePackage(), BaseEnum.class); Set<Class<?>> classSet = ClassUtil.scanPackageBySuper(projectProperties.getBasePackage(), IBaseEnum.class);
return classSet.stream() return classSet.stream()
.filter( .filter(
c -> StrUtil.equalsAnyIgnoreCase(c.getSimpleName(), enumClassName, StrUtil.toCamelCase(enumClassName))) c -> StrUtil.equalsAnyIgnoreCase(c.getSimpleName(), enumClassName, StrUtil.toCamelCase(enumClassName)))
@ -157,7 +157,7 @@ public class CommonController {
private List<LabelValueVO> listEnumDict(Class<?> enumClass) { private List<LabelValueVO> listEnumDict(Class<?> enumClass) {
Object[] enumConstants = enumClass.getEnumConstants(); Object[] enumConstants = enumClass.getEnumConstants();
return Arrays.stream(enumConstants).map(e -> { return Arrays.stream(enumConstants).map(e -> {
BaseEnum<Integer> baseEnum = (BaseEnum<Integer>)e; IBaseEnum<Integer> baseEnum = (IBaseEnum<Integer>)e;
return new LabelValueVO<>(baseEnum.getDescription(), baseEnum.getValue(), baseEnum.getColor()); return new LabelValueVO<>(baseEnum.getDescription(), baseEnum.getValue(), baseEnum.getColor());
}).collect(Collectors.toList()); }).collect(Collectors.toList());
} }