Java注解

最新推荐文章于 2022-08-11 16:31:16 发布

灰灰有点懒

最新推荐文章于 2022-08-11 16:31:16 发布

阅读量347

点赞数 1

分类专栏： Java 文章标签： java java-ee

本文链接：https://blog.csdn.net/weixin_44978864/article/details/118723011

版权

Java 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

Java注解

什么是注解

从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是 Annotation(注解)
Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation 的 “name=value” 对中
在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
Annotation的格式：
- 注解是以"@注释名"在代码中存在的，并把该 Annotation 当成一个修饰符使用，还可以添加一些参数值，例如：@SuppressWarnings（value="unchecked"）
Annotation在哪里使用
- 可以附加到package、class、method、field等上面，相当于给它们添加了额外的辅助信息，我们可以通过发射机制编程实现对这些元数据的访问

生成文档相关的注解

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

其中

@param @return 和 @exception 这三个标记都是只用于方法的。
@param的格式要求：@param 形参名形参类型形参说明
@return 的格式要求：@return 返回值类型返回值说明
@exception的格式要求：@exception 异常类型异常说明
@param和@exception可以并列多个

代码示例

package com.shao.annotation;
/**
 * @author shao
 * @version 1.0
 * @seeMath.java
 */
public class Test1 extends Object{
    /**
     *  程序的主方法，程序的入口
     * @param args  string[] 命令行参数
     */
    public static void main(String[] args) {
        System.out.println("Java注解");
    }

    /**
     * 求圆面积的方法
     * @param radius 半径值
     * @return  圆的面积
     */
    public static double getArea(double radius){
        return Math.PI * radius * radius;
    }
}

在编译时进行格式检查的内置注解

@Override：定义在java.lang.Override中，此注解只能用于修饰方法，表示一个方法打算重写超类中的另一个方法声明
@Deprecated: 定义在java.lang.Deprecated中，此注释可以用于修饰方法，属性类，表示不鼓励程序员使用这样的元素(已过时)，通常是因为所修饰的结构危险或存在更好的选择
@SuppressWarnings: 定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息
- 与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性使用就好了
  - @SuppressWarnings("all")
  - @SuppressWarnings("unchecked")
  - @SuppressWarnings("unchecked","deprecation")

public class Test2 {
    public static void main(String[] args) {
        @SuppressWarnings("unused")
        int a = 100;
    }

    @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 {
	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>

元注解

元注解的作用是负责注解其他注解，Java定义了4个标准的meta-annotation类型，它们被用来提供对其他Annotation类型作说明，分别是：Retention 、Target 、Documented 、Inherited

@Retention：只能用于修饰一个Annotation定义，用于指定该Annotation的生命周期，@Rentention包含一个RetentionPolicy类型的成员变量，使用 @Rentention 时必须为该 value 成员变量指定值

RetentionPolicy.SOURCE：在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释
RetentionPolicy.CLASS：在class文件中有效（即class保留），当运行 Java 程序时, JVM 不会保留注解。这是默认值
RetentionPolicy.RUNTIME：在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。
SOURCE<CLASS<RUNTIME
$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-M8FUtz9Z-1626231738780)(D:\温故而知新-笔记\Java基础\Java注解与反射.assets\image-20210708231228849.png)]$

public enum RetentionPolicy{
    SOURCE,
	CLASS,
	RUNTIME
}

@Retention(RetentionPolicy.SOURCE)
@interface MyAnnotation1{ }

@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{ }

@Target：用于修饰Annotation定义，用于指定被修饰的Annotation能用于修饰哪些程序元素。@Target也包含一个名为value的成员变量

取值（ElementType）		取值（ElementType）
CONSTRUCTOR	用于描述构造器	RACKAGE	用于描述包
FIELD	用于描述域	PARAMETER	用于描述参数
LOCAL_VARIABLE	用于描述局部变量	TYPE	用于描述类、接口（包括注解类型）或enum声明
METHOD	用于描述方法

@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。
- 定义为Documented的注解必须设置Retention值为RUNTIME。

@Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解

比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解
实际应用中，使用较少

@MyAnnotation
public class Test3 {
    public void test(){
        
    }
}

//定义一个注解
//target 表示我们的注解可以用到哪些地方
@Target(value = {ElementType.TYPE, ElementType.METHOD})

//Retention 表示我们的注解在什么地方还有效
//runtime>class>source
@Retention(value = RetentionPolicy.RUNTIME)

//documented 表示是否将我们的注解生成Javadoc中
@Documented

//@Inherited 子类可以继承父类的注解
@Inherited
@interface MyAnnotation{

}

自定义注解

定义新的 Annotation 类型使用 @interface关键字
自定义注解自动继承了java.lang.annotation.Annotation接口
Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
如果只有一个参数成员，建议使用参数名为value
如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值” ，如果只有一个参数成员，且名称为value，可以省略“value=”
没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation

注意：自定义注解必须配上注解的信息处理流程才有意义

/**
 * 自定义注解
 */
public class Test4 {
    // 注解可以显示赋值，如果没有默认值，我们就必须给注解赋值
    @MyAnnotation2(age = 18,name = "张三")
    public void test(){}

    @MyAnnotation3("张三")
    public void test2(){}
}
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    // 注解的参数： 参数类型 +参数名（）
    String name() default "";
    int age();
    int id() default -1; // 如果默认值为-1，代表不存在
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value();
}