一、核心啟動(dòng)注解

1. @SpringBootApplication

• 作用：Spring Boot應(yīng)用的入口注解，組合了@Configuration、@EnableAutoConfiguration和@ComponentScan
• 使用場(chǎng)景：主啟動(dòng)類上必須使用
• 示例：

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

2. @EnableAutoConfiguration

• 作用：?jiǎn)⒂肧pring Boot的自動(dòng)配置機(jī)制
• 使用場(chǎng)景：當(dāng)需要自定義自動(dòng)配置時(shí)使用
• 注意：通常不需要單獨(dú)使用，@SpringBootApplication已包含

3. @Configuration

• 作用：標(biāo)記類為配置類，替代XML配置
• 使用場(chǎng)景：定義Bean配置時(shí)使用
• 示例：

@Configuration
public class AppConfig {
    @Bean
    public MyService myService() {
        return new MyServiceImpl();
    }
}

4. @ComponentScan

• 作用：自動(dòng)掃描并注冊(cè)Bean到Spring容器
• 使用場(chǎng)景：需要自定義掃描路徑時(shí)使用
• 示例：

@SpringBootApplication
@ComponentScan({"com.example.main", "com.example.controllers"})
public class MyApplication {
    // ...
}

二、Bean定義與管理

1. @Bean

• 作用：聲明方法返回的對(duì)象由Spring管理
• 使用場(chǎng)景：配置類中定義第三方庫(kù)組件的Bean
• 示例：

@Configuration
public class AppConfig {
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

2. @Component/@Service/@Repository/@Controller

• 作用：將類標(biāo)記為Spring組件，分別對(duì)應(yīng)通用組件、服務(wù)層、數(shù)據(jù)層和控制層
• 使用場(chǎng)景：開(kāi)發(fā)業(yè)務(wù)組件時(shí)根據(jù)分層選擇對(duì)應(yīng)注解
• 示例：

@Service
public class UserServiceImpl implements UserService {
    // 業(yè)務(wù)邏輯
}
@Repository
public class UserRepositoryImpl implements UserRepository {
    // 數(shù)據(jù)訪問(wèn)邏輯
}

3. @ConfigurationProperties

• 作用：將配置文件屬性綁定到Bean
• 使用場(chǎng)景：需要集中管理配置屬性時(shí)
• 示例：

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

4. @Scope

• 作用：定義Bean的作用域（singleton, prototype等）
• 使用場(chǎng)景：需要非單例Bean時(shí)
• 示例：

@Bean
@Scope("prototype")
public MyPrototypeBean myPrototypeBean() {
    return new MyPrototypeBean();
}

三、依賴注入

1. @Autowired

• 作用：按類型自動(dòng)注入依賴
• 使用場(chǎng)景：需要注入依賴時(shí)首選
• 示例：

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

2. @Qualifier

• 作用：指定注入的Bean名稱（解決多個(gè)同類型Bean沖突）
• 使用場(chǎng)景：有多個(gè)同類型Bean時(shí)
• 示例：

@Autowired
@Qualifier("primaryDataSource")
private DataSource dataSource;

3. @Value

• 作用：注入屬性值
• 使用場(chǎng)景：注入簡(jiǎn)單配置值
• 示例：

3. @Value
作用：注入屬性值
使用場(chǎng)景：注入簡(jiǎn)單配置值
示例：

四、Web MVC開(kāi)發(fā)

1. @RestController/@Controller

• 作用：標(biāo)記類為Web控制器
• 使用場(chǎng)景：開(kāi)發(fā)REST API或傳統(tǒng)MVC控制器
• 示例：

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

2. @RequestMapping/@GetMapping/@PostMapping等

• 作用：映射HTTP請(qǐng)求路徑和方法
• 使用場(chǎng)景：定義API端點(diǎn)
• 示例：

@PostMapping("/create")
public ResponseEntity<User> createUser(@RequestBody UserDto userDto) {
    // ...
}

3. @RequestBody/@ResponseBody

• 作用：請(qǐng)求體綁定和響應(yīng)體轉(zhuǎn)換
• 使用場(chǎng)景：REST API開(kāi)發(fā)
• 示例：

@PostMapping
public User create(@RequestBody User user) {
    return userService.save(user);
}

4. @PathVariable/@RequestParam

• 作用：從URL路徑或參數(shù)中獲取值
• 使用場(chǎng)景：需要獲取URL中的變量或查詢參數(shù)
• 示例：

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

五、數(shù)據(jù)訪問(wèn)

1. @Entity/@Table

• 作用：定義JPA實(shí)體類和對(duì)應(yīng)表
• 使用場(chǎng)景：數(shù)據(jù)庫(kù)表映射
• 示例：

@Entity
@Table(name = "users")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    // ...
}

