SpringMVC中的常用注解和用法舉例詳解

更新時(shí)間：2024年08月23日 11:01:28 作者：深魚(yú)~

在Spring和SpringMVC中,注解的使用大大簡(jiǎn)化了配置,提高了代碼的可讀性和可維護(hù)性,這篇文章主要給大家介紹了關(guān)于SpringMVC中常用注解和用法的相關(guān)資料,需要的朋友可以參考下

前言：

MVC是?種架構(gòu)設(shè)計(jì)模式,也?種思想,?SpringMVC是對(duì)MVC思想的具體實(shí)現(xiàn).除此之外,Spring MVC還是?個(gè)Web框架.

總結(jié)來(lái)說(shuō)，Spring MVC是?個(gè)實(shí)現(xiàn)了MVC模式的We框架

1.@RequestMapping

@RequestMapping 是Spring Web MVC應(yīng)?程序中最常被?到的注解之?，它是?來(lái)注冊(cè)接?的路由映射的

路由映射:當(dāng)??訪(fǎng)問(wèn)?個(gè)URL時(shí),將??的請(qǐng)求對(duì)應(yīng)到程序中某個(gè)類(lèi)的某個(gè)?法的過(guò)程就叫路由映射
@RequestMapping既可修飾類(lèi)，也可以修飾?法，當(dāng)修飾類(lèi)和?法時(shí)，訪(fǎng)問(wèn)的地址是類(lèi)路徑+?法路徑

@RequestMapping標(biāo)識(shí)?個(gè)類(lèi)：設(shè)置映射請(qǐng)求的請(qǐng)求路徑的初始信息

@RequestMapping標(biāo)識(shí)?個(gè)?法：設(shè)置映射請(qǐng)求請(qǐng)求路徑的具體信息

@RequestMapping("/user")
@RestController
public class UserController {
    @RequestMapping("/sayHi")
    public String sayHi(){
        return "hello,Spring MVC";
    }
}

訪(fǎng)問(wèn)地址：http://127.0.0.1:8080/user/sayHi

@RequestMapping 的URL路徑也可以是多層路徑,最終訪(fǎng)問(wèn)時(shí),依然是類(lèi)路徑+?法路徑

@RequestMapping("/user/m1")
@RestController
public class UserController {
    @RequestMapping("/say/hi")
    public String sayHi(){
        return "hello,Spring MVC";
    }
}

訪(fǎng)問(wèn)路徑:http://127.0.0.1:8080/user/m1/say/hi

2.@RequestParam

用于將請(qǐng)求參數(shù)綁定到方法參數(shù)上（后端參數(shù)重命名，傳遞集合等）

@Controller
public class MyController {
 
    @RequestMapping("/greet")
    public String greet(@RequestParam("name") String name) {
        // Method logic using name parameter
        return "greetPage";
    }
}

使用@RequestParam 注解的方法參數(shù)默認(rèn)為必填參數(shù)

可以使用 required 屬性將@RequestParam配置為可選參數(shù)：

@Controller
public class MyController {
 
    @RequestMapping("/greet")
    public String greet(@RequestParam(value = "name2", required = false) String name) {
        // Method logic using name parameter
        return "greetPage";
    }
}

3.@RequestBody

用于將 HTTP 請(qǐng)求體中的數(shù)據(jù)綁定到控制器方法的參數(shù)上，即獲取 POST 請(qǐng)求中的數(shù)據(jù)并映射到方法參數(shù)。它通常用于處理 JSON 或 XML 格式的請(qǐng)求體數(shù)據(jù)

@Controller
@RequestMapping("/example")
public class ExampleController {

    @RequestMapping(value = "/addUser", method = RequestMethod.POST)
    @ResponseBody
    public String addUser(@RequestBody User user) {
        // 處理用戶(hù)數(shù)據(jù)
        return "User added successfully!";
    }
}

在上述示例代碼中，@RequestBody 用于將 HTTP 請(qǐng)求體中的數(shù)據(jù)轉(zhuǎn)換成 User 對(duì)象，并將其作為參數(shù)傳遞給 addUser() 方法進(jìn)行處理

4.@PathVariable

path variable:路徑變量

和字?表達(dá)的意思?樣,這個(gè)注解主要作?在請(qǐng)求URL路徑上的數(shù)據(jù)綁定，默認(rèn)傳遞參數(shù)寫(xiě)在URL上，SpringMVC就可以獲取到

@RequestMapping("/m8/{id}/{name}")
public String method8(@PathVariable Integer id, @PathVariable("name") String
userName){
    return "解析參數(shù)id:"+id+",name:"+userName;
}

使?瀏覽器發(fā)送請(qǐng)求:http://127.0.0.1:8080/param/m8/5/zhangsan

5.@RestController（返回頁(yè)面）

其方法的返回值會(huì)被直接寫(xiě)入 HTTP 響應(yīng)體中，而不是被視圖解析器解析為視圖。通常返回的是 JSON 或 XML 數(shù)據(jù)

@RestController
@RequestMapping("/example")
public class ExampleController {

    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public String hello() {
        return "Hello, World!";
    }
}

6.@Controller（返回視圖）

在方法中直接返回對(duì)象時(shí)，Spring MVC 會(huì)將其作為模型數(shù)據(jù)傳遞給視圖解析器，然后解析為具體的視圖

@Controller
public class MyController {
 
    @RequestMapping("/hello")
    public String hello() {
        return "hello.html";
    }
    //返回html頁(yè)面
}

當(dāng)在類(lèi)注解中加上 @ResponseBody 時(shí)，返回的為數(shù)據(jù)而不是頁(yè)面

@RestController=@Controller （返回視圖）+ @ResponseBody(返回?cái)?shù)據(jù)）

@Controller
public class MyController {
 
    @ResponseBody 
    @RequestMapping("/hello")
    public String hello() {
        return "hello";
    }
    //返回“hello”這個(gè)字符串
}

7.@CookieValue

簡(jiǎn)潔獲取Cookie （一次只能獲取一次cookie信息）

@RequestMapping("/getCookie")
public String cookie(@CookieValue("bite") String bite) {
    return "bite：" + bite;
}

8.@SessionAttribute

@SessionAttributes 注解用于指定哪些模型屬性需要存儲(chǔ)在會(huì)話(huà)中

@RequestMapping("/getSess2")
public String sess2(@SessionAttribute(value = "username",required = false)
String username) {
    return "username："+username;
}