@RequestBody และคำอธิบายประกอบ @ResponseBody ใน Spring

ใครสามารถอธิบาย@RequestBodyและ@ResponseBodyบันทึกย่อใน Spring 3 ได้ไหม สิ่งที่พวกเขาสำหรับ? ตัวอย่างใด ๆ ก็จะดี

มีส่วนทั้งในเอกสารที่เรียกว่า16.3.3.4 แมปร่างกายคำขอกับคำอธิบายประกอบ และเป็นหนึ่งเรียกว่า16.3.3.5 การทำแผนที่การตอบสนองของร่างกายที่มีคำอธิบายประกอบ ฉันขอแนะนำให้คุณศึกษาหัวข้อเหล่านั้น ที่เกี่ยวข้องเพิ่มเติม: @RequestBodyjavadocs, @ResponseBodyjavadocs

ตัวอย่างการใช้งานจะเป็นดังนี้:

ใช้ JavaScript-library เช่น JQuery คุณจะโพสต์ JSON-Object เช่นนี้:

{ "firstName" : "Elmer", "lastName" : "Fudd" }

วิธีการควบคุมของคุณจะมีลักษณะเช่นนี้:

// controller
@ResponseBody @RequestMapping("/description")
public Description getDescription(@RequestBody UserStats stats){
    return new Description(stats.getFirstName() + " " + stats.getLastname() + " hates wacky wabbits");
}

// domain / value objects
public class UserStats{
    private String firstName;
    private String lastName;
    // + getters, setters
}
public class Description{
    private String description;
    // + getters, setters, constructor
}

ตอนนี้ถ้าคุณมีแจ็คสันบน classpath ของคุณ (และมีการ<mvc:annotation-driven>ตั้งค่า) สปริงจะแปลง JSON ขาเข้าเป็นวัตถุ UserStats จากโพสต์เนื้อความ (เพราะคุณเพิ่ม@RequestBodyคำอธิบายประกอบ) และมันจะทำให้วัตถุที่ส่งคืนเป็น JSON เป็นลำดับ@ResponseBodyคำอธิบายประกอบ) ดังนั้นเบราว์เซอร์ / ไคลเอ็นต์จะเห็นผลลัพธ์ JSON นี้:

{ "description" : "Elmer Fudd hates wacky wabbits" }

ดูคำตอบก่อนหน้านี้ของฉันสำหรับตัวอย่างการทำงานที่สมบูรณ์: https://stackoverflow.com/a/5908632/342852

หมายเหตุ: RequestBody / ResponseBody แน่นอนว่าไม่ จำกัด JSON ซึ่งทั้งคู่สามารถจัดการได้หลายรูปแบบรวมถึงข้อความธรรมดาและ XML แต่ JSON อาจเป็นรูปแบบที่ใช้มากที่สุด

ปรับปรุง

ตั้งแต่ Spring 4.x คุณมักจะไม่ใช้@ResponseBodyในระดับวิธี แต่จะใช้@RestControllerในระดับชั้นเรียนโดยมีเอฟเฟกต์แบบเดียวกัน

นี่คือข้อความจากเอกสารอย่างเป็นทางการของSpring MVC :

@RestControllerเป็นคำอธิบายประกอบประกอบด้วยว่าเป็นตัวเองMeta-ข้อเขียน ด้วย@Controllerและ@ResponseBodyเพื่อระบุตัวควบคุมที่มีทุกวิธีสืบทอดประเภทระดับ@ResponseBodyคำอธิบายประกอบและจึงเขียนโดยตรงกับร่างกายตอบสนองกับความละเอียดของการแสดงผลและมุมมองที่มีแม่แบบ HTML

@RequestBody : คำอธิบายประกอบที่ระบุว่าพารามิเตอร์ method ควรจะถูกผูกไว้กับเนื้อความของคำขอ HTTP

ตัวอย่างเช่น:

@RequestMapping(path = "/something", method = RequestMethod.PUT)
public void handle(@RequestBody String body, Writer writer) throws IOException {
    writer.write(body);
}

สามารถใส่คำอธิบายประกอบ @ResponseBodyบนเมธอดและระบุว่าชนิดการส่งคืนควรถูกเขียนไปยังเนื้อความการตอบกลับ HTTP โดยตรง (และไม่ได้อยู่ในโมเดลหรือตีความเป็นชื่อมุมมอง)

ตัวอย่างเช่น:

@RequestMapping(path = "/something", method = RequestMethod.PUT)
public  @ResponseBody String helloWorld() {
    return "Hello World";
}  

หรือเราสามารถใช้คำอธิบายประกอบ@RestControllerแทนการ@Controllerเพิ่มความคิดเห็น @ResponseBodyนี้จะลบจำเป็นที่จะต้องใช้

สำหรับรายละเอียดเพิ่มเติม

ด้านล่างเป็นตัวอย่างของวิธีการในตัวควบคุม Java

@RequestMapping(method = RequestMethod.POST)
@ResponseBody
public HttpStatus something(@RequestBody MyModel myModel) 
{
    return HttpStatus.OK;
}

โดยการใช้คำอธิบายประกอบ @RequestBody คุณจะได้รับค่าของคุณแมปกับรุ่นที่คุณสร้างขึ้นในระบบของคุณสำหรับการจัดการการโทรเฉพาะใด ๆ ในขณะที่ใช้ @ResponseBody คุณสามารถส่งอะไรกลับไปยังสถานที่ที่มีการสร้างคำขอ ทั้งสองสิ่งจะถูกแมปอย่างง่ายดายโดยไม่ต้องเขียนโปรแกรมวิเคราะห์คำที่กำหนดเองใด ๆ

package com.programmingfree.springshop.controller;

import java.util.List;

import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.programmingfree.springshop.dao.UserShop;
import com.programmingfree.springshop.domain.User;


@RestController
@RequestMapping("/shop/user")
public class SpringShopController {

 UserShop userShop=new UserShop();

 @RequestMapping(value = "/{id}", method = RequestMethod.GET,headers="Accept=application/json")
 public User getUser(@PathVariable int id) {
  User user=userShop.getUserById(id);
  return user;
 }


 @RequestMapping(method = RequestMethod.GET,headers="Accept=application/json")
 public List<User> getAllUsers() {
  List<User> users=userShop.getAllUsers();
  return users;
 }


}

ในตัวอย่างข้างต้นพวกเขาจะแสดงรายละเอียดผู้ใช้และรหัสเฉพาะตอนนี้ฉันต้องการใช้ทั้ง id และชื่อ

1) localhost: 8093 / plejson / ร้านค้า / ผู้ใช้ <--- ลิงค์นี้จะแสดงรายละเอียดผู้ใช้ทั้งหมด
2) localhost: 8093 / plejson / shop / user / 11 <---- ถ้าฉันใช้ 11 ในลิงค์หมายความว่ามันจะ แสดงรายละเอียดเฉพาะผู้ใช้ 11 คน

ตอนนี้ฉันต้องการใช้ทั้ง id และชื่อ

localhost: 8093 / plejson / shop / user / 11 / raju <----------------- แบบนี้มันหมายความว่าเราสามารถใช้อันใดอันหนึ่งในนี้ได้โปรดช่วยฉันด้วย .... .