最近大家都在忙著功能優(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;
}