Java設(shè)計(jì)RestCodeEnum枚舉件豌,實(shí)現(xiàn)接口統(tǒng)一格式返回

1.接口返回值枚舉定義

    /**
     *接口返回枚舉定義
     */
    public enum RestCodeEnum {
    SUCCESS("200", "處理成功"),
    ERROR("500", "系統(tǒng)異常");

    private String code;
    private String msg;

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

    public String getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
 }

2.異常信息拋出返回值定義

public class RestException extends RuntimeException {
    private static final long serialVersionUID = -649224303322031383L;

    private RestCodeEnum retCode;

    public RestException() {
        super();
    }

    public RestException(RestCodeEnum retCode) {
        super(retCode.getMsg());
        this.retCode = retCode;
    }

    public RestException(RestCodeEnum retCode, String msg) {
        super(msg);
        this.retCode = retCode;
    }

    public RestCodeEnum getRetCode() {
        return this.retCode;
    }

    public void setRetCode(RestCodeEnum retCode) {
        this.retCode = retCode;
    }
}

3.接口統(tǒng)一返回參數(shù)定義

@Slf4j
public abstract class BaseController {
    public static final String CODE = "code";
    public static final String MSG = "msg";
    public static final String DATA = "data";

    protected static String success() {
        final Map<String, Object> result = Maps.newHashMap();
        result.put(CODE, RestCodeEnum.SUCCESS.getCode());
        result.put(MSG, RestCodeEnum.SUCCESS.getMsg());
        return JSON.toJSONString(result);
    }

    protected static String success(Object data) {
        final Map<String, Object> result = Maps.newHashMap();
        result.put(CODE, RestCodeEnum.SUCCESS.getCode());
        result.put(MSG, RestCodeEnum.SUCCESS.getMsg());
        result.put(DATA, data);
        return JSON.toJSONString(result);
    }

    protected static String error(RestCodeEnum code) {
        final Map<String, Object> result = Maps.newHashMap();
        result.put(CODE, code.getCode());
        result.put(MSG, code.getMsg());
        return JSON.toJSONString(result);
    }

    protected static String error(RestCodeEnum code, String msg) {
        final Map<String, Object> result = Maps.newHashMap();
        result.put(CODE, code.getCode());
        result.put(MSG, msg);
        return JSON.toJSONString(result);
    }
}

4.增加全局異常

/**
 * 全局異常處理器
 */
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler extends BaseController {
    /**
     * 基礎(chǔ)異常
     */
    @ExceptionHandler(RestException.class)
    public String baseException(RestException e) {
        return error(e.getRetCode(), e.getMessage());
    }
}

5.實(shí)例

/**
 * 直接使用error僵驰、success 需要繼承 BaseController
 */
@RestController
@RequestMapping("/dataProcessing")
public class DataProcessingController extends BaseController {

    @Resource
    private JdbcTemplate jdbcTemplate;

    @PostMapping("/deleteSource")
    public String deleteSource(@RequestBody JSONObject body) {
        String sqlCode = body.getString("sqlCode");
        if (StringUtils.isBlank(sqlCode)) {
            throw new RestException(RestCodeEnum.ERROR);//異常信息直接拋出
        }
        if (jdbcTemplate.update("UPDATE `data_sql` SET `status` = '0' where `sql_code` = '" + sqlCode + "';") > 0) {
            return success();//成功信息返回
        }
        return error(RestCodeEnum.ERROR);//錯(cuò)誤信息返回
    }
}
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末喷斋,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子蒜茴,更是在濱河造成了極大的恐慌星爪,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,651評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件矮男,死亡現(xiàn)場(chǎng)離奇詭異移必,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)毡鉴,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,468評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門(mén)崔泵,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)秒赤,“玉大人,你說(shuō)我怎么就攤上這事憎瘸∪肜海” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 162,931評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵幌甘,是天一觀的道長(zhǎng)潮售。 經(jīng)常有香客問(wèn)我,道長(zhǎng)锅风,這世上最難降的妖魔是什么酥诽? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,218評(píng)論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮皱埠,結(jié)果婚禮上肮帐,老公的妹妹穿的比我還像新娘。我一直安慰自己边器,他們只是感情好训枢,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,234評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著忘巧,像睡著了一般恒界。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上砚嘴,一...
    開(kāi)封第一講書(shū)人閱讀 51,198評(píng)論 1 299
  • 那天十酣,我揣著相機(jī)與錄音,去河邊找鬼枣宫。 笑死婆誓,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的也颤。 我是一名探鬼主播,決...
    沈念sama閱讀 40,084評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼郁轻,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼翅娶!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起好唯,我...
    開(kāi)封第一講書(shū)人閱讀 38,926評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤竭沫,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后骑篙,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體蜕提,經(jīng)...
    沈念sama閱讀 45,341評(píng)論 1 311
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,563評(píng)論 2 333
  • 正文 我和宋清朗相戀三年靶端,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了谎势。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片凛膏。...
    茶點(diǎn)故事閱讀 39,731評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖脏榆,靈堂內(nèi)的尸體忽然破棺而出猖毫,到底是詐尸還是另有隱情,我是刑警寧澤须喂,帶...
    沈念sama閱讀 35,430評(píng)論 5 343
  • 正文 年R本政府宣布吁断,位于F島的核電站,受9級(jí)特大地震影響坞生,放射性物質(zhì)發(fā)生泄漏仔役。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,036評(píng)論 3 326
  • 文/蒙蒙 一是己、第九天 我趴在偏房一處隱蔽的房頂上張望骂因。 院中可真熱鬧,春花似錦赃泡、人聲如沸寒波。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,676評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)俄烁。三九已至,卻和暖如春级野,著一層夾襖步出監(jiān)牢的瞬間页屠,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,829評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工蓖柔, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留辰企,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,743評(píng)論 2 368
  • 正文 我出身青樓况鸣,卻偏偏與公主長(zhǎng)得像牢贸,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子镐捧,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,629評(píng)論 2 354

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