開發(fā)筆記(一):避免重復代碼

最近大家都在忙著功能優(yōu)化和BUG,而我卻比較閑,開發(fā)的模塊沒有什么BUG,也沒什么需要優(yōu)化的,便抽些時間來改下正在開發(fā)項目中的一些壞代碼。

    //壞代碼
    SC_ResponseMsgProto.Builder responseMsgBuilder = SC_ResponseMsgProto.newBuilder();//重復一
    DataMsgProto.Builder dataMsgBuilder = DataMsgProto.newBuilder();//重復二
    dataMsgBuilder.setB(b.build());
    responseMsgBuilder.setDataMsg(dataMsgBuilder.build());//重復三
    responseMsgBuilder.setA(a.build());
    sendMsgToClient(channel, responseMsgBuilder.build());//重復四
message SC_ResponseMsgProto {

    optional DataMsgProto                  dataMsg                  = 1;
    optional A                              a                       = 2;


    message DataMsgProto {
       optional B              b              = 1;
    }
    
    message A {
       optional int32              num             = 1;
       optional C                  c               = 2;
    }

     message B {
          optional int32              num             = 1;
     }

     message C {
         optional int32              num             = 1;
    }
}

項目客戶端和服務器采用的是Google的protobuf協(xié)議,數(shù)據(jù)結(jié)構設計采用的是森林結(jié)構。如上所示,SC_ResponseMsgProto是最頂層對象,在最頂層對象下有多個不同類別的子對象,如A、B、C,子對象下還擁有一些不同類別的子對象C,最終成為一個森林結(jié)構,森林里每個根對象都是一顆樹。對象間有時有一些引用關系,比如,A對象使用了C引用。這樣的設計在開發(fā)中是比較常見的,但是我們在項目中使用時比較流水賬,大量的頂層對象代碼在不同地方重復出現(xiàn)在項目中。對于每個程序員員來說,避免重復代碼是大家都想做的。于是我大約花了不到30行代碼來避免以上標注的四個重復地方,代碼如下:

    /**
     * 下發(fā)給客戶端的消息
     */
    private final LinkedList<GeneratedMessageLite> responseMsgs = new LinkedList<>();
    
    //添加消息
    public void putMsg(GeneratedMessageLite msg) {
        synchronized (responseMsgs) {
            responseMsgs.add(msg);
        }
    }
    
    //發(fā)送消息
    public void sendMsg(Channel channel) {
        //和客戶端通訊的數(shù)據(jù)
        SC_ResponseMsgProto.Builder responseMsgBuilder = SC_ResponseMsgProto.newBuilder();
        DataMsgProto.Builder dataMsgBuilder = DataMsgProto.newBuilder();
        try {
            for (GeneratedMessageLite messageLite : responseMsgs) 
            {
               if (messageLite instanceof A) {
                    responseMsgBuilder.setA((A) messageLite);
                } else if(messageLite instanceof B) {
                    dataMsgBuilder.setB((B) messageLite);
                }
                responseMsgBuilder.setDataMsg(dataMsgBuilder.build());
            }
            sendMsgToClient(channel, responseMsgBuilder.build());
        }catch (Exception e) {
            e.printStackTrace();
            logger.error(e.getMessage(), e);
        } finally {
            responseMsgs.clear();
        }
        
    }

    //優(yōu)化后代碼
    role.putMsg(a.build());
    role.putMsg(b.build());
    role.sendMsg(channel);

雖然避免了重復代碼,但是細心的童鞋可能發(fā)現(xiàn)在sendMsg()里意外的出現(xiàn)了不是最頂層對象的DataMsgProto.如果當DataMsgProto里出現(xiàn)相同類型的b、b1對象時,那就無法從類型上去區(qū)分它們了。我想到的解決方案是使用自定義唯一key來區(qū)分或者在定義協(xié)議時不允許出現(xiàn)相同類型的(這里并不推薦,畢竟有時候多個類型能解決不少問題)。

有同學可能會想能否使用變量名字b作為唯一區(qū)分標識,但是Java能否獲取變量的名字?答案是不能的。詳細參考R大在知乎上的回答

message DataMsgProto {
    optional B              b              = 1;
    optional B              b1             = 2;
}
最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,345評論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,494評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,283評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,953評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,714評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,186評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,255評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,410評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,940評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,776評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,976評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,518評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,210評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,642評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,878評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,654評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,958評論 2 373

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

  • 《裕語言》速成開發(fā)手冊3.0 官方用戶交流:iApp開發(fā)交流(1) 239547050iApp開發(fā)交流(2) 10...
    葉染柒丶閱讀 27,398評論 5 19
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,639評論 25 708
  • 很久以前,年是一只猛獸,會從深山峽谷奔向千家萬戶,搶奪人類的食物,毀壞連街的房屋,甚至殘殺生命,所到之處繁華轉(zhuǎn)眼間...
    書生亦百用閱讀 315評論 2 1
  • 十點十五分,我才從利通廣場的大廈走出來。擔心錯過了B8的最后一班車,用手機百度查一下還有哪條路線可以回家,發(fā)現(xiàn)B8...
    黃青海閱讀 525評論 6 6
  • carolineyty閱讀 361評論 0 0