SpringBoot常用註解詳細整理

前言

Spring Boot常用註解整理

提示:以下是本篇文章正文內容,下面案例可供參考

一、@SpringBootApplication

此註解是Spring Boot項目的基石,創建SpringBoot項目的Application時會默認加上

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

@SpringBootApplication 看作@Configuration,@EnableAutoConfiguration,@ComponentScan 註解的集合

@EnableAutoConfiguration:啟用SpringBoot的自動配置機制

@ComponentScan:掃描被@Component /@Service/@Controller註解的bean,註解默認會掃描該類所在的包下所有類

@Configuration:允許在Spring上下文中註冊額外的bean或導入其他配置類

二、@Bean

Bean對象註冊Spring IOC容器與使用bean對象是整個Spring框架的重點,其中@Bean就是一個將方法作為Spring Bean對象註冊的一種方式

package com.edu.fruit;
 //定義一個接口
public interface Fruit<T>{
    //沒有方法
} 
/*
*定義兩個子類
*/
package com.edu.fruit;
@Configuration
 public class Apple implements Fruit<Integer>{//將Apple類約束為Integer類型

}

package com.edu.fruit;
@Configuration
public class GinSeng implements Fruit<String>{//將GinSeng 類約束為String類型
}
/*
*業務邏輯類
*/
package com.edu.service;
@Configuration
public class FruitService {
	@Autowired
	private Apple apple;
	@Autowired
	private GinSeng ginseng;
	//定義一個產生Bean的方法
	@Bean(name="getApple")
	public Fruit<?> getApple(){
		System.out.println(apple.getClass().getName().hashCode);
	  	System.out.println(ginseng.getClass().getName().hashCode);
		return new Apple();
	}
}
/*
*測試類
*/
@RunWith(BlockJUnit4ClassRunner.class)
public class Config {
    public Config(){
        super("classpath:spring-fruit.xml");
    }
    @Test
    public void test(){
        super.getBean("getApple");//這個Bean從哪來,
        //從上面的@Bean下面的方法中返回的是一個Apple類實例對象
    }
}

三、@Autowired

@Autowired自動註入註解,最常用的一種註解將對象自動導入到類中,註解自動裝配bean的類

四、Component傢族

@Component:通用註解,當不知道Bean在哪一層時,可以使用@Component註解標註。
@Repository: 對應持久層—Dao層的註解,用於操作數據庫相關
@Service: 對應服務層的註解,用來連接Dao層做邏輯處理
@Controller:對應Spring MVC控制層,主要接收用戶請求並調用service返回給前端頁面

五、@RestController

@RestController註解是@Controller註解和@ResponseBody註解的合集,用來返回Json格式給頁面(帶Rest格式的就是返回的Json文本)

六、@Scope

聲明Spring Bean的作用域

@Scope("singleton")
public Person personSingleton(){
    return new Person();
}

Spring Bean的四種作用域:singleton,prototype,request,session

七、@Configuration

一般聲明配置類,使用@Component或者@Configuration

@Configurantion
public class AppConfig{
    @Bean
    public TransferService transferService(){
        return new TransferServiceImpl();
    }
}

八、@RequsetMapping

@RequsetMapping是處理HTTP請求的最通用註解

@RequestMapping("/users")
public ResponseEntity<List<User>> getAllUsers(){
    return userRepository.findAll();
}

八、@GetMapping

一般聲明配置類,使用@Component或者@Configuration

九、@Configuration

@GetMapping 就等價於@RequestMapping(value=”/users”,method =RequsetMethod.GET)

即使用@GetMapping就相當用接收GET方法瞭

@GetMapping("/users")
public ResponseEntity<List<User>> getAllUsers(){
    return userRepository.findAll();
}

十、@PostMapping

@PostMapping 就等價於@RequestMapping(value=”/users”,method =RequsetMethod.POST)

即使用@PostMapping就相當用接收Post方法瞭

@PostMapping("/users")
public ResponseEntity<List<User>> getAllUsers(){
    return userRepository.findAll();
}

十一、@PutMapping

@PutMapping(“/users/{userId}”)等價於@RequestMapping(value = “/users/{userId}”,method = RequestMethod.PUT)

@PutMapping("/users/{userId}")
public ResponseEntity<User> updateUser(@PathVariable (value ="userId")Long userId, @Valid @RequestBody UserUpdateRequest userUpdateRequest){
...
}

十二、@DeleteMapping

@DeleteMapping(“/users/{userId}”)等價於@RequestMapping(value =”/users/{userId}”,method = RequestMethod.DELETE)

