返回json数据时出现空指针异常_springboot 项目封装：统一结果，统一异常，统一日志...

点击上方蓝色字体，选择“标星公众号”

优质文章，第一时间送达

  作者 |  iTachiLEe

来源 |  urlify.cn/q226Bb

统一结果的一般形式

• 是否响应成功；

• 响应状态码；

• 状态码描述；

• 响应数据

• 其他标识符

结果类枚举

import lombok.Getter;

/**
 * @author leon
 */

@Getter
public enum ResultCodeEnum {

    SUCCESS(true,20000,"成功"),
    UNKNOWN_ERROR(false,20001,"未知错误"),
    PARAM_ERROR(false,20002,"参数错误"),
    NULL_POINT(false,20003,"空指针异常"),
    HTTP_CLIENT_ERROR(false,20004,"客户端连接异常"),;

    /**
     * 响应是否成功
     */
    private Boolean success;
    /**
     * 响应状态码
     */
    private Integer code;
    /**
     * 响应信息
     */
    private String message;

    ResultCodeEnum(boolean success, Integer code, String message) {
        this.success = success;
        this.code = code;
        this.message = message;
    }
}

统一结果类

• 外界只可以调用统一返回类的方法，不可以直接创建，因此构造器私有；

• 内置静态方法，返回对象；

• 为便于自定义统一结果的信息，建议使用链式编程，将返回对象设类本身，即return this;

• 响应数据由于为json格式，可定义为JsonObject或Map形式

import lombok.Data;

import java.util.HashMap;
import java.util.Map;

/**
 * @author leon
 */
@Data
public class R {
    private Boolean success;

    private Integer code;

    private String message;

    private Map data = new HashMap<>();
    /**
     * 构造器私有
     */
    private R() {
    }
    /**
     * 通用返回成功
     */
    public static R ok() {
        R r = new R();
        r.setSuccess(ResultCodeEnum.SUCCESS.getSuccess());
        r.setCode(ResultCodeEnum.SUCCESS.getCode());
        r.setMessage(ResultCodeEnum.SUCCESS.getMessage());return r;
    }
    /**
     * 通用返回失败，未知错误
     *
     * @return
     */
    public static R error() {
        R r = new R();
        r.setSuccess(ResultCodeEnum.UNKNOWN_ERROR.getSuccess());
        r.setCode(ResultCodeEnum.UNKNOWN_ERROR.getCode());
        r.setMessage(ResultCodeEnum.UNKNOWN_ERROR.getMessage());return r;
    }
    /**
     * 设置结果，形参为结果枚举
     *
     * @param result
     * @return
     */
    public static R setResult(ResultCodeEnum result) {
        R r = new R();
        r.setSuccess(result.getSuccess());
        r.setCode(result.getCode());
        r.setMessage(result.getMessage());return r;
    }
    /**
     * ------------使用链式编程，返回类本身----------
     * 自定义返回数据
     *
     * @param map
     * @return
     */
    public R data(Map map) {
        this.setData(map);return this;
    }
    /**
     * 通用设置data
     *
     * @param key
     * @param value
     * @return
     */
    public R data(String key, Object value) {
        this.data.put(key, value);return this;
    }
    /**
     * 自定义状态信息
     *
     * @param message
     * @return
     */
    public R message(String message) {
        this.setMessage(message);return this;
    }
    /**
     * 自定义状态码
     *
     * @param code
     * @return
     */
    public R code(Integer code) {
        this.setCode(code);return this;
    }
    /**
     * 自定义返回结果
     *
     * @param success
     * @return
     */
    public R success(Boolean success) {
        this.setSuccess(success);return this;
    }
}

控制层返回

视图层使用统一结果

@RestController
@RequestMapping("/api/v1/users")
public class TeacherAdminController {

    @Autowired
    private UserService userService;

    @GetMapping
    public R list() {
        List list = userrService.list(null);return R.ok().data("itms", list).message("用户列表");
    }
}

json结果

{
  "success": true,
  "code": 20000,
  "message": "查询用户列表",
  "data": {
    "itms": [
      {
        "id": "1",
        "username": "admin",
        "role": "ADMIN",
        "deleted": false,
        "gmtCreate": "2019-12-26T15:32:29",
        "gmtModified": "2019-12-26T15:41:40"
      },{
        "id": "2",
        "username": "zhangsan",
        "role": "USER",
        "deleted": false,
        "gmtCreate": "2019-12-26T15:32:29",
        "gmtModified": "2019-12-26T15:41:40"
      }
    ]
  }
}

统一异常处理

使用统一返回结果时，还有一种情况，就是程序的保存是由于运行时异常导致的结果，有些异常我们可以无法提前预知，不能正常走到我们return的R对象返回。

@ControllerAdvice

该注解为统一异常处理的核心

是一种作用于控制层的切面通知(Advice)，该注解能够将通用的@ExceptionHandler、@InitBinder和@ModelAttributes方法收集到一个类型，并应用到所有控制器上

该类中的设计思路：

• 使用@ExceptionHandler注解捕获指定或自定义的异常；

• 使用@ControllerAdvice集成@ExceptionHandler的方法到一个类中；

• 必须定义一个通用的异常捕获方法，便于捕获未定义的异常信息；