2. @Transactional

• 作用：聲明事務(wù)
• 使用場(chǎng)景：需要事務(wù)管理的方法或類
• 示例：

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

3. @RepositoryRestResource

作用：將JPA倉(cāng)庫(kù)暴露為REST端點(diǎn)

使用場(chǎng)景：快速開(kāi)發(fā)RESTful數(shù)據(jù)服務(wù)

示例：

• @RepositoryRestResource(path = "users")
  public interface UserRepository extends JpaRepository<User, Long> {
  }

六、測(cè)試相關(guān)

1. @SpringBootTest

• 作用：加載完整應(yīng)用上下文進(jìn)行集成測(cè)試
• 使用場(chǎng)景：集成測(cè)試
• 示例：

@SpringBootTest
class MyIntegrationTests {
    @Autowired
    private MyService myService;
    // 測(cè)試方法
}

2. @WebMvcTest

• 作用：僅測(cè)試Web層
• 使用場(chǎng)景：控制器單元測(cè)試
• 示例：

@WebMvcTest(UserController.class)
class UserControllerTests {
    @Autowired
    private MockMvc mockMvc;
    // 測(cè)試方法
}

七、高級(jí)特性

1. @EnableCaching/@Cacheable

• 作用：?jiǎn)⒂镁彺婧吐暶骺删彺娣椒?/li>
• 使用場(chǎng)景：需要方法結(jié)果緩存時(shí)
• 示例：

@Service
public class UserService {
    @Cacheable("users")
    public User getUser(Long id) {
        // 只有第一次會(huì)執(zhí)行，后續(xù)從緩存獲取
    }
}

2. @EnableScheduling/@Scheduled

• 作用：?jiǎn)⒂枚〞r(shí)任務(wù)和定義任務(wù)執(zhí)行時(shí)間
• 使用場(chǎng)景：需要定時(shí)執(zhí)行任務(wù)時(shí)
• 示例：

@Component
public class MyScheduler {
    @Scheduled(fixedRate = 5000)
    public void doTask() {
        // 每5秒執(zhí)行一次
    }
}

3. @Async

• 作用：標(biāo)記方法為異步執(zhí)行
• 使用場(chǎng)景：需要異步執(zhí)行耗時(shí)操作時(shí)
• 示例：

@Service
public class AsyncService {
    @Async
    public void asyncMethod() {
        // 異步執(zhí)行
    }
}

最佳實(shí)踐建議

• 分層清晰：嚴(yán)格遵循Controller-Service-Repository分層，使用對(duì)應(yīng)注解
• 合理使用自動(dòng)配置：優(yōu)先使用Spring Boot的自動(dòng)配置，必要時(shí)通過(guò)@ConfigurationProperties自定義
• 依賴注入選擇：構(gòu)造函數(shù)注入優(yōu)于字段注入（特別是必選依賴）
• 事務(wù)管理：在Service層使用@Transactional，保持事務(wù)邊界清晰
• 測(cè)試策略：根據(jù)測(cè)試目標(biāo)選擇合適的測(cè)試注解（單元測(cè)試用@WebMvcTest，集成測(cè)試用@SpringBootTest）
• REST API開(kāi)發(fā)：優(yōu)先使用@RestController和HTTP方法特定注解（@GetMapping等）

到此這篇關(guān)于Spring Boot 常用注解詳解與使用指南的文章就介紹到這了,更多相關(guān)Spring Boot 常用注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論