【JavaEE学习笔记】注解

注解

1.概述

注解是一种标记，也可以理解成是一种应用在

类、方法、参数、属性、构造器上的特殊修饰符

2.作用

a.生成文档，常用的有@param@return等

b.替代配置文件的作用，尤其是在spring等一些框架中，使用注解可以大量的减少配置文件的数量

c.检查代码的格式，如@Override，标识某一个方法是否覆盖了它的父类的方法

3.底层实现原理

注解的底层也是使用反射实现的

注解和接口有点类似，不过申明注解类需要加上@interface

注解类里面，只支持基本类型、String及枚举类型

里面所有属性被定义成方法，并允许提供默认值

相关类（框架或工具中的类）根据这些信息

来决定如何使用该程序元素或改变它们的行为

4.注解基本要求

注解是不会影响程序代码的执行，无论annotation怎么变化，代码都始终如一地执行

Java语言解释器在工作时会忽略这些annotation

因此在JVM中这些annotation是“不起作用”的

只能通过配套的工具才能对这些annontaion类型的信息进行访问和处理

5.Annotation与interface的异同

a.Annotation类型使用关键字@interface而不是interface。继承了java.lang.annotation.Annotation接口，并非声明了一个interface

b.Annotation类型、方法定义是独特的、受限制的。Annotation类型的方法必须声明为无参数、无异常抛出的。这些方法定义的是annotation的成员：方法名成为了成员名，而方法返回值成为了成员的类型

c. 注解方法返回值类型必须为primitive类型、Class类型、枚举类型、annotation类型或者由前面类型之一作为元素的一维数组

d. 方法的后面可以使用default和一个默认数值来声明成员的默认值，null不能作为成员默认值，与非annotation类型中定义方法有很大不同

e.Annotation类型和它的方法不能使用annotation类型的参数、成员不能是generic。只有返回值类型是Class的方法可以在annotation类型中使用generic

6.Annotation 分类

a.标准 Annotation

Java 自带的Annotation，如Override, Deprecated, SuppressWarnings

override标识被标注的方法是否重载了父类的方法，没有的话则会编译错误

Deprecated代表成员过时，使用的话则编译器提示

SuppressWarnings告知编译器关闭对类、成员的警告

b.元 Annotation

专门注解其他注解的注解(警察和督察的关系)

1)@Target  — —注解用于什么地方

TYPE,  //给类（型）注解

FIELD, //给字段注解，不要忘了，字段可以是对象

METHOD, //给方法注解

PARAMETER, //给参数注解

CONSTRUCTOR, //给构造方法注解

LOCAL_VARIABLE, //给局部变量注解

ANNOTATION_TYPE,//给注解注解

PACKAGE, //给包注解

2)@Retention — —注解运行状态

SOURCE, //源码状态运行

CLASS, //编译类文件时运行

RUNTIME //运行时运行

3)@Documented — — 生成说明文档，添加类的解释

4)@Inherited — —允许子类继承父类中的注解

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

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface UserInfo {
	int id();
	String name() default "unknown";
	int age();
}

7.使用注解

Tip

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

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Tip {
	String name() default "unknown";
}

User

@UserInfo(id = 0, age = 18, name = "张三")
public class User {
	@Tip()
	private String name;
	
}

测试类

package org.xxxx.dmeo;

public class Demo01 {
	public static void main(String[] args) {
		// 字节码文件
		Class<User> c = User.class;

		// 获取
		UserInfo info = c.getAnnotation(UserInfo.class);
		
		if (info != null) {
			System.out.println(info.id() + "---" + info.name() + "---" + info.age());
		}
	}
}

8.变量上使用注解

测试类

package org.xxxx.dmeo;

import java.lang.reflect.Field;

public class Demo02 {
	public static void main(String[] args) throws NoSuchFieldException, SecurityException {
		// 反射
		Class<User> c = User.class;

		// 获取属性
		Field f = c.getDeclaredField("name");
		
		Tip tip = f.getAnnotation(Tip.class);
		
		if (tip != null) {
			System.out.println(tip.name());
		}

	}
}

9.基于注解的简单orm映射框架中自动建表实现

JavaBean和数据表结构的对应关系

分析：

类对应表，属性对应列，对象对应数据库中表的一条记录

那么创建一张表就需要表名，列名，则我们可以分别在类上加上注解

用来得到表名，在属性上加上注解，得到列名

步骤：

a.定义注解

1)类上的注解：对应于数据库中的表

2)属性的注解，对应于数据库中的列

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

// 表注释
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {
	String name();
}

b.应用注解

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

// 字段
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
	String name();	// 字段名
	String type();	// 字段类型
	int len();		// 字段长度
}

c.解析应用

1)建表

@Table(name = "student")	// 表名
public class Student {
	@Column(name = "sid", type = "int", len = 20)
	private int id;	// sid int类型
	
	@Column(name = "sname", type = "varchar", len = 20)
	private String name;	// sname varchar(20)

	@Column(name = "sage", type = "int", len = 20)
	private int age;
}

2)测试

package org.xxxx.test;

import java.lang.reflect.Field;

public class Test {
	public static void main(String[] args) {
		// 写语句
		StringBuilder sb = new StringBuilder("create table ");

		// 反射
		Class<Student> c = Student.class;

		// 获取表注解
		Table t = c.getAnnotation(Table.class);

		if (t != null) {
			sb.append(t.name() + "(");
		} else {
			// 获取类名
			sb.append(c.getSimpleName() + "(");
		}

		// 获取属性
		Field[] fs = c.getDeclaredFields();

		for (Field field : fs) {
			// 获取字段
			Column column = field.getAnnotation(Column.class);

			// 拼接sql语句
			sb.append(column.name() + " ").append(column.type() + "(").append(column.len() + "),");
		}
		// 多拼了一个逗号，截取
		sb.deleteCharAt(sb.length() - 1);
		
		// 拼最后一个括号
		sb.append("");
		
		System.out.println(sb.toString());

	}
}

d.运行程序