Java年薪几十万的程序员必会的骚操作（二）

骑猪看日落 2022-02-26 01:14 186阅读 0赞

# 注解 #

我们学过注释，知道注释是用文字描述程序的。给程序员看的；而注解是说明程序的，给计算机看的，它是jdk1.5及之后版本的新特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。  
**作用分类：**

*  编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
 *  代码分析：通过代码里标识的注解对代码进行分析【使用反射】
 *  编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

**常见注解**

*  @author：用来标识作者名，eclipse开发工具默认的是系统用户名。
 *  @version：用于标识对象的版本号，适用范围：文件、类、方法。
 *  @Override ：用来修饰方法声明，告诉编译器该方法是重写父类中的方法，如果父类不存在该方法，则编译失败。

## 自定义注解 ##

元注解
    public @interface 注解名称{ 
    	属性列表;
    }

*  注解本质上就是一个接口，该接口默认继承Annotation接口

public interface MyAnno extends java.lang.annotation.Annotation { }

#### 注解的属性 ####

**1. 属性的作用**  
可以让用户在使用注解时传递参数，让注解的功能更加强大。  
**2. 属性的格式**  
格式1：数据类型 属性名();  
格式2：数据类型 属性名() default 默认值;  
**3. 属性定义示例**

public @interface Student { 
    	String name(); // 姓名
    	int age() default 18; // 年龄
    	String gender() default "男"; // 性别
    }
    // 该注解就有了三个属性：name，age，gender

**4. 属性适用的数据类型**

*  八种基本数据类型（int,float,boolean,byte,double,char,long,short)
 *  String类型，Class类型，枚举类型，注解类型
 *  以上所有类型的一维数组

### 下面我们来使用一下自定义注解 ###

定义一个注解：

public @interface Book { 
    	// 书名
    	String value();
    	// 价格
    	double price() default 100;
    	// 多位作者
    	String[] authors();
    }

使用：

/** * @author pkxing * @version 1.0 * @description 书架类 * @date 2018/1/26 */
    public class BookShelf { 
    	@Book(value = "西游记",price = 998,authors = { "吴承恩","白求恩"})
    	public void showBook(){ 
    	}
    }

**2. 使用注意事项**

*  如果属性有默认值，则使用注解的时候，这个属性可以不用赋值。
 *  如果属性没有默认值，那么在使用注解时一定要给属性赋值。

### 特殊属性value ###

*  当注解中只有一个属性且名称是value，在使用注解时给value属性赋值可以直接给属性值，无论value是单值元素还是数组类型。
 *  如果注解中除了value属性还有其他属性，且至少有一个属性没有默认值，则在使用注解给属性赋值时，value属性名不能省略。

// 定义注解Book
    public @interface Book { 
    	// 书名
    	String value();
    	}
    	// 使用注解Book
    	public class BookShelf { 
    	@Book("西游记")
    	public void showBook(){ 
    	}
    }
    或
    public class BookShelf { 
    	@Book(value="西游记")
    	public void showBook(){ 
    	}
    }

# 注解之元注解 #

*  @Target
 *  @Retention

**元注解之@Target**  
作用：指明此注解用在哪个位置，如果不写默认是任何地方都可以使用。可选的参数值在枚举类ElemenetType中包括：

TYPE： 用在类,接口上
    FIELD：用在成员变量上
    METHOD： 用在方法上
    PARAMETER：用在参数上
    CONSTRUCTOR：用在构造方法上
    LOCAL_VARIABLE：用在局部变量上

**元注解之@Retention**  
作用：定义该注解的生命周期(有效范围)。可选的参数值在枚举类型RetentionPolicy中包括：  
SOURCE：注解只存在于Java源代码中，编译生成的字节码文件中就不存在了。  
CLASS：注解存在于Java源代码、编译以后的字节码文件中，运行的时候内存中没有，默认值。  
RUNTIME：注解存在于Java源代码中、编译以后的字节码文件中、运行时内存中，程序可以通过反射获取该注解。

### 元注解使用案例： ###

