java基础---->java注解的使用（一）

　　注解是众多引入到Java SE5中的重要的语言变化之一。它为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便的使用这些数据。今天我们就开始学习一下java中注解的知识。

java注解的介绍

java内置了三种标准注解，以及四种元注解。元注解专职负责注解其他的注解。

标准注解：@Override，@Deprecated，@Suppresswarnings。

@Override：表示当前的方法定义将覆盖超类中的方法。如果你不小心拼写错误，或者方法签名对不上被覆盖的方法，编译器就会发出错误提示。

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

@Suppresswarnings：关闭不当的编译器警告信息。

元注解：@Target，@Retention，@Documented，@Inherited。

注解	描述	可选的参数
@Target	表示该注解可以用于什么地方	CONSTRUCTOR、FIELD、LOCAL_VARLABLE、METHOD、PACKAGE、PARAMETER、TYPE
@Retention	表示需要在什么级别保存该注解信息	SOURCE、CLASS、RUNTIME
@Documented	将此注解包含在javadoc中
@Inherited	允许子类继承父类中的注解

java注解的使用案例

测试的项目结构如下：

一、定义注解：

package com.linux.huhx.anno;

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

/**
 * @Author huhx
 * @Date: 2017/9/17 20:07
 *  定义注解:
 */

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface HuhxTest {
    public int id();

    public String description() default "no description";
}

二、编写要被注解的测试类

package com.linux.huhx.anno;

import java.util.List;

/**
 * @Author huhx
 * @Date: 2017/9/17 20:13
 */
public class PasswordUtils {

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

    @HuhxTest(id = 48)
    public String encryptPassword(String password) {
        return new StringBuilder(password).reverse().toString();
    }

    @HuhxTest(id = 49, description = "new passrod can't equal previously used ones")
    public boolean checkForNewPassword(List<String> prevPasswords, String password) {
        return !prevPasswords.contains(password);
    }
}

三、编写注解处理器

package com.linux.huhx.anno;

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * @Author huhx
 * @Date: 2017/9/17 20:12
 */
public class UseCaseTracker {

    public static void trackUseCases(List<Integer> useCases, Class<?> cl) {
        for (Method m : cl.getDeclaredMethods()) {
            HuhxTest test = m.getAnnotation(HuhxTest.class);
            if (test != null) {
                System.out.println("found use case: " + test.id() + ", " + test.description());
                useCases.remove(new Integer(test.id()));
            }
        }
        for (int i : useCases) {
            System.out.println("warning: missing use case " + i);
        }
    }

    public static void main(String[] args) {
        List<Integer> useCases = new ArrayList<>();
        Collections.addAll(useCases, 47, 48, 49, 50);
        trackUseCases(useCases, PasswordUtils.class);
    }
}

运行的结果如下：

found use case: 49, new passrod can't equal previously used ones
found use case: 48, no description
found use case: 47, password must contain at least one numeric
warning: missing use case 50

友情链接