非官方常用类:MessageInfo 消息接口

消息接口

消息接口定义了两个方法: String getCode()String getMessage()

  • getCode()返回编码,对应接口调用时返回成功或者失败的返回码或者错误码
  • getMessage()返回文字描述信息,对应接口调用时的成功或者失败的描述,或者详细的异常信息,用于展示

使用

本接口常用于构造Result类。 由于 MessageInfo 是一个接口,其实现就非常灵活。子类可以是枚举,异常。
应用系统中,对于一些既定的场景,可以预置一些实现 MessageInfo 的 枚举类 MessageEnum。

  • 当代码执行时,出现特定场景时,返回对应的结果,此时用 MessageEnum来构造返回消息 Result或者异常(比如业务异常BusinessException)
  • 而 BusinessException 也应该是实现 MessageInfo的,程序中抛出该异常后,在外围被捕捉,这时,又可以用 BusinessException 来构造返回消息Result

/**
 * <h1>消息接口</h1>
 * 消息接口定义了两个方法:String getCode()和 String getMessage()<BR/>
 * * getCode()返回编码,对应接口调用时返回成功或者失败的返回码或者错误码<BR/>
 * * getMessage()返回文字描述信息,对应接口调用时的成功或者失败的描述,或者详细的异常信息,用于展示<P/>
 * <h2>使用</h2>
 * 本接口常用于构造Result类。 <BR/>
 * 由于 MessageInfo 是一个接口,其实现就非常灵活。子类可以是枚举,异常。 <BR/>
 * * 应用系统中,对于一些既定的场景,可以预置一些实现 MessageInfo 的 枚举类 MessageEnum。<BR/>
 * * 当代码执行时,出现特定场景时,返回对应的结果,此时用 MessageEnum来构造返回消息 Result或者异常(比如业务异常BusinessException)<BR/>
 * * 而 BusinessException 也应该是实现 MessageInfo的,程序中抛出该异常后,在外围被捕捉,这时,又可以用 BusinessException 来构造返回消息Result
 */
public interface MessageInfo {
    /**
     * 子类(枚举)定义code,通过该方法返回给调用方
     * 常见的场景有,在异常处理中,需要创建一个指定场景的异常。
     * 而该场景对应的是一个枚举类型。
     * 枚举实现了MessageInfo接口,异常的构造方法就可以通过 getCode()来赋值
     *
     * @return 子类中定义的code
     */
    String getCode();

    /**
     * 与getCode类似,子类(枚举)定义message,通过该方法返回给调用方
     * 常见的场景有,在异常处理中,需要创建一个指定场景的异常。
     * 而该场景对应的是一个枚举类型。
     * 枚举实现了MessageInfo接口,异常的构造方法就可以通过 getMessage()来赋值
     *
     * @return 子类中定义的message
     */
    String getMessage();
}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342

推荐阅读更多精彩内容