स्प्रिंग बूट में प्रतिक्रिया के रूप में JSON वस्तु लौटना

Question 1

मेरे पास स्प्रिंग बूट में एक नमूना RestController है:

@RestController
@RequestMapping("/api")
class MyRestController
{
    @GetMapping(path = "/hello")
    public JSONObject sayHello()
    {
        return new JSONObject("{'aa':'bb'}");
    }
}

मैं JSON लाइब्रेरी का उपयोग कर रहा हूं org.json

जब मैंने एपीआई को मारा /hello, तो मुझे एक अपवाद मिला:

सर्विसलेट [) सर्वलेट के लिए (dispatcherServlet] पथ के संदर्भ में [] अपवाद फेंक दिया [अनुरोध प्रसंस्करण विफल रहा; नेस्टेड अपवाद java.lang.IllegalArgumentException है: प्रकार के वापसी मूल्य के लिए कोई भी कनवर्टर नहीं मिला: मूल के साथ वर्ग org.json.JSONObject]

java.lang.IllegalArgumentException: कोई भी कनवर्टर प्रकार का वापसी मान नहीं मिला: class org.json.JSONObject

मामला क्या है? क्या कोई समझा सकता है कि वास्तव में क्या हो रहा है?

Question 2

जैसा कि आप स्प्रिंग बूट वेब का उपयोग कर रहे हैं, जैक्सन निर्भरता निहित है और हमें स्पष्ट रूप से परिभाषित करने की आवश्यकता नहीं है। यदि आप pom.xmlग्रहण का उपयोग कर रहे हैं तो आप निर्भरता पदानुक्रम टैब में अपने लिए जैक्सन निर्भरता की जांच कर सकते हैं ।

और जैसा कि आपने एनोटेट किया @RestControllerहै कि स्पष्ट जोंस रूपांतरण करने की आवश्यकता नहीं है। बस एक पीओजेओ और जैकसन सीरियलाइज़र को जोंस में बदलने का ख्याल रखेगा। यह @ResponseBody@Controller के साथ प्रयोग करने के बराबर है । @ResponseBodyप्रत्येक नियंत्रक पद्धति पर रखने के @RestControllerबजाय हम वेनिला के स्थान पर @Controllerऔर @ResponseBodyडिफ़ॉल्ट रूप से उस नियंत्रक के सभी संसाधनों पर लागू होते हैं।
इस लिंक को देखें: https://docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html#mvc-ann-responsebody

आपके द्वारा सामना की जा रही समस्या इसलिए है क्योंकि लौटी हुई वस्तु (JSONObject) में कुछ गुणों के लिए गटर नहीं है। और आपका इरादा इस JSONObject को अनुक्रमित करना नहीं है, बल्कि एक POJO को क्रमबद्ध करना है। तो बस POJO लौटाएं।
इस लिंक को देखें: https://stackoverflow.com/a/35822500/5039001

यदि आप एक जरीन क्रमबद्ध स्ट्रिंग वापस करना चाहते हैं, तो बस स्ट्रिंग वापस करें। स्प्रिंग इस मामले में JSON कनवर्टर के बजाय StringHttpMessageConverter का उपयोग करेगा।

Question 3

जैक्सन को डिफ़ॉल्ट रूप से क्रमबद्ध करने और ऑब्जेक्ट्स को डीसिएराइज़ करने के लिए उपयोग करने के कारण आपका वर्तमान दृष्टिकोण काम नहीं करता है। हालाँकि, यह पता नहीं है कि कैसे क्रमबद्ध करना है JSONObject। यदि आप एक गतिशील JSON संरचना बनाना चाहते हैं, तो आप Mapउदाहरण के लिए a का उपयोग कर सकते हैं :

@GetMapping
public Map<String, String> sayHello() {
    HashMap<String, String> map = new HashMap<>();
    map.put("key", "value");
    map.put("foo", "bar");
    map.put("aa", "bb");
    return map;
}

यह निम्नलिखित JSON प्रतिक्रिया की ओर ले जाएगा:

{ "key": "value", "foo": "bar", "aa": "bb" }

यह थोड़ा सीमित है, क्योंकि बाल वस्तुओं को जोड़ना थोड़ा और मुश्किल हो सकता है। जैक्सन का अपना तंत्र है, हालांकि, उपयोग ObjectNodeऔर ArrayNode। इसका उपयोग करने के लिए, आपको ObjectMapperअपनी सेवा / नियंत्रक में ऑटो करना होगा । तो आप का उपयोग कर सकते हैं:

@GetMapping
public ObjectNode sayHello() {
    ObjectNode objectNode = mapper.createObjectNode();
    objectNode.put("key", "value");
    objectNode.put("foo", "bar");
    objectNode.put("number", 42);
    return objectNode;
}

यह दृष्टिकोण आपको बाल वस्तुओं, सरणियों को जोड़ने और सभी विभिन्न प्रकारों का उपयोग करने की अनुमति देता है।

Question 4

