请求响应-响应-@ResponseBody统一响应结果

news2024/12/24 8:32:03

@ResponseBody

  • 类型:方法注解,类注解
  • 位置:Controller方法上/类上
  • 作用:将方法返回值直接响应,如果返回类型是 实体对象/集合,将会转化为JSON格式数据后再响应
  • 说明:@RestController = @Controller + @ResponseBody

由于前端在访问不用的业务接口时,接口返回至前端的数据格式各种各样,对于整个项目来不便于管理而且很难维护。因此在项目开发过程中,我们应该设置一个统一的响应结果

统一响应结果

在Spring Boot框架中,Result类通常用于封装控制器(Controller)的响应结果。它是一种常见的设计模式,用于统一格式化返回给客户端的数据

  • Result类一般包含以下属性
    • code:表示请求处理的状态码,通常为整数值。例如,0表示成功,其它非零值表示不同类型的错误
    • message:对处理结果的简单描述或提示信息,可以根据需求提供更多更多上下文信息
    • data:实际的响应数据对象,可以是单个对象或集合,用于向客户端返回具体的业务数据。

使用Result类的好处是可以在所有控制器方法中保持一致的响应格式。例如,在请求处理成功时,可以将数据封装到Result对象的data属性中,并设置code为0,message为空或可选的成功消息。而在处理失败时,可以设置相应的错误状态码和错误消息。

以下为一个Result类的示例(具体代码如下)

package com.example.POJO;

/**
 * 统一响应结果封装类
 */
public class Result {
    private Integer code;//1 成功 , 0 失败
    private String msg; //提示信息
    private Object data; //数据 date

    // 无参构造
    public Result() {
    }

    // 有参构造
    public Result(Integer code, String msg, Object data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    // 设置get/set方法
    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }

    // 三种情况的方法
    public static Result success(Object data) {
        return new Result(1, "success", data);
    }

    public static Result success() {
        return new Result(1, "success", null);
    }

    public static Result error(String msg) {
        return new Result(0, msg, null);
    }

    // 重写toString()方法,设置返回数据格式
    @Override
    public String toString() {
        return "Result{" +
                "code=" + code +
                ", msg='" + msg + '\'' +
                ", data=" + data +
                '}';
    }
}

Controller类具体代码为:

package com.example.Controller;

import com.example.POJO.Address;
import com.example.POJO.Result;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

/**
 * 测试响应数据
 */
@RestController
public class ResponseController {
    @RequestMapping("/hello")
    public Result hello() {
        System.out.println("Hello World ~");
        //return new Result(1,"success","Hello World ~");
        // 直接调用success()方法
        return Result.success("Hello World ~");
    }

    @RequestMapping("/getAddr")
    public Result getAddr() {
        Address addr = new Address();
        addr.setProvince("广东");
        addr.setCity("深圳");
        return Result.success(addr);
    }

    @RequestMapping("/listAddr")
    public Result listAddr() {
        List<Address> list = new ArrayList<>();

        Address addr = new Address();
        addr.setProvince("广东");
        addr.setCity("深圳");

        Address addr2 = new Address();
        addr2.setProvince("陕西");
        addr2.setCity("西安");

        list.add(addr);
        list.add(addr2);
        return Result.success(list);
    }
}

在postman中进行测试,分别查看返回结果:

1.

2.

3.

 

 

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/745323.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

【unity细节】为什么有时候修改了脚本中的数据但是面板中的数据还是不改变

&#x1f468;‍&#x1f4bb;个人主页&#xff1a;元宇宙-秩沅 hallo 欢迎 点赞&#x1f44d; 收藏⭐ 留言&#x1f4dd; 加关注✅! 本文由 秩沅 原创 收录于专栏&#xff1a;unity细节和bug ⭐为什么有时候修改了脚本中的数据但是面板中的数据还是不改变⭐ 文章目录 ⭐为什…

视频直播点播平台EasyDSS增加首次登录强制修改密码等新功能

EasyDSS视频直播点播平台支持Flash、H5播放&#xff0c;可提供一站式的视频推拉流、转码、点播、直播、时移回放、存储等服务&#xff0c;支持播放H.265编码视频&#xff0c;可兼容多操作系统。搭配RTMP高清摄像头使用&#xff0c;可将设备的实时流推送到平台上&#xff0c;实现…

java 线程安全问题

一、多线程带来的问题 多线程主要解决效率问题&#xff0c;但是也带来了线程安全问题。 例如两个线程 A 和 B 同时启动执行 400 次 m m 1&#xff0c;期待 800 &#xff0c;实际 m 的结果不一定正确&#xff0c;如下&#xff1a; public static void test1() throws Interr…

【C语言】字符函数和字符串函数(一)—>库函数的介绍与模拟实现

目录 前言&#xff1a; 一、函数介绍&#xff1a; &#xff08;一&#xff09;求字符串长度 &#xff08;1&#xff09;strlen &#xff08;二&#xff09;长度不受限制的字符串函数 &#xff08;2&#xff09;strcpy &#xff08;3&#xff09;strcat &#xff08;4&a…

什么是HTML5?HTML5的含义、元素和好处

HTML5是超文本标记语言(HTML)的第五版&#xff0c;网络浏览器使用它来可视化代码。它在网站功能、网页内容开发等方面有一些改进。 HTML的发展 在万维网的早期&#xff0c;主要的网络浏览器创造者&#xff08;例如微软Internet Explorer和Mosaic Netscape&#xff09;开发了特…

