Springboot（2.7.6）单体工程-统一响应格式（三）

如果你采用“前后端分离”的模式来开发你的web项目，除了要约定你的后端返回json外，也要约定所有的接口返回的数据格式是统一的，这样前端才更容易实现响应消息控制。例如你的后端返回的json数据格式都包含“code=200/500/404” 字段，那么前端就可以通过“code”字段的值，来提示不同风格的消息框。

统一响应消息封装

说明:在springboot启动类根目录 建立common包,然后写如下类

import lombok.Data;

import java.io.Serializable;

/**
 * 响应结果
 */

@Data
public class Result    implements Serializable {
    /**
     * 消息
     */
    private String message;
    /**
     * 数据
     */
    private Object data;
    /**
     * 200表示成功
     * 500表示异常
     */
    private  Integer  code;
    public   Result(Integer code ,String message, Object data) {
        this.message = message;
        this.data = data;
        this.code = code;
    }
    /**
     * 成功
     * @param message
     * @param data
     * @return
     */
    public  static    Result     OK(String message ,Object data){
        return   new Result(200,message,data);
    }
    /**
     * 失败
     * @param message
     * @return
     */
    public  static    Result     FAIL(String message){
        return   new Result(500,message,null);
    }

}

注意：@Data 是Lombok插件 提供的可以免写getter 和setter的注解，请提前安装lombok插件和相关依赖

接口案例

说明:在springboot启动类根目录 建立controller包 ,然后写如下类

 //controller包下 
import com.example.ldemo.common.Result;
import org.springframework.web.bind.annotation.*;
@RestController
public class TestController {
    @GetMapping("/test")
    public Result test(){
        return  Result.OK("测试成功","涛哥");

    }

}

测试

浏览器输入：http://localhost:3000/test

结果：{“message”:“测试成功”,“data”:“涛哥”,“code”:200}