com.wl4g.component.support.notification.NotificationAutoConfiguration Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017 ~ 2025 the original author or authors. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.wl4g.component.support.notification;

import static com.wl4g.component.support.notification.NoOpMessageNotifier.*;
import static com.wl4g.component.support.constant.SupportConstant.KEY_SUPPORT_NOTIFY_PREFIX;
import static java.util.stream.Collectors.toList;

import java.util.List;

import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;

import com.wl4g.component.core.framework.operator.GenericOperatorAdapter;
import com.wl4g.component.support.notification.apns.ApnsMessageNotifier;
import com.wl4g.component.support.notification.apns.ApnsNotifyProperties;
import com.wl4g.component.support.notification.bark.BarkMessageNotifier;
import com.wl4g.component.support.notification.bark.BarkNotifyProperties;
import com.wl4g.component.support.notification.dingtalk.DingtalkMessageNotifier;
import com.wl4g.component.support.notification.dingtalk.DingtalkNotifyProperties;
import com.wl4g.component.support.notification.facebook.FacebookMessageNotifier;
import com.wl4g.component.support.notification.facebook.FacebookNotifyProperties;
import com.wl4g.component.support.notification.mail.MailMessageNotifier;
import com.wl4g.component.support.notification.mail.MailNotifyProperties;
import com.wl4g.component.support.notification.qq.QqMessageNotifier;
import com.wl4g.component.support.notification.qq.QqNotifyProperties;
import com.wl4g.component.support.notification.sms.AliyunSmsMessageNotifier;
import com.wl4g.component.support.notification.sms.SmsNotifyProperties;
import com.wl4g.component.support.notification.twitter.TwitterMessageNotifier;
import com.wl4g.component.support.notification.twitter.TwitterNotifyProperties;
import com.wl4g.component.support.notification.vms.AliyunVmsMessageNotifier;
import com.wl4g.component.support.notification.vms.VmsNotifyProperties;
import com.wl4g.component.support.notification.wechat.WechatMessageNotifier;
import com.wl4g.component.support.notification.wechat.WechatNotifyProperties;

/**
 * Notification message service auto configuration
 * 
 * @author wangl.sir
 * @version v1.0 2019年8月28日
 * @since
 */
public class NotificationAutoConfiguration {

	// --- Notify properties. ---

	@Bean(name = "apnsNotifyProperties")
	@ConditionalOnProperty(name = KEY_SUPPORT_NOTIFY_PREFIX + ".apns.enable", matchIfMissing = false)
	@ConfigurationProperties(prefix = KEY_SUPPORT_NOTIFY_PREFIX + ".apns")
	public ApnsNotifyProperties apnsNotifyProperties() {
		return new ApnsNotifyProperties();
	}

	@Bean(name = "barkNotifyProperties")
	@ConditionalOnProperty(name = KEY_SUPPORT_NOTIFY_PREFIX + ".bark.enable", matchIfMissing = false)
	@ConfigurationProperties(prefix = KEY_SUPPORT_NOTIFY_PREFIX + ".bark")
	public BarkNotifyProperties barkNotifyProperties() {
		return new BarkNotifyProperties();
	}

	@Bean(name = "dingtalkNotifyProperties")
	@ConditionalOnProperty(name = KEY_SUPPORT_NOTIFY_PREFIX + ".dingtalk.enable", matchIfMissing = false)
	@ConfigurationProperties(prefix = KEY_SUPPORT_NOTIFY_PREFIX + ".dingtalk")
	public DingtalkNotifyProperties dingtalkNotifyProperties() {
		return new DingtalkNotifyProperties();
	}

	@Bean(name = "facebookNotifyProperties")
	@ConditionalOnProperty(name = KEY_SUPPORT_NOTIFY_PREFIX + ".facebook.enable", matchIfMissing = false)
	@ConfigurationProperties(prefix = KEY_SUPPORT_NOTIFY_PREFIX + ".facebook")
	public FacebookNotifyProperties facebookNotifyProperties() {
		return new FacebookNotifyProperties();
	}

	@Bean(name = "mailNotifyProperties")
	@ConditionalOnProperty(name = KEY_SUPPORT_NOTIFY_PREFIX + ".mail.enable", matchIfMissing = false)
	@ConfigurationProperties(prefix = KEY_SUPPORT_NOTIFY_PREFIX + ".mail")
	public MailNotifyProperties mailNotifyProperties() {
		return new MailNotifyProperties();
	}

	@Bean(name = "qqNotifyProperties")
	@ConditionalOnProperty(name = KEY_SUPPORT_NOTIFY_PREFIX + ".qq.enable", matchIfMissing = false)
	@ConfigurationProperties(prefix = KEY_SUPPORT_NOTIFY_PREFIX + ".qq")
	public QqNotifyProperties qqNotifyProperties() {
		return new QqNotifyProperties();
	}

	@Bean(name = "smsNotifyProperties")
	@ConditionalOnProperty(name = KEY_SUPPORT_NOTIFY_PREFIX + ".sms.enable", matchIfMissing = false)
	@ConfigurationProperties(prefix = KEY_SUPPORT_NOTIFY_PREFIX + ".sms")
	public SmsNotifyProperties smsNotifyProperties() {
		return new SmsNotifyProperties();
	}

