SpringBoot中常用的注解及其作用

SpringBoot框架提供了大量注解，简化了Java应用的开发过程。下面按照不同类别介绍SpringBoot中常用的注解及其作用。

1. 核心注解

@SpringBootApplication

这是SpringBoot的核心注解，是一个复合注解，包含了以下三个注解的功能：

• @Configuration: 标识该类为配置类
• @EnableAutoConfiguration: 启用自动配置机制
• @ComponentScan: 自动扫描组件

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

@EnableAutoConfiguration

启用SpringBoot的自动配置机制，根据类路径下的依赖自动配置Spring应用上下文。

2. 依赖注入注解

@Autowired

自动注入依赖，默认按照类型(byType)进行装配。

@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;
}

@Resource

按照名称(byName)进行依赖注入，是JSR-250标准的一部分。

@Service
public class UserService {
    @Resource(name = "userRepository")
    private UserRepository userRepository;
}

@Qualifier

当存在多个相同类型的Bean时，配合@Autowired使用，指定注入的Bean名称。

@Service
public class UserService {
    @Autowired
    @Qualifier("userRepositoryImpl")
    private UserRepository userRepository;
}

@Value

注入配置文件中的属性值。

@Value("${app.name}")
private String appName;

3. MVC相关注解

@RestController

组合注解，相当于@Controller + @ResponseBody，表示该类所有方法都返回JSON数据。

@RestController
@RequestMapping("/api/users")
public class UserController {
    // ...
}

@Controller

标识该类为Spring MVC的控制器处理器。

@RequestMapping

用于映射Web请求，可以用在类和方法上。

@RestController
@RequestMapping("/api/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        // ...
    }
}

@GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping

分别对应HTTP的GET、POST、PUT、DELETE、PATCH请求方法的快捷方式。

@PathVariable

从URL路径中获取变量。

@GetMapping("/{id}")
public User getUser(@PathVariable Long id) {
    // ...
}

@RequestParam

从请求参数中获取值。

@GetMapping("/search")
public List<User> searchUsers(@RequestParam String name) {
    // ...
}

@RequestBody

将请求体中的JSON数据映射到方法参数上。

@PostMapping
public User createUser(@RequestBody User user) {
    // ...
}

@ResponseBody

将方法返回值直接作为HTTP响应体返回，通常用于返回JSON数据。

4. 数据访问相关注解

@Entity

标识类为JPA实体类，映射到数据库表。

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    private String name;
    // getters and setters
}

@Table

指定实体类映射的数据库表名。

@Entity
@Table(name = "users")
public class User {
    // ...
}

@Id

标识实体类的主键字段。

@GeneratedValue

指定主键生成策略。

@Column

指定字段映射到数据库列的属性。

@Column(name = "user_name", nullable = false, length = 50)
private String name;

@Repository

标识类为数据访问层组件(DAO)，同时也会将该类作为异常转换的切入点。

@Repository
public interface UserRepository extends JpaRepository<User, Long> {
    // ...
}

@Transactional

声明事务，可以指定事务的传播行为、隔离级别等属性。

@Service
public class UserService {
    @Transactional
    public void createUser(User user) {
        // ...
    }
}

5. AOP相关注解

@Aspect

标识类为切面。

@Aspect
@Component
public class LogAspect {
    // ...
}

@Before

前置通知，在目标方法执行前执行。

@Before("execution(* com.example.service.*.*(..))")
public void beforeMethod(JoinPoint joinPoint) {
    // ...
}

@After

后置通知，在目标方法执行后执行（无论是否抛出异常）。

@AfterReturning

返回通知，在目标方法正常返回后执行。

@AfterThrowing

异常通知，在目标方法抛出异常后执行。

@Around

环绕通知，可以在目标方法执行前后执行自定义逻辑。

@Around("execution(* com.example.service.*.*(..))")
public Object aroundMethod(ProceedingJoinPoint joinPoint) throws Throwable {
    // 前置逻辑
    Object result = joinPoint.proceed();
    // 后置逻辑
    return result;
}

