Annotation Trong Java Là Gì Và Chức Năng Của Nó?

Trong quá trình học lập trình Java cơ bản, chúng ta có thể bắt gặp các ký hiệu như @Override, @Deprecated, @SuppressWarnings,…Vậy chúng là gì trong Java và chức năng của nó là gì? Cùng mình tìm hiểu trong bài viết “Tìm hiểu về Annotation trong Java” này nhé.

Trong bài viết này, mình san sẻ về Annotation trong Java qua những nội dung sau :

1. Annotation trong Java là gì?
2. Cấu trúc của một Annotation trong Java.
3. Chức năng của Annotation trong Java.
4. Các Annotation tích hợp sẵn trong Java.
5. Khởi tạo Annotation (Annotation tự định nghĩa).
6. Annotation lồng nhau và cách sử dụng.
7. Tổng kết.

1. Annotation trong Java là gì?

Annotation được hiểu là một dạng chú thích hoặc  một dạng siêu dữ liệu (metadata) được dùng để cung cấp thông tin dữ liệu cho mã nguồn Java. Các chú thích không có ảnh hưởng trực tiếp đến hoạt động của mã mà chúng chú thích. Annotation được thêm vào Java từ Java 5. Các Annotation được sử dụng trong mã nguồn sẽ được biên dịch thành bytecode và sử dụng kỹ thuật phản chiếu (Reflection) để truy vấn thông tin siêu dữ liệu và đưa ra hành động thích hợp.Chúng ta có thể chú thích các lớp (class), phương thức (method), các biến (variable), các gói (package) và các tham số (prameter) trong Java.

Java Annotation có hai loại:

• Các Annotation được tích hợp sẵn.
• Annotation do người dùng tự định nghĩa.

2. Cấu trúc của một Annotation trong Java

Một chú thích luôn bắt đầu với ký hiệu @ và sau đó là tên của chú thích. Ký hiệu @ chỉ ra cho trình biên dịch rằng đây là một chú thích.

Ví dụ : @ Deprecated

• Ký hiệu @ mô tả đây là một chú thích.
• Deprecated là tên của chú thích.

3. Chức năng của Annotation trong Java

Annotation được sử dụng trong Java cho 3 mục tiêu chính :

Thứ nhất, chỉ dẫn cho trình biên dịch (Compiler)

Chú thích hoàn toàn có thể được trình biên dịch sử dụng để phát hiện lỗi hoặc triệt tiêu những cảnh báo nhắc nhở. Java có 3 Annotation hoàn toàn có thể được sử dụng nhằm mục đích cung ứng hướng dẫn cho trình biên dịch :
1. @ Deprecated
2. @ Override
3. @ SuppressWarnings
Chi tiết về từng chú thích sẽ được lý giải cụ thể trong phần sau .

Thứ hai, chỉ dẫn trong thời điểm biên dịch (Build-time)

Các công cụ ứng dụng hoàn toàn có thể trải qua những hướng dẫn của chú thích để tạo mã nguồn, tệp XML, nén mã biên dịch và những tâp tin vào một tập tin, v … v

Thứ ba, chỉ dẫn trong thời gian chạy (Runtime)

Thông thường, những Annotation không xuất hiện trong mã Java sau khi biên dịch. Tuy nhiên, hoàn toàn có thể xác lập trong thời hạn chạy bằng cách sử dụng kỹ thuật Reflection và hoàn toàn có thể sử dụng để đưa ra những hướng dẫn cho chương trình trong thời hạn chạy .

4. Các Annotation tích hợp sẵn trong Java và ví dụ minh họa

Annotation tích hợp sẵn có hai loại :

1. Java Annotation được tích hợp để sử dụng trực tiếp trong code Java:

Chúng ta có 3 Annotation quan trọng :

