From 78115e050478ad44d0da4e11da87921d5f7c55e3 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子Li <15040126243@163.com>
Date: 星期二, 14 五月 2024 21:34:54 +0800
Subject: [PATCH] !534 新增工具类注释 Merge pull request !534 from AprilWind/dev-docs
---
ruoyi-common/ruoyi-common-core/src/main/java/org/dromara/common/core/utils/ValidatorUtils.java | 13 +++++-
ruoyi-common/ruoyi-common-json/src/main/java/org/dromara/common/json/utils/JsonUtils.java | 61 +++++++++++++++++++++++++++++-
ruoyi-common/ruoyi-common-redis/src/main/java/org/dromara/common/redis/utils/RedisUtils.java | 6 +++
3 files changed, 75 insertions(+), 5 deletions(-)
diff --git a/ruoyi-common/ruoyi-common-core/src/main/java/org/dromara/common/core/utils/ValidatorUtils.java b/ruoyi-common/ruoyi-common-core/src/main/java/org/dromara/common/core/utils/ValidatorUtils.java
index f94f916..06b8fd6 100644
--- a/ruoyi-common/ruoyi-common-core/src/main/java/org/dromara/common/core/utils/ValidatorUtils.java
+++ b/ruoyi-common/ruoyi-common-core/src/main/java/org/dromara/common/core/utils/ValidatorUtils.java
@@ -1,11 +1,11 @@
package org.dromara.common.core.utils;
-import lombok.AccessLevel;
-import lombok.NoArgsConstructor;
-
import jakarta.validation.ConstraintViolation;
import jakarta.validation.ConstraintViolationException;
import jakarta.validation.Validator;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+
import java.util.Set;
/**
@@ -18,6 +18,13 @@
private static final Validator VALID = SpringUtils.getBean(Validator.class);
+ /**
+ * 瀵圭粰瀹氬璞¤繘琛屽弬鏁版牎楠岋紝骞舵牴鎹寚瀹氱殑鏍￠獙缁勮繘琛屾牎楠�
+ *
+ * @param object 瑕佽繘琛屾牎楠岀殑瀵硅薄
+ * @param groups 鏍￠獙缁�
+ * @throws ConstraintViolationException 濡傛灉鏍￠獙涓嶉�氳繃锛屽垯鎶涘嚭鍙傛暟鏍￠獙寮傚父
+ */
public static <T> void validate(T object, Class<?>... groups) {
Set<ConstraintViolation<T>> validate = VALID.validate(object, groups);
if (!validate.isEmpty()) {
diff --git a/ruoyi-common/ruoyi-common-json/src/main/java/org/dromara/common/json/utils/JsonUtils.java b/ruoyi-common/ruoyi-common-json/src/main/java/org/dromara/common/json/utils/JsonUtils.java
index 42af8da..65c2faa 100644
--- a/ruoyi-common/ruoyi-common-json/src/main/java/org/dromara/common/json/utils/JsonUtils.java
+++ b/ruoyi-common/ruoyi-common-json/src/main/java/org/dromara/common/json/utils/JsonUtils.java
@@ -7,10 +7,10 @@
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.exc.MismatchedInputException;
-import org.dromara.common.core.utils.SpringUtils;
-import org.dromara.common.core.utils.StringUtils;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
+import org.dromara.common.core.utils.SpringUtils;
+import org.dromara.common.core.utils.StringUtils;
import java.io.IOException;
import java.util.ArrayList;
@@ -30,6 +30,13 @@
return OBJECT_MAPPER;
}
+ /**
+ * 灏嗗璞¤浆鎹负JSON鏍煎紡鐨勫瓧绗︿覆
+ *
+ * @param object 瑕佽浆鎹㈢殑瀵硅薄
+ * @return JSON鏍煎紡鐨勫瓧绗︿覆锛屽鏋滃璞′负null锛屽垯杩斿洖null
+ * @throws RuntimeException 濡傛灉杞崲杩囩▼涓彂鐢烰SON澶勭悊寮傚父锛屽垯鎶涘嚭杩愯鏃跺紓甯�
+ */
public static String toJsonString(Object object) {
if (ObjectUtil.isNull(object)) {
return null;
@@ -41,6 +48,15 @@
}
}
+ /**
+ * 灏咼SON鏍煎紡鐨勫瓧绗︿覆杞崲涓烘寚瀹氱被鍨嬬殑瀵硅薄
+ *
+ * @param text JSON鏍煎紡鐨勫瓧绗︿覆
+ * @param clazz 瑕佽浆鎹㈢殑鐩爣瀵硅薄绫诲瀷
+ * @param <T> 鐩爣瀵硅薄鐨勬硾鍨嬬被鍨�
+ * @return 杞崲鍚庣殑瀵硅薄锛屽鏋滃瓧绗︿覆涓虹┖鍒欒繑鍥瀗ull
+ * @throws RuntimeException 濡傛灉杞崲杩囩▼涓彂鐢烮O寮傚父锛屽垯鎶涘嚭杩愯鏃跺紓甯�
+ */
public static <T> T parseObject(String text, Class<T> clazz) {
if (StringUtils.isEmpty(text)) {
return null;
@@ -52,6 +68,15 @@
}
}
+ /**
+ * 灏嗗瓧鑺傛暟缁勮浆鎹负鎸囧畾绫诲瀷鐨勫璞�
+ *
+ * @param bytes 瀛楄妭鏁扮粍
+ * @param clazz 瑕佽浆鎹㈢殑鐩爣瀵硅薄绫诲瀷
+ * @param <T> 鐩爣瀵硅薄鐨勬硾鍨嬬被鍨�
+ * @return 杞崲鍚庣殑瀵硅薄锛屽鏋滃瓧鑺傛暟缁勪负绌哄垯杩斿洖null
+ * @throws RuntimeException 濡傛灉杞崲杩囩▼涓彂鐢烮O寮傚父锛屽垯鎶涘嚭杩愯鏃跺紓甯�
+ */
public static <T> T parseObject(byte[] bytes, Class<T> clazz) {
if (ArrayUtil.isEmpty(bytes)) {
return null;
@@ -63,6 +88,15 @@
}
}
+ /**
+ * 灏咼SON鏍煎紡鐨勫瓧绗︿覆杞崲涓烘寚瀹氱被鍨嬬殑瀵硅薄锛屾敮鎸佸鏉傜被鍨�
+ *
+ * @param text JSON鏍煎紡鐨勫瓧绗︿覆
+ * @param typeReference 鎸囧畾绫诲瀷鐨凾ypeReference瀵硅薄
+ * @param <T> 鐩爣瀵硅薄鐨勬硾鍨嬬被鍨�
+ * @return 杞崲鍚庣殑瀵硅薄锛屽鏋滃瓧绗︿覆涓虹┖鍒欒繑鍥瀗ull
+ * @throws RuntimeException 濡傛灉杞崲杩囩▼涓彂鐢烮O寮傚父锛屽垯鎶涘嚭杩愯鏃跺紓甯�
+ */
public static <T> T parseObject(String text, TypeReference<T> typeReference) {
if (StringUtils.isBlank(text)) {
return null;
@@ -74,6 +108,13 @@
}
}
+ /**
+ * 灏咼SON鏍煎紡鐨勫瓧绗︿覆杞崲涓篋ict瀵硅薄
+ *
+ * @param text JSON鏍煎紡鐨勫瓧绗︿覆
+ * @return 杞崲鍚庣殑Dict瀵硅薄锛屽鏋滃瓧绗︿覆涓虹┖鎴栬�呬笉鏄疛SON鏍煎紡鍒欒繑鍥瀗ull
+ * @throws RuntimeException 濡傛灉杞崲杩囩▼涓彂鐢烮O寮傚父锛屽垯鎶涘嚭杩愯鏃跺紓甯�
+ */
public static Dict parseMap(String text) {
if (StringUtils.isBlank(text)) {
return null;
@@ -88,6 +129,13 @@
}
}
+ /**
+ * 灏咼SON鏍煎紡鐨勫瓧绗︿覆杞崲涓篋ict瀵硅薄鐨勫垪琛�
+ *
+ * @param text JSON鏍煎紡鐨勫瓧绗︿覆
+ * @return 杞崲鍚庣殑Dict瀵硅薄鐨勫垪琛紝濡傛灉瀛楃涓蹭负绌哄垯杩斿洖null
+ * @throws RuntimeException 濡傛灉杞崲杩囩▼涓彂鐢烮O寮傚父锛屽垯鎶涘嚭杩愯鏃跺紓甯�
+ */
public static List<Dict> parseArrayMap(String text) {
if (StringUtils.isBlank(text)) {
return null;
@@ -99,6 +147,15 @@
}
}
+ /**
+ * 灏咼SON鏍煎紡鐨勫瓧绗︿覆杞崲涓烘寚瀹氱被鍨嬪璞＄殑鍒楄〃
+ *
+ * @param text JSON鏍煎紡鐨勫瓧绗︿覆
+ * @param clazz 瑕佽浆鎹㈢殑鐩爣瀵硅薄绫诲瀷
+ * @param <T> 鐩爣瀵硅薄鐨勬硾鍨嬬被鍨�
+ * @return 杞崲鍚庣殑瀵硅薄鐨勫垪琛紝濡傛灉瀛楃涓蹭负绌哄垯杩斿洖绌哄垪琛�
+ * @throws RuntimeException 濡傛灉杞崲杩囩▼涓彂鐢烮O寮傚父锛屽垯鎶涘嚭杩愯鏃跺紓甯�
+ */
public static <T> List<T> parseArray(String text, Class<T> clazz) {
if (StringUtils.isEmpty(text)) {
return new ArrayList<>();
diff --git a/ruoyi-common/ruoyi-common-redis/src/main/java/org/dromara/common/redis/utils/RedisUtils.java b/ruoyi-common/ruoyi-common-redis/src/main/java/org/dromara/common/redis/utils/RedisUtils.java
index 3fc3aac..67be2fb 100644
--- a/ruoyi-common/ruoyi-common-redis/src/main/java/org/dromara/common/redis/utils/RedisUtils.java
+++ b/ruoyi-common/ruoyi-common-redis/src/main/java/org/dromara/common/redis/utils/RedisUtils.java
@@ -65,6 +65,12 @@
consumer.accept(msg);
}
+ /**
+ * 鍙戝竷娑堟伅鍒版寚瀹氱殑棰戦亾
+ *
+ * @param channelKey 閫氶亾key
+ * @param msg 鍙戦�佹暟鎹�
+ */
public static <T> void publish(String channelKey, T msg) {
RTopic topic = CLIENT.getTopic(channelKey);
topic.publish(msg);
--
Gitblit v1.9.3