spring boot演示json返回信息與統(tǒng)一異常處理

1.創(chuàng)建基于spring boot+jpa的基本的增刪

請(qǐng)參考spring boot+jpa簡(jiǎn)單實(shí)現(xiàn)就不多介紹了醋界。本次主要是統(tǒng)一異常處理的演進(jìn)過程,還有一個(gè)目的是剛看的異常處理視頻蹭睡,記錄一下,方便以后查看尼酿。

2.最原始的返回(不友好恭理,不利于前端處理)

    @RequestMapping("findByIdFirst")
    public Student findByIdFirst(@RequestParam String id) {
        return studentService.findById(id).orElse(null);
    }

    @RequestMapping("findAllFirst")
    public List<Student> findByIdFirst() {
        return studentService.list();
    }
  • 如果存在Student的id為d4c-2cfaa59e-27a8-46c1-8578-da715e44b214則返回。

    findByIdFirst

  • 如果查詢的id不存在剿牺,則什么都不返回


    查詢id不存在
  • 如果存在數(shù)據(jù)企垦,list接口返回


    list有數(shù)據(jù)

如果不存在數(shù)據(jù),則返回晒来。


list為空

如果用這種接口返回?cái)?shù)據(jù)钞诡,肯定會(huì)被前端捶爆。(還是不要嘗試了!哎荧降!說多了都是淚=芋铩!朵诫!)

3 .怎么改進(jìn)

我們定義一個(gè)ResultInfo對(duì)象來統(tǒng)一定義返回結(jié)果辛友。

package com.d4c.exception.demo.pojo;

import lombok.Data;

/**
 * Created with IntelliJ IDEA.
 * User: liangqing.zhao(zlq)
 * Date: 2019/10/7 19:41
 * Description:
 */
@Data
public class ResultInfo<T> {
    /**
     *返回碼
     */
    private Integer code;
    /**
     *返回提示信息
     */
    private String msg;
    /**
     *返回具體對(duì)象
     */
    private T data;
}

上面的接口就可以改進(jìn)為

 @RequestMapping("findByIdSecond")
    public ResultInfo findByIdSecond(@RequestParam String id) {
        Student stu = studentService.findById(id).orElse(null);
        ResultInfo resultInfo = new ResultInfo();
        resultInfo.setCode(1);
        resultInfo.setMsg("成功!");
        resultInfo.setData(stu);
        return resultInfo;
    }

    @RequestMapping("findAllSecond")
    public ResultInfo findByIdSecond() {
        List<Student> listStudent = studentService.list();
        ResultInfo resultInfo = new ResultInfo();
        resultInfo.setCode(1);
        resultInfo.setMsg("成功剪返!");
        resultInfo.setData(listStudent);
        return resultInfo;
    }
  • 改造后的數(shù)據(jù)(1條數(shù)據(jù))


    get
  • list


    list

現(xiàn)在不管有沒有數(shù)據(jù)废累,共同的部分code和msg都會(huì)返回,這樣更有利于前端的判斷處理數(shù)據(jù)随夸。

但是九默,每次返回成功都要寫一遍
ResultInfo resultInfo = new ResultInfo();
resultInfo.setCode(1);
resultInfo.setMsg("成功!");
這有點(diǎn)太繁瑣宾毒,一點(diǎn)都不優(yōu)雅M招蕖!诈铛!

4. 代碼共同的部分提取成一個(gè)工具類乙各。

package com.d4c.exception.demo.utils;

import com.d4c.exception.demo.pojo.ResultInfo;

/**
 * Created with IntelliJ IDEA.
 * User: liangqing.zhao(zlq)
 * Date: 2019/10/7 19:42
 * Description:
 */
public class ResultInfoOldUtil {
    public static ResultInfo success(Object object) {
        ResultInfo result = new ResultInfo();
        result.setCode(1);
        result.setMsg("成功!");
        result.setData(object);
        return result;
    }

}

然后幢竹,代碼就能改成

 @RequestMapping("findByIdThird")
    public ResultInfo findByIdThird(@RequestParam String id) {
        Student stu = studentService.findById(id).orElse(null);
        return ResultInfoOldUtil.success(stu);
    }

    @RequestMapping("findAllThird")
    public ResultInfo findByIdThird() {
        List<Student> listStudent = studentService.list();
        return ResultInfoOldUtil.success(listStudent);
    }

效果與上面一樣耳峦。

到上面我們就處理了我們成功的代碼,但只是成功焕毫,前提是代碼不出現(xiàn)異常蹲坷,但是這也許有可能吧!R仂循签!

我們來主動(dòng)測(cè)試一個(gè)異常看看

 @RequestMapping("findByIdFourth")
    public ResultInfo findByIdFourth(@RequestParam String id) {
        
        Student stu = studentService.findById(id).orElse(null);
        Integer count = 1/0;
        return ResultInfoOldUtil.success(stu);
    }
