28個SpringBoot項目中常用注解，日常開發、求職面試不再懵圈

作者：Java碼農之路 2023-08-04 07:22:32

開發項目管理

@SpringBootApplication是組合注解。相當于@Configuration、@EnableAutoConfiguration、@ComponentScan的組合。

前言

在使用SpringBoot開發中或者在求職面試中都會使用到很多注解或者問到注解相關的知識。本文主要對一些常用的注解進行了總結，同時也會舉出具體例子，供大家學習和參考。

注解一覽表

啟動類以及配置類相關

@SpringBootApplication

解釋：

@SpringBootApplication是組合注解。相當于@Configuration、@EnableAutoConfiguration、@ComponentScan的組合。
用于標記啟動類，指出應用入口。

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

@Configuration

解釋：

聲明當前類為配置類。相當于xml配置中的beans標簽。

@Configuration
public class MyConfig {
    @Bean
    public MyBean myBean() {
        return new MyBean();
    }
}

@EnableAutoConfiguration

解釋：

開啟SpringBoot自動裝配功能。

@SpringBootApplication
@EnableAutoConfiguration
public class MyApplication {
    // ...
}

@ComponentScan

解釋：

配置SpringBoot掃描包路徑。

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

控制層相關

@RestController

解釋：

@RestController注解用于定義控制器類，將其返回的結果自動轉換為JSON格式

@RestController
public class UserController {
    @GetMapping("/users")
    public List<User> getAllUsers() {
        // 返回所有用戶列表的邏輯
    }
}

@RequestMapping

解釋：

用于映射HTTP請求到處理器上，指定處理器方法的URL路徑和HTTP請求方法。

@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUserById(@PathVariable("id") Long id) {
        // 根據id獲取用戶的邏輯
    }
}

@GetMapping、@PostMapping、@DeleteMapping、@PutMapping

解釋：

@GetMapping注解用于處理HTTP的GET請求，并將請求映射到相應的處理器方法上。
@PostMapping注解用于處理HTTP的POST請求，并將請求映射到相應的處理器方法上。
@DeleteMapping注解用于處理HTTP的DELETE請求，并將請求映射到相應的處理器方法上。
@PutMapping是Spring框架中用于處理HTTP的PUT請求的注解。PUT請求通常用于更新資源，即將新的數據替換掉指定的資源。

@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUserById(@PathVariable("id") Long id) {
        // 根據id獲取用戶的邏輯
    }
}


@RestController
@RequestMapping("/users")
public class UserController {
    @PostMapping
    public User createUser(@RequestBody User user) {
        // 創建用戶的邏輯
    }
}


@RestController
@RequestMapping("/users")
public class UserController {
    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable("id") Long id) {
        // 刪除用戶的邏輯
    }
}


@RestController
@RequestMapping("/users")
public class UserController {
    @PutMapping("/{id}")
    public User updateUser(@PathVariable("id") Long id, @RequestBody User user) {
        // 更新用戶信息的邏輯
    }
}

@RequestParam

解釋：

@RequestParam注解用于獲取請求參數的值，并將其綁定到處理器方法的形參上。一般用于路徑中？傳參形式。

@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping
    public List<User> getUsersByPage(@RequestParam("page") int page, 
                                     @RequestParam(value = "size", defaultValue = "10") int size) {
        // 分頁查詢用戶列表的邏輯
    }
}

@PathVariable

解釋：

用于獲取URL路徑中的變量值，并將其綁定到處理器方法的形參上。一般用于/傳參的形式。

@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUserById(@PathVariable("id") Long id) {
        // 根據id獲取用戶的邏輯
    }
}

@RequestBody

解釋：

用于接收HTTP請求的請求體內容，并將其轉化為對應的Java對象或其他類型的參數。

@RestController
@RequestMapping("/users")
public class UserController {
    @PostMapping
    public User createUser(@RequestBody User user) {
        // 創建用戶的邏輯
    }
}

@Valid

解釋：

@Valid用于開啟數據驗證功能，對方法參數進行校驗，確保其滿足定義的驗證規則

@RestController
@RequestMapping("/users")
public class UserController {
    @PostMapping
    public ResponseEntity<User> createUser(@Valid @RequestBody User user) {
        // 創建用戶的邏輯
        return ResponseEntity.status(HttpStatus.CREATED).body(user);
    }
}

Bean管理相關

@Autowired: 自動裝配，用于自動注入依賴的Bean實例。
@Service: 用于標識一個服務類，表示它是業務邏輯層的組件。
@Repository: 用于標識一個數據訪問類，表示它是數據訪問層的組件。
@Component: 通用的Spring組件注解，用于標識一個普通的Bean組件。
@Value: 注入配置文件中的值到對應的變量中。

異步和定時相關

@EnableScheduling、@Scheduled

解釋：

@EnableScheduling：啟動類添加@EnableScheduling開啟任務調度功能。
@Scheduled：定時任務注解，用于標識定時任務的方法。

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


@Component
public class MyScheduler {
    @Scheduled(fixedRate = 5000)
    public void myTask() {
        // 每個5秒執行一次的任務邏輯
    }
}


@Component
public class MyScheduler {
    @Scheduled(cron = "0 0 8 * * ?")
    public void myTask() {
        // 每天早上8點執行的任務邏輯
    }
}

@EnableAsync、@Async

解釋：

@EnableAsync：啟動類添加，開啟異步任務。
@Async：標識異步任務方法。

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


@Service
public class MyService {
    @Async
    public CompletableFuture<String> asyncTask() {
        // 異步執行的任務邏輯
        // 返回一個CompletableFuture以支持異步結果的處理
    }
}

緩存和事務管理

解釋：

@EnableCaching: 開啟Spring的緩存支持，用于緩存方法的結果，提高性能。
@Transactional: 提供聲明式事務管理，用于標識需要使用事務的方法或類。
@EnableTransactionManagement: 開啟事務管理支持，用于啟用Spring的聲明式事務管理功能

@SpringBootApplication
@EnableCaching
@EnableTransactionManagement
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}
@Service
public class MyService {
    @Transactional
    public void performTransaction() {
        // 執行數據庫操作等需要事務管理的邏輯
    }
}

異常處理相關

@RestControllerAdvice、@ExceptionHandler

@RestControllerAdvice：結合了@ControllerAdvice和@ResponseBody注解的功能。它用于定義全局的異常處理和統一的響應處理。
@ExceptionHandler：指定類型的異常進行統一處理。

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception e) {
        // 異常處理邏輯，可以根據實際需求進行對異常的處理和返回相應的錯誤信息
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Internal Server Error");
    }
}

寫在最后

有關于SpringBoot常用注解到此就結束了。

責任編輯：武曉燕來源：今日頭條