开发中常用注解及自定义注解

亦凉 2024-04-17 06:03 32阅读 0赞

### 文章目录 ###

*   *  常见的注解：
     *   *   *  java自带的注解
             *  第三方注解
             *  元注解
             *  自定义注解

> 在java中注解是一个很重要的组成部分，使用注解能够使代码更加简洁，动态的提高代码的扩展性和可维护性。

按照来源分类：

*  java自带的注解
 *  第三方提供的注解
 *  自定义的注解
 *  元注解

## 常见的注解： ##

#### java自带的注解 ####

*  @Override 重写
 *  @Test 测试
 *  @Deprecated 方法过时
 *  @SuppresWarning 忽略警告
 *  @Resource 自动装配

#### 第三方注解 ####

@Repository:　　　　用于标注数据访问组件，即DAO组件

@Service:　　　　用于标注业务层组件

@Controller:　　　　控制层

@Transactional:　　　　声明这service所有方法都需要事务管理。每一个业务方法开始时都会打开一个事务

@Component:　　　　把该中立的类交给spring管理

@Autowired:　　　　自动装配，将bean容器里的值自动注入到bean

@Path:　　　　　　处理REST请求,接口路径

@RequestBody

作用于形参上，将前台发来的固定格式的数据(xml或json)封装成JavaBean对象

如何封装: 使用系统默认配置的 HttpMessageConverter对数据进行解析，然后封装到形参上

body-> JavaBean

@ResponseBody

作用于方法，表明此方法的返回值写入Http response body中

如何写入: 该注解作用的方法返回一个对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区

JavaBean-> body

@RestController

@Controller与@ResponseBody的结合

@Configuration

表明是一个配置类

。。。

#### 元注解 ####

@Target：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）  
取值(ElementType)有：  
　　　　1.CONSTRUCTOR:用于描述构造器  
　　　　2.FIELD:用于描述域  
　　　　3.LOCAL\_VARIABLE:用于描述局部变量  
　　　　4.METHOD:用于描述方法  
　　　　5.PACKAGE:用于描述包  
　　　　6.PARAMETER:用于描述参数  
　　　　7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

@Retention:：表示它所标识的注解的生命周期  
RetentionPolicy.SOURCE:表示该注解只在源码中存在  
RetentionPolicy.CLASS: 表示该注解只在源码和编译时存在  
RetentionPolicy.RUNTIME: 表示该注解在源码和编译时以及运行时存在

@Inherited： 表示该注解可以被继承

@Documented：表示该注解可以在生成API文档的时候显示在文档上,注解将被包含至javadoc中.

#### 自定义注解 ####

使用元注解来自定义注解。

定义注解格式：public @interface 注解名 \{定义体\}

1.  自定义注解：

//在方法上使用
    @Target(ElementType.METHOD)
    //生命周期在编译及运行时
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @interface Student{ 
        String name();
        String sex() default "男";
        int age() default 18;
    }

1.  使用自定义注解的类：

import java.lang.annotation.*;
    
    public class StudentTest { 
        @Student(name="张三")
        public void show(){ 
        }
    }

1.  提取注解参数：

@Test
        public void contextLoads() { 
            Class<StudentTest> studentTestClass = StudentTest.class;
            try { 
                Student show = studentTestClass.getMethod("show").getAnnotation(Student.class);
                System.out.println(show.name());
                System.out.println(show.sex());
                System.out.println(show.age());
            } catch (NoSuchMethodException e) { 
                e.printStackTrace();
            }
        }

输出结果：  
![在这里插入图片描述][20190825224615997.png]  
以上实现自定义注解

[20190825224615997.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/16/540c6c14f4af4e70a2ec4597829d740f.png