2. 程式人生 > >spring boot 的常用註解

spring boot 的常用註解

阿新 • • 發佈：2019-01-25

轉載自https://www.cnblogs.com/ScvQ/p/7007636.html

@RestController和@RequestMapping註解

4.0重要的一個新的改進是@RestController註解，它繼承自@Controller註解。4.0之前的版本，spring MVC的元件都使用@Controller來標識當前類是一個控制器servlet。使用這個特性，我們可以開發REST服務的時候不需要使用@Controller而專門的@RestController。

 當你實現一個RESTful web services的時候，response將一直通過response body傳送。為了簡化開發，Spring 4.0提供了一個專門版本的controller。下面我們來看看@RestController實現的定義：

複製程式碼
@Target(value=TYPE)    
 @Retention(value=RUNTIME)    
 @Documented    
 @Controller    
 @ResponseBody    
public @interface RestController
複製程式碼

@RequestMapping 註解提供路由資訊。它告訴Spring任何來自"/"路徑的HTTP請求都應該被對映到 home 方法。 @RestController 註解告訴Spring以字串的形式渲染結果，並直接返回給呼叫者。

@EnableAutoConfiguration註解

第二個類級別的註解是 @EnableAutoConfiguration 。這個註解告訴Spring Boot根據新增的jar依賴猜測你想如何配置Spring。由於 spring-boot-starter-web 添加了Tomcat和Spring MVC，所以auto-configuration將假定你正在開發一個web應用並相應地對Spring進行設定。Starter POMs和Auto-Configuration：設計auto-configuration的目的是更好的使用"Starter POMs"，但這兩個概念沒有直接的聯絡。你可以自由地挑選starter POMs以外的jar依賴，並且Spring Boot將仍舊盡最大努力去自動配置你的應用。

你可以通過將 @EnableAutoConfiguration 或 @SpringBootApplication 註解新增到一個 @Configuration 類上來選擇自動配置。
注：你只需要新增一個 @EnableAutoConfiguration 註解。我們建議你將它新增到主 @Configuration 類上。

如果發現應用了你不想要的特定自動配置類，你可以使用 @EnableAutoConfiguration 註解的排除屬性來禁用它們。

複製程式碼
    <pre name="code" class="java">import org.springframework.boot.autoconfigure.*;  
    
 
import org.springframework.boot.autoconfigure.jdbc.*;  
    import org.springframework.context.annotation.*;  
    @Configuration  
    @EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})  
    public class MyConfiguration {  
    }
複製程式碼

@Configuration

Spring Boot提倡基於Java的配置。儘管你可以使用一個XML源來呼叫 SpringApplication.run() ，我們通常建議你使用 @Configuration 類作為主要源。一般定義 main 方法的類也是主要 @Configuration 的一個很好候選。你不需要將所有的 @Configuration 放進一個單獨的類。 @Import 註解可以用來匯入其他配置類。另外，你也可以使用 @ComponentScan 註解自動收集所有的Spring元件，包括 @Configuration 類。

如果你絕對需要使用基於XML的配置，我們建議你仍舊從一個 @Configuration 類開始。你可以使用附加的 @ImportResource 註解載入XML配置檔案。

@Configuration註解該類，等價 與XML中配置beans；用@Bean標註方法等價於XML中配置bean

@ComponentScan(basePackages = "com.hyxt",includeFilters = {@ComponentScan.Filter(Aspect.class)})

@SpringBootApplication

很多Spring Boot開發者總是使用 @Configuration ， @EnableAutoConfiguration 和 @ComponentScan 註解他們的main類。由於這些註解被如此頻繁地一塊使用（特別是你遵循以上最佳實踐時），Spring Boot提供一個方便的 @SpringBootApplication 選擇。
該 @SpringBootApplication 註解等價於以預設屬性使用 @Configuration ， @EnableAutoConfiguration 和 @ComponentScan 。

複製程式碼
    package com.example.myproject;  
    import org.springframework.boot.SpringApplication;  
    import org.springframework.boot.autoconfigure.SpringBootApplication;  
    @SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan  
    public class Application {  
        public static void main(String[] args) {  
            SpringApplication.run(Application.class, args);  
        }  
    }
複製程式碼Spring Boot將嘗試校驗外部的配置，預設使用JSR-303（如果在classpath路徑中）。你可以輕鬆的為你的@ConfigurationProperties類新增JSR-303 javax.validation約束註解：
    @Component  
    @ConfigurationProperties(prefix="connection")  
    public class ConnectionSettings {  
    @NotNull  
    private InetAddress remoteAddress;  
    // ... getters and setters  
    }

@Profiles

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

複製程式碼
    @Configuration  
    @Profile("production")  
    public class ProductionConfiguration {  
    // ...  
    }
複製程式碼@ResponseBody

表示該方法的返回結果直接寫入HTTP response body中

一般在非同步獲取資料時使用，在使用@RequestMapping後，返回值通常解析為跳轉路徑，加上
@responsebody後返回結果不會被解析為跳轉路徑，而是直接寫入HTTP response body中。比如
非同步獲取json資料，加上@responsebody後，會直接返回json資料。

