這篇文章將為大家詳細(xì)講解有關(guān)Java注解的定義及使用方法，小編覺得挺實(shí)用的，因此分享給大家做個參考，希望大家閱讀完這篇文章后可以有所收獲。
Java的注解在實(shí)際項(xiàng)目中使用得非常的多，特別是在使用了Spring之后。
本文會介紹Java注解的語法，以及在Spring中使用注解的例子。
注解的語法
注解的例子
以Junit中的@Test注解為例
重慶分公司
重慶分公司
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
long timeout() default 0L;
}可以看到@Test注解上有@Target()和@Retention()兩個注解。
這種注解了注解的注解，稱之為元注解。
跟聲明了數(shù)據(jù)的數(shù)據(jù)，稱為元數(shù)據(jù)是一種意思。
之后的注解的格式是
修飾符 @interface 注解名 {
注解元素的聲明1
注解元素的聲明2
}注解的元素聲明有兩種形式
type elementName(); type elementName() default value; // 帶默認(rèn)值
@Target注解@Target注解用于限制注解能在哪些項(xiàng)上應(yīng)用，沒有加@Target的注解可以應(yīng)用于任何項(xiàng)上。
在java.lang.annotation.ElementType類中可以看到所有@Target接受的項(xiàng)
TYPE 在【類、接口、注解】上使用
FIELD 在【字段、枚舉常量】上使用
METHOD 在【方法】上使用
PARAMETER 在【參數(shù)】上使用
CONSTRUCTOR 在【構(gòu)造器】上使用
LOCAL_VARIABLE 在【局部變量】上使用
ANNOTATION_TYPE 在【注解】上使用
PACKAGE 在【包】上使用
TYPE_PARAMETER 在【類型參數(shù)】上使用 Java 1.8 引入
TYPE_USE 在【任何聲明類型的地方】上使用 Java 1.8 引入
@Test注解只允許在方法上使用。
@Target(ElementType.METHOD)
public @interface Test { ... }如果要支持多項(xiàng)，則傳入多個值。
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface MyAnnotation { ... }此外元注解也是注解，也符合注解的語法，如@Target注解。@Target(ElementType.ANNOTATION_TYPE)表明@Target注解只能使用在注解上。
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
ElementType[] value();
}@Retention注解@Retention指定注解應(yīng)該保留多長時間，默認(rèn)是RetentionPolicy.CLASS。
在java.lang.annotation.RetentionPolicy可看到所有的項(xiàng)
SOURCE 不包含在類文件中
CLASS 包含在類文件中，不載入虛擬機(jī)
RUNTIME 包含在類文件中，由虛擬機(jī)載入，可以用反射API獲取
@Test注解會載入到虛擬機(jī)，可以通過代碼獲取
@Retention(RetentionPolicy.RUNTIME)
public @interface Test { ... }@Documented注解主要用于歸檔工具識別。被注解的元素能被Javadoc或類似的工具文檔化。
@Inherited注解添加了@Inherited注解的注解，所注解的類的子類也將擁有這個注解
注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface MyAnnotation { ... }父類
@MyAnnotation
class Parent { ... }子類Child會把加在Parent上的@MyAnnotation繼承下來
class Child extends Parent { ... }@Repeatable注解Java 1.8 引入的注解，標(biāo)識注解是可重復(fù)使用的。
注解1
public @interface MyAnnotations {
MyAnnotation[] value();
}注解2
@Repeatable(MyAnnotations.class)
public @interface MyAnnotation {
int value();
}有使用@Repeatable()時的使用
@MyAnnotation(1)
@MyAnnotation(2)
@MyAnnotation(3)
public class MyTest { ... }沒使用@Repeatable()時的使用，@MyAnnotation去掉@Repeatable元注解
@MyAnnotations({
@MyAnnotation(1),
@MyAnnotation(2),
@MyAnnotation(3)})
public class MyTest { ... }這個注解還是非常有用的，讓我們的代碼變得簡潔不少，Spring的@ComponentScan注解也用到這個元注解。
8種基本數(shù)據(jù)類型（byte，short，char，int，long，float，double，boolean）
String
Class
enum
注解類型
數(shù)組（所有上邊類型的數(shù)組）
枚舉類
public enum Status {
GOOD,
BAD
}注解1
@Target(ElementType.ANNOTATION_TYPE)
public @interface MyAnnotation1 {
int val();
}注解2
@Target(ElementType.TYPE)
public @interface MyAnnotation2 {
boolean boo() default false;
Class cla() default Void.class;
Status enu() default Status.GOOD;
MyAnnotation1 anno() default @MyAnnotation1(val = 1);
String[] arr();
}使用時，無默認(rèn)值的元素必須傳值
@MyAnnotation2(
cla = String.class,
enu = Status.BAD,
anno = @MyAnnotation1(val = 2),
arr = {"a", "b"})
public class MyTest { ... }Java內(nèi)置的注解@Override注解告訴編譯器這個是個覆蓋父類的方法。如果父類刪除了該方法，則子類會報錯。
@Deprecated注解表示被注解的元素已被棄用。
@SuppressWarnings注解告訴編譯器忽略警告。
@FunctionalInterface注解Java 1.8 引入的注解。該注釋會強(qiáng)制編譯器javac檢查一個接口是否符合函數(shù)接口的標(biāo)準(zhǔn)。
有兩種比較特別的注解
標(biāo)記注解 ： 注解中沒有任何元素，使用時直接是 @XxxAnnotation, 不需要加括號
單值注解 ： 注解只有一個元素，且名字為value，使用時直接傳值，不需要指定元素名@XxxAnnotation(100)
Java的AnnotatedElement接口中有getAnnotation()等獲取注解的方法。
而Method，Field，Class，Package等類均實(shí)現(xiàn)了這個接口，因此均有獲取注解的能力。
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD})
public @interface MyAnno {
String value();
}@MyAnno("class")
public class MyClass {
@MyAnno("feild")
private String str;
@MyAnno("method")
public void method() { }
}public class Test {
public static void main(String[] args) throws Exception {
MyClass obj = new MyClass();
Class clazz = obj.getClass();
// 獲取對象上的注解
MyAnno anno = clazz.getAnnotation(MyAnno.class);
System.out.println(anno.value());
// 獲取屬性上的注解
Field field = clazz.getDeclaredField("str");
anno = field.getAnnotation(MyAnno.class);
System.out.println(anno.value());
// 獲取方法上的注解
Method method = clazz.getMethod("method");
anno = method.getAnnotation(MyAnno.class);
System.out.println(anno.value());
}
}Spring中使用自定義注解注解本身不會有任何的作用，需要有其他代碼或工具的支持才有用。
設(shè)想現(xiàn)有這樣的需求，程序需要接收不同的命令CMD，
然后根據(jù)命令調(diào)用不同的處理類Handler。
很容易就會想到用Map來存儲命令和處理類的映射關(guān)系。
由于項(xiàng)目可能是多個成員共同開發(fā)，不同成員實(shí)現(xiàn)各自負(fù)責(zé)的命令的處理邏輯。
因此希望開發(fā)成員只關(guān)注Handler的實(shí)現(xiàn)，不需要主動去Map中注冊CMD和Handler的映射。
最終希望看到效果是這樣的
@CmdMapping(Cmd.LOGIN)
public class LoginHandler implements ICmdHandler {
@Override
public void handle() {
System.out.println("handle login request");
}
}
@CmdMapping(Cmd.LOGOUT)
public class LogoutHandler implements ICmdHandler {
@Override
public void handle() {
System.out.println("handle logout request");
}
}開發(fā)人員增加自己的Handler，只需要創(chuàng)建新的類并注上@CmdMapping(Cmd.Xxx)即可。
具體的實(shí)現(xiàn)是使用Spring和一個自定義的注解
定義@CmdMapping注解
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Component
public @interface CmdMapping {
int value();
}@CmdMapping中有一個int類型的元素value，用于指定CMD。這里做成一個單值注解。
這里還加了Spring的@Component注解，因此注解了@CmdMapping的類也會被Spring創(chuàng)建實(shí)例。
然后是CMD接口，存儲命令。
public interface Cmd {
int REGISTER = 1;
int LOGIN = 2;
int LOGOUT = 3;
}之后是處理類接口，現(xiàn)實(shí)情況接口會復(fù)雜得多，這里簡化了。
public interface ICmdHandler {
void handle();
}上邊說過，注解本身是不起作用的，需要其他的支持。下邊就是讓注解生效的部分了。
使用時調(diào)用handle()方法即可。
@Component
public class HandlerDispatcherServlet implements
InitializingBean, ApplicationContextAware {
private ApplicationContext context;
private Map handlers = new HashMap<>();
public void handle(int cmd) {
handlers.get(cmd).handle();
}
public void afterPropertiesSet() {
String[] beanNames = this.context.getBeanNamesForType(Object.class);
for (String beanName : beanNames) {
if (ScopedProxyUtils.isScopedTarget(beanName)) {
continue;
}
Class beanType = this.context.getType(beanName);
if (beanType != null) {
CmdMapping annotation = AnnotatedElementUtils.findMergedAnnotation(
beanType, CmdMapping.class);
if(annotation != null) {
handlers.put(annotation.value(), (ICmdHandler) context.getBean(beanType));
}
}
}
}
public void setApplicationContext(ApplicationContext applicationContext)
throws BeansException {
this.context = applicationContext;
}
} 主要工作都是Spring做，這里只是將實(shí)例化后的對象put到Map中。
測試代碼
@ComponentScan("pers.custom.annotation")
public class Main {
public static void main(String[] args) {
AnnotationConfigApplicationContext context
= new AnnotationConfigApplicationContext(Main.class);
HandlerDispatcherServlet servlet = context.getBean(HandlerDispatcherServlet.class);
servlet.handle(Cmd.REGISTER);
servlet.handle(Cmd.LOGIN);
servlet.handle(Cmd.LOGOUT);
context.close();
}
}關(guān)于Java注解的定義及使用方法就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，可以學(xué)到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn，海內(nèi)外云服務(wù)器15元起步，三天無理由+7*72小時售后在線，公司持有idc許可證，提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案，具有“安全穩(wěn)定、簡單易用、服務(wù)可用性高、性價比高”等特點(diǎn)與優(yōu)勢，專為企業(yè)上云打造定制，能夠滿足用戶豐富、多元化的應(yīng)用場景需求。
