Java 监听器实现

Question

为以下用例寻找最佳设计。

用例： 在我的应用程序中，我有一个调度程序每隔一小时运行一次并公开一项服务。

调度程序每隔一小时运行一次，从特定表中检索记录，并在任何记录处理失败时发送通知。通知可以是电子邮件或短信。

此外，此服务可以被其他服务调用以通知记录处理失败（电子邮件或短信）。

失败类型为 batchFailure 或 serviceFailure。

此外，还有一些道具设置类可以启用或禁用短信和电子邮件通知。

public class Settings {
  private boolean emailEnabled;
  private boolean smsEnabled;
}

根据类型，电子邮件主题应包含“批量失败”或“服务失败”的主题。批处理作业和服务失败的其他内容保持不变。

我创建了以下类：-

1. 主题 - 我为两者创建了一个共同的主题。

   public class Notification {
   
         private int recordId;
   
         private String recordName;
   
         private String email;  // Related to email
   
         private String smsNumber; // Related to sms
   
   }
   

2. 监听类

   public interface RecordFailureListener {
   
     void sendNotification(Notification notification);
   
   }
   

3. 电子邮件监听器

   public class EmailListener implements RecordFailureListener {
   
      void sendNotification(Notification notification) {
       // Code to send email here
      }
   }
   

4. 短信监听器

   public class SMSListener implements RecordFailureListener {
   
      void sendNotification(Notification notification) {
       // Code to send SMS here
      }
   }
   

5. 服务类

   public class NotificationService {
      List<RecordFailureListener> listeners = new ArrayList(); // This list has emailListener and smsListener
   
      void sendNotification(Notification notification) {
          listeners.forEach(listener -> listener.sendNotification(notification));
      }
   }
   

正在从调度程序调用此通知服务以应对任何故障。此外，从暴露的失败服务。

问题：

1) 在这里，主题似乎具有电子邮件和短信所需的属性。有没有其他更好的方法让电子邮件通知具有电子邮件所需的属性，而短信通知将具有短信所需的属性？还有一些共同的属性。

2) 在调用发送电子邮件之前检查电子邮件侦听器中是否启用了电子邮件，在短信侦听器中也是如此。这是正确的地方吗？

还有其他更好的设计吗？

谢谢

Answer 1

你的问题是典型的通知者/监听者问题。 我建议也使用事件总线，作为解耦lisetner 和通知程序的一种方式。这个想法是通知器将通知事件总线，事件总线将遍历侦听器并在通知时更新它们。设计如下： （这是一个简单的骨架，有一些方便的捷径，例如为 EventBus 使用枚举单例。细节取决于您）。

public interface Event {
    // general event information - date, message, meta data, etc....
}
public interface Listener { 
   public void listen(Event event);
}

public enum EventBus {
   INSTANCE;

   private List<Listener> listeners = new ArrayList<>;

   public void addListener(Listener newListener) {
       listeners.add(newListener);
   }

   public void notify(Event event) {
      for (Listener listener : listeners) {
         listener.listen(event);
      }
   }
}


public class Notifier {

    public void handlePointOfInterest(.....) {
        // do something interesting with the parameters, etc...
        Event event = // create a new event based on your needs
        EventBus.INSTANCE.notify(event);
        ...
    }
}

您的事件接口也可以使用泛型来支持特定的元数据类型 - 例如您的设置。 您的 Listener 实现可以使用泛型来处理特定类型的事件。

希望这会有所帮助，请随时要求澄清。

Answer 2

只是分享我的设计模式，不过是个老问题。

可以在 NotificationService 本身中验证设置，因为这是我们开始通知流程的地方。假设正在从调度程序调用 NotificationService 以进行失败通知

public class NotificationService {

    Notification notification;

   static List<RecordFailureListener> listenerList = new ArrayList<>(); // holds email & sms listeners

    public NotificationService (Notification notification){
        this.notification=notification;
    }

    public void sendNotification(){

        if(Settings.emailEnabled){
            listenerList.stream().filter(i-> i instanceof EmailListener).forEach(i->i.sendNotification(notification));
        }
        if(Settings.smsEnabled){
            listenerList.stream().filter(i-> i instanceof SmsListener).forEach(i->i.sendNotification(notification));
        }

    }
}

RecordeFailureListener

public interface RecordFailureListener {

    void sendNotification(Notification notification);
}

EmailListener（FailureType 可以在此处验证以分配相应的电子邮件主题行）

public class EmailListener implements RecordFailureListener {

    private String emailSubject;//emailistener specific property
    @Override
    public void sendNotification(Notification notification) {

        if(Stream.of("BatchFailure","ServiceFailure").anyMatch(notification.getFailureType()::equalsIgnoreCase)){
            emailSubject= notification.getFailureType();
        }
        else{
            emailSubject="customSubject";
        }

        //code to send email notification

    }
}

短信监听器

public class SmsListener implements  RecordFailureListener {
    @Override
    public void sendNotification(Notification notification) {
        //code to sms notification
    }
}

设置

public class Settings {

     public static boolean emailEnabled;
     public static boolean smsEnabled;
}

通知模型（已添加 failureType 作为 Notification 属性）

 public class Notification {

    private int recordId;
    private String recordName;
    private String email;
    private String smsnumber;
    private String failureType;
}