【SpringMVC】@RequestMapping註解

gonghr發表於2021-08-27
SpringMVCAPP

@RequestMapping註解的原始碼

@Target({ElementType.TYPE, ElementType.METHOD})
@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 {};
}

@RequestMapping註解的功能

@RequestMapping註解的作用就是將請求和處理請求的控制器方法關聯起來，建立對映關係。

SpringMVC 接收到指定的請求，就會來找到在對映關係中對應的控制器方法來處理這個請求。
該註解可以標識在類和方法上。

@RequestMapping註解的位置

@RequestMapping標識一個類：設定對映請求的請求路徑的初始資訊

@RequestMapping標識一個方法：設定對映請求請求路徑的具體資訊

如果有請求路徑的初始資訊，則先設定請求路徑的初始資訊才能設定請求路徑的具體資訊。

比如，想從index的超連結跳轉到welcome頁面：

index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首頁</title>
</head>
<body>
    <h1>首頁</h1>
    <a th:href="@{/testRequestMapping}">訪問welcome頁面 </a>
</body>
</html>

index的超連結跳轉的路徑是/testRequestMapping

welcome.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>welcome</title>
</head>
<body>
<h1>Welcome to My Blog</h1>
</body>
</html>

在welcome的控制器的類和方法上都加上RequestMapping註解

@Controller
@RequestMapping("/hello")
public class RequestMappingController {

    @RequestMapping("/testRequestMapping")
    public String welcome(){
        return "welcome";
    }
}

結果就是跳轉失敗
image

如果修改跳轉路徑為/hello/testRequestMapping，即可成功

<a th:href="@{/hello/testRequestMapping}">訪問welcome頁面 </a>

image

@RequestMapping註解的value屬性

@RequestMapping註解的value屬性通過請求的請求地址匹配請求對映

@RequestMapping註解的value屬性是一個字串型別的陣列，表示該請求對映能夠匹配多個請求地址所對應的請求

@RequestMapping註解的value屬性必須設定，至少通過請求地址匹配請求對映

index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首頁</title>
</head>
<body>
    <h1>首頁</h1>
    <a th:href="@{/testRequestMapping}">通過/testRequestMapping訪問welcome頁面 </a>
    <br>
    <a th:href="@{/test}">通過/test訪問welcome頁面 </a>
</body>
</html>

@Controller
public class RequestMappingController {

    @RequestMapping(value = {"/testRequestMapping","/test"})
    public String welcome(){
        return "welcome";
    }
}

image

兩個超連線都可訪問成功

@RequestMapping註解的method屬性

@RequestMapping註解的method屬性通過請求的請求方式（get或post）匹配請求對映

@RequestMapping註解的method屬性是一個RequestMethod型別的陣列，表示該請求對映能夠匹配多種請求方式的請求

若當前請求的請求地址滿足請求對映的value屬性，但是請求方式不滿足method屬性，則瀏覽器報錯405：Request method 'POST' not supported

index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首頁</title>
</head>
<body>
    <form th:action="@{/test}" method="post">
        <input type="submit" value="以post方式提交">
    </form>
    <br>
    <form th:action="@{/test}" method="get">
        <input type="submit" value="以get方式提交">
    </form>
</body>
</html>

welcome.html的控制器

    @RequestMapping(value = "/test",
    method = {RequestMethod.GET})
    public String welcome(){
        return "welcome";
    }

如果不設定控制器的method，則index的post和get兩種方式都可以訪問welcome.html

如果設定控制器的method為RequestMethod.GET，則只能用get方式訪問

以post方式訪問：

image

以get方式訪問：

image

對於處理指定請求方式的控制器方法，SpringMVC中提供了@RequestMapping的派生註解

處理get請求的對映-->@GetMapping

處理post請求的對映-->@PostMapping

處理put請求的對映-->@PutMapping

處理delete請求的對映-->@DeleteMapping

免去了設定method的麻煩，只寫對映路徑即可

    @GetMapping("/test")
    public String welcome(){
        return "welcome";
    }

常用的請求方式有get，post，put，delete

但是目前瀏覽器只支援get和post，若在form表單提交時，為method設定了其他請求方式的字串（put或delete），則按照預設的請求方式get處理

index.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首頁</title>
</head>
<body>
    <form th:action="@{/test}" method="put">
        <input type="submit" value="以put方式提交">
    </form>
    <br>
</body>
</html>

    @PostMapping("/test")
    public String welcome(){
        return "welcome";
    }

image

@RequestMapping註解的params屬性

@RequestMapping註解的params屬性通過請求的請求引數匹配請求對映

@RequestMapping註解的params屬性是一個字串型別的陣列，可以通過四種表示式設定請求引數和請求對映的匹配關係

"param"：要求請求對映所匹配的請求必須攜帶param請求引數

"!param"：要求請求對映所匹配的請求必須不能攜帶param請求引數

"param=value"：要求請求對映所匹配的請求必須攜帶param請求引數且param=value

"param!=value"：要求請求對映所匹配的請求必須攜帶param請求引數但是param!=value

<a th:href="@{/test(username='admin',password=123456)}">測試@RequestMapping的params屬性-->/test</a><br>

@RequestMapping(
        value = {"/testRequestMapping", "/test"}
        ,method = {RequestMethod.GET, RequestMethod.POST}
        ,params = {"username","password!=123456"}
)
public String testRequestMapping(){
    return "welcome";
}

image

@RequestMapping註解的headers屬性

@RequestMapping註解的headers屬性通過請求的請求頭資訊匹配請求對映

@RequestMapping註解的headers屬性是一個字串型別的陣列，可以通過四種表示式設定請求頭資訊和請求對映的匹配關係

"header"：要求請求對映所匹配的請求必須攜帶header請求頭資訊

"!header"：要求請求對映所匹配的請求必須不能攜帶header請求頭資訊

"header=value"：要求請求對映所匹配的請求必須攜帶header請求頭資訊且header=value

"header!=value"：要求請求對映所匹配的請求必須攜帶header請求頭資訊且header!=value

若當前請求滿足@RequestMapping註解的value和method屬性，但是不滿足headers屬性，此時頁面顯示404錯誤，即資源未找到

SpringMVC路徑的模糊匹配

？：表示任意的單個字元

    @RequestMapping(value = "/a?a/test")
    public String welcome(){
        return "welcome";
    }

*：表示任意的0個或多個字元

    @RequestMapping(value = "/a*a/test")
    public String welcome(){
        return "welcome";
    }

/**：表示任意的一層或多層目錄

    @RequestMapping(value = "/**/test")
    public String welcome(){
        return "welcome";
    }
  • 注意：

    • 在使用/**時，只能使用/**/xxx的方式

    • ?和*不可以用。 / ?來佔位

SpringMVC支援路徑中的佔位符（重點）

原始方式：/deleteUser?id=1

rest方式：/deleteUser/1

SpringMVC路徑中的佔位符常用於RESTful風格中，當請求路徑中將某些資料通過路徑的方式傳輸到伺服器中，就可以在相應的@RequestMapping註解的value屬性中通過佔位符{xxx}表示傳輸的資料，在通過@PathVariable註解，將佔位符所表示的資料賦值給控制器方法的形參

<a th:href="@{/testRest/1/admin}">測試路徑中的佔位符-->/testRest</a><br>

@RequestMapping("/testRest/{id}/{username}")
public String testRest(@PathVariable("id") String id, @PathVariable("username") String username){
    System.out.println("id:"+id+",username:"+username);
    return "success";
}
//最終輸出的內容為-->id:1,username:admin

相關文章