@Component：
泛指元件，當元件不好歸類的時候，我們可以使用這個註解進行標註。一般公共的方法我會用上這個註解
@AutoWired
byType方式。把配置好的Bean拿來用，完成屬性、方法的組裝，它可以對類成員變數、方法及構
造函式進行標註，完成自動裝配的工作。
當加上（required=false）時，就算找不到bean也不報錯。
@RequestParam：
用在方法的引數前面。
@RequestParam String a =request.getParameter("a")。
@PathVariable:
路徑變數。
    RequestMapping("user/get/mac/{macAddress}")  
    public String getByMacAddress(@PathVariable String macAddress){  
    //do something;  
    }
引數與大括號裡的名字一樣要相同。
以上註解的示範複製程式碼
    /** 
     * 使用者進行評論及對評論進行管理的 Controller 類； 
     */  
    @Controller  
    @RequestMapping("/msgCenter")  
    public class MyCommentController extends BaseController {  
        @Autowired  
        CommentService commentService;  
      
        @Autowired  
        OperatorService operatorService;  
      
        /** 
         * 新增活動評論； 
         * 
         * @param applyId 活動 ID； 
         * @param content 評論內容； 
         * @return 
         */  
        @ResponseBody  
        @RequestMapping("/addComment")  
        public Map<String, Object> addComment(@RequestParam("applyId") Integer applyId, @RequestParam("content") String content) {  
            ....  
            return result;  
        }  
    }
複製程式碼
@RequestMapping("/list/{applyId}")  
    public String list(@PathVariable Long applyId, HttpServletRequest request, ModelMap modelMap) {  
}
全域性處理異常的：@ControllerAdvice：
包含@Component。可以被掃描到。
統一處理異常。

@ExceptionHandler（Exception.class）：
用在方法上面表示遇到這個異常就執行以下方法。
複製程式碼
    /** 
     * 全域性異常處理 
     */  
    @ControllerAdvice  
    class GlobalDefaultExceptionHandler {  
        public static final String DEFAULT_ERROR_VIEW = "error";  
      
        @ExceptionHandler({TypeMismatchException.class,NumberFormatException.class})  
        public ModelAndView formatErrorHandler(HttpServletRequest req, Exception e) throws Exception {  
            ModelAndView mav = new ModelAndView();  
            mav.addObject("error","引數型別錯誤");  
            mav.addObject("exception", e);  
            mav.addObject("url", RequestUtils.getCompleteRequestUrl(req));  
            mav.addObject("timestamp", new Date());  
            mav.setViewName(DEFAULT_ERROR_VIEW);  
            return mav;  
        }}
複製程式碼

通過@value註解來讀取application.properties裡面的配置

    # face++ key  
    face_api_key = R9Z3Vxc7ZcxfewgVrjOyrvu1d-qR****  
    face_api_secret =D9WUQGCYLvOCIdsbX35uTH********  
    @Value("${face_api_key}")  
       private String API_KEY;  
      
       @Value("${face_api_secret}")  
       private String API_SECRET;

所以一般常用的配置都是配置在application.properties檔案的

JPA註解使用

@Id： 
@Id 標註用於宣告一個實體類的屬性對映為資料庫的主鍵列。該屬性通常置於屬性宣告語句之前，可與宣告語句同行，也可寫在單獨行上。 
@Id標註也可置於屬性的getter方法之前。

@GeneratedValue： 
@GeneratedValue 用於標註主鍵的生成策略，通過strategy 屬性指定。預設情況下，JPA 自動選擇一個最適合底層資料庫的主鍵生成策略：SqlServer對應identity，MySQL 對應 auto increment。 
在javax.persistence.GenerationType中定義了以下幾種可供選擇的策略： 
–IDENTITY：採用資料庫ID自增長的方式來自增主鍵欄位，Oracle 不支援這種方式； 
–AUTO： JPA自動選擇合適的策略，是預設選項； 
–SEQUENCE：通過序列產生主鍵，通過@SequenceGenerator 註解指定序列名，MySql不支援這種方式 
–TABLE：通過表產生主鍵，框架藉由表模擬序列產生主鍵，使用該策略可以使應用更易於資料庫移植。

推薦的兩種寫法： 
屬性之上：

@Table(name="CUSTOMERS")
@Entity
public class Customer {
    @GeneratedValue(strategy=GenerationType.AUTO)
    @Id
    private Integer id;
    private String name;
    private String email;
    private int age;

    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16

getter方法之上：

@Table(name="CUSTOMERS")
@Entity
public class Customer {
    private Integer id;
    private String name;
    private String email;
    private int age;

