在我们平时的开发中,注解可谓是开发的一把利器,给我们带来乐很多方便,譬如spring的@Autowired,@Resource,@Repository,@Service,@Controller …
这些都是第三方框架为我们提供的一些注解,其实我们也可以自定义一些注解,解决我们实际开发中可能遇到的问题,比如:记录操作日志。
首先了解这么一种存在,元注解:
元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解:
1. @Target
2. @Retention
3. @Documented
4. @Inherited
这些类型和它们所支持的类在java.lang.annotation包中可以找到。
@Target:
作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
取值(ElementType)有:
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
@Retention:
作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)
取值(RetentionPoicy)有:
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在运行时有效(即运行时保留)
@Documented:
作用:用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。
@Inherited:
作用:这重点内容是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
元注解看完了,就可以聊聊自定义注解了。
@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。
定义注解格式:
public @interface 注解名 {定义体}
Annotation类型设定:
1. 只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型;
2. 参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;
3. 如果只有一个参数成员,最好把参数名称设为”value”,后加小括号.例:下面的例子FruitName注解就只有一个参数成员。
蓝后,就阔以写Demo了!!!
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FruitName {
String name() default "";
}
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FruitColor {
enum Color{RED,YELLOW,WHITE}
Color fruitColor() default Color.RED;
}
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FruitProvider {
int id() default 0;
String user() default "";
String address() default "";
}
import com.annotation.test.FruitColor.Color;
public class Apple {
@FruitName(name="FuShi Apple")
private String fruitName;
@FruitColor(fruitColor=Color.RED)
private String fruitColor;
@FruitProvider(id=1,user="Tom",address="China")
private FruitProvider provider;
}
import java.lang.reflect.Field;
public class Test {
public static void getFruitInfo() {
Class<?> cls = Apple.class;
Field[] fields = cls.getDeclaredFields();
for (Field field : fields) {
if (field.getName().equals("fruitName")) {
FruitName fruitName = field.getAnnotation(FruitName.class);
System.out.println("Fruit Name:" + fruitName.name());
}
if (field.getName().equals("fruitColor")) {
FruitColor color = field.getAnnotation(FruitColor.class);
System.out.println("Fruit Color:" + color.fruitColor());
}
if (field.getName().equals("provider")) {
FruitProvider Provider = field.getAnnotation(FruitProvider.class);
System.out.println("Fruit FruitProvider: ProviderID:" + Provider.id() + " Provider:" + Provider.user()
+ " ProviderAddress:" + Provider.address());
}
}
}
public static void main(String[] args) {
getFruitInfo();
}
}
自定义注解的应用实例:记录操作日志
图片源于网络: