快捷導(dǎo)航

Springboot請求和響應(yīng)相關(guān)注解及使用場景分析

更新時間：2025年12月09日 11:26:56 作者：辭暮爾爾-煙火年年

本文介紹了SpringBoot中用于處理HTTP請求和構(gòu)建HTTP響應(yīng)的常用注解,包括@RequestMapping、@RequestParam、@PathVariable等請求處理注解,本文結(jié)合實例代碼給大家介紹的非常詳細,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友參考下吧

1. 請求處理注解

@RequestMapping

描述: 用于映射HTTP請求到處理方法上。
使用場景: 可以用于類級別和方法級別，適用于所有HTTP方法（GET, POST, PUT, DELETE等）。
示例:

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

@GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping

描述: 這些是 @RequestMapping 的快捷形式，用于特定的HTTP方法。
使用場景: 用于簡化請求映射。
示例:

@RestController
@RequestMapping("/api")
public class MyController {
    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, World!";
    }
    @PostMapping("/create")
    public String createItem(@RequestBody Item item) {
        return "Item created";
    }
}

@RequestParam

描述: 用于將HTTP請求參數(shù)綁定到方法參數(shù)上。
使用場景: 處理查詢參數(shù)。
示例:

@GetMapping("/greet")
public String greet(@RequestParam(name = "name", defaultValue = "World") String name) {
    return "Hello, " + name;
}

@PathVariable

描述: 用于將URI模板變量綁定到方法參數(shù)上。
使用場景: 處理路徑參數(shù)。
示例:

@GetMapping("/items/{id}")
public Item getItem(@PathVariable("id") Long id) {
    // Logic to fetch item by id
    return item;
}

@RequestBody

描述: 用于將HTTP請求體綁定到方法參數(shù)上，并使用HttpMessageConverter進行反序列化。
使用場景: 處理請求體中的JSON或XML數(shù)據(jù)。
示例:

@PostMapping("/items")
public Item createItem(@RequestBody Item item) {
    // Logic to create item
    return item;
}

@RequestHeader

描述: 將HTTP請求頭中的某個值綁定到方法參數(shù)上。
使用場景: 讀取特定請求頭信息。
示例:

@GetMapping("/user-agent")
public String getUserAgent(@RequestHeader("User-Agent") String userAgent) {
    return "User-Agent: " + userAgent;
}

2. 響應(yīng)處理注解

@ResponseBody

描述: 將方法返回值綁定到HTTP響應(yīng)體上，并使用HttpMessageConverter進行序列化。
使用場景: 直接返回JSON或XML格式的數(shù)據(jù)。
示例:

@GetMapping("/items/{id}")
@ResponseBody
public Item getItem(@PathVariable("id") Long id) {
    // Logic to fetch item by id
    return item;
}

@RestController

描述: 組合注解，相當(dāng)于@Controller和@ResponseBody的結(jié)合，所有方法默認(rèn)返回JSON或XML格式的數(shù)據(jù)。
使用場景: 用于標(biāo)記RESTful控制器。
示例:

@RestController
@RequestMapping("/api")
public class MyController {
    @GetMapping("/items/{id}")
    public Item getItem(@PathVariable("id") Long id) {
        return item;
    }
}

@ResponseStatus

描述: 用于設(shè)置HTTP響應(yīng)狀態(tài)碼。
使用場景: 將特定的狀態(tài)碼返回到客戶端。
示例:

@PostMapping("/items")
@ResponseStatus(HttpStatus.CREATED)
public Item createItem(@RequestBody Item item) {
    return item;
}

3. 異常處理注解

@ExceptionHandler

描述: 用于處理特定的異常，并返回自定義的響應(yīng)。
使用場景: 處理控制器中的異常。
示例:

@RestController
@RequestMapping("/api")
public class MyController {
    @GetMapping("/items/{id}")
    public Item getItem(@PathVariable("id") Long id) {
        if (id == null) {
            throw new ItemNotFoundException("Item not found");
        }
        return item;
    }
    @ExceptionHandler(ItemNotFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public String handleItemNotFoundException(ItemNotFoundException ex) {
        return ex.getMessage();
    }
}

4. CORS支持

@CrossOrigin

描述: 用于啟用跨域資源共享（CORS）。
使用場景: 允許跨域請求。
示例:

@RestController
@RequestMapping("/api")
@CrossOrigin(origins = "http://example.com")
public class MyController {
    @GetMapping("/items/{id}")
    public Item getItem(@PathVariable("id") Long id) {
        return item;
    }
}

5. 其他相關(guān)注解

@RequestAttribute

描述: 將請求范圍內(nèi)的屬性綁定到方法參數(shù)上。
使用場景: 處理在請求處理過程中設(shè)置的屬性。
示例:

@GetMapping("/attributes")
public String getAttribute(@RequestAttribute("myAttribute") String myAttribute) {
    return "Attribute: " + myAttribute;
}

@Valid

描述: 用于驗證請求體中的對象。
使用場景: 對輸入數(shù)據(jù)進行驗證。
示例:

@PostMapping("/items")
public Item createItem(@Valid @RequestBody Item item) {
    return item;
}

這些注解為Spring Boot提供了強大的請求和響應(yīng)處理能力，幫助開發(fā)者輕松創(chuàng)建RESTful風(fēng)格的API。通過合理使用這些注解，可以使代碼更加清晰和易于維護。

到此這篇關(guān)于Springboot請求和響應(yīng)相關(guān)注解及使用場景的文章就介紹到這了,更多相關(guān)Springboot請求和響應(yīng)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线