Springboot构造返回json对象-响应客户端渲染数据

开发工具

sts:spring tools suite开发工具
maven版本:apache-maven-3.5.2
java版本:1.8

自定义响应数据结构

JSONResult 响应的数据结构类

package com.example.pojo;
import java.util.List;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;

/**
 * 
 * @Package com.lee.utils
 * @Description: 自定义响应数据结构
 * 				这个类是提供给门户，ios，安卓，微信商城用的
 * 				门户接受此类数据后需要使用本类的方法转换成对于的数据类型格式（类，或者list）
 * 				其他自行处理
 * 				200：表示成功
 * 				500：表示错误，错误信息在msg字段中
 * 				501：bean验证错误，不管多少个错误都以map形式返回
 * 				555：异常抛出信息
 */
public class JSONResult {

    // 定义jackson对象
    private static final ObjectMapper MAPPER = new ObjectMapper();

    // 响应业务状态
    private Integer status;

    // 响应消息
    private String msg;

    // 响应中的数据
    private Object data;
    
    private String ok;	// 不使用

    public static LeeJSONResult build(Integer status, String msg, Object data) {
        return new LeeJSONResult(status, msg, data);
    }

    public static LeeJSONResult ok(Object data) {
        return new LeeJSONResult(data);
    }

    public static LeeJSONResult ok() {
        return new LeeJSONResult(null);
    }
    
    public static LeeJSONResult errorMsg(String msg) {
        return new LeeJSONResult(500, msg, null);
    }
    
    public static LeeJSONResult errorMap(Object data) {
        return new LeeJSONResult(501, "error", data);
    }
    
    public static LeeJSONResult errorException(String msg) {
        return new LeeJSONResult(555, msg, null);
    }

    public LeeJSONResult() {

    }

//    public static LeeJSONResult build(Integer status, String msg) {
//        return new LeeJSONResult(status, msg, null);
//    }

    public LeeJSONResult(Integer status, String msg, Object data) {
        this.status = status;
        this.msg = msg;
        this.data = data;
    }

    public LeeJSONResult(Object data) {
        this.status = 200;
        this.msg = "OK";
        this.data = data;
    }

    public Boolean isOK() {
        return this.status == 200;
    }

    public Integer getStatus() {
        return status;
    }

    public void setStatus(Integer status) {
        this.status = status;
    }

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

    /**
     * 
     * @Description: 将json结果集转化为LeeJSONResult对象
     * 				需要转换的对象是一个类
     * @param jsonData
     * @param clazz
     * @return
     */
    public static LeeJSONResult formatToPojo(String jsonData, Class<?> clazz) {
        try {
            if (clazz == null) {
                return MAPPER.readValue(jsonData, LeeJSONResult.class);
            }
            JsonNode jsonNode = MAPPER.readTree(jsonData);
            JsonNode data = jsonNode.get("data");
            Object obj = null;
            if (clazz != null) {
                if (data.isObject()) {
                    obj = MAPPER.readValue(data.traverse(), clazz);
                } else if (data.isTextual()) {
                    obj = MAPPER.readValue(data.asText(), clazz);
                }
            }
            return build(jsonNode.get("status").intValue(), jsonNode.get("msg").asText(), obj);
        } catch (Exception e) {
            return null;
        }
    }

    /**
     * 
     * @Description: 没有object对象的转化
     * @param json
     * @return
     */
    public static LeeJSONResult format(String json) {
        try {
            return MAPPER.readValue(json, LeeJSONResult.class);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * 
     * @Description: Object是集合转化
     * 				需要转换的对象是一个list
     */
    public static LeeJSONResult formatToList(String jsonData, Class<?> clazz) {
        try {
            JsonNode jsonNode = MAPPER.readTree(jsonData);
            JsonNode data = jsonNode.get("data");
            Object obj = null;
            if (data.isArray() && data.size() > 0) {
                obj = MAPPER.readValue(data.traverse(),
                        MAPPER.getTypeFactory().constructCollectionType(List.class, clazz));
            }
            return build(jsonNode.get("status").intValue(), jsonNode.get("msg").asText(), obj);
        } catch (Exception e) {
            return null;
        }
    }

	public String getOk() {
		return ok;
	}

	public void setOk(String ok) {
		this.ok = ok;
	}

}

UserController

package com.example.controller;

import java.util.Date;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.example.pojo.JSONResult;
import com.example.pojo.User;

@RestController  
@RequestMapping("/user")
public class UserController {
	
	@RequestMapping("/getUser")
	public User getUser() {
		User user = new User();
		user.setName("zhangsan");
		user.setAge(18);
		user.setBirthday(new Date());
		user.setPassword("zhangsan");
		return user;
	}
	
	//推荐：开发中通常返回前端都会带有响应状态信息，前端根据状态信息判断进行展示
	@RequestMapping("/getUserJson")
	public JSONResult getUserJson() {
		User user = new User();
		user.setName("zhangsan");
		user.setAge(18);
		user.setBirthday(new Date());
		user.setPassword("zhangsan");
		return JSONResult.ok(user);
	}
}

User类

public class User {
	private String name;
	private String password;
	private Integer age;
	private Date birthday;
	private String desc;
	//get和set方法自行补充
	}

运行项目

文件结构

访问地址： http://localhost:8080/user/getUserJson