使用ResponseEntity处理API返回问题

更新时间：2024年07月10日 16:24:40 作者：半城风花半城雨

这篇文章主要介绍了使用ResponseEntity处理API返回问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

ResponseEntity的使用

先上源码，看看ResponseEntity到底如何使用的。

1. ResponseEntity的第一种使用方式

public class ResponseEntity<T> extends HttpEntity<T> {
    public ResponseEntity(HttpStatus status) {
	    this((Object)null, (MultiValueMap)null, (HttpStatus)status);
	}
	
   public ResponseEntity(@Nullable T body, HttpStatus status) {
        this(body, (MultiValueMap)null, (HttpStatus)status);
    }
	
   public ResponseEntity(MultiValueMap<String, String> headers, HttpStatus status) {
        this((Object)null, headers, (HttpStatus)status);
    }
	
   public ResponseEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, HttpStatus status) {
        super(body, headers);
        Assert.notNull(status, "HttpStatus must not be null");
        this.status = status;
    }

   private ResponseEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, Object status) {
        super(body, headers);
        Assert.notNull(status, "HttpStatus must not be null");
        this.status = status;
    }
}

可以看到这个类提供了五个构造方法，返回的状态码是必传的外，头部信息以及响应体内容都是可选择的。

当我们需要使用的时候，直接new一个ResponseEntity对象作为API返回值即可，这就是它的第一种使用方式。

需要注意的是，在有headers作为参数的构造方法中，需要传入一个类型为MultiValueMap<String, String>的参数。

MultiValueMap继承自Map这个抽象类，其中拥有一个叫做HttpHeaders的子类，我们可以当它为一个key和value都为String类型的HashMap使用。

HttpHeaders里面保存了一些常用的Header的key值，例如"Accept-Charset"。当然也可以自定义一些特殊的key。

HttpHeaders headers = new HttpHeaders();
headers.add("Access-Control-Expose-Headers", "AMP-Access-Control-Allow-Source-Origin");

return new ResponseEntity<>(resultBody, headers, HttpStatus.OK);

2. ResponseEntity的第二种使用方式

继续看源码，发现了好多返回值为ResponseEntity.BodyBuilder的方法有木有

    public static ResponseEntity.BodyBuilder status(HttpStatus status) {
        Assert.notNull(status, "HttpStatus must not be null");
        return new ResponseEntity.DefaultBuilder(status);
    }

    public static ResponseEntity.BodyBuilder status(int status) {
        return new ResponseEntity.DefaultBuilder(status);
    }
        public static ResponseEntity.BodyBuilder ok() {
        return status(HttpStatus.OK);
    }
    public static ResponseEntity.BodyBuilder created(URI location) {
        ResponseEntity.BodyBuilder builder = status(HttpStatus.CREATED);
        return (ResponseEntity.BodyBuilder)builder.location(location);
    }

    public static ResponseEntity.BodyBuilder accepted() {
        return status(HttpStatus.ACCEPTED);
    }

    public static ResponseEntity.HeadersBuilder<?> noContent() {
        return status(HttpStatus.NO_CONTENT);
    }

    public static ResponseEntity.BodyBuilder badRequest() {
        return status(HttpStatus.BAD_REQUEST);
    }

    public static ResponseEntity.HeadersBuilder<?> notFound() {
        return status(HttpStatus.NOT_FOUND);
    }

    public static ResponseEntity.BodyBuilder unprocessableEntity() {
        return status(HttpStatus.UNPROCESSABLE_ENTITY);
    }
    .........

事实证明，越是伟大的软件工程师是越“懒惰”的，为了节约时间增加效率，我们可以用Builder的方式去生成ResponseEntity对象并返回：

Map<String, String> resultBody = new HashMap<>();
resultBody.put("name":"Lucas");
resultBody.put("school":"harvard university");
 return ResponseEntity.status(HttpStatus.OK)
        .body(resultBody);

与其他方式对比

@RestController注解修饰controller层。

@RestController = @Controller + @ResponseBody

@ResponseBody是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据。

注意：在使用此注解之后不会再走视图处理器（ModelAndView），而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。

@ResponseStatus

这个注解主要用在自定义的Exception 上，或者直接用在controller层的API方法上也可，当发生异常/方法执行结束时，会返回相应的Http状态码和msg。

@ResponseStatus(value=HttpStatus.FORBIDDEN,reason="不允许访问")

注：

ResponseEntity的优先级高于@ResponseBody。
只有在返回值不为ResponseEntity的情况下才去检查有没有@ResponseBody注解；如果响应类型是ResponseEntity则会忽略@ResponseBody注解。

总结

ResponseEntity能够非常方便的修改返回值的状态码，但最优秀的用法仍然是能够为不同API设置不同的返回响应头。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

java 注解默认值操作
这篇文章主要介绍了java 注解默认值操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-12-12
IDEA下载并大学生edu邮箱认证免费使用教程(图文)
这篇文章主要介绍了IDEA下载并大学生edu邮箱认证免费使用教程(图文)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-07-07
java HashMap的keyset实例
简单地说，在keyset方法返回的set上做修改会改变原来hashmap，这也许不是你想要的，于是形成一个隐藏的bug
2013-04-04
Java内部类详解
内部类在 Java 里面算是非常常见的一个功能了，在日常开发中我们肯定多多少少都用过，这里总结一下关于 Java 中内部类的相关知识点和一些使用内部类时需要注意的点。
2020-02-02
Spring Boot实现动态更新任务的方法
这篇文章主要介绍了Spring Boot实现动态更新任务的方法，文中给出了详细的示例代码供大家参考学习，对大家学习使用Spring Boot动态更新任务具有一定的参考价值，需要的朋友们来一起看看吧。
2017-04-04
Spring Boot + thymeleaf 实现文件上传下载功能
最近同事问我有没有有关于技术的电子书，我打开电脑上的小书库，但是邮件发给他太大了，公司又禁止用文件夹共享，于是花半天时间写了个小的文件上传程序，部署在自己的Linux机器上,需要的朋友可以参考下
2018-01-01
使用Java Socket实现GPS定位数据处理
在许多应用场景中,如车辆追踪、移动设备定位等,GPS定位数据的实时获取和处理至关重要,本文将介绍如何使用Java Socket编程来接收GPS设备发送的数据并进行处理,需要的朋友可以参考下
2024-07-07
剖析Java中的事件处理与异常处理机制
这篇文章主要介绍了Java中的事件处理与异常处理机制,讲解Java是如何对事件或者异常作出响应以及定义异常的一些方法,需要的朋友可以参考下
2016-01-01
浅谈SpringBoot项目如何让前端开发提高效率(小技巧)
这篇文章主要介绍了浅谈SpringBoot项目如何让前端开发提高效率(小技巧)，主要介绍了Swagger和Nginx提高效率的方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-04-04
Java 超详细讲解设计模式之原型模式讲解
原型模式是用于创建重复的对象，同时又能保证性能。这种类型的设计模式属于创建型模式，它提供了一种创建对象的最佳方式，今天通过本文给大家介绍下Java 原型设计模式，感兴趣的朋友一起看看吧
2022-03-03