From 216a059169d68c7087df3f59dcedaa9a7bf39e2d Mon Sep 17 00:00:00 2001 From: xueye Date: Fri, 2 Jul 2021 13:11:50 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=A0=B8=E5=BF=83=E6=A8=A1=E5=9D=97?= =?UTF-8?q?=E5=AE=9E=E7=8E=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../com/cicdi/notify/AbstractNotifier.java | 27 ++++++ .../cicdi/notify/DefaultNotifierManager.java | 68 ++++++++++++++ .../com/cicdi/notify/DefaultNotifyType.java | 29 ++++++ .../main/java/com/cicdi/notify/Notifier.java | 55 +++++++++++ .../com/cicdi/notify/NotifierManager.java | 28 ++++++ .../com/cicdi/notify/NotifierProperties.java | 94 +++++++++++++++++++ .../com/cicdi/notify/NotifierProvider.java | 40 ++++++++ .../com/cicdi/notify/NotifyConfigManager.java | 19 ++++ .../java/com/cicdi/notify/NotifyType.java | 20 ++++ .../main/java/com/cicdi/notify/Provider.java | 20 ++++ .../template/AbstractTemplateManager.java | 63 +++++++++++++ .../com/cicdi/notify/template/Template.java | 11 +++ .../notify/template/TemplateManager.java | 34 +++++++ .../notify/template/TemplateProperties.java | 50 ++++++++++ .../notify/template/TemplateProvider.java | 29 ++++++ 15 files changed, 587 insertions(+) create mode 100644 notify-core/src/main/java/com/cicdi/notify/AbstractNotifier.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/DefaultNotifierManager.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/DefaultNotifyType.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/Notifier.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/NotifierManager.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/NotifierProperties.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/NotifierProvider.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/NotifyConfigManager.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/NotifyType.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/Provider.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/template/AbstractTemplateManager.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/template/Template.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/template/TemplateManager.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/template/TemplateProperties.java create mode 100644 notify-core/src/main/java/com/cicdi/notify/template/TemplateProvider.java diff --git a/notify-core/src/main/java/com/cicdi/notify/AbstractNotifier.java b/notify-core/src/main/java/com/cicdi/notify/AbstractNotifier.java new file mode 100644 index 0000000..b2454ee --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/AbstractNotifier.java @@ -0,0 +1,27 @@ +package com.cicdi.notify; + +import com.cicdi.notify.template.Template; +import com.cicdi.notify.template.TemplateManager; + +import java.util.Map; + +/** + * @author xueye + */ +public abstract class AbstractNotifier implements Notifier { + + private final TemplateManager templateManager; + + public AbstractNotifier(TemplateManager templateManager) { + this.templateManager = templateManager; + } + + @Override + public void send(String templateId, Map context) { + Template template = templateManager.getTemplate(this.getType(), templateId); + if (null == template) { + throw new UnsupportedOperationException("模版不存在:" + templateId); + } + this.send((T) template, context); + } +} diff --git a/notify-core/src/main/java/com/cicdi/notify/DefaultNotifierManager.java b/notify-core/src/main/java/com/cicdi/notify/DefaultNotifierManager.java new file mode 100644 index 0000000..103308b --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/DefaultNotifierManager.java @@ -0,0 +1,68 @@ +package com.cicdi.notify; + +import com.cicdi.notify.template.Template; + +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +/** + * @author xueye + */ +public class DefaultNotifierManager implements NotifierManager { + private final Map> providers = new ConcurrentHashMap<>(); + + private Map notifiers = new ConcurrentHashMap<>(); + + private NotifyConfigManager configManager; + +// private EventBus eventBus; + + public DefaultNotifierManager(NotifyConfigManager manager/*, EventBus eventBus*/) { + this.configManager = manager; +// this.eventBus = eventBus; + } + + protected NotifierProperties getProperties(NotifyType notifyType, String id) { + return configManager.getNotifyConfig(notifyType, id); + } + + public void reload(String id) { + Notifier notifier = notifiers.remove(id); + if (null != notifier) { + notifier.close(); + } + } + + protected Notifier createNotifier(NotifierProperties properties) { + Map providerMap = providers.get(properties.getType()); + if (null == providerMap) { + throw new UnsupportedOperationException("不支持的通知类型: " + properties.getType()); + } + NotifierProvider provider = providerMap.get(properties.getProvider()); + if (null == provider) { + throw new UnsupportedOperationException("不支持的服务商: " + properties.getProvider()); + } + Notifier notifier1 = provider.createNotifier(properties); + Notifier notifier2 = notifiers.put(properties.getId(), notifier1); + if (null != notifier2) { + notifier2.close(); + } + return notifier1; + } + + @Override + public Notifier getNotifier(NotifyType type, String id) { + Notifier notifier = notifiers.get(id); + if (null == notifier) { + notifier = createNotifier(getProperties(type, id)); + } + return notifier; + } + + @Override + public void registerProvider(NotifierProvider provider) { + providers.computeIfAbsent(provider.getType().getId(), ignore -> new ConcurrentHashMap<>()) + .put(provider.getProvider().getId(), provider); + } + +} diff --git a/notify-core/src/main/java/com/cicdi/notify/DefaultNotifyType.java b/notify-core/src/main/java/com/cicdi/notify/DefaultNotifyType.java new file mode 100644 index 0000000..4f630d1 --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/DefaultNotifyType.java @@ -0,0 +1,29 @@ +package com.cicdi.notify; + +/** + * 默认通知类型 + * + * @author xueye + */ +public enum DefaultNotifyType implements NotifyType { + + email("邮件"), + ; + + private final String name; + + DefaultNotifyType(String name) { + this.name = name; + } + + @Override + public String getId() { + return name(); + } + + @Override + public String getName() { + return name; + } + +} diff --git a/notify-core/src/main/java/com/cicdi/notify/Notifier.java b/notify-core/src/main/java/com/cicdi/notify/Notifier.java new file mode 100644 index 0000000..151368d --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/Notifier.java @@ -0,0 +1,55 @@ +package com.cicdi.notify; + +import com.cicdi.notify.template.Template; + +import java.util.Map; + +/** + * 通知器 + * + * @param 通知模板 + * @author xueye + */ +public interface Notifier { + + /** + * @return 通知器唯一标识 + */ + String getNotifierId(); + + /** + * @return 通知器类型 + * @see NotifyType + */ + NotifyType getType(); + + /** + * @return 通知提供商 + */ + Provider getProvider(); + + /** + * 指定模板ID进行发送 + * + * @param templateId 模板唯一标识 + * @param context 上下文 + */ + void send(String templateId, Map context); + + /** + * 指定模板进行发送 + * + * @param template 通知模板 + * @param context 上下文 + */ + void send(T template, Map context); + + /** + * 关闭通知器 + */ + void close(); + + default > R unwrap(Class type) { + return type.cast(this); + } +} diff --git a/notify-core/src/main/java/com/cicdi/notify/NotifierManager.java b/notify-core/src/main/java/com/cicdi/notify/NotifierManager.java new file mode 100644 index 0000000..1d16ad8 --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/NotifierManager.java @@ -0,0 +1,28 @@ +package com.cicdi.notify; + +import com.cicdi.notify.template.Template; + +/** + * 通知器管理 + * + * @author xueye + */ +public interface NotifierManager { + + /** + * @param type 通知类型 {@link NotifyType} + * @param id 唯一标识 + * @param 模板类型 + * @return 通知器 + */ + Notifier getNotifier(NotifyType type, String id); + + /** + * 重新加载通知管理器 + * + * @param id 通知管理器ID + */ + void reload(String id); + + void registerProvider(NotifierProvider provider); +} diff --git a/notify-core/src/main/java/com/cicdi/notify/NotifierProperties.java b/notify-core/src/main/java/com/cicdi/notify/NotifierProperties.java new file mode 100644 index 0000000..0c030f2 --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/NotifierProperties.java @@ -0,0 +1,94 @@ +package com.cicdi.notify; + +import java.util.Map; +import java.util.Optional; + +/** + * 通知器属性 + * + * @author xueye + */ +public class NotifierProperties { + + /** + * 唯一标识 + */ + private String id; + + /** + * 通知类型标识 + * + * @see NotifyType + */ + private String type; + + /** + * 通知服务提供商标识,如: aliyun ... + */ + private String provider; + + /** + * 配置名称 + */ + private String name; + + /** + * 配置内容,不同的服务提供商,配置不同. + * + * @see NotifierProvider + */ + private Map configuration; + + + + public Optional getConfig(String key) { + return Optional.ofNullable(configuration) + .map(conf -> conf.get(key)); + } + + public Object getConfigOrNull(String key) { + return Optional.ofNullable(configuration) + .map(conf -> conf.get(key)) + .orElse(null); + } + + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public String getProvider() { + return provider; + } + + public void setProvider(String provider) { + this.provider = provider; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public Map getConfiguration() { + return configuration; + } + + public void setConfiguration(Map configuration) { + this.configuration = configuration; + } +} diff --git a/notify-core/src/main/java/com/cicdi/notify/NotifierProvider.java b/notify-core/src/main/java/com/cicdi/notify/NotifierProvider.java new file mode 100644 index 0000000..31f423b --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/NotifierProvider.java @@ -0,0 +1,40 @@ +package com.cicdi.notify; + +import com.cicdi.notify.template.Template; + +/** + * 通知器提供商 + * + * @author xueye + */ +public interface NotifierProvider { + /** + * 获取通知类型 + * + * @return 通知类型 + * @see NotifyType + */ + NotifyType getType(); + + /** + * @return 服务商 + */ + Provider getProvider(); + + /** + * 根据配置创建通知器 + * + * @param properties 通知配置 + * @return 创建结果 + */ + Notifier createNotifier(NotifierProperties properties); + +// /** +// * 获取通知配置元数据,通过元数据可以知道此通知所需要的配置信息 +// * +// * @return 配置元数据 +// */ +// default ConfigMetadata getNotifierConfigMetadata() { +// return null; +// } +} diff --git a/notify-core/src/main/java/com/cicdi/notify/NotifyConfigManager.java b/notify-core/src/main/java/com/cicdi/notify/NotifyConfigManager.java new file mode 100644 index 0000000..f92db88 --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/NotifyConfigManager.java @@ -0,0 +1,19 @@ +package com.cicdi.notify; + +/** + * 通知器配置管理 + * + * @author xueye + */ +public interface NotifyConfigManager { + + /** + * 根据类型和配置ID获取通知器配置 + * + * @param notifyType 通知器类型 {@link NotifyType} + * @param configId 通知器配置ID + * @return 通知器配置 + */ + NotifierProperties getNotifyConfig(NotifyType notifyType, String configId); + +} diff --git a/notify-core/src/main/java/com/cicdi/notify/NotifyType.java b/notify-core/src/main/java/com/cicdi/notify/NotifyType.java new file mode 100644 index 0000000..74a6392 --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/NotifyType.java @@ -0,0 +1,20 @@ +package com.cicdi.notify; + +/** + * 通知器类型 + * + * @author xueye + */ +public interface NotifyType { + + /** + * @return 唯一标识 + */ + String getId(); + + /** + * @return 通知器名称 + */ + String getName(); + +} diff --git a/notify-core/src/main/java/com/cicdi/notify/Provider.java b/notify-core/src/main/java/com/cicdi/notify/Provider.java new file mode 100644 index 0000000..7012014 --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/Provider.java @@ -0,0 +1,20 @@ +package com.cicdi.notify; + +/** + * 提供商标识 + * + * @author xueye + */ +public interface Provider { + + /** + * @return 唯一标识 + */ + String getId(); + + /** + * @return 提供商名称 + */ + String getName(); + +} diff --git a/notify-core/src/main/java/com/cicdi/notify/template/AbstractTemplateManager.java b/notify-core/src/main/java/com/cicdi/notify/template/AbstractTemplateManager.java new file mode 100644 index 0000000..a18af76 --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/template/AbstractTemplateManager.java @@ -0,0 +1,63 @@ +package com.cicdi.notify.template; + +import com.cicdi.notify.NotifyType; + +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +/** + * 模板管理器 + * + * @author xueye + */ +public abstract class AbstractTemplateManager implements TemplateManager { + + protected Map> providers = new ConcurrentHashMap<>(); + + protected Map templates = new ConcurrentHashMap<>(); + + protected abstract TemplateProperties getProperties(NotifyType type, String id); + + /** + * 注册模板提供商 + * + * @param provider 模板提供商 + */ + @Override + public void register(TemplateProvider provider) { + providers.computeIfAbsent(provider.getType().getId(), ignore -> new ConcurrentHashMap<>()).put(provider.getProvider().getId(), provider); + } + + @Override + public Template createTemplate(NotifyType type, TemplateProperties prop) { + Map providerMap = providers.get(type.getId()); + if (null == providerMap) { + throw new UnsupportedOperationException("不支持的通知类型: " + prop.getType()); + } + TemplateProvider templateProvider = providerMap.get(prop.getProvider()); + if (null == templateProvider) { + throw new UnsupportedOperationException("不支持的提供商: " + prop.getProvider()); + } + return templateProvider.createTemplate(prop); + } + + + @Override + public Template getTemplate(NotifyType type, String id) { + Template template = templates.get(id); + if (null == template) { + TemplateProperties properties = this.getProperties(type, id); + template = this.createTemplate(type, properties); + if (null == template) { + throw new UnsupportedOperationException("通知类型不支持: " + type.getId()); + } + templates.put(id, template); + } + return template; + } + + @Override + public void reload(String templateId) { + templates.remove(templateId); + } +} diff --git a/notify-core/src/main/java/com/cicdi/notify/template/Template.java b/notify-core/src/main/java/com/cicdi/notify/template/Template.java new file mode 100644 index 0000000..4e69ad9 --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/template/Template.java @@ -0,0 +1,11 @@ +package com.cicdi.notify.template; + +import java.io.Serializable; + +/** + * 通知模板 + * + * @author xueye + */ +public interface Template extends Serializable { +} diff --git a/notify-core/src/main/java/com/cicdi/notify/template/TemplateManager.java b/notify-core/src/main/java/com/cicdi/notify/template/TemplateManager.java new file mode 100644 index 0000000..b7067c9 --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/template/TemplateManager.java @@ -0,0 +1,34 @@ +package com.cicdi.notify.template; + +import com.cicdi.notify.NotifyType; + +/** + * 通知模板管理器，用于模板的转换 + * + * @author xueye + */ +public interface TemplateManager { + + /** + * @param type 模板类型 + * @param id 模板ID + * @return 模板 + */ + Template getTemplate(NotifyType type, String id); + + /** + * @param type 模板类型 + * @param properties 模板属性 + * @return 模板 + */ + Template createTemplate(NotifyType type, TemplateProperties properties); + + /** + * 重新加载模板 + * + * @param id 模板ID + */ + void reload(String id); + + void register(TemplateProvider provider); +} diff --git a/notify-core/src/main/java/com/cicdi/notify/template/TemplateProperties.java b/notify-core/src/main/java/com/cicdi/notify/template/TemplateProperties.java new file mode 100644 index 0000000..222f9da --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/template/TemplateProperties.java @@ -0,0 +1,50 @@ +package com.cicdi.notify.template; + +import java.io.Serializable; + +/** + * 模板属性 + * + * @author xueye + */ +public class TemplateProperties implements Serializable { + + /** + * 模板类型 + */ + private String type; + + /** + * 模板提供商 + */ + private String provider; + + /** + * 模板 + */ + private String template; + + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public String getProvider() { + return provider; + } + + public void setProvider(String provider) { + this.provider = provider; + } + + public String getTemplate() { + return template; + } + + public void setTemplate(String template) { + this.template = template; + } +} diff --git a/notify-core/src/main/java/com/cicdi/notify/template/TemplateProvider.java b/notify-core/src/main/java/com/cicdi/notify/template/TemplateProvider.java new file mode 100644 index 0000000..295a49a --- /dev/null +++ b/notify-core/src/main/java/com/cicdi/notify/template/TemplateProvider.java @@ -0,0 +1,29 @@ +package com.cicdi.notify.template; + +import com.cicdi.notify.NotifyType; +import com.cicdi.notify.Provider; + +/** + * 模板提供商 + * + * @author xueye + */ +public interface TemplateProvider { + + /** + * @return 通知类型 + * @see NotifyType + */ + NotifyType getType(); + + /** + * @return 通知提供商 + */ + Provider getProvider(); + + /** + * @param properties 模板属性 + * @return 模板 + */ + Template createTemplate(TemplateProperties properties); +}