    @GeneratedValue(strategy=GenerationType.AUTO)
    @Id
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16

但是不能某個註解在屬性之上，某個註解在getter之上，將丟擲異常，對其他註解也相同


相關推薦

Spring Boot常用註解總結

auto 基於 back rgs enable glob 裝配 內容 註意 Spring Boot常用註解總結 @RestController和@RequestMapping註解 @RestController註解，它繼承自@Controller註解。4.0之前的版本，Sp

spring boot常用註解

cati resource resp .profile ring isa selection cor 服務層 @EnableAutoConfiguration 啟動自動裝載：使用了這個註解之後，所有引入的jar的starters都會被自動註入。這個類的設計就是為start

spring boot常用註解使用小結

throws 配置文件 只需要 extends 開發者 valid In 需要 hex 1、@RestController和@RequestMapping註解 　　4.0重要的一個新的改進是@RestController註解，它繼承自@Controller註解。 　　4.0

spring-boot常用註解

註解 常用註解 @RestController 控制器註解 @RequestParam 獲取url引數 ?name=value @RequestParam(value = "name",defaultValue = "張三") String name @Reques

Spring Boot常用註解（二）

1.概述 在 Spring Boot常用註解（一） - 宣告Bean的註解 中學習了Spring Boot中宣告Bean的註解 那Spring容器中的Bean是怎麼實現自動裝配（依賴）的呢？ 這就是接下來學習的注入註解咯 注入Bean的註解： @Au

Spring Boot常用註解（三）

一.概述 Spring Boot推薦使用java配置完全代替XML配置，java配置是通過@Configration和@Bean註解實現的 @Configration註解聲明當前類是一個配置類，相當於Spring中的一個XML檔案 @Bean註解作用在方法

Spring boot常用註解 總結

Java註解： 註解，也叫元資料。一種程式碼級別的說明。它是JDK1.5及以後版本引入的一個特性，與類、介面、列舉是在同一個層次。它可以宣告在包、類、欄位、方法、區域性變數、方法引數等的前面，用來對這些元素進行說明，註釋。 作用分類： ①編寫文件：通過程式碼裡標

spring boot 常用註解解析

（1）@SpringBootApplication        申明讓spring boot自動給程式進行必要的配置，這個配置等同於： @Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三個配置。 示例

spring 、spring boot 常用註解

xml配置 意思 無法 產生 webp con delattr bin ddr @Profile 1.用戶配置文件註解. 2.使用範圍： @Configration 和 @Component 註解的類及其方法， 其中包括繼

Spring Boot 常用註解彙總

Spring Boot 常用註解彙總 一、啟動註解 @SpringBootApplication @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @SpringBootConfigurat

Spring boot常用一些註解

spring boot 常用的註解 首先是通常用在主類上：@SpringBootApplication @Configuration @EnableAutoConfiguration @ComponentScan 用於標註資料訪問元件，即DAO元件：@Repos

spring boot 的註解

spring boot 的註解（1）@SpringBootApplication 申明讓spring boot自動給程序進行必要的配置，這個配置等同於：@Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三個配置。示例代碼：packa

spring mvc常用註解的說明

control debug mvc ref this mediatype display 說明 tom 最近一段時間學習了springboot,所以熟悉一下mvc中常用的註解，這樣可以方便開發 簡介： @RequestMapping RequestMa

spring-boot主要註解

路徑 res 頁面 nbsp con 請求方式 方式 字符串 如何 一、@Controller 處理http請求 1、結合模版組件返回頁面，spring-boot提供了spring-boot-starter-thymeleaf組件 2、結合@ResponseBoy返回JSO

spring boot: 條件註解@Condition

.sh 列表 一個 condition cati name property sta 輸出 @Conditional根據滿足某一個特定的條件創建一個特定的Bean（基於條件的Bean的創建，即使用@Conditional註解）。 比方說，當一個jar包在一個類的路徑下的時候

spring boot: @Retention註解 @Documented 註解 @Inherited 註解

ann log 讀取 dos return 方法 運行 lan int http://www.jb51.net/article/55371.htm Retention註解 Retention(保留)註解說明,這種類型的註解會被保留到那個階段. 有三個值:1.Retent

007-Spring Boot @Enable*註解的工作原理

sync express override factor run ext soft navi itself 一、@Enable* 啟用某個特性的註解 1、EnableConfigurationProperties 回顧屬性裝配 application.properti

Spring Boot常用配置

resource intellij runtime 默認 per context none splay 文件的 概述 　　　　本文主要寫了下Spring Boot的一些常用配置。 Spring Boot基本配置 　　　　入口類： 　　　　　　　　Sprin

spring boot 之註解

spring boot 註解@EnableAutoConfiguration有這個註解，spring boot 就會根據classpat中的jar依賴，來猜測你將要開發一個什麽樣的spring應用。比如：spring-boot-starter-web這個依賴，則springboot就會自動嵌入tomcat和s

SpringBoot，Spring 中常用註解@RequestMapping/@GetMapping/@PostMapping /@PutMapping/@DeleteMapping介紹

1、@Controller @Controller 用來響應頁面，表示當前的類為控制器。 2、@RestController @RestController 是@ResponseBody和@Controller的結合 表明當前類是控制器且返回的是一