JavaWeb中用来定义统一的响应结果的result类

简介: JavaWeb中用来定义统一的响应结果的result类

在JavaWeb中,通常会使用一个名为Result的类来表示控制器方法的执行结果。这个类的作用是封装了控制器方法执行后的返回结果,包括要返回的数据、跳转的视图等信息。Result类通常具有以下属性和方法:

  1. 数据属性:用于存储要返回给前端的数据,例如一个对象或者一个集合。
  2. 视图路径属性:用于存储要跳转的视图路径,通常是一个JSP页面的路径。
  3. 重定向标志属性:用于表示是否进行重定向操作。
  4. 错误信息属性:用于存储发生错误时的错误信息。
  5. 构造方法:用于创建Result对象,并设置其中的属性。
  6. Getter和Setter方法:用于获取和设置Result对象的属性值

使用Result类可以提高代码的可读性、可维护性和可扩展性,是一种常见的在JavaWeb开发中处理控制器方法返回结果的方式。

使用Result类的好处有几点:

  1. 封装性Result类封装了控制器方法的执行结果,将数据、视图路径、重定向标志和错误信息等相关信息封装在一个对象中,使得控制器方法的返回结果更加清晰和统一。
  2. 灵活性:通过Result类可以灵活地处理不同情况下的返回结果。可以根据业务需求设置要返回的数据、跳转的视图路径,以及是否进行重定向等操作。
  3. 统一规范:使用Result类可以统一规范控制器方法的返回格式,使得不同的控制器方法返回的结果具有一致的格式和结构,方便前端页面对返回结果的处理和展示。
  4. 错误处理Result类可以用于统一处理错误情况,例如用户不存在、权限不足等情况,通过设置错误信息和错误视图路径,可以向用户提供友好的错误提示页面。
  5. 可扩展性Result类可以根据业务需求进行扩展,例如添加其他属性或方法,以满足特定业务场景下的需求。

背景

实际上我们之前所有的springboot程序都设置了响应

响应给客户端服务器

而这些都依赖一个注解 ResponseBody

修饰注解的注解叫做源注解

@ResponseBody

如果加上这个注解 当前类下 方法的所有返回值都会作为响应数据返回给浏览器

如果是数组或者是集合 会自动转换成json

返回值不同

通过RequestBody处理后返回给前端的也不同

那么前端解析数据的方式五花八门

增加了成本

导致了项目不变管理 难以维护

所以我们设置了一个统一的响应结果

通用性

这样项目的管理和维护就变得很容易

Result类 代码

自己整的 手搓了一个简单的Result不需要引入依赖

code响应码 和前端的一个约定

message提示信息

data返回的数据 对于一些查询的数据返回查询数据我们都返回给data数据里面

之后前端拿回的所有数据都是这样的一种格式的数据

只需要对这一种数据进行解析就行了

package com.bigdata.pojo;
 
public class Result{
    private Integer code;
    private String msg;
    private Object data;
    public Result(){};
    public Result(Integer code,String msg,Object data){
        this.code=code;
        this.msg=msg;
        this.data=data;
    }
 
    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;
    }
 
    //定义静态方法 帮助我们快速构造result对象
    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 success(String msg){
        return new Result(1,msg,null);
    }
}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

案例

package com.bigdata.springboottext;
 
import com.sun.net.httpserver.Authenticator;
import jakarta.servlet.http.HttpServletRequest;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import pojo.Address;
import pojo.Result;
import pojo.User;
 
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.util.*;
 
@RestController
public class RequestController {
    @RequestMapping("/hello")
    public Result Param1(){
        System.out.println("Hello World");
        return new Result(1,"success","Hello world");
    }
 
    @RequestMapping("/hi")
    public Result Param2(){
        System.out.println("Hello World");
        return Result.success("Hello world");
    }
 
    @RequestMapping("/list")
    public Result Param3(){
        List<Address>list=new ArrayList<>();
        Address addr=new Address();
        addr.setProvince("江苏");
        addr.setCity("扬州");
        list.add(addr);
        return Result.success(list);
    }
}

启动springboot

发送请求

这样前端就能获得格式化的数据

降低了维护难度和成本

不管哪个方法返回给前端的数据格式是一定的

所以我们就可以 方便管理  方便维护  降低维护成本

目录
相关文章
|
3月前
|
设计模式 消息中间件 传感器
Java 设计模式之观察者模式:构建松耦合的事件响应系统
观察者模式是Java中常用的行为型设计模式,用于构建松耦合的事件响应系统。当一个对象状态改变时,所有依赖它的观察者将自动收到通知并更新。该模式通过抽象耦合实现发布-订阅机制,广泛应用于GUI事件处理、消息通知、数据监控等场景,具有良好的可扩展性和维护性。
347 8
|
3月前
|
存储 Java 索引
用Java语言实现一个自定义的ArrayList类
自定义MyArrayList类模拟Java ArrayList核心功能,支持泛型、动态扩容(1.5倍)、增删改查及越界检查,底层用Object数组实现,适合学习动态数组原理。
141 4
|
3月前
|
IDE JavaScript Java
在Java 11中,如何处理被弃用的类或接口?
在Java 11中,如何处理被弃用的类或接口?
225 5
|
3月前
|
JSON 网络协议 安全
【Java】(10)进程与线程的关系、Tread类;讲解基本线程安全、网络编程内容;JSON序列化与反序列化
几乎所有的操作系统都支持进程的概念,进程是处于运行过程中的程序,并且具有一定的独立功能,进程是系统进行资源分配和调度的一个独立单位一般而言,进程包含如下三个特征。独立性动态性并发性。
216 1
|
3月前
|
Java Go 开发工具
【Java】(8)正则表达式的使用与常用类分享
正则表达式定义了字符串的模式。正则表达式并不仅限于某一种语言,但是在每种语言中有细微的差别。
270 1
|
3月前
|
存储 Java 程序员
【Java】(6)全方面带你了解Java里的日期与时间内容,介绍 Calendar、GregorianCalendar、Date类
java.util 包提供了 Date 类来封装当前的日期和时间。Date 类提供两个构造函数来实例化 Date 对象。第一个构造函数使用当前日期和时间来初始化对象。Date( )第二个构造函数接收一个参数,该参数是从1970年1月1日起的毫秒数。
217 1
|
3月前
|
JSON 网络协议 安全
【Java基础】(1)进程与线程的关系、Tread类;讲解基本线程安全、网络编程内容;JSON序列化与反序列化
几乎所有的操作系统都支持进程的概念,进程是处于运行过程中的程序,并且具有一定的独立功能,进程是系统进行资源分配和调度的一个独立单位一般而言,进程包含如下三个特征。独立性动态性并发性。
237 1
|
4月前
|
数据采集 存储 弹性计算
高并发Java爬虫的瓶颈分析与动态线程优化方案
高并发Java爬虫的瓶颈分析与动态线程优化方案
Java 数据库 Spring
193 0
|
4月前
|
算法 Java
Java多线程编程:实现线程间数据共享机制
以上就是Java中几种主要处理多线程序列化资源以及协调各自独立运行但需相互配合以完成任务threads 的技术手段与策略。正确应用上述技术将大大增强你程序稳定性与效率同时也降低bug出现率因此深刻理解每项技术背后理论至关重要.
311 16