@Pointcut

定义切入点表达式。

@Pointcut("execution(* com.example.service.*.*(..))")
public void servicePointcut() {}

6. 测试相关注解

@SpringBootTest

用于SpringBoot应用的集成测试，加载完整的Spring应用上下文。

@SpringBootTest
public class UserServiceTest {
    @Autowired
    private UserService userService;
    
    @Test
    public void testCreateUser() {
        // ...
    }
}

@Test

标识方法为测试方法，来自JUnit。

@RunWith

指定测试运行器，如SpringRunner。

@RunWith(SpringRunner.class)
public class UserServiceTest {
    // ...
}

@WebMvcTest

用于Spring MVC控制器的测试，只加载Web层相关的组件。

@WebMvcTest(UserController.class)
public class UserControllerTest {
    @Autowired
    private MockMvc mockMvc;
    
    @Test
    public void testGetUser() throws Exception {
        mockMvc.perform(get("/api/users/1"))
               .andExpect(status().isOk());
    }
}

@DataJpaTest

用于JPA数据访问层的测试，只加载JPA相关的组件。

@MockBean

在测试中创建Mock对象并注入到Spring上下文中。

@SpringBootTest
public class UserServiceTest {
    @MockBean
    private UserRepository userRepository;
    
    @Test
    public void testGetUser() {
        when(userRepository.findById(1L)).thenReturn(Optional.of(new User()));
        // ...
    }
}

7. 配置相关注解

@Configuration

标识类为配置类，Spring容器会将其作为Bean定义的来源。

@Configuration
public class AppConfig {
    @Bean
    public UserService userService() {
        return new UserService();
    }
}

@Bean

声明一个方法，其返回值作为一个Bean注册到Spring容器中。

@ComponentScan

自动扫描组件，默认扫描当前包及其子包下的所有带有@Component、@Service、@Repository、@Controller等注解的类。

@PropertySource

指定属性文件的位置。

@Configuration
@PropertySource("classpath:app.properties")
public class AppConfig {
    // ...
}

@ConfigurationProperties

将配置文件中的属性批量绑定到一个Java对象上。

@Component
@ConfigurationProperties(prefix = "app")
public class AppProperties {
    private String name;
    private int port;
    // getters and setters
}

@Profile

指定Bean在哪个Profile下生效。

@Configuration
@Profile("dev")
public class DevConfig {
    // ...
}

@Conditional

条件化地注册Bean，满足特定条件时才创建Bean。

@Bean
@ConditionalOnClass(DataSource.class)
public DataSource dataSource() {
    // ...
}

8. 其他常用注解

@Component

通用的组件注解，标识一个类为Spring管理的组件。

@Service

标识类为业务逻辑层组件。

@Service
public class UserService {
    // ...
}

@Controller

标识类为Web层控制器组件。

@Repository

标识类为数据访问层组件。

@Primary

当存在多个相同类型的Bean时，指定优先注入的Bean。

@Primary
@Bean
public DataSource primaryDataSource() {
    // ...
}

@Lazy

延迟初始化Bean，第一次使用时才创建。

@Lazy
@Service
public class UserService {
    // ...
}

@Scope

指定Bean的作用域，如singleton、prototype等。

@Bean
@Scope("prototype")
public User user() {
    return new User();
}

@PostConstruct

在Bean初始化完成后执行的方法。

@Component
public class UserService {
    @PostConstruct
    public void init() {
        // 初始化逻辑
    }
}

@PreDestroy

在Bean销毁前执行的方法。

@Component
public class UserService {
    @PreDestroy
    public void cleanup() {
        // 清理逻辑
    }
}

SpringBoot注解关系图

SpringBoot请求处理流程

总结

SpringBoot通过提供丰富的注解，极大地简化了Java应用的开发。这些注解涵盖了从依赖注入、Web开发、数据访问到AOP、测试等各个方面。掌握这些注解的使用和作用，是开发高质量SpringBoot应用的基础。