10.1 注解概述
10.1.1 什么是注解
注解(Annotation)是从JDK5.0
开始引入,以“@注解名
”在代码中存在。例如:
@Override
@Deprecated
@SuppressWarnings(value=”unchecked”)
Annotation 可以像修饰符一样被使用,可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明。还可以添加一些参数值,这些信息被保存在 Annotation 的 “name=value” 对中。
注解可以在类编译、运行时进行加载,体现不同的功能。
10.1.2 注解与注释
注解也可以看做是一种注释,通过使用 Annotation,程序员可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充信息。但是,注解,不同于单行注释和多行注释。
-
对于单行注释和多行注释是给程序员看的。
-
而注解是可以被编译器或其他程序读取的。程序还可以根据注解的不同,做出相应的处理。
10.1.3 注解的重要性
在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。在JavaEE/Android中注解占据了更重要的角色
,例如用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗代码
和XML配置
等。
未来的开发模式都是基于注解的,JPA是基于注解的,Spring2.5以上都是基于注解的,Hibernate3.x以后也是基于注解的,Struts2有一部分也是基于注解的了。注解是一种趋势
,一定程度上可以说:框架 = 注解 + 反射 + 设计模式
。
10.2 常见的Annotation作用
示例1:生成文档相关的注解
@author 标明开发该类模块的作者,多个作者之间使用,分割 @version 标明该类模块的版本 @see 参考转向,也就是相关主题 @since 从哪个版本开始增加的 @param 对方法中某参数的说明,如果没有参数就不能写 @return 对方法返回值的说明,如果方法的返回值类型是void就不能写 @exception 对方法可能抛出的异常进行说明 ,如果方法没有用throws显式抛出的异常就不能写
package com.annotation.javadoc; /** * @version 1.0 * @see Math.java */ 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; } }
示例2:在编译时进行格式检查(JDK内置的三个基本注解)
@Override
: 限定重写父类方法,该注解只能用于方法
@Deprecated
: 用于表示所修饰的元素(类,方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
@SuppressWarnings
: 抑制编译器警告
package com.annotation.javadoc; 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方法()"; } }
示例3:跟踪代码依赖性,实现替代配置文件功能
-
Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。
@WebServlet("/login") public class LoginServlet extends HttpServlet { private static final long serialVersionUID = 1L; protected void doGet(HttpServletRequest request, HttpServletResponse response) { } protected void doPost(HttpServletRequest request, HttpServletResponse response) { doGet(request, response); } }
<servlet> <servlet-name>LoginServlet</servlet-name> <servlet-class>com.servlet.LoginServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>LoginServlet</servlet-name> <url-pattern>/login</url-pattern> </servlet-mapping>
-
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>
10.3 三个最基本的注解
10.3.1 @Override
-
用于检测被标记的方法为有效的重写方法,如果不是,则报编译错误!
-
只能标记在方法上。
-
它会被编译器程序读取。
10.3.2 @Deprecated
-
用于表示被标记的数据已经过时,不推荐使用。
-
可以用于修饰 属性、方法、构造、类、包、局部变量、参数。
-
它会被编译器程序读取。
10.3.3 @SuppressWarnings
-
抑制编译警告。当我们不希望看到警告信息的时候,可以使用 SuppressWarnings 注解来抑制警告信息
-
可以用于修饰类、属性、方法、构造、局部变量、参数
-
它会被编译器程序读取。
-
可以指定的警告类型有(了解)
-
all,抑制所有警告
-
unchecked,抑制与未检查的作业相关的警告
-
unused,抑制与未用的程式码及停用的程式码相关的警告
-
deprecation,抑制与淘汰的相关警告
-
nls,抑制与非 nls 字串文字相关的警告
-
null,抑制与空值分析相关的警告
-
rawtypes,抑制与使用 raw 类型相关的警告
-
static-access,抑制与静态存取不正确相关的警告
-
static-method,抑制与可能宣告为 static 的方法相关的警告
-
super,抑制与置换方法相关但不含 super 呼叫的警告
-
...
-
示例代码:
package com.atguigu.annotation; import java.util.ArrayList; public class TestAnnotation { @SuppressWarnings("all") public static void main(String[] args) { int i; ArrayList list = new ArrayList(); list.add("hello"); list.add(123); list.add("world"); Father f = new Son(); f.show(); f.methodOl(); } } class Father{ @Deprecated void show() { System.out.println("Father.show"); } void methodOl() { System.out.println("Father Method"); } } class Son extends Father{ /* @Override void method01() { System.out.println("Son Method"); }*/ }
10.4 元注解
JDK1.5在java.lang.annotation包定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。
(1)@Target:用于描述注解的使用范围
-
可以通过枚举类型ElementType的10个常量对象来指定
-
TYPE,METHOD,CONSTRUCTOR,PACKAGE.....
(2)@Retention:用于描述注解的生命周期
-
可以通过枚举类型RetentionPolicy的3个常量对象来指定
-
SOURCE(源代码)、CLASS(字节码)、RUNTIME(运行时)
-
唯有RUNTIME阶段才能被反射读取到
。
(3)@Documented:表明这个注解应该被 javadoc工具记录。
(4)@Inherited:允许子类继承父类中的注解
示例代码:
package java.lang; import java.lang.annotation.*; @Target(ElementType.METHOD) @Retention(RetentionPolicy.SOURCE) public @interface Override { }
package java.lang; import java.lang.annotation.*; import static java.lang.annotation.ElementType.*; @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) @Retention(RetentionPolicy.SOURCE) public @interface SuppressWarnings { String[] value(); }
package java.lang; import java.lang.annotation.*; import static java.lang.annotation.ElementType.*; @Documented @Retention(RetentionPolicy.RUNTIME) @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE}) public @interface Deprecated { }
拓展:元数据
String name = "Tom";
10.5 自定义注解的使用
一个完整的注解应该包含三个部分: (1)声明 (2)使用 (3)读取
10.5.1 声明自定义注解
【元注解】 【修饰符】 @interface 注解名{ 【成员列表】 }
-
自定义注解可以通过四个元注解@Retention,@Target,@Inherited,@Documented,分别说明它的声明周期,使用位置,是否被继承,是否被生成到API文档中。
-
Annotation 的成员在 Annotation 定义中以无参数有返回值的抽象方法的形式来声明,我们又称为配置参数。返回值类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组
-
可以使用 default 关键字为抽象方法指定默认返回值
-
如果定义的注解含有抽象方法,那么使用时必须指定返回值,除非它有默认值。格式是“方法名 = 返回值”,如果只有一个抽象方法需要赋值,且方法名为value,可以省略“value=”,所以如果注解只有一个抽象方法成员,建议使用方法名value。
package com.atguigu.annotation; import java.lang.annotation.*; @Inherited @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface Table { String value(); }
package com.atguigu.annotation; import java.lang.annotation.*; @Inherited @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) public @interface Column { String columnName(); String columnType(); }
10.5.2 使用自定义注解
package com.atguigu.annotation; @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 + '\'' + '}'; } }
10.5.3 读取和处理自定义注解
自定义注解必须配上注解的信息处理流程才有意义。
我们自己定义的注解,只能使用反射的代码读取。所以自定义注解的声明周期必须是RetentionPolicy.RUNTIME。
个人思考:
Java注解是一种元数据标记,它可以用于在Java代码中提供额外的信息,用于编译、运行时或其他工具处理Java类、方法、字段等元素。注解在Java中的使用已经广泛,并且它们可以为开发人员提供各种好处,例如更好的代码可读性、静态分析、运行时行为定制和工具生成代码等。
-
元数据标记:注解是元数据标记,可以用于提供关于代码元素的额外信息,比如描述、配置、约束等。
-
内置注解:Java提供了一些内置注解,例如
@Override
、@Deprecated
和@SuppressWarnings
等,用于标记代码中的特定情况,以提供编译器或其他工具的指导。 -
自定义注解:Java允许开发人员创建自定义注解。这些自定义注解可以用于特定的业务需求,以便更好地描述代码元素,也可以用于编写自定义工具来处理这些注解。
-
注解处理器:Java注解类通常需要结合注解处理器使用。注解处理器是一种工具,可以扫描并处理代码中的注解,从而生成代码、进行静态分析或执行其他操作。这有助于自动化任务和提高代码质量。
-
代码可读性:注解可以提高代码的可读性,通过为代码元素提供描述性信息,开发人员能够更容易地理解和维护代码。
-
运行时行为定制:某些注解可以影响代码的运行时行为。例如,
@Transactional
注解可用于启用事务管理,@Autowired
注解可用于依赖注入,这些注解可以在运行时影响代码的行为。 -
API文档生成:注解可以用于生成API文档,通过提供描述性信息,文档工具可以为开发人员生成更详细和准确的文档。
-
约束和验证:注解还可以用于添加约束和验证,以确保代码的正确性和安全性。例如,
@NotNull
、@Size
等注解可用于验证输入参数。 -
框架和库支持:许多Java框架和库使用注解来配置和扩展功能。例如,Spring框架使用注解配置依赖注入和AOP。