用 Spring @ResponseBody & ResponseEntity 整合 JSONP

最新推荐文章于 2025-05-26 19:00:00 发布

转载最新推荐文章于 2025-05-26 19:00:00 发布 · 401 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://www.jianshu.com/p/454b695c263e

springmvc 专栏收录该内容

4 篇文章

订阅专栏

本文详细介绍了如何在Spring REST应用中整合@ResponseBody和ResponseEntity，同时演示了如何使用JSONP解决跨域问题。通过具体实例，包括实现AbstractJsonpResponseBodyAdvice抽象类、创建POJO类和响应JSONP的服务类，展示了JSONP响应格式的实现过程。

这篇文章主要展示了如何用 Spring REST 整合 @ResponseBody 和 ResponseEntity，以及 JSONP。JSONP文本格式由JSON填充，通常需解决跨域交互时才会用到它。

如果我们这样发送请求：

http://localhost:8080/book1?callback=myfunction

预期的JSONP响应应该是这样：

myfunction({"bookName":"Godan","writer":"Premchand"});

当我们在不同域时，可以这样使用：

值得注意的是，前端若想在接收响应后执行某些操作，那需要有名叫myfunction的函数。在Spring里，我们可以简单的让类实现AbstractJsonpResponseBodyAdvice抽象类并为实现类添加注解@ControllerAdvice

JsonpAdvice.java

@ControllerAdvice
public class JsonpAdvice extends AbstractJsonpResponseBodyAdvice {
     public JsonpAdvice() {
       super("callback"); 
     } 
}

以上构造器中，我们调用了父类的构造器并为其传入了Key，该Key主要用于规范前端请求时若带有callback=xxxx参数，将自动转换为JSONP响应格式。

我们先创建一个简单的 POJO

public class Book { 
 private String bookName;  
 private String writer; 
 public String getBookName() {
  return bookName; 
 } 
 public void setBookName(String bookName) { 
  this.bookName = bookName; 
  } 
 public String getWriter() {
  return writer; 
 } 
 public void setWriter(String writer) { 
  this.writer = writer;
 } 
}

再创建一个类用作响应 JSONP：BookService.java

@RestController 
class BookService {
 @RequestMapping(value= "/book1", produces = MediaType.APPLICATION_JSON_VALUE) 
 Book bookInfo1() {
  Book book = new Book(); 
  book.setBookName("Godan"); 
  book.setWriter("Premchand");
  return book; 
 } 
}

现在当我们在浏览器提交 http://localhost:8080/book1?callback=functionCall后应该会得到如下响应：

functionCall({"bookName":"Godan","writer":"Premchand"});

我们为以上的类添加了@RestController 控制器，她将应用于整个类。有时我们需要用到 @ResponseBody 和 ResponseEntity，用起来其实都一样。

@Controller
class BookController {
 @RequestMapping(value ="/book2", produces =MediaType.APPLICATION_JSON_VALUE ) 
 @ResponseBody 
 Book bookInfo2() { 
  Book book = new Book(); 
  book.setBookName("Ramcharitmanas");
  book.setWriter("TulasiDas"); 
  return book; 
 }
 @RequestMapping(value ="/book3", produces =MediaType.APPLICATION_JSON_VALUE ) 
 public ResponseEntity<Book> bookInfo3() { 
  Book book = new Book(); 
  book.setBookName("Ramayan");
  book.setWriter("Valmiki"); 
  return ResponseEntity.accepted().body(book); 
 } 
}

现在请求 http://localhost:8080/book2?callback=functionCall 你应该会得到如下反馈：

functionCall({"bookName":"Ramcharitmanas","writer":"TulasiDas"});

当请求 http://localhost:8080/book3?callback=functionCall 时：

functionCall({"bookName":"Ramayan","writer":"Valmiki"});