JavaSE的注解

注解概述

注解是从JDK5.0开始引入的，以@注解名在代码中存在。例如：

• @Override
• @Deprecated
• @SuppressWarnings(value=”unchecked”)

Annotation注解可以像修饰符一样使用，可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明

注解可以在类编译、运行时加载，体现在不同的功能

常见的Annotation作用

生成文档相关的注解

• @author 标明开发该类模块的作者，多个作者之间使用,分割
• @version 标明该类模块的版本
• @see 参考转向，也就是相关主题
• @since 从哪个版本开始增加的
• @param 对方法中某参数的说明，如果没有参数就不能写
• @return 对方法返回值的说明，如果方法的返回值类型是void就不能写
• @exception 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写

public class JavadocTest {
	/**
	 * 程序的主方法，程序的入口
	 * @param args String[] 命令行参数
	 */
	public static void main(String[] args) {
	}
	
	/**
	 * 求圆面积的方法
	 * @param radius double 半径值
	 * @return double 圆的面积
	 */
	public static double getArea(double radius){
		return Math.PI * radius * radius;
	}
}

在编译时进行格式检查(JDK内置的三个基本注解)

• @Override: 限定重写父类方法，该注解只能用于方法
• @Deprecated: 用于表示所修饰的元素(类，方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
• @SuppressWarnings: 抑制编译器警告

public class AnnotationTest{
 
	public static void main(String[] args) {
		@SuppressWarnings("unused")
		int a = 10;
	}
	@Deprecated
	public void print(){
		System.out.println("过时的方法");
	}
 
	@Override
	public String toString() {
		return "重写的toString方法()";
	}
}

跟踪代码依赖性，实现替代配置文件功能

Spring框架中关于“事务”的管理

@Transactional(propagation=Propagation.REQUIRES_NEW,isolation=Isolation.READ_COMMITTED,readOnly=false,timeout=3)
public void buyBook(String username, String isbn) {
	//1.查询书的单价
    int price = bookShopDao.findBookPriceByIsbn(isbn);
    //2. 更新库存
    bookShopDao.updateBookStock(isbn);	
    //3. 更新用户的余额
    bookShopDao.updateUserAccount(username, price);
}
<!-- 配置事务属性 -->
<tx:advice transaction-manager="dataSourceTransactionManager" id="txAdvice">
       <tx:attributes>
       <!-- 配置每个方法使用的事务属性 -->
       <tx:method name="buyBook" propagation="REQUIRES_NEW" 
	 isolation="READ_COMMITTED"  read-only="false"  timeout="3" />
       </tx:attributes>
</tx:advice>

三个最基本的注解

@Override

• 用于检测被标记的方法为有效的重写方法，如果不是，则报编译错误
• 只能标记在方法上
• 它会被编译器程序读取

@Deprecated

• 用于表示被标记的数据已经过时，不推荐使用
• 可以用于修饰 属性、方法、构造、类、包、局部变量、参数
• 它会被编译器程序读取

@SuppressWarnings

• 抑制编译警告。当我们不希望看到警告信息的时候，可以使用 SuppressWarnings 注解来抑制警告信息

• 可以用于修饰类、属性、方法、构造、局部变量、参数

• 它会被编译器程序读取

• 可以指定的警告类型有（了解）

• all，抑制所有警告

• unchecked，抑制与未检查的作业相关的警告

• unused，抑制与未用的程式码及停用的程式码相关的警告

• deprecation，抑制与淘汰的相关警告

• nls，抑制与非 nls 字串文字相关的警告

• null，抑制与空值分析相关的警告

• rawtypes，抑制与使用 raw 类型相关的警告

• static-access，抑制与静态存取不正确相关的警告

• static-method，抑制与可能宣告为 static 的方法相关的警告

• super，抑制与置换方法相关但不含 super 呼叫的警告

元注解

注解的注解

• **@Target：**用于描述注解的使用范围

  • 可以通过枚举类型ElementType的10个常量对象来指定
  • TYPE，METHOD，CONSTRUCTOR，PACKAGE…

• **@Retention：**用于描述注解的生命周期

  • 可以通过枚举类型RetentionPolicy的3个常量对象来指定
  • SOURCE（源代码）、CLASS（字节码）、RUNTIME（运行时）
  • 唯有RUNTIME阶段才能被反射读取到。

• @Documented：表明这个注解应该被 javadoc工具记录。

• **@Inherited：**允许子类继承父类中的注解

自定义注解的使用

自定义注解可以通过四个元注解@Retention,@Target，@Inherited,@Documented，分别说明它的声明周期，使用位置，是否被继承，是否被生成到API文档中

Annotation 的成员在 Annotation 定义中以无参数有返回值的抽象方法的形式来声明，我们又称为配置参数。返回值类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组

可以使用 default 关键字为抽象方法指定默认返回值

如果定义的注解含有抽象方法，那么使用时必须指定返回值，除非它有默认值。格式是“方法名 = 返回值”，如果只有一个抽象方法需要赋值，且方法名为value，可以省略“value=”，所以如果注解只有一个抽象方法成员，建议使用方法名value。

@Inherited
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {
    String value();
}

@Inherited
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    String columnName();
    String columnType();
}

@Table("t_stu")
public class Student {
    @Column(columnName = "sid",columnType = "int")
    private int id;
    @Column(columnName = "sname",columnType = "varchar(20)")
    private String name;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

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

    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }
}

解析注解

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro{
    String className();
    String methodName();
}

实质上在内存对于这个接口有具体的实现类

public class ProImpl implements Pro{
    public String className(){
        return 'cn.itcast.annotation.Demo'
    }
    public String methodName(){
        return 'show'
    }
}

使用

@Pro(classname="cn.itcast.annotation.Demo",methodName="show")
public class ReflectTest{
    public static void main(String[] args) throws Exception{
        // 获取该类的字节码文件对象
        Class<ReflecTest> reflectTestClass = ReflectTest.class;
        // 获取上边的注解对象
        // 其实就是在内存中生成了一个该注解接口的子类实现对象（上面的代码）
        Pro an = reflectTestClass.getAnnotation(Pro.class);
        String classname = an.className();
        String methodname = an.methodName();
        
        Class cls = Class.forName(classname);
        Object obj = cls.newInstance();
        Method method = cls.getMethod(methodName);
        method.invoke(obj);
    }
}