java - 有没有一个漂亮的解决方案来禁用所有电子邮件通知？

Question

我有一个邮件服务，它只是向收件人发送通知。

@Service
public class MailService {

        @Autowired
        private JavaMailSender mailSender;

        public void send(String subject, String text, String... emails) {
                // MailMessage object configuration
                mailSender.send(mail);
        }
}

然后我有一个休息 Controller ，在一些业务逻辑之后调用此方法。

@RestController
public class MyRestController {

        @Autowired
        private MailService mailService;

        @PostMapping("/orders")
        public void createOrders(@RequestBody List<Order> orders) {
                // manipulations with orders
                mailService.send("Order notification", "New orders", "1@mail.com");
        }
}

我应该如何设计一个应用程序来关闭不同 Spring 配置文件的通知？是否有根据配置文件配置电子邮件分发的最佳实践？

Answer 1

使用多种实现

一种可能性是创建一个具有两个实现的 MailService 接口(interface)。通过将这些实现与 @Profile 注释相结合，您可以根据您使用的配置文件正确注入(inject)一种或另一种实现。例如:

public interface MailService {
    void send(String subject, String text, String... emails);
}

然后您可以将 @Profile("mail") 注释添加到一个实现中:

@Service
@Profile("mail") // Only create this bean when the 'mail' profile is used
public class JavaMailServiceImpl implements MailService {

    @Autowired
    private JavaMailSender mailSender;

    public void send(String subject, String text, String... emails) {
        // MailMessage object configuration
        mailSender.send(mail);
    }
}

此外，您可以在邮件配置文件未激活时添加另一个实现:

@Service
@Profile("!mail") // By adding the exclamination mark, this implementation will be used when the mail profile isn't active
public class NoopMailServiceImpl implements MailService {
    private final Logger logger = LoggerFactory.getLogger(getClass());

    @Override
    public void send(String subject, String text, String... emails) {
        logger.debug("Dummy implementation, no e-mail is being sent");
    }
}

如果您现在将 MailService 自动连接到 Controller 中，它将根据您使用的配置文件正确实现正确的实现。

<小时/>

使用方面

另一种替代方法是使用方面将发送邮件与订单创建逻辑完全解耦。

这允许您从 MyRestController Controller 中完全删除 MailService 依赖项:

@RestController
public class MyRestController {

    @PostMapping("/orders")
    public void createOrders(@RequestBody List<Order> orders) {
        // manipulations with orders
    }
}

取而代之的是，您将 mailService 逻辑添加到单独的方面:

@Aspect
@Component
@Profile("mail")
public class OrderNotificationAspect {
    private final MailService mailService;

    public OrderNotificationAspect(MailService mailService) {
        this.mailService = mailService;
    }

    @AfterReturning("execution(* com.example.MyRestController.createOrders(..))")
    public void sendNotification() {
        mailService.send("Order notification", "New orders", "1@mail.com");
    }
}

像以前一样，我们使用@Profile注释仅在邮件配置文件处于 Activity 状态时注册方面bean。但是，由于我们不再直接将 Controller 绑定(bind)到 MailService，因此我们不再需要“虚拟实现”。

要在 Spring boot 中使用方面，您应该添加 spring-boot-starter-aop 依赖项。

<小时/>

以编程方式检查配置文件

另一种选择是在代码中编写检查，例如:

@RestController
public class MyRestController {

    @Autowired
    private MailService mailService;
    @Autowired
    private Environment environment;  

    @PostMapping("/orders")
    public void createOrders(@RequestBody List<Order> orders) {
        // manipulations with orders
        if (environment.acceptsProfiles(Profiles.of("mail"))) {
            mailService.send("Order notification", "New orders", "1@mail.com");
        }
    }
}

根据您希望此逻辑的细粒度程度，您可以将其放入 Controller 或服务中(如果您想禁用针对特定配置文件发送的所有电子邮件)。

<小时/>

您选择哪个选项取决于您的需求。使用多个实现是禁用所有邮件发送的最简单方法。

但是，如果您只想禁止发送某些邮件，则必须选择其他方式。使用方面的缺点是它有时会使流程更难以遵循，尽管 IDE 对方面有很好的支持。