std::thread和std::mutex

std::thread std::thread用来创建一个线程&#xff1a; #include <thread>void threadFun(int temp) {int i 0; }int main() {std::thread t1(threadFun, 100);t1.join();//t1.detach();return 0; }创建了一个名为t1的线程&#xff0c;调用join方法阻塞等待线程退出&a…

【leetcode】61. 旋转链表 (python)

题目链接&#xff1a;61.旋转链表 写法一&#xff1a;暴力 class Solution(object):def rotateRight(self, head, k):""":type head: ListNode:type k: int:rtype: ListNode"""# 暴力&#xff1a;每次移动一个&#xff0c;时间复杂度 O(N^2)&am…

详解汽车电磁悬架(上)

摘要&#xff1a; 从汽车发明之日起&#xff0c;人们对于汽车平稳行驶的追求步伐就不曾停止过。充气轮胎的发明让车辆能够更加平稳舒适的行驶&#xff0c;承载式车身以及加厚的底盘则进一步提高了汽车的舒适性。随着科技的发展与生活水平的提高&#xff0c;人们对汽车的舒适性…

【C】字符串函数和内存函数的介绍

库函数&#xff08;这些函数都在头文件string.h中&#xff09; 字符串函数求字符串长度strlen 长度不受限的字符串函数strcpystrcmpstrcat 长度受限的字符串函数strncpystrncmpstrncat 字符串查找strstrstrtok 错误信息报告strerror 字符操作字符分类函数字符转换函数 内存函数…

测试必备的15个docker命令,你都掌握了吗

1、Docker容器信息 ##查看docker容器版本docker version##查看docker容器信息docker info##查看docker容器帮助docker --help 2、镜像操作 提示&#xff1a;对于镜像的操作可使用镜像名、镜像长ID和短ID。 2.1、镜像查看 ##列出本地imagesdocker images##含中间映像层docke…

iview-admin使用小结

首先在使用一个框架之前一定要完整的看一下相关文档&#xff0c;因为框架中会封装常用的功能&#xff0c;也会更加符合大众要求。在ui设计图上&#xff0c;可能实现某个功能设计图中给出的交互并不是很好&#xff0c;而在框架中有更好的组件可以实现&#xff0c;但因为没有看文…

物联网技术、测试要点和测试标准

目录 物联网定义 物联网中最常用的技术 物联网测试概述 测试人员在物联网中面临的挑战 测试物联网系统时使用了各种工具 &#x1f381;更多干货 完整版文档下载方式&#xff1a; 物联网定义 物联网&#xff1a;利用嵌入式电子设备、微芯片等连接车辆、家电、医疗设备&am…

广州华锐互动 | 鸡养殖VR教育实训系统

鸡养殖VR教育实训系统由广州华锐互动开发&#xff0c;是一种基于虚拟现实技术的培训工具&#xff0c;旨在为鸡养殖行业的从业人员提供更加直观、生动的学习体验。该系统通过虚拟现实技术&#xff0c;将鸡养殖过程中的各种场景、操作和技能呈现在学员面前&#xff0c;让学员可以…

关于 Linux 的常用命令

目录 前言什么是 Linux获得 Linux 环境为什么使用命令控制关于 XShell 下的复制粘贴 Linux 常用命令ls (罗列文件)cd (切换目录)pwd (显示当前路径)touch (创建一个空文件)cat (读取文件内容)man (查看用户手册)echo (回显)vim (文件编辑器)mkdir (创建目录)rm (删除目录/文件)…

数仓常见问题以及解决方案yyds

文章目录 01 数据仓库现状业务系统侧【上游】数仓内部数据应用测【下游】 02 如何解决问题业务系统侧【上游】数仓内部 03 体系化架构设计一致性维度一致性事实数据应用侧【下游】 建设可视化的取数平台 大家好&#xff0c;我是脚丫先生 (o^^o) 看到几篇不错的文章&#xff0c…

App Inventor 2 从.aia项目文件中提取.aix拓展包

从.aia项目文件中提取.aix拓展包的步骤 如果看到一个项目中&#xff0c;用到了拓展&#xff0c;但拓展的帮助中没有原链接&#xff0c;这时就可以考虑从项目文件中进行提取&#xff1a; 导出项目.aia文件&#xff1a; 在电脑的“下载”目录查看.aia项目文件&#xff1a; 将.a…

写在2023年年中

写在2023年年中 收拾旧山河再出发 很久没有写规划了&#xff0c;博客也很少写&#xff0c;着实是太懒了。想想自己年纪也不小了&#xff0c;加上程序员的环境越来越不好&#xff0c;总得想想自己的出路不是。 目标 提升系统设计能力保持算法刷题能力(一般面试需要)知识输出能…

RabbitMQ工作模式代码示例及用SpringBoot整合RabbitMQ

一&#xff0c;RabbitMQ的工作模式 RabbitMQ 的工作模式是指 RabbitMQ 中不同的消息传递方式&#xff0c;包括简单模式、工作队列模式、发布订阅模式、路由模式和主题模式 。这些工作模式适用于不同的应用场景。详细的文档可参照RabbitMQ的官网&#xff1a;RabbitMQ: easy to u…

基于JavaSwing+MySQL的员工工资管理系统

点击以下链接获取源码&#xff1a; https://download.csdn.net/download/qq_64505944/88042468?spm1001.2014.3001.5503 JDK1.8 MySQL5.7