注解
什么是注解?
-
注解不是注释
-
在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,
忽略警告等。在JavaEE/Android中注解占据了更重要的角色,例如
用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗
代码和XML配置等。
-
未来的开发模式都是基于注解的,JPA是基于注解的,Spring2.5以
上都是基于注解的,Hibernate3.x以后也是基于注解的,现在的
Struts2有一部分也是基于注解的了,注解是一种趋势,一定程度上
可以说:框架 = 注解 + 反射 + 设计模式。
常见的Annotation示例
生成文档相关的注解
- @author 标明开发该类模块的作者,多个作者之间使用,分割
- @version 标明该类模块的版本
- @see 参考转向,也就是相关主题
- @since 从哪个版本开始增加的
- @param 对方法中某参数的说明,如果没有参数就不能写
- @return 对方法返回值的说明,如果方法的返回值类型是void就不能写
- @exception 对方法可能抛出的异常进行说明 ,如果方法没有用throws显式抛出的异常就不能写
- @param @return 和 @exception 这三个标记都是只用于方法的。
- @param的格式要求:@param 形参名 形参类型 形参说明
- @return 的格式要求:@return 返回值类型 返回值说明
- @exception的格式要求:@exception 异常类型 异常说明
- @param和@exception可以并列多个
package com.annotation.javadoc;
/**
* @author shkstart
* @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; } }
在编译时进行格式检查(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方法()"; } }
跟踪代码依赖性,实现替代配置文件功能
- 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) throws
ServletException, IOException { }
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws
ServletException, IOException {
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>
自定义注解
-
定义新的 Annotation 类型使用 @interface 关键字
-
自定义注解自动继承了java.lang.annotation.Annotation接口
-
Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其
方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能
是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、
以上所有类型的数组。
-
可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始
值可使用 default 关键字
-
如果只有一个参数成员,建议使用参数名为value
-
如果定义的注解含有配置参数,那么使用时必须指定参数值,除非它有默认
值。格式是“参数名 = 参数值”,如果只有一个参数成员,且名称为value,
可以省略“value=”
-
没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数
据 Annotation
-
自定义注解必须配上注解的信息处理流程才有意义。
@MyAnnotation(value="hyb")
public class MyAnnotationTest {
public static void main(String[] args) {
Class clazz = MyAnnotationTest.class;
Annotation a = clazz.getAnnotation(MyAnnotation.class);
MyAnnotation m = (MyAnnotation) a;
String info = m.value();
System.out.println(info);
} }
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface MyAnnotation{
String value() default "hyb"; }
元注解
-
对注解修饰的注解叫元注解
-
元数据理解也一样
-
JDK5.0提供了4个标准的meta-annotation类型:
-
@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命
周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用
@Rentention 时必须为该 value 成员变量指定值:
-
**RetentionPolicy.SOURCE:**在源文件中有效(即源文件保留),编译器直接丢弃这种策略的
注释
-
RetentionPolicy.CLASS:在class文件中有效(即class保留) , 当运行 Java 程序时, JVM
不会保留注解。 这是默认值
-
RetentionPolicy.RUNTIME:在运行时有效(即运行时保留),当运行 Java 程序时, JVM 会
保留注释。程序可以通过反射获取该注释。
-
-
@Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于
修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。
:下面是Target(element)可以修饰的代码结构
https://i.loli.net/2021/06/12/FMwJueyAP1kxzoR.png
-
jdk8新特性
-
Java 8对注解处理提供了两点改进:可重复的注解及可用于类型的注解。此外,
反射也得到了加强,在Java8中能够得到方法参数的名称。这会简化标注在方法
参数上的注解。
-
可重复的注解:在j8之前,我们如果要进行重复注解,必须使用到数组,而之后,直接写几行就可以了。
https://i.loli.net/2021/06/12/joUiNzKvHJm59QY.png
-
JDK1.8之后,关于元注解@Target的参数类型ElementType枚举值多了两个:
TYPE_PARAMETER,TYPE_USE。
-
在Java 8之前,注解只能是在声明的地方所使用,Java8开始,注解可以应用
在任何地方。
-
ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语
句中(如:泛型声明)。
-
ElementType.TYPE_USE 表示该注解能写在使用类型(int,double……)的任何语句中。
https://i.loli.net/2021/06/12/aLnZuvVNB3QqiMc.png
https://i.loli.net/2021/06/12/mJD1XUFINVTlMft.png
-
因为目前没有学到反射,所以注解这一块只做了解便可。但这不代表注解不重要,反而注解很重要,学到反射的时候要深入理解注解。