Hướng dẫn và ví dụ Java Annotation

package org.o7planning.tutorial.ann.builtin;

import java.util.Date;

public class DeprecatedMethodDemo {

  /**
   * @deprecated replaced by {@link #todo(String,Date)}
   */
  @Deprecated
  public void todoJob(String jobName) {
      System.out.println("Todo " + jobName);
  }

  public void todo(String jobName, Date atTime) {
      System.out.println("Todo " + jobName + " at " + atTime);
  }

  public void todoNothing() {
      System.out.println("Todo Nothing");
  }

  public static void main(String[] args) {

      DeprecatedMethodDemo obj = new DeprecatedMethodDemo();

      obj.todoJob("Java coding");

      obj.todoNothing();
  }
}

package org.o7planning.tutorial.ann.builtin;

public class Job {

	// Đây là một phương thức của lớp Job.
	public String getName() {
		return null;
	}

}

package org.o7planning.tutorial.ann.builtin;

public class JavaCoding extends Job {

	// Đây là một phương thức ghi đè phương thức getName() của lớp cha.
	// @Override không bắt buộc phải gắn trên phương thức này.
	// Nhưng nó cần thiết nếu ai đó thay đổi tên của phương thức getName()
	// của class cha, sẽ có một thông báo lỗi cho bạn biết.
	@Override
	public String getName() {
		return "Java Coding";
	}

}

package org.o7planning.tutorial.ann.builtin;

import java.util.Date;

public class SuppressWarningsDemo {

  @SuppressWarnings("deprecation")
  public Date getSomeDate() {

      Date date = new Date(2014, 9, 25);
      return date;
  }

}

package org.o7planning.tutorial.ann.builtin;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

public class SuppressWarningsDemo2 {

	public List<?> getDatas() {
		List<String> list = new ArrayList<String>();
		list.add("One");
		return list;
	}

	@SuppressWarnings({ "deprecation", "unused", "unchecked" })
	public void processDatas() {

		// Bạn đang sử dụng constructor lỗi thời
		// Và biến 'date' đã được tạo ra, nhưng không được sử dụng.
		Date date = new Date(2014, 9, 25);

		// Ép kiểu (cast) không an toàn.
		// Và biến 'datas' được tạo ra, nhưng không được sử dụng trong code.
		List<String> datas = (List<String>) this.getDatas();
	}

}

package org.o7planning.tutorial.ann1;

public @interface MyFirstAnnotation {

	// Phần tử 'name'.
	public String name();

	// Phần tử 'description', có giá trị mặc định "".
	public String description() default "";

}

package org.o7planning.tutorial.ann1;

@MyFirstAnnotation(name = "Some name", description = "Some description")
public class UsingMyFirstAnnotation {

	// Annotation được gắn trên một Constructor.
	// Với giá trị của phần tử name là "John"
	// Giá trị phần tử description là "Write by John".
	@MyFirstAnnotation(name = "John", description = "Write by John")
	public UsingMyFirstAnnotation() {

	}

	// Annotation được gắn trên một phương thức.
	// Với giá trị của phần tử 'name' là "Tom"
	// Phần tử 'description' không được khai báo, nó sẽ lấy theo mặc định.
	@MyFirstAnnotation(name = "Tom")
	public void someMethod() {

	}

	// Annotation gắn trên tham số của một phương thức.
	public void todo(@MyFirstAnnotation(name = "none") String job) {

		// Annotation được gắn lên biến địa phương.
		@MyFirstAnnotation(name = "Some name")
		int localVariable = 0;

	}

}

package org.o7planning.tutorial.ann2;

public @interface AnnWithValue {

	// Một phần tử có tên là 'value', của Annotation.
	// Có một chút đặc biệt khi sử dụng phần tử này.
	public int value();

	// Phần tử 'name'
	public String name() default "";

}

package org.o7planning.tutorial.ann2;

public class UsingAnnWithValue {

	// Khởi tạo các phần tử của Annotation theo cách thông thường.
	@AnnWithValue(name = "Name1", value = 100)
	public void someMethod1() {

	}

	// Khởi tạo các phần tử của Annotation theo cách thông thường.
	// Phần tử 'name' của Annotation này sẽ có giá trị mặc định
	@AnnWithValue(value = 100)
	public void someMethod2() {

	}

	// Phần tử có tên 'value' là đặc biệt.
	// Thay vì viết @AnnWithValue(value = 100)
	// Bạn chỉ cần viết @AnnWithValue(100)
	@AnnWithValue(100)
	public void someMethod3() {

	}
}

