面向外部系统的网关接口
设计网关接口以便与外部服务通信，例如 API、消息队列或第三方库。
面向外部系统的网关接口 是 CoddyKit 上的免费 Clean Architecture & Design Patterns in Practice 课时。 这是第 2 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Clean Architecture & Design Patterns in Practice 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Clean Architecture & Design Patterns in Practice 课程共包含 4 节课。
本课时的部分内容尚未翻译，以英文显示。
What are Gateway Interfaces?
In Clean Architecture, we want our core business logic to be independent of external details. This means not directly relying on specific databases, UI frameworks, or even external services.
Gateway Interfaces are your solution for communicating with these external systems without tightly coupling your core application to them.
Avoiding Direct External Calls
Imagine your core logic directly calls an external email API. What happens if that API changes, or you want to switch providers?
- Your core code breaks.
- Testing becomes hard, needing real API calls.
- Your application is "coupled" to that specific external service.
Coupling makes your system rigid and difficult to change.
Gateways and the Dependency Rule
Remember the Dependency Rule in Clean Architecture? Dependencies must always point inwards, towards the core business logic.
Gateway interfaces live in an inner layer (like Use Cases), while their implementations live in an outer layer (Frameworks/Drivers).
This allows inner layers to define what they need from an external system, without knowing how it's done.
Designing a Gateway Interface
Let's define a simple EmailGateway interface. This interface declares the operations our core application needs for sending emails, without caring about the email provider.
It's just a contract!
package application.ports; // Inner layer
public interface EmailGateway {
void sendEmail(String recipient, String subject, String body);
}Bringing the Gateway to Life
Now, an outer layer (like an adapter for a specific email service) will implement this interface. For demonstration, we'll create a MockEmailGateway.
This is where the actual interaction with an external system would happen.
package infrastructure.adapters; // Outer layer
import application.ports.EmailGateway;
public class MockEmailGateway implements EmailGateway {
@Override
public void sendEmail(String recipient, String subject, String body) {
System.out.println("--- Mock Email Service ---");
System.out.println("To: " + recipient);
System.out.println("Subject: " + subject);
System.out.println("Body: " + body);
System.out.println("Email sent successfully (mocked).");
System.out.println("--------------------------");
}
}Use Case Interacts with Gateway
Our Use Case, SendWelcomeEmailUseCase, only knows about the EmailGateway interface. It doesn't care if it's a mock, a real Gmail API, or SendGrid.
This is dependency inversion in action!
package application.usecases; // Inner layer
import application.ports.EmailGateway;
public class SendWelcomeEmailUseCase {
private final EmailGateway emailGateway;
public SendWelcomeEmailUseCase(EmailGateway emailGateway) {
this.emailGateway = emailGateway;
}
public void execute(String userEmail, String userName) {
String subject = "Welcome to CoddyKit, " + userName + "!";
String body = "Hello " + userName + ",\n\n"
+ "Thanks for joining CoddyKit!\n"
+ "We're excited to have you.";
emailGateway.sendEmail(userEmail, subject, body);
}
}Gateway Integration Demo
Let's see the full picture. Our Main class (part of the outer Frameworks/Drivers layer) creates the concrete MockEmailGateway and injects it into the SendWelcomeEmailUseCase.
Try running this example!
public class Main {
// Define the Gateway interface (conceptually in application.ports)
public interface EmailGateway {
void sendEmail(String recipient, String subject, String body);
}
// Define the Use Case (conceptually in application.usecases)
public static class SendWelcomeEmailUseCase {
private final EmailGateway emailGateway;
public SendWelcomeEmailUseCase(EmailGateway emailGateway) {
this.emailGateway = emailGateway;
}
public void execute(String userEmail, String userName) {
String subject = "Welcome to CoddyKit, " + userName + "!";
String body = "Hello " + userName + ",\n\n"
+ "Thanks for joining CoddyKit!\n"
+ "We're excited to have you.";
emailGateway.sendEmail(userEmail, subject, body);
}
}
// Define the concrete Gateway implementation (conceptually in infrastructure.adapters)
public static class MockEmailGateway implements EmailGateway {
@Override
public void sendEmail(String recipient, String subject, String body) {
System.out.println("--- Mock Email Service ---");
System.out.println("To: " + recipient);
System.out.println("Subject: " + subject);
System.out.println("Body: " + body);
System.out.println("Email sent successfully (mocked).");
System.out.println("--------------------------");
}
}
public static void main(String[] args) {
// 1. Create the concrete Gateway implementation (outer layer)
EmailGateway emailGateway = new MockEmailGateway();
// 2. Create the Use Case, injecting the Gateway (inner layer)
SendWelcomeEmailUseCase useCase =
new SendWelcomeEmailUseCase(emailGateway);
// 3. Execute the Use Case
useCase.execute("john.doe@example.com", "John Doe");
}
}Why Use Gateway Interfaces?
Using Gateway Interfaces brings many advantages:
- Testability: Easily swap real services with mocks for testing.
- Flexibility: Change email providers without touching core logic.
- Isolation: Core business rules stay clean, unaware of external tech.
- Maintainability: Easier to update or debug external integrations.
Gateways vs. Repositories
You might notice Gateways sound similar to Repositories. Both abstract external concerns, but they have different focuses:
- Repositories: Abstract data persistence (e.g., database operations).
- Gateways: Abstract external services (e.g., APIs, message queues, file systems).
They both help maintain the Dependency Rule by defining interfaces in inner layers.
Test Your Knowledge
Which of the following is the primary benefit of using Gateway Interfaces in Clean Architecture?
Recap: Gateway Power
You've learned about Gateway Interfaces, a crucial pattern in Clean Architecture!
- They abstract interactions with external services (APIs, queues).
- They ensure your core logic remains independent and testable.
- They uphold the Dependency Rule by defining contracts in inner layers.
Keep your core clean and let Gateways handle the outside world!
用 AI 导师学习 Clean Architecture & Design Patterns in Practice — 免费
在浏览器中编写并运行真实代码，获得全天候 AI 导师的即时帮助，并在网页或应用中继续学习。
- 课程
- 12
- 课程
- 48
常见问题解答
「面向外部系统的网关接口」课时是免费的吗？
是的 — 「面向外部系统的网关接口」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Clean Architecture & Design Patterns in Practice 课程的其余内容，请升级到 CoddyKit PRO。 Clean Architecture & Design Patterns in Practice 课程共包含 4 节课。
「面向外部系统的网关接口」这节课中我会学到什么？
设计网关接口以便与外部服务通信，例如 API、消息队列或第三方库。 你通过在浏览器中直接运行的动手代码来练习 Clean Architecture & Design Patterns in Practice，全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 Clean Architecture & Design Patterns in Practice 需要有经验吗？
无需任何先前经验。CoddyKit 上的 Clean Architecture & Design Patterns in Practice 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 2 节课，共 4 节。
「面向外部系统的网关接口」课时需要多长时间？
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。
我能在这节 Clean Architecture & Design Patterns in Practice 课中编写并运行代码吗？
能。每节 Clean Architecture & Design Patterns in Practice 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- 整洁架构中的仓储模式
- 面向外部系统的网关接口
- 数据映射器与 DTO
- 面向第三方 API 的防腐层