SpringBoot从零搭建一个项目（五）定义返回格式

最新推荐文章于 2024-07-05 21:44:28 发布

WongWoo1991

最新推荐文章于 2024-07-05 21:44:28 发布

阅读量293

点赞数

CC 4.0 BY-SA版权

分类专栏： SpringBoot

本文链接：https://blog.csdn.net/yu75567218/article/details/107810909

SpringBoot 专栏收录该内容

5 篇文章

订阅专栏

本文介绍了如何在SpringBoot项目中定义并封装统一的JSON返回格式，以提高用户体验，包括设置返回状态码、错误信息等，并展示了在控制器层的具体应用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

如果我们直接返回对象的json格式，对于客户端来说，使用体验不是很好，一般还要返回code和错误信息，所以这里我们做一次封装。
先定义返回的格式如下：

{
    data: {}
	code: 100
    msg：“正常”
}

封装返回的类：

public class JsonResult {
	
	public static String CODE_SUCCESS = "100";
	public static String CODE_FAIL = "101";

    private Object data;
	private String code;
    private String msg;

    public JsonResult(Object data, String code, String msg) {
        this.data = data;
        this.code = code;
        this.msg = msg;
    }
    
    /**
     * 成功
     * @param data
     * @return
     */
    public static JsonResult buildData(Object data) {
		return new JsonResult(data, CODE_SUCCESS, "");
	}
    
    /**
     * 失败
     * @return
     */
    public static JsonResult buildFail() {
		return new JsonResult("", CODE_FAIL, "异常");
	}
}

定义一个控制层基础类，方便在控制层中直接返回格式

public class BaseController {

	/**
	 * 成功-带参数
	 * @param t
	 * @return
	 */
	public String success(Object t) {
		JsonResult jsonResult = JsonResult.buildData(t);
		String resultString = JSONObject.fromObject(jsonResult).toString();
		return resultString;
	}

	/**
	 * 失败-通用
	 * @return
	 */
	public String fail() {
		JsonResult jsonResult = JsonResult.buildFail();
		String resultString = JSONObject.fromObject(jsonResult).toString();
		return resultString;
	}
}

在控制层中使用：

@RestController
@RequestMapping("/user")
public class UserController extends BaseController {
	
	@RequestMapping("/login")
	public String registerAndLogin(
			@RequestParam("code") String code,
			@RequestParam("nickName") String nickName,
			@RequestParam("avatarUrl") String avatarUrl) {
		
		 // .......

		return success(user);
	}
}

返回的结果：

{
	code: "100"
	data: {avatarUrl: "https://wx.qlogo.cn/mmopen/vi_32/DYAIOgq83eo4kicic…MvuIu6doOsvxelA87fzvuAL5rnx3JwCDRXice2HtnzUwQ/132", createDate: "2020-08-04 16:10:40.0", nickName: "WongWoo", openid: "oW_rF5DQwwRl7Ek2ApqrXJryYVMM", unionid: "", …}
	msg: ""
}