java进阶学习十二之自定义注解与Properties类

1: 注解

​ 1.1 定义 : Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。

Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同，Java 标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。

​ 1.2 内置注解 : JDK自己内部定义的注解;

Java 定义了一套注解，共有 7 个，3 个在 java.lang 中，剩下 4 个在 java.lang.annotation 中。

作用在代码的注解是

@Override - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
@Deprecated - 标记过时方法。如果使用该方法，会报编译警告。
@SuppressWarnings - 指示编译器去忽略注解中声明的警告。

元注解(标记注解的注解)
@Retention - 注解声明周期; 1: java文件里 2: class文件里 3: 运行时。
@Target - 标记这个注解可以注解哪些元素。
@Documented - 标记这些注解是否包含在用户文档中。
@Inherited - 标记这个注解能否被继承;

从 Java 7 开始，额外添加了 3 个注解:

@SafeVarargs - Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
@FunctionalInterface - Java 8 开始支持，标识一个匿名函数或函数式接口。
@Repeatable - Java 8 开始支持，标识某注解可以在同一个声明上使用多次。

​ 1.3 自定义注解

​ 语法: 使用 @interface 来声明一个注解;

​ 使用4个元注解来标识这个注解;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
@Inherited
public @interface MyAnnotation {

	String name() default "";
}

@Target(ElementType.TYPE)详解; 标识该注解可以定义在什么位置;

public enum ElementType {
    TYPE,               /* 类、接口（包括注释类型）或枚举声明  */

    FIELD,              /* 字段声明（包括枚举常量）  */

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

    CONSTRUCTOR,        /* 构造方法声明  */

    LOCAL_VARIABLE,     /* 局部变量声明  */

    ANNOTATION_TYPE,    /* 注释类型声明  */

    PACKAGE             /* 包声明  */
        
    /**
     * Type parameter declaration
     * 针对类型参数(泛型)  <@xx T>
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     	能标注任何类型名称
     
     * @since 1.8
     */
    TYPE_USE
}

@Retention(RetentionPolicy.RUNTIME) 详解; 标注自定义注解的声明周期

public enum RetentionPolicy {
    SOURCE,   /* Annotation信息仅存在于编译器处理期间，编译器处理完之后就没有该Annotation信息了  */

    CLASS,    /* 编译器将Annotation存储于类对应的.class文件中。默认行为  */

    RUNTIME   /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */
}

注解的属性

注解的属性也叫做成员变量，注解只有成员变量，没有方法。

注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型;

注解的属性,如果没有default,表示使用注解时,需要对该属性进行赋值;

默认的value
如果一个注解内仅仅只有一个名字为 value 的属性时，应用这个注解时可以直接把属性值填写到括号内。

无属性
一个注解没有任何属性，那么在应用这个注解的时候，括号都可以省略。
没有强制要赋值的属性,就可以省略括号

1.4 通过反射获取注解

//方法返回此元素上直接存在的所有注解。 与此接口中的其他方法不同，此方法忽略了继承的注解。	
	x.getDeclaredAnnotations(); 

//返回所有的注解
	x.getAnnotations();

代码演示：

package com.qianfeng.cl;

import java.lang.reflect.Method;

/**
 * 
 * @Title DemoAnnotation.java
 * @Package com.qianfeng.cl
 * @Description 
 * @author CL 
 * @date 2020年3月20日
 * @version 1.0
 */
public class DemoAnnotation {

	@SuppressWarnings("rawtypes")
	public static void main(String[] args) {
		
		//获取Class对象
		Class ps = Person.class;
		
		try {
			//创建实体对象
			Person person = (Person) ps.newInstance();
			
			//获取所有方法
			Method[] methods = ps.getDeclaredMethods();
			for(Method method:methods) {
				if(null != method.getDeclaredAnnotation(MyAnnotation.class)) {
					method.setAccessible(true);
					method.invoke(person, "水果");
				}
			}
			
		} catch (Exception e) {
			e.printStackTrace();
		} 
		
	}
	
}
class Person{
	
	private String name;
	
	private int age;
	
	//使用自定义注释
	@MyAnnotation
	private void eat(String foot) {
		System.out.println("他在吃"+foot);
	}

	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;
	}

	@Override
	public String toString() {
		return "person [name=" + name + ", age=" + age + "]";
	}
	
	
}

---

2: Properties;

​ 2.1 文件定义

• 后缀properties是一种属性文件。
• 这种文件以key=value格式存储内容

​ 2.2 Properties对象

 Properties类继承自Hashtable类并且实现了Map接口，也是使用一种键值对的形式来保存属性集。不过Properties有特殊的地方，就是它的键和值都是字符串类型。

​ 2.3 Properties使用

load(InputStream inStream)
这个方法可以从.properties属性文件对应的文件输入流中，加载属性列表到Properties类对象。

store(OutputStream out, String comments)
这个方法将Properties类对象的属性列表保存到输出流中。

getProperty/setProperty
这两个方法是分别是获取和设置属性信息。

users.properties文件内容如下：

jack=123456

代码演示：

package com.qianfeng.cl;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Iterator;
import java.util.Properties;
import java.util.Set;

/**
 * 
 * @Title DemoProperties.java
 * @Package com.qianfeng.cl
 * @Description 
 * @author CL 
 * @date 2020年3月20日
 * @version 1.0
 */
public class DemoProperties {

	public static void main(String[] args) {
		
		//创建Properties对象
		Properties properties = new Properties();
		
		try {
			//加载文件
			properties.load(new FileInputStream("users.properties"));
			
			//获取key集合
			Set<Object> keys = properties.keySet();
			
			//获取迭代器
			Iterator<Object> iterator = keys.iterator();
			
			//打印所有信息
			while(iterator.hasNext()) {
				
				String key = (String) iterator.next();
				System.out.println(key+"="+properties.getProperty(key));
			}
			
			//清空数据
			properties.clear();
			//添加信息
			properties.put("trm", "af123123");
			
			//添加到文件中
			properties.store(new FileOutputStream("users.properties",true),"新加数据");
			
		} catch (FileNotFoundException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
}