Java注解二 自定义注解

首先今天想先聊聊怎么自定义一个注解。
　定义注解格式：
　　public @interface 注解名 {定义体}

　　注解参数的可支持数据类型：

　　　　1. 所有基本数据类型（int,float,boolean,byte,double,char,long,short)
　　　　2. String类型
　　　　3. Class类型
　　　　4. enum类型
　　　　5. Annotation类型
　　　　6. 以上所有类型的数组

　　Annotation类型里面的参数该怎么设定:
　　第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；　 　
　　第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;　　
　　第三,如果只有一个参数成员,最好把参数名称设为”value”,后加小括号。（引用自http://www.cnblogs.com/ITtangtang/p/3974531.html）。

知道了自定义注解的方法，我们使用一个简单的例子作为讲解。
首先自定义一个注解：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
package com.lu.annotation;

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

/**
 * 自定义注解
 * 保留时间一直到Runtime
 * 只能在类、接口、或者是枚举
 * @author lusm
 *
 */

@Retention(RetentionPolicy.RUNTIME)
@Target(value=ElementType.TYPE)
public @interface MyAnnoation {
	String time() default "";

	String author() default "lusm";

	String description() default "";

}

这是一个自定义的注解，我们把他的目标身为Type，那就只能在类、接口、或者是枚举。他的被保留时间一直到Runtime。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package com.lu.beannoated;

import com.lu.annotation.MyAnnoation;

@MyAnnoation(author = "lushunming", description = "这是一个被注解的类", time = "2016-5-21")
public class Annoated {
	private String author;
	private String description;
	private String time;

	public String getAuthor() {
		return author;
	}

	public void setAuthor(String author) {
		this.author = author;
	}

	public String getDescription() {
		return description;
	}

	public void setDescription(String description) {
		this.description = description;
	}

	public String getTime() {
		return time;
	}

	public void setTime(String time) {
		this.time = time;
	}

}

这是被注解的类。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package com.lu.parser;

import java.lang.annotation.Annotation;

import com.lu.annotation.MyAnnoation;
import com.lu.beannoated.Annoated;

/**
 * 注解解析器
 * 
 * @author lusm
 *
 */
public class MyAnnoationParser {
	public void parse() {
		Class<Annoated> clazz = Annoated.class;
		//获取被注解类上的所有注解
		Annotation[] ans=clazz.getAnnotations();
		System.out.println("所有的注解开始");
		for (Annotation annotation : ans) {
			System.out.println(annotation);
		}
		System.out.println("所有的注解结束");
	//获取特定的注解
		MyAnnoation myAnnoation=clazz.getAnnotation(MyAnnoation.class);
		System.out.println("获取MyAnnoation");
		System.out.println(myAnnoation);
		System.out.println("获取MyAnnoation的详细信息");
		//获取注解中的信息
		System.out.println("author---"+myAnnoation.author());
		System.out.println("description---"+myAnnoation.description());
		System.out.println("time---"+myAnnoation.time());
		
		
	}
}

这是注解解析器，用来解析注解。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package com.lu.main;

import com.lu.parser.MyAnnoationParser;

/**
 * 运行主方法
 * 
 * @author lusm
 *
 */
public class MyAnnoationMain {
	public static void main(String[] args) {

		MyAnnoationParser parser = new MyAnnoationParser();
		parser.parse();

	}

}

在main方法中调用，获取到的结果如下。

1
2
3
4
5
6
7
8
9
所有的注解开始
@com.lu.annotation.MyAnnoation(author=lushunming, description=这是一个被注解的类, time=2016-5-21)
所有的注解结束
获取MyAnnoation
@com.lu.annotation.MyAnnoation(author=lushunming, description=这是一个被注解的类, time=2016-5-21)
获取MyAnnoation的详细信息
author---lushunming
description---这是一个被注解的类
time---2016-5-21

这便是一个简单的注解的使用。样例代码托管在https://git.oschina.net/shunming/Annoation.git ，可以用git拷贝

由于jekyll的环境非常难维护，所以转转阵营了，blog换为Hexo的了，而且换了主题。博客的地址是http://www.lushunming.com.cn ，我的博客中的排版更为美观，欢迎大家去看我的博客，也可以用邮箱订阅。