type=Internal Server Error, status=500

直接異常拋到頁面上疙咸,這怎么可以县匠。

因此又處理了一下,變成了

  @RequestMapping("findByIdFourth")
    public ResultInfo findByIdFourth(@RequestParam String id) {
        try {
            Student stu = studentService.findById(id).orElse(null);
            Integer count = 1/0;
            return ResultInfoOldUtil.success(stu);
        } catch (Exception e) {
            e.printStackTrace();
            return ResultInfoOldUtil.error();
        }
    }

    @RequestMapping("findAllFourth")
    public ResultInfo findByIdFourth() throws Exception {
        try {
            List<Student> listStudent = studentService.list();
            throw new Exception("出現(xiàn)異常");
        } catch (Exception e) {
            e.printStackTrace();
            return ResultInfoOldUtil.error();
        }
    }

此時(shí)的結(jié)果變成了


異常統(tǒng)一

異常也變得優(yōu)雅了撒轮!

但是乞旦,如果異常多了,我們分別處理题山,就有變成了兰粉。
try {...} catch(...) {...}catch(...).... finally {...}

這樣處理如此繁瑣。能不能把這些異常統(tǒng)一處理一下顶瞳,處理一次亲桦,下次就不有再處理同樣的異常了崖蜜。

5.統(tǒng)一異常處理@ControllerAdvice+ @ExceptionHandler(...)

package com.d4c.exception.demo.handle;

import com.d4c.exception.demo.enums.ResultInfoEnum;
import com.d4c.exception.demo.exception.StudentException;
import com.d4c.exception.demo.pojo.ResultInfo;
import com.d4c.exception.demo.utils.ResultInfoUtil;
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;

/**
 * Created with IntelliJ IDEA.
 * User: liangqing.zhao(zlq)
 * Date: 2019/10/7 19:40
 * Description:
 */
@ControllerAdvice
@Slf4j
public class ExceptionHandle {
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ResultInfo handleException(Exception e) {
        if (e instanceof StudentException) {
            StudentException studentException = (StudentException) e;
            return ResultInfoUtil.error(studentException.getCode(), studentException.getMessage());
        } else if (e instanceof NullPointerException) {
            ResultInfoEnum resultInfoEnum = ResultInfoEnum.NULL_POINT_EXCEPTION;
            return ResultInfoUtil.error(resultInfoEnum.getCode(), resultInfoEnum.getMsg());
        } else if (e instanceof IndexOutOfBoundsException) {
            ResultInfoEnum resultInfoEnum = ResultInfoEnum.INDEX_OUT_BOUNDS_EXCEPTION;
            return ResultInfoUtil.error(resultInfoEnum.getCode(), resultInfoEnum.getMsg());
        } else {
            log.error("【系統(tǒng)異常】{}", e);
            ResultInfoEnum unknown = ResultInfoEnum.UNKNOWN;
            return ResultInfoUtil.error(unknown.getCode(), unknown.getMsg());
        }
    }
}
package com.d4c.exception.demo.exception;


import com.d4c.exception.demo.enums.ResultInfoEnum;
import lombok.Data;
import lombok.Getter;
import lombok.Setter;
import net.bytebuddy.implementation.bind.annotation.Super;

/**
 * Created with IntelliJ IDEA.
 * User: liangqing.zhao(zlq)
 * Date: 2019/10/7 19:36
 * Description:
 */
@Getter
@Setter
public class StudentException extends RuntimeException {

    private Integer code;

    public StudentException(ResultInfoEnum resultInfoEnum){
        super(resultInfoEnum.getMsg());
        this.code = resultInfoEnum.getCode();
    }

}

然后我們就不用顯示的try catch了客峭。只要在ExceptionHandle處理一遍就好了。就變成了下面:

 @RequestMapping("findByIdFifth")
    public ResultInfo findByIdFifth(@RequestParam String id) {
        Student stu = studentService.findById(id).orElse(null);
        Integer count = 1 / 0;
        return ResultInfoOldUtil.success(stu);
    }

    @RequestMapping("findAllFifth")
    public ResultInfo findByIdFifth() throws Exception {
        List<Student> listStudent = studentService.list();
        throw new Exception("出現(xiàn)異常");
    }
處理后

6.自定義異常類StudentException

package com.d4c.exception.demo.exception;


import com.d4c.exception.demo.enums.ResultInfoEnum;
import lombok.Getter;
import lombok.Setter;

/**
 * Created with IntelliJ IDEA.
 * User: liangqing.zhao(zlq)
 * Date: 2019/10/7 19:36
 * Description:
 */
@Getter
@Setter
public class StudentException extends RuntimeException {

    private Integer code;