@Target({ ElementType.METHOD,ElementType.TYPE})
    @interface Stu{ 
    	String name();
    }
    // 类
    @Stu(name="jack")
    public class AnnotationDemo02 { 
    	// 成员变量
    	@Stu(name = "lily") // 编译失败
    	private String gender;
    	
    	// 成员方法
    	@Stu(name="rose")
    	public void test(){ }
    	
    	// 构造方法
    	@Stu(name="lucy") // 编译失败
    	public AnnotationDemo02(){ }
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1Jvb2tpZXhpYW9NdV9h_size_16_color_FFFFFF_t_70]

# 注解解析：通过反射得到注解 #

*  如注解作用在类上，就通过Class对象得到它的注解

// 获得Class对象
    Class c = 类名.class;
    // 根据注解的Class获得使用在类上的注解对象
    Book book = c.getAnnotation(Book.class);

*  如注解作用在方法上，就通过方法(Method)对象得到它的注解

// 得到方法对象
    Method method = clazz.getDeclaredMethod("方法名");
    // 根据注解名得到方法上的注解对象
    Book book = method.getAnnotation(Book.class);

#### 需求说明 ####

1.  定义注解Book，要求如下：  
    包含属性：String value() 书名  
    包含属性：double price() 价格，默认值为 100  
    包含属性：String\[\] authors() 多位作者  
    限制注解使用的位置：类和成员方法上  
    指定注解的有效范围：RUNTIME
2.  定义BookStore类，在类和成员方法上使用Book注解
3.  定义TestAnnotation测试类获取Book注解上的数据

代码实现：

注解Book：

@Target({ ElementType.METHOD,ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Book { 
    	// 书名
    	String value();
    	// 价格
    	double price() default 100;
    	// 作者
    	String[] authors();
    }

BookStore类:

@Book(value = "红楼梦",authors = "曹雪芹",price = 998)
    public class BookStore { 
    	@Book(value = "西游记",authors = "吴承恩")
    	public void buyBook(){ 
    	}
    }

TestAnnotation类:

/** * @author pkxing * @version 1.0 * @description com.it.annotation * @date 2018/1/26 */
    public class TestAnnotation { 
    	public static void main(String[] args) throws Exception{ 
    		System.out.println("‐‐‐‐‐‐‐‐‐获取类上注解的数据‐‐‐‐‐‐‐‐‐‐");
    		test01();
    		System.out.println("‐‐‐‐‐‐‐‐‐获取成员方法上注解的数据‐‐‐‐‐‐‐‐‐‐");
    		test02();
    	}
    	/** * 获取BookStore类上使用的Book注解数据 */
    	public static void test01(){ 
    		// 获得BookStore类对应的Class对象
    		Class c = BookStore.class;
    		// 根据注解Class对象获取注解对象
    		Book book = (Book) c.getAnnotation(Book.class);
    		// 输出book注解属性值
    		System.out.println("书名：" + book.value());
    		System.out.println("价格：" + book.price());
    		System.out.println("作者：" + Arrays.toString(book.authors()));
    	}
    	/** * 获取BookStore类成员方法buyBook使用的Book注解数据 */
    	public static void test02() throws Exception{ 
    		// 获得BookStore类对应的Class对象
    		Class c = BookStore.class;
    		// 获得成员方法buyBook对应的Method对象
    		Method m = c.getMethod("buyBook");
    		// 根据注解Class对象获取注解对象
    		Book book = (Book) m.getAnnotation(Book.class);
    		// 输出book注解属性值
    		System.out.println("书名：" + book.value());
    		System.out.println("价格：" + book.price());
    		System.out.println("作者：" + Arrays.toString(book.authors()));
    	}
    }

结果：  
![在这里插入图片描述][20190328163751479.png]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1Jvb2tpZXhpYW9NdV9h_size_16_color_FFFFFF_t_70]: /images/20220226/34179a2cae214d3baa917e89784d29ba.png
[20190328163751479.png]: /images/20220226/a4a750d456ad480eaf2b36f0fb94cf9a.png