Essential Spring Boot Annotations Every Java Developer Should Know

Spring Boot Annotations

@SpringBootApplication : Enables Spring Boot’s auto‑configuration and is equivalent to using @Configuration, @EnableAutoConfiguration, and @ComponentScan together.

@EnableAutoConfiguration : Triggers Spring Boot’s auto‑configuration mechanism, attempting to configure beans based on the classpath.

@ConditionalOnXXXX : Derived from @Conditional, loads a bean only when specific conditions are met, e.g., @ConditionalOnBean, @ConditionalOnClass.

@ConfigurationProperties : Binds external properties to a type‑safe bean, allowing configuration values to be injected as strongly typed fields.

Spring Basic Annotations

@Conditional : Determines bean loading based on a condition, widely used throughout Spring Boot.

@ComponentScan : Scans the package of the annotated class (and sub‑packages) for components such as @Component, @Controller, @Service, and registers them as beans.

@Configuration : Marks a class as a source of bean definitions, replacing XML configuration files.

@Profile : Activates a bean only when a specific profile (environment) is active.

@Import : Imports additional @Configuration classes, similar to the XML <import> element.

@ImportResource : Imports traditional XML configuration files into a Spring Boot application.

@Autowired : Performs dependency injection by type; can be combined with @Qualifier for name‑based injection.

@Service : Stereotype for service‑layer components; registers the class as a bean with a default name derived from the class name.

@Component : Generic stereotype for any Spring-managed component that does not fit other specific stereotypes.

@Repository : Marks a DAO or persistence layer component, enabling exception translation.

@Bean : Declares a method that produces a bean, equivalent to an XML <bean> definition.

@Value : Injects a literal value or a property from configuration files into a field.

@Inject : JSR‑330 standard injection annotation, functionally similar to @Autowired.

@Qualifier : Disambiguates injection when multiple beans of the same type exist.

@Resource : JSR‑250 injection by name, often used with a name attribute.

@JsonBackReference : Jackson annotation to handle bidirectional relationships during JSON serialization.

@PropertySource : Loads additional property files into the Spring Environment.

Spring Web Annotations

@ResponseBody : Indicates that the return value of a method should be written directly to the HTTP response body, typically as JSON.

@Controller : Marks a class as a Spring MVC controller, handling HTTP requests.

@RestController : Combines @Controller and @ResponseBody for RESTful APIs.

@RequestMapping : Maps URLs to controller methods, defining the request path and HTTP method.

@GetMapping : Shortcut for @RequestMapping(method = RequestMethod.GET).

@PostMapping : Shortcut for @RequestMapping(method = RequestMethod.POST).

@PathVariable : Binds a URI template variable to a method parameter.

@RequestParam : Binds a query parameter or form data to a method parameter.

@ControllerAdvice : Provides global exception handling, data binding, and model attributes across all controllers.

@ExceptionHandler : Defines a method to handle specific exceptions, typically used within @ControllerAdvice.

JPA Annotations

@Entity : Marks a class as a JPA entity, mapping it to a database table.

@Table : Specifies the table name when it differs from the entity name.

@MappedSuperclass : Indicates a superclass whose mapping information is applied to its subclasses but is not itself an entity.

@NoRepositoryBean : Prevents Spring Data from creating a repository bean for the annotated interface.

@Column : Maps an entity field to a specific column in the database.

@Id : Denotes the primary key of an entity.

@GeneratedValue : Configures the generation strategy for primary key values (e.g., AUTO, IDENTITY, SEQUENCE).

@Transient : Excludes a field from persistence.

@JsonIgnore : Instructs Jackson to ignore a field during JSON serialization and deserialization.

@JoinColumn : Specifies the foreign key column for entity relationships.

@OneToOne , @OneToMany , @ManyToOne : Define the cardinality of relationships between entities.