使用 REST 的通知微服务设计困境

Question

我正在创建一个微服务，负责执行由其他接口和微服务触发的所有通知（例如电子邮件、短信）。这是为了集中所有通知逻辑和处理。通过调用其 rest web 服务 url 来触发通知操作。

现在这是我的困境。我应该为每种类型的请求创建一个 url 还是为所有请求创建一个 url？

例如

选项1

@Path("{sourceId}/registationEmail")
@Path("{sourceId}/forgotPasswordEmail")
@Path("{sourceId}/productionTicketEmail")
@Path("{sourceId}/registationSms")
@Path("{sourceId}/forgotPasswordSms")
@Path("{sourceId}/productionTicketSms")

或

选项 2

@Path("{sourceId}/email")
@Path("{sourceId}/sms")

这里的问题是我们使用@BeanParam 作为输入，所以每种类型的通知都会有一组不同的输入值。这是我们决定选择选项 2 的主要问题，还是有办法在 REST 配置中解决这个问题？

Answer 1

看看Richardson Maturity Model level 1，我会说你最多有2个资源（又名选项2），并且两者都可以有一个类型属性。当然，它们会有一组不同的输入值，但所有这些电子邮件类型都应该具有相同的属性，对吧（发件人、收件人、主题、正文等）？如果它的外观和行为与其他 2 个端点相同，那么拥有一个单独的端点是没有意义的。

Answer 2

我会选择选项 2：

@Path("{sourceId}/email")
@Path("{sourceId}/sms")

它看起来比其他选项好得多。

---

我不知道你的完整 URI 是什么样的，但我会得到类似 /sources/{sourceId}/email 或 /sources/{sourceId}/notification/email 的东西。

你的请求可能是这样的：

POST /sources/{sourceId}/email HTTP/1.1
Host: example.com
Content-Type: application/json

{
  "to": "mail@example.com",
  "subject": "Question 38602123",
  "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}

---

您没有提供有关输入内容的详细信息。没有关于您正在使用的依赖项的详细信息。因此很难猜测并为您提供明确的答案。

您提到了@BeanParam，所以我假设您正在使用 JAX-RS 及其实现之一，例如 Jersey。如果您使用 JSON 或 XML 来表示您的资源，那么您很可能使用的是 Jackson。

因此，要处理不同的输入，您可以使用继承和 Jackson 多态反序列化。有一些注解，例如 @JsonTypeInfo 和 @JsonSubTypes 可以解决问题。