From 63165c666681bd282889a3a6db2af32ca9a4bd0c Mon Sep 17 00:00:00 2001 From: SerLiunx-ctrl <17689543@qq.com> Date: Mon, 17 Jun 2024 09:09:17 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=90=84=E4=B8=AA=E7=B1=BB=E7=9A=84?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=B3=A8=E9=87=8A=E8=B0=83=E6=95=B4,=20?= =?UTF-8?q?=E6=9B=B4=E6=96=B0=E4=BD=9C=E8=80=85=E4=BF=A1=E6=81=AF.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/main/java/com/serliunx/ddns/ManagerLite.java | 5 +++-- .../com/serliunx/ddns/config/AbstractConfiguration.java | 5 +++-- src/main/java/com/serliunx/ddns/config/Configuration.java | 5 +++-- .../java/com/serliunx/ddns/config/ConfigurationKeys.java | 5 +++-- .../java/com/serliunx/ddns/config/FileConfiguration.java | 5 ++++- .../com/serliunx/ddns/config/PropertiesConfiguration.java | 5 +++-- .../java/com/serliunx/ddns/constant/InstanceClasses.java | 5 +++-- .../java/com/serliunx/ddns/constant/InstanceFileType.java | 5 +++-- .../java/com/serliunx/ddns/constant/InstanceSource.java | 5 +++-- .../java/com/serliunx/ddns/constant/InstanceType.java | 5 +++-- .../java/com/serliunx/ddns/constant/SystemConstants.java | 5 +++-- src/main/java/com/serliunx/ddns/core/Clearable.java | 3 +++ .../java/com/serliunx/ddns/core/InstanceFileFilter.java | 5 +++-- src/main/java/com/serliunx/ddns/core/Priority.java | 5 +++-- src/main/java/com/serliunx/ddns/core/Refreshable.java | 5 +++-- .../ddns/core/context/AbstractInstanceContext.java | 5 +++-- .../serliunx/ddns/core/context/FileInstanceContext.java | 5 +++-- .../ddns/core/context/GenericInstanceContext.java | 5 +++-- .../com/serliunx/ddns/core/context/InstanceContext.java | 6 ++++-- .../ddns/core/context/MultipleSourceInstanceContext.java | 5 +++-- .../ddns/core/factory/AbstractInstanceFactory.java | 8 ++++++-- .../ddns/core/factory/DatabaseInstanceFactory.java | 5 +++-- .../serliunx/ddns/core/factory/FileInstanceFactory.java | 8 ++++++-- .../com/serliunx/ddns/core/factory/InstanceFactory.java | 7 +++++-- .../ddns/core/factory/JacksonFileInstanceFactory.java | 5 +++-- .../ddns/core/factory/JsonFileInstanceFactory.java | 5 +++-- .../ddns/core/factory/ListableInstanceFactory.java | 7 +++++-- .../ddns/core/factory/XmlFileInstanceFactory.java | 5 +++-- .../ddns/core/factory/YamlFileInstanceFactory.java | 7 +++++-- .../com/serliunx/ddns/core/instance/AbstractInstance.java | 5 +++-- .../com/serliunx/ddns/core/instance/AliyunInstance.java | 5 +++-- .../com/serliunx/ddns/core/instance/HuaweiInstance.java | 5 +++-- .../java/com/serliunx/ddns/core/instance/Instance.java | 6 ++++-- .../com/serliunx/ddns/core/instance/TencentInstance.java | 5 +++-- .../com/serliunx/ddns/exception/InstanceException.java | 3 ++- .../serliunx/ddns/exception/InstanceExistsException.java | 3 ++- src/main/java/com/serliunx/ddns/support/Assert.java | 5 +++-- src/main/java/com/serliunx/ddns/support/Configurer.java | 7 +++++-- .../com/serliunx/ddns/support/NetworkContextHolder.java | 5 +++-- .../java/com/serliunx/ddns/support/SystemInitializer.java | 5 +++-- .../com/serliunx/ddns/support/feign/JacksonDecoder.java | 5 +++-- .../com/serliunx/ddns/support/feign/JacksonEncoder.java | 5 +++-- .../ddns/support/feign/client/IPAddressClient.java | 5 +++-- .../support/feign/client/entity/IPAddressResponse.java | 5 +++-- .../java/com/serliunx/ddns/thread/TaskThreadFactory.java | 6 ++++-- .../java/com/serliunx/ddns/thread/UtilThreadFactory.java | 6 ++++-- src/main/java/com/serliunx/ddns/util/InstanceUtils.java | 5 +++-- src/main/java/com/serliunx/ddns/util/ReflectionUtils.java | 5 +++-- 48 files changed, 161 insertions(+), 91 deletions(-) diff --git a/src/main/java/com/serliunx/ddns/ManagerLite.java b/src/main/java/com/serliunx/ddns/ManagerLite.java index ed00292..aa90b11 100644 --- a/src/main/java/com/serliunx/ddns/ManagerLite.java +++ b/src/main/java/com/serliunx/ddns/ManagerLite.java @@ -7,8 +7,9 @@ import com.serliunx.ddns.support.SystemInitializer; /** * 启动类 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public final class ManagerLite { diff --git a/src/main/java/com/serliunx/ddns/config/AbstractConfiguration.java b/src/main/java/com/serliunx/ddns/config/AbstractConfiguration.java index 6adbab6..b751f23 100644 --- a/src/main/java/com/serliunx/ddns/config/AbstractConfiguration.java +++ b/src/main/java/com/serliunx/ddns/config/AbstractConfiguration.java @@ -11,8 +11,9 @@ import java.util.concurrent.locks.ReentrantLock; /** * 配置信息的抽象实现, 定义公共逻辑 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public abstract class AbstractConfiguration implements Configuration { diff --git a/src/main/java/com/serliunx/ddns/config/Configuration.java b/src/main/java/com/serliunx/ddns/config/Configuration.java index 9139660..82fe5b4 100644 --- a/src/main/java/com/serliunx/ddns/config/Configuration.java +++ b/src/main/java/com/serliunx/ddns/config/Configuration.java @@ -5,8 +5,9 @@ import com.serliunx.ddns.core.Refreshable; /** * 配置信息逻辑定义 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public interface Configuration extends Refreshable, Priority { diff --git a/src/main/java/com/serliunx/ddns/config/ConfigurationKeys.java b/src/main/java/com/serliunx/ddns/config/ConfigurationKeys.java index 2d084e2..09ed943 100644 --- a/src/main/java/com/serliunx/ddns/config/ConfigurationKeys.java +++ b/src/main/java/com/serliunx/ddns/config/ConfigurationKeys.java @@ -2,8 +2,9 @@ package com.serliunx.ddns.config; /** * 配置文件键常量信息 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public final class ConfigurationKeys { diff --git a/src/main/java/com/serliunx/ddns/config/FileConfiguration.java b/src/main/java/com/serliunx/ddns/config/FileConfiguration.java index b4b6aa2..c06b848 100644 --- a/src/main/java/com/serliunx/ddns/config/FileConfiguration.java +++ b/src/main/java/com/serliunx/ddns/config/FileConfiguration.java @@ -1,8 +1,11 @@ package com.serliunx.ddns.config; /** + * 文件配置管理 + * @see PropertiesConfiguration * @author SerLiunx - * @since 1.0 + * @version 1.0.0 + * @since 2024/5/15 */ public abstract class FileConfiguration extends AbstractConfiguration { diff --git a/src/main/java/com/serliunx/ddns/config/PropertiesConfiguration.java b/src/main/java/com/serliunx/ddns/config/PropertiesConfiguration.java index 7dc2deb..0e453f5 100644 --- a/src/main/java/com/serliunx/ddns/config/PropertiesConfiguration.java +++ b/src/main/java/com/serliunx/ddns/config/PropertiesConfiguration.java @@ -13,8 +13,9 @@ import java.util.Set; /** * 使用{@link Properties}实现的简单读取键值对形式的配置信息实现 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public class PropertiesConfiguration extends FileConfiguration { diff --git a/src/main/java/com/serliunx/ddns/constant/InstanceClasses.java b/src/main/java/com/serliunx/ddns/constant/InstanceClasses.java index b4369fa..50f04a6 100644 --- a/src/main/java/com/serliunx/ddns/constant/InstanceClasses.java +++ b/src/main/java/com/serliunx/ddns/constant/InstanceClasses.java @@ -9,8 +9,9 @@ import java.util.Map; /** * 实例类型集合 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public final class InstanceClasses { private InstanceClasses(){throw new UnsupportedOperationException();} diff --git a/src/main/java/com/serliunx/ddns/constant/InstanceFileType.java b/src/main/java/com/serliunx/ddns/constant/InstanceFileType.java index 7dac84c..cbcfeec 100644 --- a/src/main/java/com/serliunx/ddns/constant/InstanceFileType.java +++ b/src/main/java/com/serliunx/ddns/constant/InstanceFileType.java @@ -2,8 +2,9 @@ package com.serliunx.ddns.constant; /** * 保存实例的文件类型: XML、JSON等 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public enum InstanceFileType { XML(".xml"), diff --git a/src/main/java/com/serliunx/ddns/constant/InstanceSource.java b/src/main/java/com/serliunx/ddns/constant/InstanceSource.java index 3698b08..929eb55 100644 --- a/src/main/java/com/serliunx/ddns/constant/InstanceSource.java +++ b/src/main/java/com/serliunx/ddns/constant/InstanceSource.java @@ -4,8 +4,9 @@ import static com.serliunx.ddns.constant.SystemConstants.*; /** * 实例来源 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public enum InstanceSource { FILE_JSON(JSON_FILE), diff --git a/src/main/java/com/serliunx/ddns/constant/InstanceType.java b/src/main/java/com/serliunx/ddns/constant/InstanceType.java index 50c9f75..95f052c 100644 --- a/src/main/java/com/serliunx/ddns/constant/InstanceType.java +++ b/src/main/java/com/serliunx/ddns/constant/InstanceType.java @@ -2,8 +2,9 @@ package com.serliunx.ddns.constant; /** * 实例类型: 阿里云、华为云、腾讯云等 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public enum InstanceType { diff --git a/src/main/java/com/serliunx/ddns/constant/SystemConstants.java b/src/main/java/com/serliunx/ddns/constant/SystemConstants.java index 772d7d9..8f0744a 100644 --- a/src/main/java/com/serliunx/ddns/constant/SystemConstants.java +++ b/src/main/java/com/serliunx/ddns/constant/SystemConstants.java @@ -4,8 +4,9 @@ import java.io.File; /** * 系统常量 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public final class SystemConstants { diff --git a/src/main/java/com/serliunx/ddns/core/Clearable.java b/src/main/java/com/serliunx/ddns/core/Clearable.java index b7681b9..7e1becb 100644 --- a/src/main/java/com/serliunx/ddns/core/Clearable.java +++ b/src/main/java/com/serliunx/ddns/core/Clearable.java @@ -3,6 +3,9 @@ package com.serliunx.ddns.core; /** * 定义一个实体的清理逻辑 *
  • 一般用来清理中间加载过程中所产生的无用对象 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ @FunctionalInterface public interface Clearable { diff --git a/src/main/java/com/serliunx/ddns/core/InstanceFileFilter.java b/src/main/java/com/serliunx/ddns/core/InstanceFileFilter.java index bbaedd5..65b411a 100644 --- a/src/main/java/com/serliunx/ddns/core/InstanceFileFilter.java +++ b/src/main/java/com/serliunx/ddns/core/InstanceFileFilter.java @@ -5,8 +5,9 @@ import java.io.FileFilter; /** * 文件过滤器, 用于加载过滤存储在文件中的实例信息时 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 * @see com.serliunx.ddns.core.factory.FileInstanceFactory */ public final class InstanceFileFilter implements FileFilter { diff --git a/src/main/java/com/serliunx/ddns/core/Priority.java b/src/main/java/com/serliunx/ddns/core/Priority.java index 60e3e7f..bc7a4b8 100644 --- a/src/main/java/com/serliunx/ddns/core/Priority.java +++ b/src/main/java/com/serliunx/ddns/core/Priority.java @@ -3,8 +3,9 @@ package com.serliunx.ddns.core; /** * 定义一个对象的优先级 *
  • 数字越大, 优先级越小 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ @FunctionalInterface public interface Priority { diff --git a/src/main/java/com/serliunx/ddns/core/Refreshable.java b/src/main/java/com/serliunx/ddns/core/Refreshable.java index efec483..81b71e8 100644 --- a/src/main/java/com/serliunx/ddns/core/Refreshable.java +++ b/src/main/java/com/serliunx/ddns/core/Refreshable.java @@ -2,8 +2,9 @@ package com.serliunx.ddns.core; /** * 刷新逻辑 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ @FunctionalInterface public interface Refreshable { diff --git a/src/main/java/com/serliunx/ddns/core/context/AbstractInstanceContext.java b/src/main/java/com/serliunx/ddns/core/context/AbstractInstanceContext.java index 3965420..e1bce03 100644 --- a/src/main/java/com/serliunx/ddns/core/context/AbstractInstanceContext.java +++ b/src/main/java/com/serliunx/ddns/core/context/AbstractInstanceContext.java @@ -19,8 +19,9 @@ import static com.serliunx.ddns.util.InstanceUtils.validateInstance; /** * 实例容器的抽象实现, 定义大部分公共逻辑 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public abstract class AbstractInstanceContext implements InstanceContext, MultipleSourceInstanceContext { diff --git a/src/main/java/com/serliunx/ddns/core/context/FileInstanceContext.java b/src/main/java/com/serliunx/ddns/core/context/FileInstanceContext.java index e748a32..a6a03a1 100644 --- a/src/main/java/com/serliunx/ddns/core/context/FileInstanceContext.java +++ b/src/main/java/com/serliunx/ddns/core/context/FileInstanceContext.java @@ -7,8 +7,9 @@ import com.serliunx.ddns.core.factory.YamlFileInstanceFactory; /** * 文件形式的实例容器 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public class FileInstanceContext extends AbstractInstanceContext { diff --git a/src/main/java/com/serliunx/ddns/core/context/GenericInstanceContext.java b/src/main/java/com/serliunx/ddns/core/context/GenericInstanceContext.java index 5efa4ac..8974307 100644 --- a/src/main/java/com/serliunx/ddns/core/context/GenericInstanceContext.java +++ b/src/main/java/com/serliunx/ddns/core/context/GenericInstanceContext.java @@ -2,8 +2,9 @@ package com.serliunx.ddns.core.context; /** * 简易的容器实现, 需要手动进行刷新、添加实例工厂. - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/25 */ public class GenericInstanceContext extends AbstractInstanceContext { diff --git a/src/main/java/com/serliunx/ddns/core/context/InstanceContext.java b/src/main/java/com/serliunx/ddns/core/context/InstanceContext.java index 699b723..3f2f5d7 100644 --- a/src/main/java/com/serliunx/ddns/core/context/InstanceContext.java +++ b/src/main/java/com/serliunx/ddns/core/context/InstanceContext.java @@ -3,8 +3,10 @@ package com.serliunx.ddns.core.context; import com.serliunx.ddns.core.factory.InstanceFactory; /** - * @author SerLiunx - * @since 1.0 + * 实例容器接口定义 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public interface InstanceContext extends InstanceFactory { diff --git a/src/main/java/com/serliunx/ddns/core/context/MultipleSourceInstanceContext.java b/src/main/java/com/serliunx/ddns/core/context/MultipleSourceInstanceContext.java index 2590877..a739270 100644 --- a/src/main/java/com/serliunx/ddns/core/context/MultipleSourceInstanceContext.java +++ b/src/main/java/com/serliunx/ddns/core/context/MultipleSourceInstanceContext.java @@ -9,8 +9,9 @@ import java.util.Set; * 多数据源的实例容器, 将多种实例来源汇聚到一起 * @see InstanceFactory * @see InstanceContext - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public interface MultipleSourceInstanceContext extends InstanceContext, ListableInstanceFactory { diff --git a/src/main/java/com/serliunx/ddns/core/factory/AbstractInstanceFactory.java b/src/main/java/com/serliunx/ddns/core/factory/AbstractInstanceFactory.java index 69c7b95..8c8add3 100644 --- a/src/main/java/com/serliunx/ddns/core/factory/AbstractInstanceFactory.java +++ b/src/main/java/com/serliunx/ddns/core/factory/AbstractInstanceFactory.java @@ -12,8 +12,12 @@ import java.util.stream.Collectors; import static com.serliunx.ddns.util.InstanceUtils.validateInstance; /** - * @author SerLiunx - * @since 1.0 + * 实例工厂抽象实现, 定义通用逻辑及实例存储. + * @see FileInstanceFactory + * @see DatabaseInstanceFactory + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public abstract class AbstractInstanceFactory implements InstanceFactory, ListableInstanceFactory { diff --git a/src/main/java/com/serliunx/ddns/core/factory/DatabaseInstanceFactory.java b/src/main/java/com/serliunx/ddns/core/factory/DatabaseInstanceFactory.java index 01d08e6..4ead103 100644 --- a/src/main/java/com/serliunx/ddns/core/factory/DatabaseInstanceFactory.java +++ b/src/main/java/com/serliunx/ddns/core/factory/DatabaseInstanceFactory.java @@ -7,8 +7,9 @@ import java.util.Set; /** * 数据库实例工厂 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public abstract class DatabaseInstanceFactory extends AbstractInstanceFactory { diff --git a/src/main/java/com/serliunx/ddns/core/factory/FileInstanceFactory.java b/src/main/java/com/serliunx/ddns/core/factory/FileInstanceFactory.java index 4dbc171..44043b2 100644 --- a/src/main/java/com/serliunx/ddns/core/factory/FileInstanceFactory.java +++ b/src/main/java/com/serliunx/ddns/core/factory/FileInstanceFactory.java @@ -8,8 +8,12 @@ import java.util.*; import java.util.stream.Collectors; /** - * @author SerLiunx - * @since 1.0 + * 文件相关实例工厂, 定义所有来源为文件的实例工厂通用逻辑 + * @see JacksonFileInstanceFactory 使用Jackson序列化、反序列化的实例 + * @see YamlFileInstanceFactory 使用SankeYaml序列化、反序列化的实例 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public abstract class FileInstanceFactory extends AbstractInstanceFactory { diff --git a/src/main/java/com/serliunx/ddns/core/factory/InstanceFactory.java b/src/main/java/com/serliunx/ddns/core/factory/InstanceFactory.java index 152a286..8beb621 100644 --- a/src/main/java/com/serliunx/ddns/core/factory/InstanceFactory.java +++ b/src/main/java/com/serliunx/ddns/core/factory/InstanceFactory.java @@ -6,8 +6,11 @@ import com.serliunx.ddns.core.Refreshable; import com.serliunx.ddns.core.instance.Instance; /** - * @author SerLiunx - * @since 1.0 + * 简单的实例工厂逻辑定义, 添加、获取实例. + *
  • 属于顶层接口, 定义了通用行为: 如刷新和清理逻辑、排序规则等. + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public interface InstanceFactory extends Priority, Comparable, Refreshable, Clearable { diff --git a/src/main/java/com/serliunx/ddns/core/factory/JacksonFileInstanceFactory.java b/src/main/java/com/serliunx/ddns/core/factory/JacksonFileInstanceFactory.java index 02eecc3..da53952 100644 --- a/src/main/java/com/serliunx/ddns/core/factory/JacksonFileInstanceFactory.java +++ b/src/main/java/com/serliunx/ddns/core/factory/JacksonFileInstanceFactory.java @@ -12,8 +12,9 @@ import static com.serliunx.ddns.constant.InstanceClasses.match; /** * Jackson文件实例工厂, 使用jackson的ObjectMapper来分别处理json和xml - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 * @see ObjectMapper * @see com.fasterxml.jackson.dataformat.xml.XmlMapper * @see com.fasterxml.jackson.databind.json.JsonMapper diff --git a/src/main/java/com/serliunx/ddns/core/factory/JsonFileInstanceFactory.java b/src/main/java/com/serliunx/ddns/core/factory/JsonFileInstanceFactory.java index 1ff345e..5f3f31a 100644 --- a/src/main/java/com/serliunx/ddns/core/factory/JsonFileInstanceFactory.java +++ b/src/main/java/com/serliunx/ddns/core/factory/JsonFileInstanceFactory.java @@ -6,8 +6,9 @@ import com.serliunx.ddns.core.instance.Instance; /** * Jackson-Json文件实例工厂 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public class JsonFileInstanceFactory extends JacksonFileInstanceFactory { diff --git a/src/main/java/com/serliunx/ddns/core/factory/ListableInstanceFactory.java b/src/main/java/com/serliunx/ddns/core/factory/ListableInstanceFactory.java index 928addb..0d1e521 100644 --- a/src/main/java/com/serliunx/ddns/core/factory/ListableInstanceFactory.java +++ b/src/main/java/com/serliunx/ddns/core/factory/ListableInstanceFactory.java @@ -7,8 +7,11 @@ import java.util.Map; import java.util.Set; /** - * @author SerLiunx - * @since 1.0 + * 扩展型实自工厂接口, 定义了批量获取、筛选实例的方式. + * @see InstanceFactory + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public interface ListableInstanceFactory extends InstanceFactory { diff --git a/src/main/java/com/serliunx/ddns/core/factory/XmlFileInstanceFactory.java b/src/main/java/com/serliunx/ddns/core/factory/XmlFileInstanceFactory.java index 2d80c2e..01daf86 100644 --- a/src/main/java/com/serliunx/ddns/core/factory/XmlFileInstanceFactory.java +++ b/src/main/java/com/serliunx/ddns/core/factory/XmlFileInstanceFactory.java @@ -6,8 +6,9 @@ import com.serliunx.ddns.core.instance.Instance; /** * Jackson-Xml文件实例工厂 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public class XmlFileInstanceFactory extends JacksonFileInstanceFactory { diff --git a/src/main/java/com/serliunx/ddns/core/factory/YamlFileInstanceFactory.java b/src/main/java/com/serliunx/ddns/core/factory/YamlFileInstanceFactory.java index e7b994e..4049354 100644 --- a/src/main/java/com/serliunx/ddns/core/factory/YamlFileInstanceFactory.java +++ b/src/main/java/com/serliunx/ddns/core/factory/YamlFileInstanceFactory.java @@ -20,8 +20,11 @@ import java.util.Map; import static com.serliunx.ddns.constant.SystemConstants.TYPE_FIELD; /** - * @author SerLiunx - * @since 1.0 + * Yaml文件实例工厂, 使用SnakeYaml来反序列化实例. 属于文件型实例工厂. + * @see FileInstanceFactory + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public class YamlFileInstanceFactory extends FileInstanceFactory { diff --git a/src/main/java/com/serliunx/ddns/core/instance/AbstractInstance.java b/src/main/java/com/serliunx/ddns/core/instance/AbstractInstance.java index bc402a8..3b5789b 100644 --- a/src/main/java/com/serliunx/ddns/core/instance/AbstractInstance.java +++ b/src/main/java/com/serliunx/ddns/core/instance/AbstractInstance.java @@ -14,8 +14,9 @@ import static com.serliunx.ddns.constant.SystemConstants.XML_ROOT_INSTANCE_NAME; /** * 实例抽象实现 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) diff --git a/src/main/java/com/serliunx/ddns/core/instance/AliyunInstance.java b/src/main/java/com/serliunx/ddns/core/instance/AliyunInstance.java index d6d09ff..8e921c9 100644 --- a/src/main/java/com/serliunx/ddns/core/instance/AliyunInstance.java +++ b/src/main/java/com/serliunx/ddns/core/instance/AliyunInstance.java @@ -21,8 +21,9 @@ import static com.serliunx.ddns.constant.SystemConstants.XML_ROOT_INSTANCE_NAME; /** * 阿里云实例定义 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ @SuppressWarnings("all") @JacksonXmlRootElement(localName = XML_ROOT_INSTANCE_NAME) diff --git a/src/main/java/com/serliunx/ddns/core/instance/HuaweiInstance.java b/src/main/java/com/serliunx/ddns/core/instance/HuaweiInstance.java index 69c09f7..8a96e9f 100644 --- a/src/main/java/com/serliunx/ddns/core/instance/HuaweiInstance.java +++ b/src/main/java/com/serliunx/ddns/core/instance/HuaweiInstance.java @@ -2,8 +2,9 @@ package com.serliunx.ddns.core.instance; /** * 华为云实例定义 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public class HuaweiInstance extends AbstractInstance { diff --git a/src/main/java/com/serliunx/ddns/core/instance/Instance.java b/src/main/java/com/serliunx/ddns/core/instance/Instance.java index ede56d0..81b26e2 100644 --- a/src/main/java/com/serliunx/ddns/core/instance/Instance.java +++ b/src/main/java/com/serliunx/ddns/core/instance/Instance.java @@ -5,8 +5,10 @@ import com.serliunx.ddns.constant.InstanceType; import com.serliunx.ddns.core.Refreshable; /** - * @author SerLiunx - * @since 1.0 + * 实例行为、参数定义接口 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public interface Instance extends Runnable, Refreshable { diff --git a/src/main/java/com/serliunx/ddns/core/instance/TencentInstance.java b/src/main/java/com/serliunx/ddns/core/instance/TencentInstance.java index 54f7b30..1c25b7e 100644 --- a/src/main/java/com/serliunx/ddns/core/instance/TencentInstance.java +++ b/src/main/java/com/serliunx/ddns/core/instance/TencentInstance.java @@ -2,8 +2,9 @@ package com.serliunx.ddns.core.instance; /** * 腾讯云实例定义 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public class TencentInstance extends AbstractInstance { diff --git a/src/main/java/com/serliunx/ddns/exception/InstanceException.java b/src/main/java/com/serliunx/ddns/exception/InstanceException.java index 488e842..6fb8b22 100644 --- a/src/main/java/com/serliunx/ddns/exception/InstanceException.java +++ b/src/main/java/com/serliunx/ddns/exception/InstanceException.java @@ -3,7 +3,8 @@ package com.serliunx.ddns.exception; /** * 实例相关异常信息 * @author SerLiunx - * @since 1.0 + * @version 1.0.0 + * @since 2024/5/15 */ public abstract class InstanceException extends RuntimeException { diff --git a/src/main/java/com/serliunx/ddns/exception/InstanceExistsException.java b/src/main/java/com/serliunx/ddns/exception/InstanceExistsException.java index f9f0c74..715b940 100644 --- a/src/main/java/com/serliunx/ddns/exception/InstanceExistsException.java +++ b/src/main/java/com/serliunx/ddns/exception/InstanceExistsException.java @@ -5,7 +5,8 @@ import com.serliunx.ddns.core.instance.Instance; /** * 异常信息, 实例已存在 * @author SerLiunx - * @since 1.0 + * @version 1.0.0 + * @since 2024/5/15 */ public class InstanceExistsException extends InstanceException { diff --git a/src/main/java/com/serliunx/ddns/support/Assert.java b/src/main/java/com/serliunx/ddns/support/Assert.java index 6bfe5f3..f3c48c9 100644 --- a/src/main/java/com/serliunx/ddns/support/Assert.java +++ b/src/main/java/com/serliunx/ddns/support/Assert.java @@ -4,8 +4,9 @@ import java.util.Collection; /** * 断言 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public final class Assert { diff --git a/src/main/java/com/serliunx/ddns/support/Configurer.java b/src/main/java/com/serliunx/ddns/support/Configurer.java index 332aa35..7fe6ce1 100644 --- a/src/main/java/com/serliunx/ddns/support/Configurer.java +++ b/src/main/java/com/serliunx/ddns/support/Configurer.java @@ -4,8 +4,11 @@ import com.serliunx.ddns.config.Configuration; import com.serliunx.ddns.core.context.MultipleSourceInstanceContext; /** - * @author SerLiunx - * @since 1.0 + * 系统启动配置器 + * @see SystemInitializer + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public final class Configurer { diff --git a/src/main/java/com/serliunx/ddns/support/NetworkContextHolder.java b/src/main/java/com/serliunx/ddns/support/NetworkContextHolder.java index 1389ccf..baa6ca0 100644 --- a/src/main/java/com/serliunx/ddns/support/NetworkContextHolder.java +++ b/src/main/java/com/serliunx/ddns/support/NetworkContextHolder.java @@ -10,8 +10,9 @@ import java.util.concurrent.locks.ReentrantLock; /** * 网络参数上下文, 目前仅用于存储本机网络IP - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public final class NetworkContextHolder { diff --git a/src/main/java/com/serliunx/ddns/support/SystemInitializer.java b/src/main/java/com/serliunx/ddns/support/SystemInitializer.java index dab73b2..6b574b4 100644 --- a/src/main/java/com/serliunx/ddns/support/SystemInitializer.java +++ b/src/main/java/com/serliunx/ddns/support/SystemInitializer.java @@ -30,8 +30,9 @@ import static com.serliunx.ddns.config.ConfigurationKeys.KEY_THREAD_POOL_CORE_SI /** * 系统初始化 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public final class SystemInitializer implements Refreshable, Clearable { diff --git a/src/main/java/com/serliunx/ddns/support/feign/JacksonDecoder.java b/src/main/java/com/serliunx/ddns/support/feign/JacksonDecoder.java index 0a59688..b2c4f54 100644 --- a/src/main/java/com/serliunx/ddns/support/feign/JacksonDecoder.java +++ b/src/main/java/com/serliunx/ddns/support/feign/JacksonDecoder.java @@ -14,8 +14,9 @@ import java.util.Collections; /** * feign解码器 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public class JacksonDecoder implements Decoder { diff --git a/src/main/java/com/serliunx/ddns/support/feign/JacksonEncoder.java b/src/main/java/com/serliunx/ddns/support/feign/JacksonEncoder.java index ae505e7..2cda665 100644 --- a/src/main/java/com/serliunx/ddns/support/feign/JacksonEncoder.java +++ b/src/main/java/com/serliunx/ddns/support/feign/JacksonEncoder.java @@ -16,8 +16,9 @@ import java.util.Collections; /** * Feign兼容Jackson(反序列化返回值) - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public class JacksonEncoder implements Encoder { diff --git a/src/main/java/com/serliunx/ddns/support/feign/client/IPAddressClient.java b/src/main/java/com/serliunx/ddns/support/feign/client/IPAddressClient.java index 11a3dad..94e8478 100644 --- a/src/main/java/com/serliunx/ddns/support/feign/client/IPAddressClient.java +++ b/src/main/java/com/serliunx/ddns/support/feign/client/IPAddressClient.java @@ -11,8 +11,9 @@ import feign.slf4j.Slf4jLogger; /** * 本机外网IP地址获取 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ @SuppressWarnings("all") public interface IPAddressClient { diff --git a/src/main/java/com/serliunx/ddns/support/feign/client/entity/IPAddressResponse.java b/src/main/java/com/serliunx/ddns/support/feign/client/entity/IPAddressResponse.java index 09b11c9..2df2b8e 100644 --- a/src/main/java/com/serliunx/ddns/support/feign/client/entity/IPAddressResponse.java +++ b/src/main/java/com/serliunx/ddns/support/feign/client/entity/IPAddressResponse.java @@ -2,8 +2,9 @@ package com.serliunx.ddns.support.feign.client.entity; /** * IP地址查询响应 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ @SuppressWarnings("all") public class IPAddressResponse { diff --git a/src/main/java/com/serliunx/ddns/thread/TaskThreadFactory.java b/src/main/java/com/serliunx/ddns/thread/TaskThreadFactory.java index 33052d7..f2696a5 100644 --- a/src/main/java/com/serliunx/ddns/thread/TaskThreadFactory.java +++ b/src/main/java/com/serliunx/ddns/thread/TaskThreadFactory.java @@ -7,8 +7,10 @@ import java.util.concurrent.ThreadFactory; import java.util.concurrent.atomic.AtomicInteger; /** - * @author SerLiunx - * @since 1.0 + * 简易的实例活动相关的线程工厂, 仅仅定义了线程的名称规则. + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public class TaskThreadFactory implements ThreadFactory { diff --git a/src/main/java/com/serliunx/ddns/thread/UtilThreadFactory.java b/src/main/java/com/serliunx/ddns/thread/UtilThreadFactory.java index 9ef5140..1c2f693 100644 --- a/src/main/java/com/serliunx/ddns/thread/UtilThreadFactory.java +++ b/src/main/java/com/serliunx/ddns/thread/UtilThreadFactory.java @@ -1,8 +1,10 @@ package com.serliunx.ddns.thread; /** - * @author SerLiunx - * @since 1.0 + * 同 {@link TaskThreadFactory}, 暂未使用. + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public class UtilThreadFactory extends TaskThreadFactory { diff --git a/src/main/java/com/serliunx/ddns/util/InstanceUtils.java b/src/main/java/com/serliunx/ddns/util/InstanceUtils.java index c32daeb..ae8e219 100644 --- a/src/main/java/com/serliunx/ddns/util/InstanceUtils.java +++ b/src/main/java/com/serliunx/ddns/util/InstanceUtils.java @@ -5,8 +5,9 @@ import com.serliunx.ddns.support.Assert; /** * 实例相关工具方法集合 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public final class InstanceUtils { diff --git a/src/main/java/com/serliunx/ddns/util/ReflectionUtils.java b/src/main/java/com/serliunx/ddns/util/ReflectionUtils.java index ff54e01..010b8a8 100644 --- a/src/main/java/com/serliunx/ddns/util/ReflectionUtils.java +++ b/src/main/java/com/serliunx/ddns/util/ReflectionUtils.java @@ -6,8 +6,9 @@ import java.util.List; /** * 反射相关工具类 - * @author SerLiunx - * @since 1.0 + * @author SerLiunx + * @version 1.0.0 + * @since 2024/5/15 */ public final class ReflectionUtils {