Java注解

Posted 2022-03-21 364.99°

目录

• 1.元注解+自定义注解
• 2.常用注解

1.元注解+自定义注解

元注解： 用于解释其他注解的注解

java.lang.annotation

@Target 描述注解的使用范围

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target 
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();

public enum ElementType 
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE

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

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention 
    /**
     * Returns the retention policy.
     * @return the retention policy
     */
    RetentionPolicy value();

public enum RetentionPolicy 
    /**
     * Annotations are to be discarded by the compiler.
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     *
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME

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

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented 

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

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Inherited 

自定义注解

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

• 格式：修饰符 @interface 注解名 定义内容
• 其中每一个方法实际上是声明了一个配置参数
• 方法名就是参数名
• 返回值类型就是参数的类型（返回值只能是基本类型——Class、String、enum）
• 可以通过default来声明参数的默认值
• 如果只有一个参数成员，一般参数名为value
• 注解元素必须要有值，定义注解元素时，常用空字符串，0作为默认值

//使用自定义注解
@MyAnnotation(name = "小李子")
public class Test01 



//定义一个注解
//@Target(value = ElementType.METHOD)   定义单个作用域
@Target(value = ElementType.TYPE, ElementType.FIELD,ElementType.METHOD) //定义三个作用域
@Retention(value = RetentionPolicy.RUNTIME) //运行由VM保存，并且可以使用反射获取
@interface MyAnnotation
    //注解参数：参数类型+参数名();
    String name();
    String description() default "帅";
    int id() default -1; //默认值为-1，表示不存在

2.常用注解

Servlet注解：

注解	说明
@WebServlet	配置servlet的属性
@WebInitParam	配置一些初始化属性
@WebFilter	将一个实现了javax.servlet.Filter接口的类定义为过滤器

@WebServlet属性：

@WebInitParam 属性：

mybatis注解：

注解	说明
@Insert	增
@Delete	删
@Update	改
@Select	查
@Result	结果集封装
@Results	可以与@Result 一起使用，封装多个结果集
@ResultMap	实现引用@Results 定义的封装
@One	实现一对一结果集封装
@Many	实现一对多结果集封装
@SelectProvider	实现动态 SQL 映射
@CacheNamespace	实现注解二级缓存的使用
@

spring注解：

注解	说明
@Configuration	等于一个配置文件，如果某个Java类上标注了这个注解，则表示这个类是一个配置类
@Bean	将一个Java类装配到Spring的IOC容器中，默认是singleton。id默认是方法名。
@ComponentScan	在配置类上进行标注，指定Spring的扫描规则
@Filter	ComponentScan注解类中的子注解（内部注解），可以指定一些过滤规则
@ComponentScans	jdk8以后，@ComponentScan是个可重复注解@Repeatable。也可以使用@ComponentScans指定扫描策略
@Scope	设置组件的作用域，如果是单例，则该Bean在装配的时候，Spring会自动创建并放到IOC容器中。如果是多实例，只会在使用到该Bean的时候才创建然后装配。
@Lazy-bean	针对singleton的实例，容器启动的时候先不创建，在第一次使用的时候创建，以后每次都从容器中去取。
@Conditional	按照条件注册Bean
@Import	快速给容器导入组件，组件名默认为全类名
@PostConstruct	用来修饰一个非静态的void（）方法。被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行，并且只会被服务器执行一次。PostConstruct在构造函数之后执行，init（）方法之前执行。
@PreDestroy	修饰的方法会在服务器卸载Servlet的时候运行，并且只会被服务器调用一次，类似于Servlet的destroy()方法
@Value	属性注入
@PropertySource	指定配置文件
@Autowired	自动导入依赖的bean
@Qualifier	自动装配，明确指定要装配的组件id
@Primary	Spring自动装配的时候默认使用首选的Bean
@Resource	自动装配，默认按名称进行装配
@Inject	需要引入javax.inject包，与@Autowired功能一样
@Profile	Spring提供的可以根据当前环境动态激活和切换一系列组件（Bean）的功能。指定组件在哪个环境下才能被注册到容器。不指定的话，任何环境都能注册。
@Before	AOP，前置通知
@After	AOP，后置通知
@AfterReturning	AOP，返回通知
@AfterThrowing	AOP，异常通知
@Around	AOP，环绕通知
@DeclareParents	以透明的方式为被通知的对象引入额外的接口

springmvc注解：

注解	说明
@Controller	标记在一个类上，使用它标记的类就是一个SpringMvc Controller对象，分发处理器会扫描使用该注解的类的方法，并检测该方法是否使用了@RequestMapping注解
@Service	于业务逻辑层，未指定name时，默认按照名称进行装配，匹配不到bean时，按照类型进行装配
@RequestMapping	匹配请求路径与具体处理方法
@GetMapping	用于处理请求方法的GET类型
@PostMapping	用于处理请求方法的POST类型
@RequestBody	数据接收，接收前端传递给后端的json字符串中的数据的(请求体中的数据的)
@RequestParam	数据接收，将请求参数区数据映射到功能处理方法的参数上
@ControllerAdvice	全局异常处理
@ResControllerAdvice	@ControllerAdvice + @ResponseBody
@Repository	持久层组件，用于标注数据访问组件，即DAO组件

springboot注解：

注解	说明
@SpringBootApplication	Sprnig Boot项目的核心注解，目的是开启自动配置
@ComponentScan	让spring Boot扫描到Configuration类并把它加入到程序上下文
@Configuration	等同于spring的XML配置文件；使用Java代码可以检查类型安全
@EnableAutoConfiguration	自动配置
@ComponentScan	组件扫描，可自动发现和装配一些Bean
@RestController	表示这是个控制器bean,并且是将函数的返回值直 接填入HTTP响应体中,是REST风格的控制器
@PathVariable	获取参数