आप या तो एक प्रतिक्रिया वापस कर सकते हैं Stringजैसा कि @vagaasen द्वारा सुझाया गया है या आप ResponseEntityनीचे दी गई स्प्रिंग द्वारा प्रदान की गई वस्तु का उपयोग कर सकते हैं । इस तरह से आप वापसी भी कर सकते हैं Http status codeजो कि वेबसर्विस कॉल में अधिक सहायक है।

@RestController
@RequestMapping("/api")
public class MyRestController
{

    @GetMapping(path = "/hello", produces=MediaType.APPLICATION_JSON_VALUE)
    public ResponseEntity<Object> sayHello()
    {
         //Get data from service layer into entityList.

        List<JSONObject> entities = new ArrayList<JSONObject>();
        for (Entity n : entityList) {
            JSONObject entity = new JSONObject();
            entity.put("aa", "bb");
            entities.add(entity);
        }
        return new ResponseEntity<Object>(entities, HttpStatus.OK);
    }
}

Question 5

आप इसके लिए हैशमैप का उपयोग भी कर सकते हैं

@GetMapping
public HashMap<String, Object> get() {
    HashMap<String, Object> map = new HashMap<>();
    map.put("key1", "value1");
    map.put("results", somePOJO);
    return map;
}

Question 6

@RequestMapping("/api/status")
public Map doSomething()
{
    return Collections.singletonMap("status", myService.doSomething());
}

पुनश्च। केवल 1 मान के लिए काम करता है

Question 7

उपयोग ResponseEntity<ResponseBean>

यहां आप रिस्पॉन्सबिन या किसी भी जावा बीन का उपयोग कर सकते हैं क्योंकि आप अपनी एपीआई प्रतिक्रिया वापस करना चाहते हैं और यह सबसे अच्छा अभ्यास है। मैंने प्रतिक्रिया के लिए Enum का उपयोग किया है। यह एपीआई का स्टेटस कोड और स्टेटस मैसेज लौटाएगा।

@GetMapping(path = "/login")
public ResponseEntity<ServiceStatus> restApiExample(HttpServletRequest request,
            HttpServletResponse response) {
        String username = request.getParameter("username");
        String password = request.getParameter("password");

        loginService.login(username, password, request);
        return new ResponseEntity<ServiceStatus>(ServiceStatus.LOGIN_SUCCESS,
                HttpStatus.ACCEPTED);
    }

प्रतिक्रिया के लिए ServiceStatus या (ResponseBody)

    public enum ServiceStatus {

    LOGIN_SUCCESS(0, "Login success"),

    private final int id;
    private final String message;

    //Enum constructor
    ServiceStatus(int id, String message) {
        this.id = id;
        this.message = message;
    }

    public int getId() {
        return id;
    }

    public String getMessage() {
        return message;
    }
}

प्रतिक्रिया में स्प्रिंग रेस्ट एपीआई की कुंजी नीचे होनी चाहिए

स्थिति का कोड
संदेश

आपको नीचे अंतिम प्रतिक्रिया मिलेगी

{

   "StatusCode" : "0",

   "Message":"Login success"

}

आप अपनी आवश्यकता के अनुसार रिस्पांसबॉडी (जावा पोजो, एनयूएम, आदि) का उपयोग कर सकते हैं।

Question 8

API प्रश्नों के लिए DTO को अधिक सही बनाएं, उदाहरण के लिए ,DDTO:

संस्थाओं की सूची के साथ डिफ़ॉल्ट प्रतिक्रिया ठीक है:

@GetMapping(produces=MediaType.APPLICATION_JSON_VALUE)
@ResponseStatus(HttpStatus.OK)
public List<EntityDto> getAll() {
    return entityService.getAllEntities();
}

लेकिन अगर आपको अलग-अलग मैप मापदंडों की ज़रूरत है, तो आप अगले दो उदाहरणों का उपयोग कर सकते हैं
। 2. रिटर्न के लिए एक पैरामीटर जैसे मानचित्र:

@GetMapping(produces=MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<Object> getOneParameterMap() {
    return ResponseEntity.status(HttpStatus.CREATED).body(
            Collections.singletonMap("key", "value"));
}

और अगर आपको कुछ मापदंडों का रिटर्न मैप चाहिए (जावा 9 के बाद से):

@GetMapping(produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<Object> getSomeParameters() {
    return ResponseEntity.status(HttpStatus.OK).body(Map.of(
            "key-1", "value-1",
            "key-2", "value-2",
            "key-3", "value-3"));
}

Question 9

यदि आपको स्ट्रिंग का उपयोग करके एक JSON ऑब्जेक्ट वापस करने की आवश्यकता है, तो निम्न कार्य करना चाहिए:

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.http.ResponseEntity;
...

@RestController
@RequestMapping("/student")
public class StudentController {

    @GetMapping
    @RequestMapping("/")
    public ResponseEntity<JsonNode> get() throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        JsonNode json = mapper.readTree("{\"id\": \"132\", \"name\": \"Alice\"}");
        return ResponseEntity.ok(json);
    }
    ...
}