小村村长

导航

ResponseEntity 理解

查看ResponseEntity源码,我们发现是它一种泛型类型。

public class ResponseEntity<T> extends HttpEntity<T> {

	private final Object status;

	/**
	 * Create a {@code ResponseEntity} with a status code only.
	 * @param status the status code
	 */
	public ResponseEntity(HttpStatus status) {
		this(null, null, status);
	}
}

因此,我们可以使用任何类型作为响应主体:

@Controller
public class XXXController{

 @GetMapping("/hello")
 public ResponseEntity<String> hello() {
   return new ResponseEntity<>("Hello World!", HttpStatus.OK);
}

这里字符串"Hello World!"作为字符串返回给REST端。
我们还可以设置响应标头

@GetMapping("/customHeader")
ResponseEntity<String> customHeader() {
   HttpHeaders headers = new HttpHeaders();
   headers.add("Custom-Header", "foo");

   return new ResponseEntity<>(
         "Custom header set", headers, HttpStatus.OK);
}

设置自定义标头:

@GetMapping("/customHeader")
ResponseEntity<String> customHeader() {
   return ResponseEntity.ok()
         .header("Custom-Header", "foo")
         .body("Custom header set")

如果将一个对象放入,自动返回一个json字符串:

@GetMapping("/hello")
 public ResponseEntity<String> hello() {
   return new ResponseEntity<>(new User(‘jdon’), HttpStatus.OK);
 }

[ { ‘name’: 'jdon'}]

当然,也可以返回json列表:

public ResponseEntity<List<ProcessDef>> repositoryProcessDefinitionsGet() {
   return new ResponseEntity<>(processDefRepo.findAll(), HttpStatus.FOUND);
}

常用 ResponseEntity 状态:

ResponseEntity.badRequest().build();   //400: 参数不合法
ResponseEntity.notFound().build();     //404:资源服务器找不到
ResponseEntity.ok(categories);         //200:查询成功

参考:https://www.jianshu.com/p/2a843c93af29
https://www.jianshu.com/p/7893169a7c93

posted on 2022-05-01 23:47  小村村长  阅读(193)  评论(0编辑  收藏  举报