Debug.Assert vs Code Hợp đồng sử dụng

Question

Khi nào tôi nên debug.assert qua hợp đồng mã hoặc ngược lại? Tôi muốn kiểm tra điều kiện tiên quyết cho một phương pháp và tôi đang bối rối để chọn một cái khác. Tôi có các bài kiểm tra đơn vị mà tôi muốn kiểm tra các tình huống thất bại và mong đợi các ngoại lệ.

Thực tiễn tốt là sử dụng Debug.Assert và hợp đồng Mã trên cùng một phương pháp. Nếu vậy thì thứ tự trong đó mã sẽ được viết là gì?

Debug.Assert(parameter!= null); 
Contract.Requires<ArgumentNullException>(parameter != null, "parameter"); 

hoặc

Contract.Requires<ArgumentNullException>(parameter != null, "parameter"); 
Debug.Assert(parameter!= null); 

Có bất kỳ lý do đằng sau nó?

Answer 1

Đây là những thứ khác nhau. Một xác nhận gỡ lỗi chỉ được thực hiện khi mã được biên dịch như là gỡ lỗi và do đó sẽ chỉ kiểm tra/xác nhận dưới gỡ lỗi. Ý tưởng là sử dụng điều này cho "kiểm tra sanity" cho mã bạn đang phát triển. Các hợp đồng mã có thể được sử dụng trong việc gỡ rối hoặc phát hành. Họ đảm bảo rằng trước và sau điều kiện của phương pháp thực hiện theo sự mong đợi của phương pháp (đáp ứng các hợp đồng). Ngoài ra còn có một khung kiểm tra cung cấp chức năng tương tự, được thiết kế để kiểm tra sự tuân thủ kiểm tra.

Sử dụng Debug.Assert khi bạn muốn đảm bảo rằng một số thứ nhất định như bạn mong đợi khi phát triển mã (và trong quá trình phát triển bảo trì sau này).

Sử dụng hợp đồng mã khi bạn muốn đảm bảo rằng các điều kiện là đúng trong cả gỡ lỗi và phát hành. Các hợp đồng cũng cho phép một số dạng phân tích tĩnh nhất định có thể hữu ích trong việc xác minh rằng chương trình của bạn là "đúng".

Sử dụng xác nhận khung kiểm tra khi tạo kiểm tra đơn vị.

Answer 2

Cá nhân, tôi sẽ không sử dụng cả hai Debug.Assert VÀ Hợp đồng mã để thực thi điều kiện tiên quyết trong mã mới được viết - Hợp đồng mã IMO supercede Debug.Assert, vì chúng cung cấp một bộ kiểm tra toàn diện hơn, chưa kể đến lợi ích có thể thu được từ kiểm tra tĩnh có thể được thực hiện trước khi mã được chạy thời gian. Việc duy trì kiểm tra điều kiện trùng lặp trùng lặp trong cả hai số Debug.Assert và Contracts sẽ rất cồng kềnh.

Lý do:

• Bạn không cần phải tái mã bất kỳ điều kiện tiên quyết di sản bạn có thể đã được mã hóa trong Debug.Assert hoặc throw mã - bạn có thể giữ mã kiểm tra điều kiện tiên quyết hiện hành và terminate it with Contract.EndContractBlock()
• Bạn có thể nhận được cùng một hành vi 'chế độ phát hành' không được kiểm tra khi System.Diagnostics.Debug được tạo mà không cần /d:DEBUG nếu bạn xây dựng với kiểm tra thời gian chạy hợp đồng được đặt thành None. Ref 6.2.1 in the Docs
• Hợp đồng cho phép người sáng tạo hiểu rõ hơn về mã là 'lý do' trạng thái không hợp lệ đã được phát hiện - ví dụ: trực tiếp là do tham số ngoài băng tần (Contract.Requires). Nếu không, Contract.Assert hoặc Contract.Assume có thể kiểm tra trạng thái chung và "trạng thái được đảm bảo" của trạng thái khi có phương pháp có thể được biểu thị bằng cách sử dụng Contract.Ensures. Và Invariants thể hiện rằng nhà nước phải được tổ chức mọi lúc. Và tốt nhất là kiểm tra tĩnh có thể thực thi các Hợp đồng này khi bạn xây dựng mã của bạn - theo cách này bạn có cơ hội nhận lỗi thông qua thời gian thiết kế hoặc cảnh báo thời gian biên dịch thay vì phải đợi thời gian chạy. Quay lại đầu trangKiểm tra hợp đồng có thể được thêm vào tích hợp liên tục của bạn để tìm kiếm sự không tuân thủ.

Một caveat: Nếu bạn đang đi để viết đơn vị xét nghiệm mà cố tình vi phạm hợp đồng, bạn có thể cần để đối phó với ContractException - Jon Skeet giải thích tốt này here. ví dụ. Kết nối một số Contract.ContractFailed handler trong thiết lập thử nghiệm của bạn với một trình xử lý gọi số SetHandled và sau đó ném ngoại lệ công khai mà bạn có thể nắm bắt và xác nhận trong UT của mình.