springboot統一異常處理及返回數據的處理

一.返回code數據的處理

代碼:

Result.java

/**
 * http請求返回的最外層對象
 * Created by 廖師兄
 * 2017-01-21 13:34
 */
public class Result<T> {

    /** 錯誤碼. */
    private Integer code;

    /** 提示信息. */
    private String msg;

    /** 具體的內容. */
    private T data;

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}

ResultUtil .java

public class ResultUtil {

    public static Result success(Object object) {
        Result result = new Result();
        result.setCode(0);
        result.setMsg("成功");
        result.setData(object);
        return result;
    }

    public static Result success() {
        return success(null);
    }

    public static Result error(Integer code, String msg) {
        Result result = new Result();
        result.setCode(code);
        result.setMsg(msg);
        return result;
    }
}

 

@Entity
public class Gril {
    @Id
    @GeneratedValue
 @NotNull(message = "這個id必傳")
    private Integer id;
   

    public Integer getId(Integer id) {
        return this.id;
    }

    public void setId(Integer id) {
        this.id = id;
    }
}

使用:

@RestController
public class GrilController {   
 //添加女生
    @PostMapping(value = "/grils/{id}")
 public Result<Gril> grilAdd(@Valid Gril gril, BindingResult bindingResult){ 

if(bindingResult.hasErrors())
{ 
//這個是把gril里面的這個id必傳返回給前端
return ResultUtil.error(1,bindingResult.getFieldError().getDefaultMessage());
 } 

return ResultUtil.success(grilpepository.save(gril));
 }

訪問http://127.0.0.1:8081/grils

返回

{
  "code": 1,
  "msg": "這個id必傳",
  "data": null
}

訪問http://127.0.0.1:8081/grils/2

返回

  {
    "id": 21
  }

 

二:統一異常處理

 

public class GrilException extends RuntimeException{
    private Integer code;

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

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }
}

 

@ControllerAdvice
public class ExceptionHandle {
    private final static Logger logger = LoggerFactory.getLogger(ExceptionHandle.class);
    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public Result Handle(Exception e){

        if (e instanceof GrilException){
            GrilException grilException = (GrilException) e;
            return ResultUtil.error(grilException.getCode(),grilException.getMessage());

        }else {
　　　　　　//將系統異常以打印出來
            logger.info("[系統異常]{}",e);
            return ResultUtil.error(-1,"未知錯誤");
        }

    }
}

使用:

@Service
public class GirlService {
 public void getAge(Integer id) throws Exception{
        Girl girl = girlRepository.findOne(id);
        Integer age = girl.getAge();
        if (age < 10) {
            //返回"你還在上小學吧" code=100
            throw new GirlException(100,"你還在上小學吧");
        }else if (age > 10 && age < 16) {
            //返回"你可能在上初中" code=101
            throw new GirlException(101,"你可能在上初中" );
        }

    }
}

 

@RestController
public class GirlController {

    @Autowired
    private GirlService girlService;
   @GetMapping(value = "girls/getAge/{id}")
    public void getAge(@PathVariable("id") Integer id) throws Exception{
        girlService.getAge(id);
    }
}

執行結果為:

三:異常是統一維護:

 

public class GirlException extends RuntimeException{

    private Integer code;

    public GirlException(ResultEnum resultEnum) {
        super(resultEnum.getMsg());
        this.code = resultEnum.getCode();
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }
}

 

@ControllerAdvice
public class ExceptionHandle {

    private final static Logger logger = LoggerFactory.getLogger(ExceptionHandle.class);

    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public Result handle(Exception e) {
        if (e instanceof GirlException) {
            GirlException girlException = (GirlException) e;
            return ResultUtil.error(girlException.getCode(), girlException.getMessage());
        }else {
            logger.error("【系統異常】{}", e);
            return ResultUtil.error(-1, "未知錯誤");
        }
    }
}

這個就是統一維護的文件,采用枚舉

public enum ResultEnum {
    UNKONW_ERROR(-1, "未知錯誤"),
    SUCCESS(0, "成功"),
    PRIMARY_SCHOOL(100, "我猜你可能還在上小學"),
    MIDDLE_SCHOOL(101, "你可能在上初中"),

    ;

    private Integer code;

    private String msg;

    ResultEnum(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public Integer getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
}

 

使用:

@Service
public class GirlService {

    @Autowired
    private GirlRepository girlRepository;

    public void getAge(Integer id) throws Exception{
        Girl girl = girlRepository.findOne(id);
        Integer age = girl.getAge();
        if (age < 10) {
            //返回"你還在上小學吧" code=100
            throw new GirlException(ResultEnum.PRIMARY_SCHOOL);
        }else if (age > 10 && age < 16) {
            //返回"你可能在上初中" code=101
            throw new GirlException(ResultEnum.MIDDLE_SCHOOL);
        }

        //如果>16歲,加錢
        //...
    }
}

 

@RestController
public class GirlController {


    @Autowired
    private GirlService girlService;


    @GetMapping(value = "girls/getAge/{id}")
    public void getAge(@PathVariable("id") Integer id) throws Exception{
        girlService.getAge(id);
    }