	@Bean(name = "vmsNotifyProperties")
	@ConditionalOnProperty(name = KEY_SUPPORT_NOTIFY_PREFIX + ".vms.enable", matchIfMissing = false)
	@ConfigurationProperties(prefix = KEY_SUPPORT_NOTIFY_PREFIX + ".vms")
	public VmsNotifyProperties vmsNotifyProperties() {
		return new VmsNotifyProperties();
	}

	@Bean(name = "wechatNotifyProperties")
	@ConditionalOnProperty(name = KEY_SUPPORT_NOTIFY_PREFIX + ".wechat.enable", matchIfMissing = false)
	@ConfigurationProperties(prefix = KEY_SUPPORT_NOTIFY_PREFIX + ".wechat")
	public WechatNotifyProperties wechatNotifyProperties() {
		return new WechatNotifyProperties();
	}

	@Bean(name = "twitterNotifyProperties")
	@ConditionalOnProperty(name = KEY_SUPPORT_NOTIFY_PREFIX + ".twitter.enable", matchIfMissing = false)
	@ConfigurationProperties(prefix = KEY_SUPPORT_NOTIFY_PREFIX + ".twitter")
	public TwitterNotifyProperties twitterNotifyProperties() {
		return new TwitterNotifyProperties();
	}

	// --- Message notifier. ---

	@Bean
	@ConditionalOnBean(ApnsNotifyProperties.class)
	public ApnsMessageNotifier apnsMessageNotifier(ApnsNotifyProperties config) {
		return new ApnsMessageNotifier(config);
	}

	@Bean
	@ConditionalOnBean(BarkNotifyProperties.class)
	public BarkMessageNotifier barkMessageNotifier(BarkNotifyProperties config) {
		return new BarkMessageNotifier(config);
	}

	@Bean
	@ConditionalOnBean(DingtalkNotifyProperties.class)
	public DingtalkMessageNotifier dingtalkMessageNotifier(DingtalkNotifyProperties config) {
		return new DingtalkMessageNotifier(config);
	}

	@Bean
	@ConditionalOnBean(FacebookNotifyProperties.class)
	public FacebookMessageNotifier facebookMessageNotifier(FacebookNotifyProperties config) {
		return new FacebookMessageNotifier(config);
	}

	@Bean
	@ConditionalOnBean(MailNotifyProperties.class)
	public MailMessageNotifier mailMessageNotifier(MailNotifyProperties config) {
		return new MailMessageNotifier(config);
	}

	@Bean
	@ConditionalOnBean(QqNotifyProperties.class)
	public QqMessageNotifier qqMessageNotifier(QqNotifyProperties config) {
		return new QqMessageNotifier(config);
	}

	@Bean
	@ConditionalOnBean(SmsNotifyProperties.class)
	public AliyunSmsMessageNotifier aliyunSmsMessageNotifier(SmsNotifyProperties config) {
		return new AliyunSmsMessageNotifier(config);
	}

	@Bean
	@ConditionalOnBean(VmsNotifyProperties.class)
	public AliyunVmsMessageNotifier aliyunVmsMessageNotifier(VmsNotifyProperties config) {
		return new AliyunVmsMessageNotifier(config);
	}

	@Bean
	@ConditionalOnBean(WechatNotifyProperties.class)
	public WechatMessageNotifier wechatMessageNotifier(WechatNotifyProperties config) {
		return new WechatMessageNotifier(config);
	}

	@Bean
	@ConditionalOnBean(TwitterNotifyProperties.class)
	public TwitterMessageNotifier twitterMessageNotifier(TwitterNotifyProperties config) {
		return new TwitterMessageNotifier(config);
	}

	/**
	 * 1, Cannot inject at this time:
	 * 
	 * 	 * @Bean
	 * public CompositeMessageNotifier compositeMessageNotifier(List<MessageNotifier<NotifyMessage>> notifiers) {
	 *   ...
	 * }
	 * 
	 * 
	 * 2, Can operate correctly:
	 * 
	 * 	 * @Bean
	 * public CompositeMessageNotifier compositeMessageNotifier(List<MessageNotifier<? extends NotifyMessage>> notifiers) {
	 *   ...
	 * }
	 * 
	 * 
	 * @param notifiers
	 * @return
	 */
	@Bean(BEAN_NOTIFIER_ADAPTER)
	@ConditionalOnBean(MessageNotifier.class)
	public GenericOperatorAdapter compositeMessageNotifierAdapter(
			List notifiers) {
		return new GenericOperatorAdapter(
				notifiers.stream().map(n -> ((MessageNotifier) n)).collect(toList()), DefaultNoOp) {
		};
	}

	/**
	 * Default NoOp message notifier.
	 */
	@Bean
	@ConditionalOnMissingBean(name = BEAN_NOTIFIER_ADAPTER)
	public NoOpMessageNotifierAdapter noOpCompositeMessageNotifierAdapter() {
		return new NoOpMessageNotifierAdapter();
	}

	/**
	 * {@link NoOpMessageNotifierAdapter}
	 *
	 * @author Wangl.sir 
	 * @version v1.0 2020年6月4日
	 * @since
	 */
	public static class NoOpMessageNotifierAdapter extends GenericOperatorAdapter {

		public NoOpMessageNotifierAdapter() {
			super(DefaultNoOp);
		}

	}

	public static final String BEAN_NOTIFIER_ADAPTER = "compositeMessageNotifierAdapter";

}