docs 补充项目注释

2026-06-01 13:58:13 +08:00
parent 107d3326b4
commit e49f3b2260
94 changed files with 2328 additions and 68 deletions
@@ -14,7 +14,7 @@ import java.util.concurrent.*;
 * 线程池配置
 *
 * @author Lion Li
- **/
+ */
@Slf4j
@AutoConfiguration
 public class ThreadPoolConfig {
@@ -20,6 +20,9 @@ import java.util.concurrent.TimeUnit;
 * @author ruoyi
 */
 public class DateUtils extends org.apache.commons.lang3.time.DateUtils {
+    /**
+     * 日期解析格式集合。
+     */
    private static final String[] PARSE_PATTERNS = {
        "yyyy-MM-dd", "yyyy-MM-dd HH:mm:ss", "yyyy-MM-dd HH:mm", "yyyy-MM",
        "yyyy/MM/dd", "yyyy/MM/dd HH:mm:ss", "yyyy/MM/dd HH:mm", "yyyy/MM",
@@ -6,25 +6,56 @@ package org.dromara.common.core.utils.file;
 * @author ruoyi
 */
 public class MimeTypeUtils {
+
+    /**
+     * PNG 图片 MIME 类型。
+     */
    public static final String IMAGE_PNG = "image/png";

+    /**
+     * JPG 图片 MIME 类型。
+     */
    public static final String IMAGE_JPG = "image/jpg";

+    /**
+     * JPEG 图片 MIME 类型。
+     */
    public static final String IMAGE_JPEG = "image/jpeg";

+    /**
+     * BMP 图片 MIME 类型。
+     */
    public static final String IMAGE_BMP = "image/bmp";

+    /**
+     * GIF 图片 MIME 类型。
+     */
    public static final String IMAGE_GIF = "image/gif";

+    /**
+     * 图片扩展名集合。
+     */
    public static final String[] IMAGE_EXTENSION = {"bmp", "gif", "jpg", "jpeg", "png"};

+    /**
+     * Flash 扩展名集合。
+     */
    public static final String[] FLASH_EXTENSION = {"swf", "flv"};

+    /**
+     * 媒体扩展名集合。
+     */
    public static final String[] MEDIA_EXTENSION = {"swf", "flv", "mp3", "wav", "wma", "wmv", "mid", "avi", "mpg",
        "asf", "rm", "rmvb"};

+    /**
+     * 视频扩展名集合。
+     */
    public static final String[] VIDEO_EXTENSION = {"mp4", "avi", "rmvb"};

+    /**
+     * 默认允许上传扩展名集合。
+     */
    public static final String[] DEFAULT_ALLOWED_EXTENSION = {
        // 图片
        "bmp", "gif", "jpg", "jpeg", "png",
@@ -16,8 +16,16 @@ import java.util.Set;
 */
 public class EnumPatternValidator implements ConstraintValidator<EnumPattern, String> {

+    /**
+     * 枚举允许值集合。
+     */
    private final Set<String> values = new HashSet<>();

+    /**
+     * 初始化枚举允许值集合。
+     *
+     * @param annotation 枚举校验注解
+     */
    @Override
    public void initialize(EnumPattern annotation) {
        ConstraintValidator.super.initialize(annotation);
@@ -33,6 +41,13 @@ public class EnumPatternValidator implements ConstraintValidator<EnumPattern, St
        }
    }

+    /**
+     * 校验字符串是否在枚举允许值集合内。
+     *
+     * @param value                      待校验值
+     * @param constraintValidatorContext 校验上下文
+     * @return true 校验通过 false 校验失败
+     */
    @Override
    public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
        if (StringUtils.isBlank(value)) {
@@ -13,6 +13,13 @@ import org.dromara.common.core.utils.StringUtils;
 */
 public class XssValidator implements ConstraintValidator<Xss, String> {

+    /**
+     * 校验字符串是否包含 HTML 标签。
+     *
+     * @param value                      待校验值
+     * @param constraintValidatorContext 校验上下文
+     * @return true 校验通过 false 包含 HTML 标签
+     */
    @Override
    public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
        if (StringUtils.isBlank(value)) {