• @Override: 
  Được sử dụng cho những phương pháp có nghĩa là ghi đè một phương pháp trong lớp cha ( supperclass ). Nếu một phương pháp ghi lại @ Override không ghi đè đúng chuẩn một phương pháp trong lớp cha của nó hay hiểu đơn thuần là phương pháp đó không hợp lệ thì trình biên dịch sẽ báo lỗi. Chúng ta không nhất thiết phải sử dụng @ Override khi ghi đè phương pháp, nhưng Annotation này sẽ giúp tất cả chúng ta tránh lỗi thuận tiện hơn .
  Ví dụ: 

public class superExampleNMD {
    public void methodOverride() {
        System.out.println("SupperClass Nguyen Minh Duc");
    }
}

public class ExampleNMD extends superExampleNMD{
    @Override
    public void methodOverride() {
        System.out.println("SubClass Nguyen Minh Duc");
    }
}

public class MainNMD {
    public static void main(String[] args) {
        ExampleNMD ex = new ExampleNMD();
        ex.methodOverride();
    }    
}

Kết quả :

 

Chúng ta hoàn toàn có thể thấy rằng phương pháp ở lớp con đã ghi đè nội dung lên phương pháp của lớp cha .

• @Deprecated    

Được sử dụng để dánh dấu một đối tượng người dùng ( class, method hoặc field ) và hướng dẫn rằng nó tốt nhất không nên được sử dụng nữa. Trình biên dịch sẽ đưa những câu cảnh báo nhắc nhở khi chương trình sử dụng những thuộc tính, lớp hoặc phương pháp có gắn với @ Deprecated .
Ví dụ :

• @SuppressWarnings

Thông báo cho trình biên dịch biết là không được in những câu cảnh báo nhắc nhở nào đó .
Cú pháp sử dụng : @ SuppressWarnings ( ” … ” ) hoặc @ SuppressWarnings ( { ” … “, ” … “, v … v … } ) trong ” … ” được hiểu là tên những loại cảnh báo nhắc nhở .
Chúng ta thường dùng :
@ SuppressWarnings ( “ deprecation ” ) để thông tin trình biên dịch không cảnh báo nhắc nhở việc sử dụng phương pháp có sử dụng @ Deprecated .
@ SuppressWarnings ( “ unchecked ” ) để thông tin trình biên dịch không cảnh báo nhắc nhở việc sử một ép kiểu không bảo đảm an toàn .
@ SuppressWarnings ( “ rawtypes ” ) để thông tin trình biên dịch không cảnh báo nhắc nhở lỗi trong khai báo kiểu tài liệu .
Ví dụ :

2. Java Annotation được tích hợp sẵn được sử dụng trong Annotation khác.

• @Target: Dùng để chú thích phạm vi sử dụng của một Annotation. 

   Các chú thích này đã được định nghĩa trong enum

  Xem thêm: 0283 là mạng gì, ở đâu? Cách nhận biết nhà mạng điện thoại bàn cố định – http://139.180.218.5

   java.lang.annotation.ElementType:

ElementType.TYPE	Chú thích trên Class, interface, enum, annotation
ElementType.FIELD	Chú thích trường ( field ), gồm có cả những hằng số enum .
ElementType.METHOD	Chú thích trên method .
ElementType.PARAMETER	Chú thích trên parameter .
ElementType.CONSTRUCTOR	Chú thích trên constructor .
ElementType.LOCAL_VARIABLE	Chú thích trên biến địa phương .
ElementType.ANNOTATION_TYPE	Chú thích trên Annotation khác .
ElementType.PACKAGE	Chú thích trên package .

• @Retention: Dùng để chú thích mức độ tồn tại của một Annotation nào đó. Cụ thể có 3 mức nhận thức sống sót của vật được chú thích, và được định nghĩa trong enumjava.lang.annotation.RetentionPolicy:

RetentionPolicy.SOURCE	Tồn tại trên mã nguồn, và không được trình biên dịch nhận ra .
RetentionPolicy.CLASS	Mức sống sót được trình biên dịch nhận ra, nhưng không được phân biệt bởi máy ảo tại thời gian chạy ( Runtime ) .
RetentionPolicy.RUNTIME	Mức sống sót lớn nhất, được trình biên dịch nhận ra, và máy ảo ( JVM ) cũng nhận ra khi chạy chương trình .

• @Inherited: Chú thích này chỉ ra rằng chú thích mới nên được gồm có trong tài liệu Java được tạo ra bởi những công cụ tạo tài liệu Java .
• @Documented: Chú thích chỉ ra rằng loại chú thích có thể được kế thừa từ lớp cha và có giá trị mặc định là false. Khi người dùng truy vấn kiểu Annotation của lớp con và lớp con không có chú thích cho kiểu này thì lớp cha của lớp được truy vấn cho loại chú thích sẽ được gọi. Chú thích này chỉ áp dụng cho các khai báo class.

5 .Khởi tạo Annotation (Annotation tự định nghĩa)

Annotation khá giống một interface, để khai báo một Annotation chúng ta sử dụng @interface. Annotation có thể có hoặc không có các phần tử (element) trong đó.

Một thành phần của Annotation có những đặc thù như sau :

1. Không có thân hàm
2. Không có tham số hàm
3. Khai báo trả về phải là một kiểu dữ liệu cụ thể (Kiểu nguyên thủy, Enum, Annotation hoặc Class).
4. Có thể có giá trị mặc định.

Một Annotation sẽ đượng định nghĩa bởi các Meta-Annotations. Các Meta-Annotations gồm @Retention, @Target, @Documented, @Inherited. 

Ví dụ :

#Khởi tạo

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Retention(value = RetentionPolicy.SOURCE)
//Nó tồn tại trên mã nguồi và trình biên dịch không nhận ra
@Target(value = {ElementType.METHOD, ElementType.FIELD})
//Nó sẽ được dùng chú thích tren mot method
public @interface MyCustomAnnotation{    
}

#Sử dụng

public class UsingAnno {
    @MyCustomAnnotation  //Gán trước một field
    private int myAge = 22;    
    
    @MyCustomAnnotation   //Gán trước một method
    public void aMethod(){
        
    }
}

Trên là một ví dụ nhằm mục đích có cái nhìn cơ bản về cách khởi tạo một Annotation .

6. Annotation lồng nhau (lặp lại chú thích) và cách sử dụng

Trong một số trường hợp, nhu cầu sử dụng một Annotation nhiều lần. Khi đó chúng ta cần tạo một Wrapper chứa danh sách các Annotation có thể lặp lại.

Ví dụ :

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

public class TestAnnotationMain {

    // 1. Koi tao mot chu thich can lap lai
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface ReAnno {

        String value();
    };

    // 2. Khoi tao mot chu thich long nhau
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface ReAnnos {

        ReAnno[] value();
    }

    // 3. Use repeating annotations
    @ReAnnos({
        @ReAnno("Codelearn"),
        @ReAnno("NMD.SE")})
    public interface ReAnnotation {
    }

    public static void main(String[] args) {
        // 4. Retrieving Annotations via the Filters class
        ReAnnos rep = ReAnnotation.class.getAnnotation(ReAnnos.class);
        for (ReAnno re : rep.value()) {
            System.out.println(re.value());
        }
    }
}

7. Tổng kết

Trên đây là bài viết chia sẽ những kiến thức và kỹ năng cơ bản về Annotation ( chú thích ) trong Java. Hi vọng qua bài viết này, bạn đọc hoàn toàn có thể nắm được kiến thức và kỹ năng nền tảng về Annotation trong Java và cách sử dụng nó. Cảm ơn những bạn đã chăm sóc tới bài viết và rất mong nhận được quan điểm góp phần, bổ trợ nhằm mục đích giúp bài viết hoàn hảo hơn. Nếu bạn thấy hay hãy like và san sẻ để ủng hộ mình nhé !

Nguồn tham khảo: Annotation – Java Oracle