Java中常用注解

在Java开发中，注解（Annotation）是一种元数据信息，用于提供关于程序代码的额外信息，但它们本身不会直接影响程序的运行。Java提供了许多内置注解，同时框架（如Spring、Hibernate等）也定义了大量自定义注解。以下是一些常用的Java注解及其作用。

---

1. 标准Java注解

1.1 @Override

• 作用：用于标记方法覆盖（override）父类方法。
• 适用场景：确保方法正确覆盖了父类中的方法。
• 示例：

  @Override
  public void someMethod() {
      // 方法实现
  }
  

1.2 @Deprecated

• 作用：标记方法、类或字段为“已废弃”，不推荐使用。
• 适用场景：当某些API不再推荐使用时。
• 示例：

  @Deprecated
  public void oldMethod() {
      // 方法实现
  }
  

1.3 @SuppressWarnings

• 作用：用于关闭特定的编译器警告。
• 适用场景：当某些警告是已知的，但不会影响程序运行时。
• 示例：

  @SuppressWarnings("unchecked")
  public void someMethod() {
      // 方法实现
  }
  

1.4 @SafeVarargs

• 作用：用于标记方法的可变参数是安全的，避免编译器警告。
• 适用场景：在使用可变参数时，确保不会导致类型安全问题。
• 示例：

  @SafeVarargs
  public static <T> void someMethod(T... args) {
      // 方法实现
  }
  

---

2. Spring框架中的注解

2.1 @Component

• 作用：标记类为Spring管理的组件。
• 适用场景：用于定义一个普通的Spring Bean。
• 示例：

  @Component
  public class SomeComponent {
      // 类实现
  }
  

2.2 @Service

• 作用：标记类为服务层组件。
• 适用场景：用于定义业务逻辑层的Bean。
• 示例：

  @Service
  public class SomeService {
      // 类实现
  }
  

2.3 @Controller

• 作用：标记类为控制器层组件。
• 适用场景：用于定义Web层的控制器。
• 示例：

  @Controller
  public class SomeController {
      // 类实现
  }
  

2.4 @RestController

• 作用：标记类为RESTful风格的控制器。
• 适用场景：用于定义返回JSON或XML数据的控制器。
• 示例：

  @RestController
  public class SomeRestController {
      // 类实现
  }
  

2.5 @Repository

• 作用：标记类为持久层组件。
• 适用场景：用于定义数据访问层的Bean。
• 示例：

  @Repository
  public class SomeRepository {
      // 类实现
  }
  

2.6 @Autowired

• 作用：用于自动注入依赖。
• 适用场景：在需要注入Spring管理的Bean时。
• 示例：

  @Autowired
  private SomeService someService;
  

2.7 @Qualifier

• 作用：用于指定注入的Bean名称。
• 适用场景：当存在多个相同类型的Bean时，指定注入哪一个。
• 示例：

  @Autowired
  @Qualifier("someBean")
  private SomeBean someBean;
  

2.8 @Configuration

• 作用：标记类为配置类。
• 适用场景：用于定义Spring的配置类。
• 示例：

  @Configuration
  public class SomeConfig {
      // 配置内容
  }
  

2.9 @Bean

• 作用：用于定义一个Bean。
• 适用场景：在配置类中定义一个Bean。
• 示例：

  @Bean
  public SomeBean someBean() {
      return new SomeBean();
  }
  

2.10 @Value

• 作用：用于注入配置文件中的值。
• 适用场景：在需要注入配置文件中的值时。
• 示例：

  @Value("${some.property}")
  private String someProperty;
  

2.11 @Scope

• 作用：用于指定Bean的作用域。
• 适用场景：在需要指定Bean的作用域时（如singleton、prototype等）。
• 示例：

  @Component
  @Scope("prototype")
  public class SomeComponent {
      // 类实现
  }
  

---

3. JPA/Hibernate注解

3.1 @Entity

• 作用：标记类为JPA实体。
• 适用场景：用于定义与数据库表对应的实体类。
• 示例：

  @Entity
  public class User {
      // 类实现
  }
  

3.2 @Table

• 作用：用于指定实体类对应的数据库表名。
• 适用场景：当需要自定义表名时。
• 示例：

  @Entity
  @Table(name = "users")
  public class User {
      // 类实现
  }
  

3.3 @Id

• 作用：用于标记实体类的主键字段。
• 适用场景：在定义实体类的主键时。
• 示例：

  @Id
  private Long id;
  

3.4 @GeneratedValue

• 作用：用于指定主键的生成策略。
• 适用场景：在需要自动生成主键时。
• 示例：

  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;
  

3.5 @Column

• 作用：用于指定字段对应的数据库列名。
• 适用场景：当需要自定义列名时。
• 示例：

  @Column(name = "username")
  private String name;
  

3.6 @OneToMany、@ManyToOne、@OneToOne、@ManyToMany

• 作用：用于定义实体之间的关系。
• 适用场景：在定义实体之间的关联关系时。
• 示例：

  @OneToMany(mappedBy = "user")
  private List<Order> orders;
  

---

4. Lombok注解

4.1 @Data

• 作用：自动生成getter、setter、toString、equals和hashCode方法。
• 适用场景：用于简化实体类的代码。
• 示例：

  @Data
  public class User {
      private Long id;
      private String name;
  }
  

4.2 @Getter、@Setter

• 作用：分别生成getter和setter方法。
• 适用场景：当需要自动生成getter或setter时。
• 示例：

  @Getter
  @Setter
  public class User {
      private Long id;
      private String name;
  }
  

4.3 @NoArgsConstructor、@AllArgsConstructor

• 作用：分别生成无参构造函数和全参构造函数。
• 适用场景：当需要自动生成构造函数时。
• 示例：

  @NoArgsConstructor
  @AllArgsConstructor
  public class User {
      private Long id;
      private String name;
  }
  

---

5. 其他常用注解

5.1 @FunctionalInterface

• 作用：标记接口为函数式接口。
• 适用场景：在定义函数式接口时。
• 示例：

  @FunctionalInterface
  public interface SomeFunction {
      void execute();
  }
  

5.2 @Repeatable

• 作用：允许注解重复使用。
• 适用场景：在需要重复使用注解时。
• 示例：

  @Repeatable(SomeAnnotations.class)
  public @interface SomeAnnotation {
      String value();
  }
  

5.3 @Target、@Retention

• 作用：定义注解的适用范围和保留策略。
• 适用场景：在定义自定义注解时。
• 示例：

  @Target(ElementType.METHOD)
  @Retention(RetentionPolicy.RUNTIME)
  public @interface SomeAnnotation {
      String value();
  }
  

---

总结

Java提供了丰富的注解，用于简化代码编写、提供额外信息或实现特定功能。这些注解可以分为标准Java注解、Spring框架注解、JPA/Hibernate注解、Lombok注解以及其他自定义注解。通过合理使用这些注解，可以提高代码的可读性、可维护性和开发效率。

这篇文章的内容就到这里了，如果你感觉这篇文章对你有帮助的话请点赞、收藏 ➕ 关注。

感谢您的阅读，这里是开发小白，期待与您的下次相遇(●’◡’●) ~