快捷導(dǎo)航

Springmvc常用的注解代碼示例

更新時間：2025年11月24日 11:34:37 作者：小王不愛笑132

本文介紹了SpringMVC中常用的控制器和請求映射注解,包括@Controller、@RequestMapping等,以及請求參數(shù)綁定注解,如@RequestParam、@RequestBody等,本文結(jié)合實例代碼給大家介紹的非常詳細,感興趣的朋友一起看看吧

一、控制器與請求映射注解

1. @Controller

作用：標識當(dāng)前類為 SpringMVC 控制器，由 Spring 容器自動掃描管理。
代碼示例：

@Controller // 標識此類為控制器
@RequestMapping("/user")
public class UserController {
    // 控制器方法...
}

講解：需配合配合 Spring 配置文件中開啟組件掃描（<context:component-scan base-package="com.qcby"/>），否則才能使注解生效。

2. @RequestMapping

作用：映射請求 URL 與控制器方法的對應(yīng)關(guān)系，可標注在類或方法上。
代碼示例：

@Controller
@RequestMapping("/user") // 類級路徑（基礎(chǔ)路徑）
public class UserController {
    // 方法級路徑，完整 URL 為 /user/save
    @RequestMapping(
        value = "/save", 
        method = RequestMethod.POST, // 限制請求方式為 POST
        params = "username" // 要求請求必須攜帶 username 參數(shù)
    )
    public String save() {
        System.out.println("用戶保存成功");
        return "success";
    }
}

講解：
- 類級注解 + 方法級注解組合成完整請求路徑（如 /user/save）。
- method 屬性指定允許的請求方式（GET/POST 等），不指定則允許所有方式。
- params 屬性用于校驗請求參數(shù)，確保請求攜帶指定參數(shù)。

二、請求參數(shù)綁定注解

1. @RequestParam

作用：解決請求參數(shù)名與方法參數(shù)名不一致的問題，強制綁定參數(shù)。
代碼示例：

@RequestMapping("/find")
public String find(
    @RequestParam(
        value = "name", // 映射請求參數(shù)名（前端傳遞的參數(shù)名為 name）
        required = false, // 非必須傳遞，默認值為 true
        defaultValue = "guest" // 無參數(shù)時的默認值
    ) String username
) {
    System.out.println("用戶名：" + username);
    return "success";
}

講解：若前端傳遞參數(shù)為 name=張三，通過 @RequestParam 可映射到方法參數(shù) username。

2. @RequestBody

作用：獲取請求體中的原始數(shù)據(jù)（如 JSON、XML 或表單數(shù)據(jù)），適用于 POST 請求。
代碼示例：

@RequestMapping("/getBody")
public String getBody(@RequestBody String requestBody) {
    System.out.println("請求體內(nèi)容：" + requestBody); // 輸出原始請求數(shù)據(jù)
    return "success";
}

講解：常用于接收前端發(fā)送的 JSON 數(shù)據(jù)（需配合 Jackson 等 JSON 解析依賴），直接獲取字符串形式的請求體。

3. @RequestHeader

作用：獲取 HTTP 請求頭中的信息（如瀏覽器類型、Accept 格式等）。
代碼示例：

@RequestMapping("/getHeader")
public String getHeader(@RequestHeader("User-Agent") String userAgent) {
    System.out.println("瀏覽器信息：" + userAgent); // 輸出瀏覽器類型信息
    return "success";
}

講解：通過參數(shù) value 指定請求頭名稱，可獲取客戶端的環(huán)境信息。

4. @CookieValue

作用：獲取請求中攜帶的 Cookie 值（如 JSESSIONID）。
代碼示例：

@RequestMapping("/getCookie")
public String getCookie(@CookieValue("JSESSIONID") String sessionId) {
    System.out.println("會話 ID：" + sessionId); // 輸出當(dāng)前會話的 JSESSIONID
    return "success";
}

講解：用于獲取客戶端存儲的 Cookie 數(shù)據(jù)，常用于會話跟蹤。

5. @DateTimeFormat

作用：指定日期類型參數(shù)的解析格式，解決字符串與 Date 類型的轉(zhuǎn)換問題。
代碼示例：

public class User {
    private String username;
    // 指定日期格式為 yyyy-MM-dd HH:mm:ss
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date birthday;
    // getter/setter 省略
}

控制器方法：

@RequestMapping("/saveUser")
public String saveUser(User user) {
    System.out.println("生日：" + user.getBirthday()); // 自動轉(zhuǎn)換為 Date 類型
    return "success";
}

講解：前端傳遞 birthday=2023-10-01 12:00:00 時，會自動解析為 Date 對象。

三、其他常用注解（擴展）

1. @PathVariable（REST 風(fēng)格）

作用：獲取 URL 路徑中的參數(shù)（適用于 RESTful 接口）。
代碼示例：

@RequestMapping("/user/{id}")
public String getUserById(@PathVariable("id") Integer userId) {
    System.out.println("用戶 ID：" + userId); // 獲取路徑中的 id 參數(shù)
    return "success";
}

講解：請求 URL 為 /user/100 時，userId 會被賦值為 100。

2. @ResponseBody

作用：將方法返回值直接作為響應(yīng)體返回（而非跳轉(zhuǎn)視圖），常用于 AJAX 請求。
代碼示例：

@RequestMapping("/getJson")
@ResponseBody // 返回 JSON 數(shù)據(jù)，而非視圖
public User getJson() {
    User user = new User();
    user.setUsername("張三");
    return user; // 需配合 Jackson 依賴，自動轉(zhuǎn)換為 JSON
}

講解：需在 Spring 配置文件中開啟 <mvc:annotation-driven/> 以支持 JSON 轉(zhuǎn)換。

四、注解使用注意事項

路徑?jīng)_突：@RequestMapping 標注的路徑需唯一，避免不同方法映射同一 URL。
參數(shù)校驗：@RequestParam 的 required=true 時，若前端未傳參數(shù)會拋出異常，需注意處理。
日期轉(zhuǎn)換優(yōu)先級：自定義類型轉(zhuǎn)換器（實現(xiàn) Converter 接口）優(yōu)先級高于 @DateTimeFormat。
配置支持：所有注解需在 Spring 配置文件中開啟 <mvc:annotation-driven/> 才能生效（自動注冊處理器映射器和適配器）。