Java自定义注解

一直对自定义注解感到好奇，今天就觉得学一下，从网上搜了个文章(https://www.cnblogs.com/liangweiping/p/3837332.html)，跟着例子跑了一遍，还挺有趣的，遂分享出来。以下示例，在此文章基础上改进而来，仅供参考。

一、注解的基础

1.注解的定义：Java文件叫做Annotation，用@interface表示。

2.元注解：@interface上面按需要注解上一些东西，包括@Retention、@Target、@Document、@Inherited四种。

3.注解的保留策略：

　　@Retention(RetentionPolicy.SOURCE)   // 注解仅存在于源码中，在class字节码文件中不包含

　　@Retention(RetentionPolicy.CLASS)     // 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得

　　@Retention(RetentionPolicy.RUNTIME)  // 注解会在class字节码文件中存在，在运行时可以通过反射获取到

4.注解的作用目标：

　　@Target(ElementType.TYPE)                      // 接口、类、枚举、注解

　　@Target(ElementType.FIELD)                     // 字段、枚举的常量

　　@Target(ElementType.METHOD)                 // 方法

　　@Target(ElementType.PARAMETER)            // 方法参数

　　@Target(ElementType.CONSTRUCTOR)       // 构造函数

　　@Target(ElementType.LOCAL_VARIABLE)   // 局部变量

　　@Target(ElementType.ANNOTATION_TYPE) // 注解

　　@Target(ElementType.PACKAGE)               // 包

5.注解包含在javadoc中：

　　@Documented

6.注解可以被继承：

　　@Inherited

7.注解解析器：用来解析自定义注解。

 

二、通过注解进行赋值 - 注解在方法上（结合了工厂方法模式）

　　1.自定义注解

package init;

import java.lang.annotation.*;

@Documented
@Inherited
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Init {
    public String value() default "";
}

 

　　2.在数据模型使用注解

package init;

public class User {
    private String name;
    private String age;

    public String getName() {
        return name;
    }

    @Init(value = "liang")
    public void setName(String name) {
        this.name = name;
    }

    public String getAge() {
        return age;
    }

    @Init(value = "23")
    public void setAge(String age) {
        this.age = age;
    }
}

　　3.用“构造工厂”充当“注解解析器”

package init;

import java.lang.reflect.Method;

public class UserFactory {
    public static User create() {
        User user = new User();

        // 获取User类中所有的方法（getDeclaredMethods也行）
        Method[] methods = User.class.getDeclaredMethods();

        try {
            for (Method method : methods) {
                // 如果此方法有注解，就把注解里面的数据赋值到user对象
                if (method.isAnnotationPresent(Init.class)) {
                    Init init = method.getAnnotation(Init.class);
                    method.invoke(user, init.value());
                }
            }
        } catch (Exception e) {
            System.err.println("发生异常：" + e.getMessage());
            return null;
        }

        return user;
    }
}

　　4.运行的代码

package init;

public class Test {
    public static void main(String[] args) {
//        testField();
        testMethod();
    }

    public static void testMethod(){
        User user = UserFactory.create();

        System.out.println(user.getName());
        System.out.println(user.getAge());
    }

}

　　5.运行结果

liang
23

三、通过注解进行赋值 - 注解在属性上（结合了工厂方法模式）

　　1.自定义注解

package init;

import java.lang.annotation.*;

@Documented
@Inherited
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Init {
    public String value() default "";
}

 

　　2.在数据模型使用注解

package init;

public class UserField {

    @Init(value = "liang")
    private String name;

    @Init(value = "23")
    private String age;

    public String getName() {
        return name;
    }

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

    public String getAge() {
        return age;
    }

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

　　3.用“构造工厂”充当“注解解析器”

package init;


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

public class UserFieldFactory {
    public static UserField create() {
        UserField userField = new UserField();

        // 获取User类中所有的方法（getDeclaredMethods也行）
        Field[] fields = UserField.class.getDeclaredFields();

        try {
            for (Field field : fields) {
                // 如果此方法有注解，就把注解里面的数据赋值到user对象
                if (field.isAnnotationPresent(Init.class)) {
                    Init init = field.getAnnotation(Init.class);

                    //设置字段的值
                    field.setAccessible(true);
                    field.set(userField, init.value());

                    //通过method设置字段的值
//                    String fieldName = field.getName();
//                    fieldName = fieldName.replaceFirst(fieldName.substring(0, 1), fieldName.substring(0, 1).toUpperCase());
//                    Method method = UserField.class.getMethod("set" + fieldName, String.class);
//                    method.invoke(userField, init.value());
                }
            }
        } catch (Exception e) {
            System.err.println("发生异常：" + e.getMessage());
            return null;
        }

        return userField;
    }
}

　　4.运行的代码

package init;

public class Test {
    public static void main(String[] args) {
        testField();
//        testMethod();
    }

    public static void testField(){
        UserField user = UserFieldFactory.create();

        System.out.println(user.getName());
        System.out.println(user.getAge());
    }

}

　　5.运行结果

liang
23

四、通过注解进行校验

　　1.自定义注解

package valid;

import java.lang.annotation.*;

@Documented
@Inherited
@Target({ ElementType.FIELD, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface Validate
{
    public int min() default 1;

    public int max() default 10;

    public boolean isNotNull() default true;

    public String minErrorMsg() default "";

    public String maxErrorMsg() default "";

    public String isNotNullErrorMsg() default "";
}

　　2.在数据模型使用注解

package valid;

public class User {
    @Validate(min = 2, minErrorMsg = "名字最小长度校验不通过！", max = 5, maxErrorMsg = "名字最大长度校验不通过！", isNotNullErrorMsg = "名称不能为空")
    private String name;

    @Validate(isNotNull = false)
    private String age;

    public String getName() {
        return name;
    }

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

    public String getAge() {
        return age;
    }

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

　　3.注解解析器

package valid;

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

public class UserCheck {
    public static boolean check(User user) {
        if (user == null) {
            System.out.println("！！校验对象为空！！");
            return false;
        }

        // 获取User类的所有属性（如果使用getFields，就无法获取到private的属性）
        Field[] fields = user.getClass().getDeclaredFields();

        try {
            for (Field field : fields) {
                // 如果属性有注解，就进行校验
                if (field.isAnnotationPresent(Validate.class)) {
                    Validate validate = field.getAnnotation(Validate.class);

                    //获取字段的值
                    field.setAccessible(true);
                    String fieldValue = (String) field.get(user);

                    if(fieldValue == null){
                        if (validate.isNotNull()) {
                            System.out.println(validate.isNotNullErrorMsg());
                            return false;
                        }
                    }else{
                        if (fieldValue.length() < validate.min()) {
                            System.out.println(validate.minErrorMsg());
                            return false;
                        }
                        if (fieldValue.length() > validate.max()) {
                            System.out.println(validate.maxErrorMsg());
                            return false;
                        }
                    }
                }
            }
        } catch (SecurityException e) {
            System.err.println("类型转换安全异常: " + e.getMessage());
        } catch (IllegalAccessException e) {
            System.err.println("访问属性改变错误: " + e.getMessage());
        } catch (IllegalArgumentException e) {
            System.err.println("非法参数: " + e.getMessage());
        }
        return true;
    }
}

　　4.运行的代码

package valid;

public class Test {
    public static void main(String[] args) {
        User user = new User();

        user.setName("p");
//        user.setName("pppppppppppppppppppp");
//        user.setName("pff");
//        user.setAge("1");

        System.out.println(UserCheck.check(user));
    }
}

　　5.运行结果

名字最小长度校验不通过！
false

参考：

https://www.cnblogs.com/liangweiping/p/3837332.html