使用ResponseEntity作为的返回值的应用

 更新时间:2024年07月05日 08:39:54   作者:DanceDonkey  
这篇文章主要介绍了使用ResponseEntity作为的返回值的应用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

ResponseEntity作为的返回值

通常如果后端想响应json数据,我们需要在方法体上添加@Response注解,标注这个注解的方法的返回值会被spingmvc转为json形式并写入到响应体中。

但ResponseEntity则不会被springmvc转换,可以使用这个类定义响应头,状态码,响应体等。

@Controller
public class ResponseBodyTest {

    @ResponseBody
    @GetMapping("b1")
    public R b1(){
        //将方法的返回值转为json写入到响应体中
        return R.ok().put("msg","success");
    }

	@ResponseBody
    @GetMapping("b2")
    public ResponseEntity<String> b2(){
        HttpHeaders httpHeaders = new HttpHeaders();
        httpHeaders.setContentType(MediaType.TEXT_PLAIN);
        String str = "hello,world";
        ResponseEntity responseEntity = new ResponseEntity<String>(str,httpHeaders,HttpStatus.OK);
        return responseEntity;
    }

}

我们 /b2 请求设置了@ResponseBody注解,但由于返回的是ResponseEntity对象,而且我们又重新设置了响应类型为 text/plain,我们访问b2请求查看结果:

心得

ResponseEntity的优先级高于@ResponseBody。

在不是ResponseEntity的情况下才去检查有没有@ResponseBody注解。如果响应类型是ResponseEntity可以不写@ResponseBody注解,写了也没有关系。

简单的说@ResponseBody可以直接返回Json结果, @ResponseEntity不仅可以返回json结果,还可以定义返回的HttpHeaders和HttpStatus。

统一结果返回 ResponseEntity

在正规的严格的企业的前后端系统开发中,返回严谨的状态码很有必要

平常大家为了统一格式返回,或许会自己封装一个ResultUtils,然后自定义ResultCode枚举类来返回,这样有些麻烦;

我们可以使用SpringMVC为我们封装的ResponseEntity对象来自定义状态码

源码:

public class ResponseEntity<T> extends HttpEntity<T> {
    private final Object status;

    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;
    }

@param body: the entity body

  • ResponseEntity需要一个泛型T
  • 代表我们需要传入的数据对象

@param headers : the entity headers

  • 我们可以new MultiValueMap<String, String> headers
  • 设置响应头信息

@param status: the status code

  • 我们可以使用HttpStatus
  • 也可以自己定义状态码(Object)

HttpStatus status是一个包含了各种响应状态码的枚举类

// 201:创建成功   Created
// 203 :没有认证   NON_AUTHORITATIVE_INFORMATION
// 204: 成功没有返回值 No-content  一般是delete,update时使用
.....

例子:

	@GetMapping("/categories")
    public ResponseEntity<List<Category>> getCategoryList(String token){
        return new ResponseEntity<>(categoryService.queryAll(), HttpStatus.OK);
    }

    @PostMapping("/categories")
    public ResponseEntity<Category> AddCategory(String token, @RequestBody Category category){
        
        return new ResponseEntity<>(categoryService.insert(category),HttpStatus.CREATED);
    }

总结

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

相关文章

  • 只用400行Java代码就能实现的飞翔的小鸟游戏

    只用400行Java代码就能实现的飞翔的小鸟游戏

    今天给大家带来的是关于Java实战的相关知识,文章围绕着只用400行Java代码就能实现的飞翔的小鸟游戏展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • Spring Validation和Hibernate Validator结合国际化代码实例

    Spring Validation和Hibernate Validator结合国际化代码实例

    这篇文章主要介绍了Spring Validation和Hibernate Validator结合国际化代码实例,我们需要对请求参数进行非空、长度、正确性进行校验, 本文主要讲解Spring Validation 和 Hibernate Validator, 同时整合i18n(国际化)实现参数校验自动,需要的朋友可以参考下
    2023-10-10
  • Java实现在线语音识别

    Java实现在线语音识别

    这篇文章主要为大家详细介绍了Java实现在线语音识别功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-08-08
  • Java多线程synchronized同步方法详解

    Java多线程synchronized同步方法详解

    这篇文章主要介绍了Java多线程synchronized同步方法详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • Java多线程 ReentrantReadWriteLock原理及实例详解

    Java多线程 ReentrantReadWriteLock原理及实例详解

    这篇文章主要介绍了Java多线程 ReentrantReadWriteLock原理及实例详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-09-09
  • IDEA远程部署调试Java应用程序的详细流程

    IDEA远程部署调试Java应用程序的详细流程

    这篇文章主要介绍了IDEA远程部署调试Java应用程序,本文通过图文并茂的形式给大家介绍的非常详细,需要的朋友可以参考下
    2021-10-10
  • Mybatis Plus查询时sql字段名大小写报错的解决

    Mybatis Plus查询时sql字段名大小写报错的解决

    这篇文章主要介绍了Mybatis Plus查询时sql字段名大小写报错的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • 如何使用MybatisPlus快速进行增删改查详解

    如何使用MybatisPlus快速进行增删改查详解

    增删改查在日常开发中是再正常不多的一个需求了,下面这篇文章主要给大家介绍了关于如何使用MybatisPlus快速进行增删改查的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-08-08
  • java 将byte中的有效长度转换为String的实例代码

    java 将byte中的有效长度转换为String的实例代码

    下面小编就为大家带来一篇java 将byte中的有效长度转换为String的实例代码。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-11-11
  • Java实战之小蜜蜂扩音器网上商城系统的实现

    Java实战之小蜜蜂扩音器网上商城系统的实现

    这篇文章主要介绍了如何利用Java实现简单的小蜜蜂扩音器网上商城系统,文中采用到的技术有JSP、Servlet 、JDBC、Ajax等,感兴趣的可以动手试一试
    2022-03-03

最新评论