Cách sử dụng chú thích @DisplayName trong JUnit

Xóa tên phương pháp thử nghiệm của bạn bằng chú thích đơn giản này.

Một trong những vấn đề khó khăn nhất trong phát triển phần mềm là đặt tên. Việc tạo ra các tên có ý nghĩa cho các khía cạnh cơ bản của một chương trình, chẳng hạn như các lớp và phương thức, có thể rất khó. Các hạn chế đặt tên, chẳng hạn như không có khoảng cách, càng làm tăng thêm vấn đề này.

Vấn đề đặt tên vẫn tồn tại trong mọi khía cạnh của vòng đời phát triển phần mềm, bao gồm cả thử nghiệm. Đây là nơi mà chú thích JUnit @DisplayName trở nên hữu ích.

Chú thích @DisplayName là gì?

Một phương pháp duy nhất có thể có một số phương pháp kiểm tra mà mỗi phương pháp kiểm tra một hành vi cụ thể. Tuy nhiên, nếu bạn gán tên hành vi cho các phương pháp thử nghiệm, chúng có thể trở nên dài dòng và khó đọc.

Chú thích @DisplayName là một thành phần JUnit cho phép bạn tạo tên tùy chỉnh cho các lớp và phương thức thử nghiệm của mình. Những tên này có thể có dấu cách, ký tự đặc biệt và thậm chí cả biểu tượng cảm xúc. Chú thích @DisplayName sẽ giúp bạn tạo tên mô tả, có ý nghĩa hơn cho các lớp và phương thức thử nghiệm.

Cách sử dụng chú thích @DisplayName

Trong một lớp thử nghiệm JUnit, chú thích @DisplayName xuất hiện phía trên tên lớp hoặc ngay trước phần khai báo phương thức. Chú thích @DisplayName nhận một đối số duy nhất (tên). Đối số này sau đó xuất hiện trong các báo cáo thử nghiệm, làm cho tài liệu thử nghiệm mang tính mô tả hơn.

package displayname;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
@DisplayName("Test class demonstrating how the @DisplayName annotation works.")
class DisplayNameTest {
@Test
@DisplayName("Testing display name containing special characters: °□°）╯")
void testDisplayNameWithSpecialCharacters() {}
@Test
@DisplayName("Testing display name containing space")
void testDisplayNameWithSpaces() {}
@Test
@DisplayName("Testing display name containing emoji: 😱")
void testDisplayNameWithEmoji() {}
}

Việc thực thi lớp Java này tạo ra báo cáo kiểm tra đơn vị JUnit sau:

Mỗi đối số chú thích @DisplayName thay thế tên lớp hoặc phương thức tương ứng của nó trong báo cáo kiểm tra JUnit. Chú thích @DisplayName, “Lớp thử nghiệm chứng minh cách hoạt động của chú thích @DisplayName” biểu cảm và toàn diện hơn nhiều so với DisplayNameTest.

Tiếp theo cho Thử nghiệm là gì?

Biết cách sử dụng chú thích @DisplayName chắc chắn sẽ cải thiện tài liệu kiểm tra đơn vị của bạn. Ngoài chú thích @DisplayName, bạn sẽ thấy rằng tất cả các bài kiểm tra đơn vị JUnit của bạn sẽ cần một hoặc nhiều xác nhận. Các xác nhận là nền tảng của các bài kiểm tra đơn vị JUnit, do đó, thật tốt để học cách sử dụng chúng.