package org.o7planning.tutorial.ann3;

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

// Annotation này nói rằng AnnFM chỉ được nhận biết trên mã nguồn.
// Nó sẽ không được nhận biết bởi bộ biên dịch (compiler),
// và trong thời gian chạy máy ảo cũng không biết sự tồn tại của nó.
@Retention(value = RetentionPolicy.SOURCE)

// Annotation này nói rằng:
// AnnFM sẽ chỉ được dùng để chú thích (annotate) trên FIELD hoặc METHOD.
@Target(value = { ElementType.FIELD, ElementType.METHOD })
public @interface AnnFM {

}

package org.o7planning.tutorial.ann3;

public class UsingAnnFM {

	// AnnFM chỉ được phép chú thích (annotate) trên FIELD hoặc METHOD.
	@AnnFM
	protected int someField = 100;

	// AnnFM chỉ được phép chú thích (annotate)trên FIELD hoặc METHOD.
	@AnnFM
	public void someMethod() {

	}

}

package org.o7planning.tutorial.ann4;

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

@Retention(RetentionPolicy.RUNTIME)

// Annotation này nói rằng:
// AnnHtmlUL chỉ được sử dụng cho Class, interface, annotation, enum.
@Target(value = { ElementType.TYPE })

// AnnHtmlUL: Mô phỏng thẻ (tag) <UL> trong HTML.
public @interface AnnHtmlUL {

	public String border() default "border:1px solid blue;";
	
}

package org.o7planning.tutorial.ann4;

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

@Retention(RetentionPolicy.RUNTIME)
@Target(value = { ElementType.FIELD, ElementType.METHOD })

// Mô phỏng thẻ (tag) <LI> trong HTML.
public @interface AnnHtmlLI {

	public String background();

	public String color() default "red";
	
}

package org.o7planning.tutorial.ann4;

@AnnHtmlUL(border = "1px solid red")
public class DocumentClass {

	private String author;

	@AnnHtmlLI(background = "blue", color = "black")
	public String getDocumentName() {
		return "Java Core";
	}

	@AnnHtmlLI(background = "yellow")
	public String getDocumentVersion() {
		return "1.0";
	}

	@AnnHtmlLI(background = "green")
	public void setAuthor(String author) {
		this.author = author;
	}

	@AnnHtmlLI(background = "red", color = "black")
	public String getAuthor() {
		return author;
	}
	
	// Phương thức này không được chú thích bởi Annotation nào.
	public float getPrice()  {
		return 100;
	}

}

package org.o7planning.tutorial.ann4;

import java.lang.reflect.Method;

public class HtmlGenerator {

	public static void main(String[] args) {

		Class<?> clazz = DocumentClass.class;

		// Kiểm tra xem lớp này có được chú thích (annotate) bởi AnnHtmlUL hay không.
		boolean isHtmlUL = clazz.isAnnotationPresent(AnnHtmlUL.class);

		StringBuilder sb = new StringBuilder();
		if (isHtmlUL) {

			// Lấy ra đối tượng AnnHtmlUL, chú thích trên lớp này.
			AnnHtmlUL annUL = clazz.getAnnotation(AnnHtmlUL.class);

			sb.append("<H3>" + clazz.getName() + "</H3>");
			sb.append("\n");

			// Lấy ra giá trị của phần tử 'border' của AnnHtmlUL.
			String border = annUL.border();

			sb.append("<UL style='border:" + border + "'>");

			// Thêm dấu xuống dòng.
			sb.append("\n");

			Method[] methods = clazz.getMethods();

			for (Method method : methods) {
				// Kiểm tra xem phương thức này có được chú thích (annotate)
				// bởi AnnHtmlLI hay không?
				if (method.isAnnotationPresent(AnnHtmlLI.class)) {
					// Lấy ra annotation đó.
					AnnHtmlLI annLI = method.getAnnotation(AnnHtmlLI.class);

					// Lấy ra các giá trị các phần tử của AnnHtmlLI.
					String background = annLI.background();
					String color = annLI.color();

					sb.append("<LI style='margin:5px;padding:5px;background:" + background + ";color:" + color + "'>");
					sb.append("\n");
					sb.append(method.getName());
					sb.append("\n");
					sb.append("</LI>");
					sb.append("\n");
				}
			}
			sb.append("</UL>");
		}
		writeToFile(clazz.getSimpleName() + ".html", sb);
	}

	// Ghi các thông tin ra màn hình Console (Hoặc file).
	private static void writeToFile(String fileName, StringBuilder sb) {
		System.out.println(sb);
	}

}