@DeleteMapping("/users/{userId}")
public ResponseEntity deleteUser(@PathVariable(value = "userId) Long userId){
...
}

十三、@ParhVariable和@RequestParam

@PathVariable 用於獲取路徑參數, @RequestParam用於獲取查詢參數

@GetMapping("/users/{userId}/teachers")
public List<Teacher> getUserRelatedTeachers(@PathVariable("userId") Long userId,@RequestParam(value = "type",required = false) String type){
...
}

其中@PathVariable是獲取請求中的{userId}值,@RequestParam則是url讀取請求中type的值

比如我們url請求中/users/{123456}/teachers?type=Chinese 則我們在Controller獲取到的就是userId = 123456 , type = Chinese

另在@RequestParam中 value=“參數名” required = “true/false”(true表示參數不允許不存在,false表示參數允許不存在) defaultValue=”” 設置defaultValue時默認required為false。

十四、@RequestBody

用於讀取Request請求的body部分,且Content-Type為application/json格式數據,接收到數據後會自動將數據綁定在Java對象上,系統會使用HttpMessageConverter來講請求的body中的json字符串轉換為Java對象

@PostMapping("/sing-up")
public ResponseEntity signUp(@RequsetBody @Valid UserRegisterRequest userRegisterRequest){
    userService.save(userRegisterRequest);
    return ResponseEntity.ok().build()'
}

在這裡插入圖片描述

這就是典型的RequestBody在Post請求裡進行傳輸數據當後端Controller接收到json格式的數據後,直接就會生成Java對象映射到UserRegisterRequest類上,這樣就可以直接將userRegisterRequest對象進行存儲。順便說一下@Valid註解是用

來驗證數據格式是否符合要求,如果符合要求則通過,不符合要求,提示註解中message信息

十五、讀取配置信息

讀取application.yml的註解

wuhan2020: 武漢加油!中國加油!

my-profile:
  name: name
  email: [email protected]

library:
  location: dalian
  books:
    - name: name1
      description: description1
    - name: name2
      description: description2
    - name: name3
      description: description3

[email protected]

使用@Value(“${property}”)讀取簡單的配置信息

@Value("${wuhan2020}")
String wuhan2020;

[email protected]

通過@ConfigurationProperties讀取配置信息並與bean綁定

@Component
@ConfigurationProperties(prefix = "library")
class LibraryProperties{
    @NotEmpty
    private String location;
    private List<Book> books;
    @Data
    @ToString
    static class Book{
        String name;
        String description;
    }
}

十六、@Qualifier

當有多個同一類型的Bean時,可以用@Qualifier(“name”)來指定。與@Autowired配合使用。@Qualifier限定描述符除瞭能根據名字進行註入,但能進行更細粒度的控制如何選擇候選者,具體使用方式如下:

@Autowired 
@Qualifier(value = “demoInfoService”) 
private DemoInfoService demoInfoService;

十七、@MapperScan

spring-boot支持mybatis組件的一個註解,通過此註解指定mybatis接口類的路徑,即可完成對mybatis接口的掃描。

它和@mapper註解是一樣的作用,不同的地方是掃描入口不一樣。@mapper需要加在每一個mapper接口類上面。所以大多數情況下,都是在規劃好工程目錄之後,通過@MapperScan註解配置路徑完成mapper接口的註入。

添加mybatis相應組建依賴之後。就可以使用該註解。

在這裡插入圖片描述

十八、@CrossOrigin

@CrossOrigin(origins = “”, maxAge = 1000) 這個註解主要是為瞭解決跨域訪問的問題。這個註解可以為整個controller配置啟用跨域,也可以在方法級別啟用。

十九、@ControllerAdvice

@ControllerAdvice 和 @RestControllerAdvice:通常和@ExceptionHandler、@InitBinder、@ModelAttribute一起配合使用。

@ControllerAdvice 和 @ExceptionHandler 配合完成統一異常攔截處理。

@RestControllerAdvice 是 @ControllerAdvice 和 @ResponseBody的合集,可以將異常以json的格式返回數據。

如下面對數據異常返回的統一處理。

在這裡插入圖片描述

二十、資源導入註解

@ImportResource @Import @PropertySource 這三個註解都是用來導入自定義的一些配置文件。

@ImportResource(locations={}) 導入其他xml配置文件,需要標準在主配置類上。

導入property的配置文件 @PropertySource指定文件路徑,這個相當於使用spring的標簽來完成配置項的引入。

@import註解是一個可以將普通類導入到spring容器中做管理

二十一、@Transactional

通過這個註解可以聲明事務,可以添加在類上或者方法上。

在spring boot中 不用再單獨配置事務管理,一般情況是我們會在servcie層添加瞭事務註解,即可開啟事務。要註意的是,事務的開啟隻能在public 方法上。並且主要事務切面的回滾條件。正常我們配置rollbackfor exception時 ,如果在方法

裡捕獲瞭異常就會導致事務切面配置的失效。

總結

到此這篇關於SpringBoot常用註解詳細整理的文章就介紹到這瞭,更多相關SpringBoot常用註解內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: