对响应值Response的封装使用(可格式化Json格式数据)

---

配置

返回的json中忽略null属性值，不传递
pom引入:

<!-- lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>
<!-- jackson -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
</dependency>

第一种，在yml中写入（全局）：

spring:
  jackson:
    default-property-inclusion: non_null

第二种，在应用类上写入（局部）：

@JsonInclude(JsonInclude.Include.NON_NULL)

类

ResponseBean：

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.Data;
import lombok.SneakyThrows;
import lombok.experimental.Accessors;

import java.io.Serializable;

/**
 * @author: Demon
 * @date 2021/3/8 13:27
 * @description: 返回的JSON数据结构标准
 */
@Data
@Accessors(chain = true)
public class ResponseBean implements Serializable {

    private boolean success = false;
    private Object data;
    private String msg;
    private String errCode;
    private String errMsg;

    @JsonIgnore
    private boolean dataFormat = false;

    @SneakyThrows
    @Override
    public String toString() {
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        ResponseBeanVo responseBeanVo = new ResponseBeanVo()
                .setSuccess(this.isSuccess()).setData(this.getData()).setMsg(this.getMsg())
                .setErrCode(this.getErrCode()).setErrMsg(this.getErrMsg());
        if (this.isDataFormat()) {
            return objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(responseBeanVo);
        } else {
            return objectMapper.writer().writeValueAsString(responseBeanVo);
        }
    }
}

@Data
@Accessors(chain = true)
class ResponseBeanVo implements Serializable {
    private boolean success;
    private Object data;
    private String msg;
    private String errCode;
    private String errMsg;

}

BaseController

/**
 * @className: BaseController.java
 * @description:  基本
 * @author: Demon
 */
public abstract class BaseController {
  /**
    * 使用response输出JSON
    * @param response response
    * @param str 响应对应
    */
   protected void out(HttpServletResponse response, Object str) {
       PrintWriter out = null;
       try {
           response.setCharacterEncoding("UTF-8");
           response.setContentType("application/json");
           out = response.getWriter();
           out.print(str);
       } catch (Exception e) {
           log.error("输出JSON出错",e.getMessage());
       } finally {
           if (out != null) {
               out.flush();
               out.close();
           }
       }
   }
}

使用

import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @ClassName: IndexController
 * @Description: 控制层测试
 * @Author: Demon
 */
@RestController
public class TestController extends BaseController {

   @RequestMapping(method = {RequestMethod.GET,RequestMethod.POST})
   public @ResponseBody void getIndex(HttpServletResponse response) {
       ResponseBean responseBean = new ResponseBean();
       responseBean.setSuccess(true);
       responseBean.setDataFormat(true);
       this.out(response,responseBean);
   }
}

结果：

{
  "success" : true
}