Java之Annotation注解

• 一、基础概念
• • 1、介绍
  • 2、格式
  • 3、应用场景
• 二、内置注解
• • 1、常用的内置注解
  • • （1）@Override
    • （2）@Autowired
    • （3）@Service
    • （4）@Repository
    • （5）@Mapper
    • （6）@Deprecated
    • （7）@SuppressWarnings
• 三、元注解
• • 1、作用
  • 2、相关注解
  • • （1）@Target
    • （2）@Retention
    • （3）@Document
    • （4）@Inherited
  • 3、样例
• 四、自定义注解
• • 1、介绍
  • 2、特点
  • 3、样例

一、基础概念

1、介绍

注解又称Annotation，它是从JDK5.0开始引入的新技术。
它不是程序本身，但可以对程序作出解释，同时可以被其他程序（编译器）读取。

2、格式

注解是以"@注释名"在代码中存在的，还可以添加一些参数值。

@注释名(value = "参数值")

例如

@SuppressWarnings(value="all")

3、应用场景

可以附加在package，class，method，field等上面，相当于添加了额外的辅助信息，进而可以通过反射机制编程实现对元数据的访问。

@Override
public String toString(){return super.toString();
}

二、内置注解

1、常用的内置注解

（1）@Override

定义在java.lang.Override中，此注释只适用于修辞方法，表示一个方法声明打算重写超类中的另一个方法声明。

（2）@Autowired

它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。 通过 @Autowired的使用来消除 set ，get方法。

（3）@Service

@Service注解用于类上，标记当前类是一个service类，加上该注解会将当前类自动注入到spring容器中，不需要再在applicationContext.xml文件定义bean了。

（4）@Repository

它是 Spring 的注解，用于声明一个 Bean。但单独使用是没用的。因为注解放在接口上本来就没有意义，spring中在mapper接口上写一个@Repository注解，只是为了标识，要想真正是这个接口被扫描，必须使用@MapperScannerConfigurer。对于mybatis来说，可以不用写mapper.xml文件。

（5）@Mapper

@Mapper是mybatis自身带的注解。在spring程序中，mybatis需要找到对应的mapper，在编译时生成动态代理类，与数据库进行交互，这时需要用到@Mapper注解，更为方便的是它不需要配置扫描地址，可以单独使用，如果有多个mapper文件的话，可以在项目启动类中加入@MapperScan(“mapper文件所在包”)，也可以和@Repository连用，消除警告，对于mybatis来说，可以不用写mapper.xml文件。

（6）@Deprecated

定义在java.lang.Deprecated中，此注释可以用于修辞方法，属性，类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择。

（7）@SuppressWarnings

定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息

三、元注解

1、作用

元注解的作用就是负责注解其他注解，Java定义了4个标准的meta-annotation类型，被用来提供对其他annotation类型作说明（这些类型和所支持的类在java.lang.annotation包中）

2、相关注解

（1）@Target

用于描述注解的使用范围

（2）@Retention

表示需要在什么级别保存该注释信息，用于描述注解的生命周期（SOURCE

（3）@Document

说明该注解将被包含在javadoc中

（4）@Inherited

说明子类可以继承父类中的该注解

3、样例

package com.example.annotation;import java.lang.annotation.*;// 测试元注解
@MyAnnotation
public class test1 {public void test1() {}
}// 定义一个注解
// Target 表示注解可应用的范围
@Target(value = {ElementType.METHOD, ElementType.TYPE})// Retention 表示注解在什么地方有效
// runtime > class > sources
@Retention(value = RetentionPolicy.RUNTIME)// Documented 表示是否将我们的注解生成在JAVAdoc中
@Documented// Inherited 子类可以继承父类的注解
@Inherited
@interface MyAnnotation{}

四、自定义注解

1、介绍

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口

2、特点

（1）@ interface用来声明一个注解 , 格式: public @ interface 注解名{定义内容}。
（2）其中的每一个方法实际上是声明了一个配置参数，方法的名称就是参数的名称。
（3）返回值类型就是参数的类型（返回值只能是基本类型,Class , String , enum )。
（4）以通过default来声明参数的默认值，如果只有一个参数成员，一般参数名为value。
（5）注解元素必须要有值，定义注解元素时，经常使用空字符串，0作为默认值。

3、样例

package com.example.annotation;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;public class test2 {@MyAnnotation2(age = 22, name = "张三")public void test1(){}// 当参数名是value时，可省略不写value@MyAnnotation3("")public void test2() {}}@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{// 注解的参数 ： 参数类型 + 参数名（）;String name() default "";int age();// 如果默认为-1，代表不存在int id() default -1;String[] schools() default {"学校","专业"};
}@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3 {String value();
}