cf-framework：banner、error-code移到starter-web，desensitize移除

2026-08-13 05:12:07 +08:00 · 2025-07-17 10:41:47 +08:00
parent 59a2b3184c
commit ee65adab45
59 changed files with 58 additions and 1384 deletions
@@ -0,0 +1,20 @@
+package com.cf.imes.framework.banner.config;
+
+import com.cf.imes.framework.banner.core.BannerApplicationRunner;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.context.annotation.Bean;
+
+/**
+ * Banner 的自动配置类
+ *
+ * @author 晨丰科技
+ */
+@AutoConfiguration
+public class ChenfengBannerAutoConfiguration {
+
+    @Bean
+    public BannerApplicationRunner bannerApplicationRunner() {
+        return new BannerApplicationRunner();
+    }
+
+}
@@ -0,0 +1,30 @@
+package com.cf.imes.framework.banner.core;
+
+import cn.hutool.core.thread.ThreadUtil;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.boot.ApplicationArguments;
+import org.springframework.boot.ApplicationRunner;
+
+import java.util.concurrent.TimeUnit;
+
+/**
+ * 项目启动成功后，提供文档相关的地址
+ *
+ * @author 晨丰科技
+ */
+@Slf4j
+public class BannerApplicationRunner implements ApplicationRunner {
+
+    @Override
+    public void run(ApplicationArguments args) {
+        ThreadUtil.execute(() -> {
+            ThreadUtil.sleep(1, TimeUnit.SECONDS); // 延迟 1 秒，保证输出到结尾
+            log.info("\n----------------------------------------------------------\n\t" +
+                            "晨丰IMES项目启动成功！\n" +
+                            "----------------------------------------------------------"
+                    );
+
+        });
+    }
+
+}
@@ -0,0 +1,39 @@
+package com.cf.imes.framework.errorcode.config;
+
+import com.cf.imes.framework.errorcode.core.generator.ErrorCodeAutoGenerator;
+import com.cf.imes.framework.errorcode.core.generator.ErrorCodeAutoGeneratorImpl;
+import com.cf.imes.framework.errorcode.core.loader.ErrorCodeLoader;
+import com.cf.imes.framework.errorcode.core.loader.ErrorCodeLoaderImpl;
+import com.cf.imes.module.system.api.errorcode.ErrorCodeApi;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.scheduling.annotation.EnableScheduling;
+
+/**
+ * 错误码配置类
+ *
+ * @author 晨丰科技
+ */
+@AutoConfiguration
+@ConditionalOnProperty(prefix = "chenfeng.error-code", value = "enable", matchIfMissing = true) // 允许使用 chenfeng.error-code.enable=false 禁用访问日志
+@EnableConfigurationProperties(ErrorCodeProperties.class)
+@EnableScheduling // 开启调度任务的功能，因为 ErrorCodeRemoteLoader 通过定时刷新错误码
+public class ChenfengErrorCodeAutoConfiguration {
+
+    @Bean
+    public ErrorCodeAutoGenerator errorCodeAutoGenerator(@Value("${spring.application.name}") String applicationName,
+                                                         ErrorCodeProperties errorCodeProperties,
+                                                         ErrorCodeApi errorCodeApi) {
+        return new ErrorCodeAutoGeneratorImpl(applicationName, errorCodeProperties.getConstantsClassList(), errorCodeApi);
+    }
+
+    @Bean
+    public ErrorCodeLoader errorCodeLoader(@Value("${spring.application.name}") String applicationName,
+                                           ErrorCodeApi errorCodeApi) {
+        return new ErrorCodeLoaderImpl(applicationName, errorCodeApi);
+    }
+
+}
@@ -0,0 +1,15 @@
+package com.cf.imes.framework.errorcode.config;
+
+import com.cf.imes.module.system.api.errorcode.ErrorCodeApi;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.cloud.openfeign.EnableFeignClients;
+
+/**
+ * 错误码用到 Feign 的配置项
+ *
+ * @author 晨丰科技
+ */
+@AutoConfiguration
+@EnableFeignClients(clients = ErrorCodeApi.class) // 主要是引入相关的 API 服务
+public class ChenfengErrorCodeRpcAutoConfiguration {
+}
@@ -0,0 +1,30 @@
+package com.cf.imes.framework.errorcode.config;
+
+import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.validation.annotation.Validated;
+
+import javax.validation.constraints.NotNull;
+import java.util.List;
+
+/**
+ * 错误码的配置属性类
+ *
+ * @author dlyan
+ */
+@ConfigurationProperties("chenfeng.error-code")
+@Data
+@Validated
+public class ErrorCodeProperties {
+
+    /**
+     * 是否开启
+     */
+    private Boolean enable = true;
+    /**
+     * 错误码枚举类
+     */
+    @NotNull(message = "错误码枚举类不能为空")
+    private List<String> constantsClassList;
+
+}
@@ -0,0 +1,15 @@
+package com.cf.imes.framework.errorcode.core.generator;
+
+/**
+ * 错误码的自动生成器
+ *
+ * @author dylan
+ */
+public interface ErrorCodeAutoGenerator {
+
+    /**
+     * 将配置类到错误码写入数据库
+     */
+    void execute();
+
+}
@@ -0,0 +1,108 @@
+package com.cf.imes.framework.errorcode.core.generator;
+
+import cn.hutool.core.collection.CollUtil;
+import cn.hutool.core.exceptions.ExceptionUtil;
+import cn.hutool.core.util.ClassUtil;
+import cn.hutool.core.util.ReflectUtil;
+import com.cf.imes.framework.common.exception.ErrorCode;
+import com.cf.imes.module.system.api.errorcode.ErrorCodeApi;
+import com.cf.imes.module.system.api.errorcode.dto.ErrorCodeAutoGenerateReqDTO;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.context.event.EventListener;
+import org.springframework.scheduling.annotation.Async;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * ErrorCodeAutoGenerator 的实现类
+ * 目的是，扫描指定的 {@link #constantsClassList} 类，写入到 system 服务中
+ *
+ * @author dylan
+ */
+@RequiredArgsConstructor
+@Slf4j
+public class ErrorCodeAutoGeneratorImpl implements ErrorCodeAutoGenerator {
+
+    /**
+     * 应用分组
+     */
+    private final String applicationName;
+    /**
+     * 错误码枚举类
+     */
+    private final List<String> constantsClassList;
+    /**
+     * 错误码 Api
+     */
+    private final ErrorCodeApi errorCodeApi;
+
+    @Override
+    @EventListener(ApplicationReadyEvent.class)
+    @Async // 异步，保证项目的启动过程，毕竟非关键流程
+    public void execute() {
+        // 第一步，解析错误码
+        List<ErrorCodeAutoGenerateReqDTO> autoGenerateDTOs = parseErrorCode();
+        log.info("[execute][解析到错误码数量为 ({}) 个]", autoGenerateDTOs.size());
+
+        // 第二步，写入到 system 服务
+        try {
+            errorCodeApi.autoGenerateErrorCodeList(autoGenerateDTOs).checkError();
+            log.info("[execute][写入到 system 组件完成]");
+        } catch (Exception ex) {
+            log.error("[execute][写入到 system 组件失败({})]", ExceptionUtil.getRootCauseMessage(ex));
+        }
+    }
+
+    /**
+     * 解析 constantsClassList 变量，转换成错误码数组
+     *
+     * @return 错误码数组
+     */
+    private List<ErrorCodeAutoGenerateReqDTO> parseErrorCode() {
+        // 校验 errorCodeConstantsClass 参数
+        if (CollUtil.isEmpty(constantsClassList)) {
+            log.info("[execute][未配置 chenfeng.error-code.constants-class-list 配置项，不进行自动写入到 system 服务中]");
+            return new ArrayList<>();
+        }
+
+        // 解析错误码
+        List<ErrorCodeAutoGenerateReqDTO> autoGenerateDTOs = new ArrayList<>();
+        constantsClassList.forEach(constantsClass -> {
+            try {
+                // 解析错误码枚举类
+                Class<?> errorCodeConstantsClazz = ClassUtil.loadClass(constantsClass);
+                // 解析错误码
+                autoGenerateDTOs.addAll(parseErrorCode(errorCodeConstantsClazz));
+            } catch (Exception ex) {
+                log.warn("[parseErrorCode][constantsClass({}) 加载失败({})]", constantsClass,
+                        ExceptionUtil.getRootCauseMessage(ex));
+            }
+        });
+        return autoGenerateDTOs;
+    }
+
+    /**
+     * 解析错误码类，获得错误码数组
+     *
+     * @return 错误码数组
+     */
+    private List<ErrorCodeAutoGenerateReqDTO> parseErrorCode(Class<?> constantsClass) {
+        List<ErrorCodeAutoGenerateReqDTO> autoGenerateDTOs = new ArrayList<>();
+        Arrays.stream(constantsClass.getFields()).forEach(field -> {
+            if (field.getType() != ErrorCode.class) {
+                return;
+            }
+            // 转换成 ErrorCodeAutoGenerateReqDTO 对象
+            ErrorCode errorCode = (ErrorCode) ReflectUtil.getFieldValue(constantsClass, field);
+            autoGenerateDTOs.add(new ErrorCodeAutoGenerateReqDTO().setApplicationName(applicationName)
+                    .setCode(errorCode.getCode()).setMessage(errorCode.getMsg()));
+        });
+        return autoGenerateDTOs;
+    }
+
+}
+
@@ -0,0 +1,34 @@
+package com.cf.imes.framework.errorcode.core.loader;
+
+import com.cf.imes.framework.common.exception.util.ServiceExceptionUtil;
+
+/**
+ * 错误码加载器
+ *
+ * 注意，错误码最终加载到 {@link ServiceExceptionUtil} 的 MESSAGES 变量中！
+ *
+ * @author dlyan
+ */
+public interface ErrorCodeLoader {
+
+    /**
+     * 添加错误码
+     *
+     * @param code 错误码的编号
+     * @param msg 错误码的提示
+     */
+    default void putErrorCode(Integer code, String msg) {
+        ServiceExceptionUtil.put(code, msg);
+    }
+
+    /**
+     * 刷新错误码
+     */
+    void refreshErrorCodes();
+
+    /**
+     * 加载错误码
+     */
+    void loadErrorCodes();
+
+}
@@ -0,0 +1,82 @@
+package com.cf.imes.framework.errorcode.core.loader;
+
+import cn.hutool.core.collection.CollUtil;
+import cn.hutool.core.exceptions.ExceptionUtil;
+import com.cf.imes.framework.common.util.date.DateUtils;
+import com.cf.imes.module.system.api.errorcode.ErrorCodeApi;
+import com.cf.imes.module.system.api.errorcode.dto.ErrorCodeRespDTO;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.context.event.EventListener;
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.scheduling.annotation.Scheduled;
+
+import java.time.LocalDateTime;
+import java.util.List;
+
+/**
+ * ErrorCodeLoader 的实现类，从 infra 的数据库中，加载错误码。
+ *
+ * 考虑到错误码会刷新，所以按照 {@link #REFRESH_ERROR_CODE_PERIOD} 频率，增量加载错误码。
+ *
+ * @author dlyan
+ */
+@RequiredArgsConstructor
+@Slf4j
+public class ErrorCodeLoaderImpl implements ErrorCodeLoader {
+
+    /**
+     * 刷新错误码的频率，单位：毫秒
+     */
+    private static final int REFRESH_ERROR_CODE_PERIOD = 60 * 1000;
+
+    /**
+     * 应用分组
+     */
+    private final String applicationName;
+    /**
+     * 错误码 Api
+     */
+    private final ErrorCodeApi errorCodeApi;
+
+    /**
+     * 缓存错误码的最大更新时间，用于后续的增量轮询，判断是否有更新
+     */
+    private LocalDateTime maxUpdateTime;
+
+    @Override
+    @EventListener(ApplicationReadyEvent.class)
+    @Async // 异步，保证项目的启动过程，毕竟非关键流程
+    public void loadErrorCodes() {
+        loadErrorCodes0();
+    }
+
+    @Override
+    @Scheduled(fixedDelay = REFRESH_ERROR_CODE_PERIOD, initialDelay = REFRESH_ERROR_CODE_PERIOD)
+    public void refreshErrorCodes() {
+        loadErrorCodes0();
+    }
+
+    private void loadErrorCodes0() {
+        try {
+            // 加载错误码
+            List<ErrorCodeRespDTO> errorCodeRespDTOs = errorCodeApi.getErrorCodeList(applicationName, maxUpdateTime).getCheckedData();
+            if (CollUtil.isEmpty(errorCodeRespDTOs)) {
+                return;
+            }
+            log.info("[loadErrorCodes0][加载到 ({}) 个错误码]", errorCodeRespDTOs.size());
+
+            // 刷新错误码的缓存
+            errorCodeRespDTOs.forEach(errorCodeRespDTO -> {
+                // 写入到错误码的缓存
+                putErrorCode(errorCodeRespDTO.getCode(), errorCodeRespDTO.getMessage());
+                // 记录下更新时间，方便增量更新
+                maxUpdateTime = DateUtils.max(maxUpdateTime, errorCodeRespDTO.getUpdateTime());
+            });
+        } catch (Exception ex) {
+            log.error("[loadErrorCodes0][加载错误码失败({})]", ExceptionUtil.getRootCauseMessage(ex));
+        }
+    }
+
+}
@@ -4,3 +4,6 @@ com.cf.imes.framework.swagger.config.ChenfengSwaggerAutoConfiguration
 com.cf.imes.framework.web.config.ChenfengWebAutoConfiguration
 com.cf.imes.framework.apilog.config.ChenfengApiLogRpcAutoConfiguration
 com.cf.imes.framework.async.ChenfengAsyncAutoConfiguration
+com.cf.imes.framework.banner.config.ChenfengBannerAutoConfiguration
+com.cf.imes.framework.errorcode.config.ChenfengErrorCodeRpcAutoConfiguration
+com.cf.imes.framework.errorcode.config.ChenfengErrorCodeAutoConfiguration
@@ -0,0 +1,17 @@
+晨丰科技 http://www.cf.com
+Application Version: ${chenfeng.info.version}
+Spring Boot Version: ${spring-boot.version}
+
+.__   __.   ______      .______    __    __    _______
+|  \ |  |  /  __  \     |   _  \  |  |  |  |  /  _____|
+|   \|  | |  |  |  |    |  |_)  | |  |  |  | |  |  __
+|  . `  | |  |  |  |    |   _  <  |  |  |  | |  | |_ |
+|  |\   | |  `--'  |    |  |_)  | |  `--'  | |  |__| |
+|__| \__|  \______/     |______/   \______/   \______|
+
+███╗   ██╗ ██████╗     ██████╗ ██╗   ██╗ ██████╗
+████╗  ██║██╔═══██╗    ██╔══██╗██║   ██║██╔════╝
+██╔██╗ ██║██║   ██║    ██████╔╝██║   ██║██║  ███╗
+██║╚██╗██║██║   ██║    ██╔══██╗██║   ██║██║   ██║
+██║ ╚████║╚██████╔╝    ██████╔╝╚██████╔╝╚██████╔╝
+╚═╝  ╚═══╝ ╚═════╝     ╚═════╝  ╚═════╝  ╚═════╝