    public StudentException(ResultInfoEnum resultInfoEnum) {
        super(resultInfoEnum.getMsg());
        this.code = resultInfoEnum.getCode();
    }

}

7.統(tǒng)一管理異常信息ResultInfoEnum

package com.d4c.exception.demo.enums;

import lombok.AllArgsConstructor;
import lombok.Getter;

/**
 * Created with IntelliJ IDEA.
 * User: liangqing.zhao(zlq)
 * Date: 2019/10/7 19:39
 * Description:
 * @author
 */
@Getter
@AllArgsConstructor
public enum ResultInfoEnum {
    /**
     * 成功
     */
    SUCCESS(1,"success"),
    /**
     * 失敗
     */
    FAILED(2,"failed"),
    /**
     *未知錯(cuò)誤
     */
    UNKNOWN(3,"未知錯(cuò)誤"),
    /**
     *id不存在
     */
    NOT_EXIST_ID(4,"要查詢的id不存在"),

    NULL_POINT_EXCEPTION(5,"空指針異常"),
    INDEX_OUT_BOUNDS_EXCEPTION(6,"下標(biāo)超出異常")
    ;
    private Integer code;
    private String msg;
}

8.優(yōu)化后的ResultInfoUtil

package com.d4c.exception.demo.utils;

import com.d4c.exception.demo.enums.ResultInfoEnum;
import com.d4c.exception.demo.pojo.ResultInfo;

/**
 * Created with IntelliJ IDEA.
 * User: liangqing.zhao(zlq)
 * Date: 2019/10/7 19:42
 * Description:
 */
public class ResultInfoUtil {
    public static ResultInfo success(Object object) {
        ResultInfo result = new ResultInfo();
        ResultInfoEnum successEnum = ResultInfoEnum.SUCCESS;
        result.setCode(successEnum.getCode());
        result.setMsg(successEnum.getMsg());
        result.setData(object);
        return result;
    }

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

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

最后抡柿,代碼優(yōu)化成

最后項(xiàng)目結(jié)構(gòu)

json與統(tǒng)一異常處理到這里就告一段落了舔琅。
具體的源碼請(qǐng)參考exception-demo

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市洲劣,隨后出現(xiàn)的幾起案子备蚓,更是在濱河造成了極大的恐慌,老刑警劉巖囱稽,帶你破解...
    沈念sama閱讀 216,324評(píng)論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件郊尝,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡战惊,警方通過查閱死者的電腦和手機(jī)流昏,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,356評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來吞获,“玉大人况凉,你說我怎么就攤上這事「骺剑” “怎么了刁绒?”我有些...
    開封第一講書人閱讀 162,328評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)烤黍。 經(jīng)常有香客問我知市,道長(zhǎng),這世上最難降的妖魔是什么速蕊? 我笑而不...
    開封第一講書人閱讀 58,147評(píng)論 1 292
  • 正文 為了忘掉前任嫂丙,我火速辦了婚禮,結(jié)果婚禮上互例,老公的妹妹穿的比我還像新娘奢入。我一直安慰自己,他們只是感情好媳叨,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,160評(píng)論 6 388
  • 文/花漫 我一把揭開白布腥光。 她就那樣靜靜地躺著,像睡著了一般糊秆。 火紅的嫁衣襯著肌膚如雪武福。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,115評(píng)論 1 296
  • 那天痘番,我揣著相機(jī)與錄音捉片,去河邊找鬼平痰。 笑死,一個(gè)胖子當(dāng)著我的面吹牛伍纫,可吹牛的內(nèi)容都是我干的宗雇。 我是一名探鬼主播,決...
    沈念sama閱讀 40,025評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼莹规,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼赔蒲!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起良漱,我...
    開封第一講書人閱讀 38,867評(píng)論 0 274
  • 序言:老撾萬榮一對(duì)情侶失蹤舞虱,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后母市,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體矾兜,經(jīng)...
    沈念sama閱讀 45,307評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,528評(píng)論 2 332
  • 正文 我和宋清朗相戀三年患久,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了椅寺。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,688評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡墙杯,死狀恐怖配并,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情高镐,我是刑警寧澤溉旋,帶...
    沈念sama閱讀 35,409評(píng)論 5 343
  • 正文 年R本政府宣布,位于F島的核電站嫉髓,受9級(jí)特大地震影響观腊,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜算行,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,001評(píng)論 3 325
  • 文/蒙蒙 一梧油、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧州邢,春花似錦儡陨、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,657評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至呀枢,卻和暖如春胚股,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背裙秋。 一陣腳步聲響...
    開封第一講書人閱讀 32,811評(píng)論 1 268
  • 我被黑心中介騙來泰國打工琅拌, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留缨伊,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,685評(píng)論 2 368
  • 正文 我出身青樓进宝,卻偏偏與公主長(zhǎng)得像刻坊,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子党晋,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,573評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容