Java注解详解-优快云博客

2019独角兽企业重金招聘Python工程师标准>>>

一、什么是注解(Annotation)

注解，顾名思义，即是对代码的注明解释，又称为元数据，它为我们在代码中添加信息提供了一种形式化的方法，使我们在稍后某个时刻非常方便地使用这些数据。

二、Java中内置注解

三种基本的注解:

@SuppressWarnings，关闭不当的编译器警告信息。

@Deprecated，如果程序员使用了注解为它的元素，那么编译器会发出警告信息。

@Override，表示当前的方法定义将覆盖父类中的方法，如果不小心拼写错误，或者方法签名对不上被覆盖的方法，则编译器会有错误提示

四种元注解(下面将会详细介绍)

@Target @Retention @Documented @Inherited

三、自定义注解

在我们实际的工作中，仅凭借以上三种注解很难满足我们实际的开发需求，因此Java允许我们自定义注解，而自定义注解主要有两个步骤，如下:

(1)使用@interface修饰所要定义的注解

(2)使用java内置的四个元注解对自定义标注的功能和范围进行一些限制

代码示例1:自定义注解

package com.zbx.myannotation;
import java.lang.annotation;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)

public @interface UserCase{
	public int id();
	public String description() default:"no description";
}

注1:对于非基本类型的元素，无论是在源代码中声明时，或是在注解接口中定义默认值时，都不能以null作为其值。

代码示例2:应用以上的注解

package scau.zbx.myannotation;

public class TestAnnotation{
	@UseCase(id=47,
		 description="Password must contain at least one numeric");
	public boolean validatePassword(String password){
		return (password.matches("\\w*\\d\\w*"));
	}
}

四、元注解

Java目前只内置了三种标准注解(前面已提及)和四种元注解。元注解专职负责注解其他的注解。

@Taget 表示该注解可以用于什么地方。可能的ElementType参数包括:

CONSTRUCTOR：构造器的声明

FIELD：域声明(包括enum实例)

LOCAL_VARIABLE：局部变量声明

METHOD：方法声明

PACKAGE：包声明

PARAMETER：参数声明

TYPE：类、接口(包括注解类型)或enum声明

@Retention 表示需要在什么级别保存该注解细腻。可选的RetentionPolicy参数包括:

SOURCE：注解将被编译器丢弃

CLASS：注解在class文件中可用，但会被VM丢弃

RUNTIME：VM将在运行期也保留注解，因此可以通过反射机制读取注解的信息

@Documented 将此注解包含在Javadoc中

@Inherited 允许子类继承父类中的注解

五、获取注解信息

下面我们将一个详细的例子揭示怎么通过反射获取注解中的内容。

代码示例3:自定义类级别的注解Description

package scau.zbx.annotation;
import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented//将此注解包含在javadoc中
public @interface Description{
	publc String name();
}

代码示例4:自定义方法级别的注解Name

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented

public @interface Name {
	String originate();
	String community();
}

代码示例5：使用上述注解

package scau.zbx.annotation;

@Description(name="开源中国社区")
public class OsChina {
	public String name;
	public String name2;
	@Name(originate="创始人之一:xxx",community="oschina")
	public String getName()
	{
		return name;
	}
	@Name(originate="创始人之一:xxx",community="oschina")
	public String getName2()
	{
		return name2;
	}
}

代码示例6：提取注解中的内容(利用反射)

package scau.zbx.annotation;

import java.lang.reflect.Method;
import java.util.HashSet;
import java.util.Set;

public class TestAnnotation {
	public static void main(String[] args) {
	//利用反射加载带有注解的类
	Class testClass = Class.forName("scau.zbx.annotation.OsChina");
	//获得注解类的所有方法
	Method[] method = testClass.getMethods();
	//判断是否有类级别的Description注解
	boolean classFlag = testClass.isAnnotationPresent(Description.class);
	if(classFlag){
		//获得类注解的信息，通过getAnnotation(Class)方法
		Description des = (Description)testClass.getAnnotation(Description.class);
		System.out.println("描述:"+des.name());
	}
	//把OsChina类中添加了@Name注解的全部方法保存到Set中
	Set<Method> set = new HashSet<Method>();
	for(int i=0;i<method.length;i++) {
		//判断是否有方法级别的Name注解
		boolean methodFlag = method[i].isAnnotationPresent(Name.class);
		if(methodFlag) 
			set.add(method[i]);
	}
	for(Method m: set) {
		Name name = m.getAnnotation(Name.class);
		System.out.println(name.originate());
		System.out.println("创建的社区:"+name.community());
	}
  }
}

转载于:https://my.oschina.net/boxizen/blog/177086