spring boot 常用注釋

WEB 模塊相關

  • spring-boot-starter:核心模塊,包括自動配置支持、日志和YAML
  • spring-boot-starter-test:測試模塊,包括JUnit、Hamcrest、Mockito
  • spring-boot-starter-web

常用注解

  • @RequestMapping =》處理地址映射的注解

  • @PathVariable =》 用來獲取請求路徑(url)中的動態參數

    1. 示例
        /**
        * @RequestMapping(value = "user/login/{id}/{name}/{status}") 中的 {id}/{name}/{status}
        * 與 @PathVariable int id、@PathVariable String name、@PathVariable boolean status
        * 一一對應,按名匹配。
        */
    
        @RequestMapping(value = "user/login/{id}/{name}/{status}")
        @ResponseBody
        //@PathVariable注解下的數據類型均可用
        public User login(@PathVariable int id, @PathVariable String name, @PathVariable boolean status) {
        //返回一個User對象響應ajax的請求
            return new User(id, name, status);
        }
    
  • @ResponseBody => 將客戶端請求的數據解析為json 數據或者 xml 格式返回給HTTP響應正文(ResponseBody)中, 也就是客戶端需要的數據。

  • @Controller =》 spring mvc 中配置view 成的注解 ,可以通過此返回jsp 頁面,重定向等 ,配合 @ResponseBody 就可以返回頁面需要的數據 ,比如json 等。

  • @RestController => @RestController注解相當于@ResponseBody +@Controller合在一起的作用。但是如果只是使用@RestController注解Controller,則Controller中的方法無法返回jsp頁面。@RestController 注解更適合 restfulApi 項目的使用 。

  • @RequestParam=> 頁面傳入參數名與方法參數名不一致時可以使用此注解綁定。

  • @RequestBody=> 將ajax(datas)發出的請求寫入 User 對象中。

  • 組合注解(RequestMapping的升級版)

    1. @GetMapping = @RequestMapping(method = RequestMethod.GET)
    2. @PostMapping = @RequestMapping(method = RequestMethod.POST)
    3. @PutMapping = @RequestMapping(method = RequestMethod.PUT)
    4. @DeleteMapping = @RequestMapping(method = RequestMethod.DELETE)
    組合注解是方法級別的,只能用在方法上,我們的實例基本都用組合注解。


@SpringBootApplication:

包含@Configuration、@EnableAutoConfiguration、@ComponentScan
通常用在主類上。

@Repository:

用于標注數據訪問組件,即DAO組件。

@Service:

用于標注業務層組件。

@Controller:

用于標注 controller 層。

@Component:

泛指組件,當組件不好歸類的時候,我們可以使用這個注解進行標注。

@RestController:

用于標注控制層組件(如struts中的action),包含@Controller和@ResponseBody。

@ResponseBody:

表示該方法的返回結果直接寫入HTTP response body中
一般在異步獲取數據時使用,在使用@RequestMapping后,返回值通常解析為跳轉路徑,加上@responsebody后返回結果不會被解析為跳轉路徑,而是直接寫入HTTP response body中。比如異步獲取json數據,加上@responsebody后,會直接返回json數據。

@PathVariable:

路徑變量。參數與大括號里的名字一樣要相同。

@RequestParam:

用在方法的參數前面,用來接收 get 請求 表單數據 ,約束是否是必須的 , 默認值,起別名用來接收表單值 等如 :

http://127.0.0.1:8080/user/login?username=admin&password=admin

public void test(@RequestParam(default="admintest",required=true) String username,@RequestParam(name="password") String pwd){
    
}

@ComponentScan:

當主啟動類不在其他類的 父包中時,使用此注解掃描包含了所有類的包。

組件掃描。個人理解相當于<context:component-scan>,如果掃描到有@Component @Controller @Service等這些注解的類,則把這些類注冊為bean。

@Configuration:

指出該類是 Bean 配置的信息源,相當于XML中的<beans></beans>,一般加在主類上。

@Bean:

相當于XML中的<bean></bean>,放在方法的上面,而不是類,意思是產生一個bean,并交給spring管理。

@EnableAutoConfiguration:

讓 Spring Boot 根據應用所聲明的依賴來對 Spring 框架進行自動配置,一般加在主類上。

@AutoWired:

byType方式。把配置好的Bean拿來用,完成屬性、方法的組裝,它可以對類成員變量、方法及構造函數進行標注,完成自動裝配的工作。
當加上(required=false)時,就算找不到bean也不報錯。

@Qualifier:

當有多個同一類型的Bean時,可以用@Qualifier("name")來指定。與@Autowired配合使用

@Resource(name="name",type="type"):

沒有括號內內容的話,默認byName。與@Autowired干類似的事。

@RequestMapping:

RequestMapping是一個用來處理請求地址映射的注解,可用于類或方法上。用于類上,表示類中的所有響應請求的方法都是以該地址作為父路徑。
該注解有六個屬性:
params:指定request中必須包含某些參數值是,才讓該方法處理。
headers:指定request中必須包含某些指定的header值,才能讓該方法處理請求。
value:指定請求的實際地址,指定的地址可以是URI Template 模式
method:指定請求的method類型, GET、POST、PUT、DELETE等
consumes:指定處理請求的提交內容類型(Content-Type),如application/json,text/html;
produces:指定返回的內容類型,僅當request請求頭中的(Accept)類型中包含該指定類型才返回

@Profiles
Spring Profiles提供了一種隔離應用程序配置的方式,并讓這些配置只能在特定的環境下生效。
任何@Component或@Configuration都能被@Profile標記,從而限制加載它的時機。

@Configuration
@Profile("prod")
public class ProductionConfiguration {
    // ...
}

@ConfigurationProperties
Spring Boot將嘗試校驗外部的配置,默認使用JSR-303(如果在classpath路徑中)。
你可以輕松的為你的@ConfigurationProperties類添加JSR-303 javax.validation約束注解:

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNull
private InetAddress remoteAddress;
// ... getters and setters
}

@ControllerAdvice:
包含@Component。可以被掃描到。
統一處理異常。

@ExceptionHandler(Exception.class):
用在方法上面表示遇到這個異常就執行以下方法。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容