自定义注解,判断带注解的类或属性是否符合条件

  • Post author:
  • Post category:其他




1 原文链接:

http://www.cnblogs.com/mouseIT/p/5033746.html





1.自定义注解

import java.lang.annotation.*;

@Documented
@Target(ElementType.FIELD)
@Inherited
@Retention(RetentionPolicy.RUNTIME )
public @interface MyAnno {
    /**
     * 是否能为null
     * @return
     */
    boolean isCanNull() default true;

    /**
     * 是否能为空字符串
     * @return
     */
    boolean isCanEmpty() default true;

    /**
     * 是否能为0
     * @return
     */
    boolean isCanZero() default true;
}



2.使用注解:

public class Mouse {

    @MyAnno(isCanNull=true)
    private  String name;
    @MyAnno(isCanNull = false,isCanZero = false)
    private  int age;
    @MyAnno(isCanNull = false)
    private String address;
    @MyAnno(isCanZero = false)
    private double money;

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    public double getMoney() {
        return money;
    }

    public void setMoney(double money) {
        this.money = money;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}



3.获得注解的值并对其判断

package com.vweb.util;

import com.vweb.webapp.Mouse;
import com.vweb.webapp.MyAnno;
import com.vweb.webapp.TestUtil;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.util.Arrays;
import java.util.List;

public class IntactCheckUtil {

    public static boolean check(Object obj){
           // list = Arrays.asList(AnnotationParsing.class.getClassLoader().loadClass(((Class)obj).getClass().getName()).getDeclaredFields());
        List<Field>  list = Arrays.asList(obj.getClass().getDeclaredFields());
        for(int i=0;i<list.size();i++){
            Field field = list.get(i);
            if(field.isAnnotationPresent(MyAnno.class)){//是否使用MyAnno注解
                for (Annotation anno : field.getDeclaredAnnotations()) {//获得所有的注解
                    if(anno.annotationType().equals(MyAnno.class) ){//找到自己的注解
                        if(!((MyAnno)anno).isCanNull()){//注解的值
                            if(TestUtil.getFieldValueByName(field.getName(),obj)==null){
                                throw new RuntimeException("类:"+Mouse.class+"的属性:"+field.getName()+"不能为空,实际的值:"+TestUtil.getFieldValueByName(field.getName(),obj)+",注解:field.getDeclaredAnnotations()");
                            }
                        }
                        if(!((MyAnno)anno).isCanEmpty()){
                            if(TestUtil.getFieldValueByName(field.getName(),obj).equals("")){
                                throw new RuntimeException("类:"+Mouse.class+"的属性:"+field.getName()+"不能为空字符串,实际的值:"+TestUtil.getFieldValueByName(field.getName(),obj)+",注解:field.getDeclaredAnnotations()");
                            }
                        }
                        if(!((MyAnno)anno).isCanZero()){
                            if(TestUtil.getFieldValueByName(field.getName(),obj).toString().equals("0") || TestUtil.getFieldValueByName(field.getName(),obj).toString().equals("0.0")){
                                throw new RuntimeException("类:"+Mouse.class+"的属性:"+field.getName()+"不能为空字符0,实际的值:"+TestUtil.getFieldValueByName(field.getName(),obj)+",注解:field.getDeclaredAnnotations()");
                            }
                        }
                    }
                }
            }

        }
        return  true;
    }
}


备注:注解各参数的使用

(以下内容来自互联网http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html)


@Target:

@Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。



取值(ElementType)有:

1.CONSTRUCTOR:用于描述构造器


2.FIELD:用于描述域


3.LOCAL_VARIABLE:用于描述局部变量


4.METHOD:用于描述方法


5.PACKAGE:用于描述包


6.PARAMETER:用于描述参数


7.TYPE:用于描述类、接口(包括注解类型) 或enum声明


@Retention

定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

取值(RetentionPoicy)有:

1.SOURCE:在源文件中有效(即源文件保留)


2.CLASS:在class文件中有效(即class保留)


3.RUNTIME:在运行时有效(即运行时保留)


@Documented:



该属性用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。


@Inherited:



@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。

注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。

当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。


自定义注解:

使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。


定义注解格式:



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”,后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

简单的自定义注解和使用注解实例:



2 原文中作者少传了一个工具类,我这里给补全:


package anno;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

public class TestUtil {
	
	/** 
	* 获取对象属性,返回一个字符串数组     
	*  
	* @param  o 对象 
	* @return String[] 字符串数组 
	*/  
	private String[] getFiledName(Object o)  
	{    
	try   
	{  
	Field[] fields = o.getClass().getDeclaredFields();  
	String[] fieldNames = new String[fields.length];    
	for (int i=0; i < fields.length; i++)  
	{    
	    fieldNames[i] = fields[i].getName();    
	}    
	return fieldNames;  
	} catch (SecurityException e)   
	{  
	e.printStackTrace();  
	System.out.println(e.toString());  
	}  
	    return null;  
	}    
	
	
	/** 
	* 使用反射根据属性名称获取属性值  
	*  
	* @param  fieldName 属性名称 
	* @param  o 操作对象 
	* @return Object 属性值 
	*/  
	  
	public static Object getFieldValueByName(String fieldName, Object o)   
	{      
	   try   
	   {      
	       String firstLetter = fieldName.substring(0, 1).toUpperCase();      
	       String getter = "get" + firstLetter + fieldName.substring(1);      
	       Method method = o.getClass().getMethod(getter, new Class[] {});      
	       Object value = method.invoke(o, new Object[] {});      
	       return value;      
	   } catch (Exception e)   
	   {      
	       System.out.println("属性不存在");      
	       return null;      
	   }      
	}   
}


使用:

public static void main(String[] args) {
		boolean b = check(new Mouse());
		System.out.println(b);
	}



版权声明:本文为wabiaozia原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。