Microservice Patterns
Consumer-Driven Contract Testing
Cho mỗi consumer công bố đúng những phần API mình dựa vào, và bắt build của provider kiểm tra chúng — để thay đổi phá vỡ bị bắt ngay trong CI thay vì trên production, mà không cần môi trường test end-to-end chậm chạp.
Sau bài này bạn sẽ
- Giải thích vì sao unit test của provider và môi trường dùng chung bỏ sót thay đổi phá vỡ.
- Viết contract phía consumer và kiểm tra nó trong build của provider.
- Tiến hoá API an toàn bằng thay đổi chỉ thêm vào và expand/contract.
- Đặt contract test vào đúng chỗ giữa unit, component và end-to-end test.
Nên đọc trước
Tổng quan
Một hãng sản xuất phích cắm có thể tự test phích cắm của mình mà vẫn ship ra những cái chẳng vừa ổ cắm nào. Tốt hơn là: hãng làm ổ cắm gửi số đo chính xác, và mọi mẫu phích cắm mới đều được đối chiếu với chúng trước khi rời nhà máy.
Trong microservices, test của provider chứng minh nó làm đúng điều *nó* nghĩ là đúng, chứ không phải điều consumer đang dựa vào. Môi trường end-to-end bắt được chỗ không khớp, nhưng chậm và hay chập chờn. Với consumer-driven contract, mỗi consumer ghi lại request nó gửi và những trường nó đọc (một contract), publish lên broker, và CI của provider kiểm tra mọi contract với code provider thật trước khi được deploy.
Chạy thử
Customers v2 đổi tên một trường mà checkout đang đọc. Ở A thay đổi đó lên tới production; ở B contract test đã lỗi trong CI và một phiên bản chỉ thêm vào được ship thay thế. So sánh ô Lượt thanh toán lỗi.
Một contract Pact
@Pact(consumer = "checkout", provider = "customers")
V4Pact customerTier(PactDslWithProvider builder) {
return builder
.given("customer 42 is a gold member")
.uponReceiving("get customer 42")
.path("/customers/42").method("GET")
.willRespondWith()
.status(200)
.body(newJsonBody(b -> { b.stringType("name", "Ada"); b.stringValue("tier", "gold"); }).build())
.toPact(V4Pact.class);
}@Provider("customers")
@PactBroker // lấy contract của mọi consumer
@SpringBootTest(webEnvironment = RANDOM_PORT)
class CustomersContractTest {
@TestTemplate @ExtendWith(PactVerificationInvocationContextProvider.class)
void verify(PactVerificationContext ctx) { ctx.verifyInteraction(); }
@State("customer 42 is a gold member")
void gold() { customers.save(new Customer(42, "Ada", Tier.GOLD)); }
}
// Cổng CI: `pact-broker can-i-deploy --pacticipant customers --to-environment production`Đánh đổi
| Được | Mất | |
|---|---|---|
| Phản hồi | Thay đổi phá vỡ làm build của provider lỗi chỉ trong vài phút. | Chỉ kiểm tra những gì consumer đã ghi lại; hành vi ngoài contract không được test. |
| Tốc độ | Không cần môi trường end-to-end dùng chung mới yên tâm về tích hợp. | Các team phải duy trì contract và provider state. |
| Tự chủ | Provider biết chính xác ai dùng gì, và tự do thay đổi phần còn lại. | Cần một broker và kỷ luật CI giữa các team. |
Lưu ý khi chạy production
- Chặn deploy bằng can-i-deploy cho cả consumer lẫn provider.
- Giữ contract tối giản: chỉ những trường consumer thật sự đọc (dùng type matcher).
- Kết hợp với service component test (service chạy với phụ thuộc giả lập) và một lớp mỏng smoke test end-to-end.
- Áp dụng ý tưởng này cho cả event: contract-test schema message giữa producer và consumer.