關於RequestMapping註解的作用說明

Posted on by

@RequestMapping註解的作用

@RequestMapping 是 Spring Web 應用程序中最常被用到的註解之一。這個註解會將 HTTP 請求映射到 MVC 和 REST 控制器的處理方法上。並且一個處理請求地址映射的註解，可用在類或方法上。用於類上，表示類中的所有響應請求的方法都是以該地址作為父路徑。

以下為@RequestMapping的源碼

package org.springframework.web.bind.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
    String name() default "";
    @AliasFor("path")
    String[] value() default {};
    @AliasFor("value")
    String[] path() default {};
    RequestMethod[] method() default {};
    String[] params() default {};
    String[] headers() default {};
    String[] consumes() default {};
    String[] produces() default {};
}

方法上：

請求 URL 的第二級訪問目錄。

屬性：

  • value：用於指定請求的 URL。它和 path 屬性的作用是一樣的。
  • method：用於指定請求的方式。
  • params：用於指定限制請求參數的條件。它支持簡單的表達式。要求請求參數的 key 和 value 必須和 配置的一模一樣。

例如：

  • params = {“accountName”}，表示請求參數必須有
  • accountNameparams = {“moeny!100”}，表示請求參數中 money 不能是 100。
  • headers：用於指定限制請求消息頭的條件。

註意：

以上四個屬性隻要出現 2 個或以上時，他們的關系是與的關系。

作用：

用於建立請求URL和處理請求方法之間的對應關系。

出現位置：

請求 URL 的第一級訪問目錄。此處不寫的話，就相當於應用的根目錄。寫的話需要以/開頭。 它出現的目的是為瞭使我們的 URL 可以按照模塊化管理:

例如：

賬戶模塊：

  • /account/add
  • /account/update
  • /account/delete …

訂單模塊：

  • /order/add
  • /order/update
  • /order/delete

案例

普通案例： 將@RequestMapping註解分別註釋在類和方法上，所以在前端寫鏈接的時候要寫完全的路徑（類上標簽的路徑+方法標簽上的路勁）

控制器的代碼塊：

/**
* RequestMapping 註解出現的位置
* @author 
* @Company http://www.ithiema.com
* @Version 1.0
*/
@Controller("accountController")
@RequestMapping("/account")
public class AccountController {
	@RequestMapping("/findAccount")
	public String findAccount() {
		System.out.println("查詢瞭賬戶。。。。");
		return "success";
	}
}

JSP中的代碼塊

<%@ page language="java" contentType="text/html; charset=UTF-8"pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<title>requestmapping 的使用</title>
</head>
<body>
	<!-- 第一種訪問方式 -->
	<a href="${pageContext.request.contextPath}/account/findAccount" rel="external nofollow" >
		查詢賬戶
	</a>


	<!-- 第二種訪問方式 -->
	<a href="account/findAccount" rel="external nofollow" >查詢賬戶</a>
</body>
</html>

案例： 用於指定請求的方式，如果要求是get請求，那麼在前端寫請求方式時的method=get，反之如果要求是post請求，前端的，medthod=post

控制器代碼塊：

/**
* 保存賬戶
* @return
*/
@RequestMapping(value="/saveAccount",method=RequestMethod.POST)
public String saveAccount() {
	System.out.println("保存瞭賬戶");
	return "success";
}

jsp代碼塊

<a href="account/saveAccount" rel="external nofollow" >保存賬戶，get 請求</a>
<form action="account/saveAccount" method="post">
<input type="submit" value="保存賬戶，post 請求">
</form>

註意： 當使用 get 請求時，提示錯誤信息是 405，信息是方法不支持 get 方式請求

在這裡插入圖片描述

params 屬性的示例： 用於指定限制請求參數的條件。它支持簡單的表達式。要求請求參數的 key 和 value 必須和 配置的一模一樣。 寫瞭這個屬性之後就一定要在前端發送請求的時候，前端就要有這個屬性，否則就無法訪問。控制器代碼塊：

/**
* 刪除賬戶
* @return
*/
@RequestMapping(value="/removeAccount",params= {"accountName","money>100"})
public String removeAccount() {
	System.out.println("刪除瞭賬戶");
	return "success";
}

jsp代碼塊：

<a href="account/removeAccount?accountName=aaa&money>100" rel="external nofollow" >刪除賬戶，金額 100</a>
<a href="account/removeAccount?accountName=aaa&money>150" rel="external nofollow" >刪除賬戶，金額 150</a>

註意：

當我們點擊第一個超鏈接時,可以訪問成功。

當我們點擊第二個超鏈接時，無法訪問。

如下圖：

在這裡插入圖片描述

支持REST風格的參數： 代表性狀態傳輸 (REST) 是一種用於分佈式超媒體系統（如萬維網）的體系結構樣式。 (以下測試代碼與@PathVariable聯用)

控制器代碼塊：

    @RequestMapping(value = "/testRequestMapping/{Id}")
    public String testRequestMapping(@PathVariable String Id){
        System.out.println("testRequestMapping執行瞭"+Id);
        return "success";
    }

jsp前端代碼塊

<a href="account/testRequestMapping/21" rel="external nofollow" >@RequestMapping測試</a>

@RequestMapping註解的六個屬性詳解

RequestMapping是一個用來處理請求地址映射的註解，可用於類或方法上。用於類上，表示類中的所有響應請求的方法都是以該地址作為父路徑。

RequestMapping註解有六個屬性

下面分成三類進行說明

value， method

  • value：指定請求的實際地址，指定的地址可以是具體地址、可以RestFul動態獲取、也可以使用正則設置；
  • method：指定請求的method類型， 分為GET、POST、PUT、DELETE等；

consumes，produces

  • consumes：指定處理請求的提交內容類型（Content-Type），例如application/json, text/html;
  • produces：指定返回的內容類型，僅當request請求頭中的(Accept)類型中包含該指定類型才返回；

params，headers

  • params：指定request中必須包含某些參數值是，才讓該方法處理。
  • headers：指定request中必須包含某些指定的header值，才能讓該方法處理請求。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：