• 自定一个异常类，捕获针对项目或业务的异常;

• 异常的对象信息补充到统一结果枚举中；

import lombok.Data;@Data
public class CMSException extends RuntimeException {
    private Integer code;

    public CMSException(Integer code, String message) {
        super(message);
        this.code = code;
    }

    public CMSException(ResultCodeEnum resultCodeEnum) {
        super(resultCodeEnum.getMessage());
        this.code = resultCodeEnum.getCode();
    }

    @Override
    public String toString() {
        return "CMSException{" + "code=" + code + ", message=" + this.getMessage() + '}';
    }
}

统一异常处理器

import com.reason.gsny.util.ExceptionUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.client.HttpClientErrorException;

/**
 * @author leon
 */
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

    /**-------- 通用异常处理方法 --------**/
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public R error(Exception e) {
        // 通用异常结果打印到日志
        log.error(ExceptionUtil.getMessage(e));
        return R.error();
    }

    /**-------- 指定异常处理方法 --------**/
    @ExceptionHandler(NullPointerException.class)
    @ResponseBody
    public R error(NullPointerException e) {
        e.printStackTrace();
        return R.setResult(ResultCodeEnum.NULL_POINT);
    }

    @ExceptionHandler(HttpClientErrorException.class)
    @ResponseBody
    public R error(IndexOutOfBoundsException e) {
        e.printStackTrace();
        return R.setResult(ResultCodeEnum.HTTP_CLIENT_ERROR);
    }

    /**-------- 自定义定异常处理方法 --------**/
    @ExceptionHandler(CMSException.class)
    @ResponseBody
    public R error(CMSException e) {
        e.printStackTrace();
        return R.error().message(e.getMessage()).code(e.getCode());
    }
}

统一日志收集

关于logback的配置和介绍，可以参考官网或推荐博客glmapper的logback博客，logback-spring.xml配置文件

配置

在application.yml配置文件中添加：

logging:
  config: classpath:logback-spring.xml

以下直接贴出配置信息，介绍信息可以直接参考备注(

logback-spring.xml 位于resources文件夹下

<?xml  version="1.0" encoding="UTF-8"?>




"true" scanPeriod="10 seconds">logback"log.path" value="${log.path}/web_info.log" />"clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />"wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />"wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />"CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>"CONSOLE" class="ch.qos.logback.core.ConsoleAppender">"ch.qos.logback.classic.filter.ThresholdFilter">debug${CONSOLE_LOG_PATTERN}UTF-8"DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">${log.path}/web_debug.log%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%nUTF-8 "ch.qos.logback.core.rolling.TimeBasedRollingPolicy">${log.path}/web-debug-%d{yyyy-MM-dd}.%i.log"ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">100MB15"ch.qos.logback.classic.filter.LevelFilter">debugACCEPTDENY"INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">${log.path}/web_info.log%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%nUTF-8"ch.qos.logback.core.rolling.TimeBasedRollingPolicy">${log.path}/web-info-%d{yyyy-MM-dd}.%i.log"ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">100MB15"ch.qos.logback.classic.filter.LevelFilter">infoACCEPTDENY"WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">${log.path}/web_warn.log%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%nUTF-8 "ch.qos.logback.core.rolling.TimeBasedRollingPolicy">${log.path}/web-warn-%d{yyyy-MM-dd}.%i.log"ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">100MB15"ch.qos.logback.classic.filter.LevelFilter">warnACCEPTDENY"ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">${log.path}/web_error.log%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%nUTF-8 "ch.qos.logback.core.rolling.TimeBasedRollingPolicy">${log.path}/web-error-%d{yyyy-MM-dd}.%i.log"ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">100MB15"ch.qos.logback.classic.filter.LevelFilter">ERRORACCEPTDENY"dev">"com.reason.gsny" level="debug"/>"info">"CONSOLE" />"DEBUG_FILE" />"INFO_FILE" />"WARN_FILE" />"ERROR_FILE" />

日志收集异常信息

日志信息往往伴随着异常信息的输出，因此，我们需要修改统一异常的处理器，将异常信息以流的方式写到日志文件中

异常信息文件工具类

import lombok.extern.slf4j.Slf4j;

import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;

/**
 * 日志处理工具类
 * @author leon
 */
@Slf4j
public class ExceptionUtil {

    /**
     * 打印异常信息
     */
    public static String getMessage(Exception e) {
        String swStr = null;
        try (
                StringWriter sw = new StringWriter();
                PrintWriter pw = new PrintWriter(sw)) {
            e.printStackTrace(pw);
            pw.flush();
            sw.flush();
            swStr = sw.toString();
        } catch (IOException ex) {
            ex.printStackTrace();
            log.error(ex.getMessage());
        }
        return swStr;
    }
}

注意

• 日志的环境即spring.profiles.acticve，跟随项目启动；

• 启动后，即可到自定目录查找到生成的日志文件；

• 本地idea调试时，推荐Grep Console插件可实现控制台的自定义颜色输出

• 新款SpringBoot在线教育平台开源了

• 精品帖子大汇总

• 一把“乐观锁”轻松搞定高并发下的幂等性问题(附视频教程)

• 一文搞懂Java8 Lambda表达式(附视频教程)

感谢点赞支持下哈