概述

本文是繼《編寫代碼的「八榮八恥」(上篇)》和《編寫代碼的「八榮八恥」-以開關(guān)上線為榮，以自信編碼為恥 》之后，編寫代碼的「八榮八恥」系列的第三篇。

本篇整體框架還是采用經(jīng)典的問題分析三步曲：what、why、how。

?

WHAT

編寫代碼的「八榮八恥」

1. 產(chǎn)品命名：以簡單有趣為榮，以平庸難記為恥。

2. 單個(gè)方法：以短小精悍為榮，以冗長費(fèi)神為恥。

3. 代碼維護(hù)：以持續(xù)重構(gòu)為榮，以停滯不前為恥。

4. 編程思想：以面向?qū)ο鬄闃s，以面向過程為恥。

5. 程序設(shè)計(jì)：以開關(guān)上線為榮，以自信編碼為恥。

6. 接口定義：以用戶易用為榮，以復(fù)雜歧義為恥。

7. 斷言分支：以實(shí)時(shí)報(bào)警為榮，以忽略分支為恥。

8. 報(bào)警策略：以定時(shí)調(diào)整為榮，以放棄維護(hù)為恥。

?

WHY

面向?qū)ο蟮脑O(shè)計(jì)中，之所以要抽象成接口，而不直接面向?qū)崿F(xiàn)類。主要是基于「抽象比細(xì)節(jié)更長久」的理論基礎(chǔ)，實(shí)現(xiàn)類可更改可替換。

?

調(diào)用方不需要關(guān)心接口怎么實(shí)現(xiàn)，只需要知道接口做什么和怎么用即可。這也注定了接口設(shè)計(jì)的兩個(gè)基本指標(biāo)：易懂和易用。

?

HOW

這里主要針對(duì)平時(shí)工作中看到的同學(xué)經(jīng)常犯的三個(gè)誤區(qū)做建議。

以包羅萬象為恥

以需傳默認(rèn)為恥

以按業(yè)務(wù)定義為榮，以按技術(shù)定義為恥。

來看一下出現(xiàn)這個(gè)三個(gè)誤區(qū)的影響三葉草：

?

從圖中可以看出，出現(xiàn)這三個(gè)誤區(qū)，最終會(huì)產(chǎn)出難懂又難用的爛接口。下面針對(duì)這三個(gè)方面給出具體的例子。

?

以包羅萬象為恥

Elasticsearch(ES)很強(qiáng)大，支持很多復(fù)雜查詢。做了一個(gè)查詢系統(tǒng)，底層用了ES做存儲(chǔ)。提供接口給上層調(diào)用。如果直接把ES接口作為自己的業(yè)務(wù)接口給上層來調(diào)用，這會(huì)很強(qiáng)大，想查的東西一定可以查到。但是請(qǐng)回家路上小心點(diǎn)，很可能第二天就看不到你來上班了，因?yàn)楸蛔錾蠈拥耐陆o打死了。

比較好的一個(gè)實(shí)踐是針對(duì)上層調(diào)用方的具體需求，產(chǎn)生出一個(gè)更加有針對(duì)性的接口。有很簡單的入?yún)⒑统鰠ⅰ１热鏓S里存的是世界地圖。上層調(diào)用方是做定位的。他會(huì)輸入兩個(gè)參數(shù)：經(jīng)度和緯度。他只需要返回一個(gè)信息：所在城市。那就自己封裝好給調(diào)用方提供一個(gè)根據(jù)經(jīng)緯度查詢城市的接口就好了。

?

以需傳默認(rèn)為恥

這個(gè)很好理解。下面是java.lang.String類的構(gòu)造方法。如果不提供只有char入?yún)⒌?#xff0c;每次調(diào)用都需要填寫默認(rèn)的new String('f',-1,2)，是不是很想砍人？

?

最悲催的是這種形式的調(diào)用：

Shit shit = crap.shit("shit",null,null,null,null,null,null);

數(shù)null數(shù)到頭暈。底層封裝一層撒。

?

以按業(yè)務(wù)定義為榮，以按技術(shù)定義為恥

其實(shí)靜兒在寫代碼的時(shí)候經(jīng)常寫這樣一種實(shí)現(xiàn)：定義一個(gè)XXXBuilder，入?yún)⑹且粋€(gè)XXXXOption類。這是一種常見的設(shè)計(jì)模式。將各種選項(xiàng)放到構(gòu)造器里構(gòu)造出真正需要的入?yún)ⅰＨ缓笤俳唤o一個(gè)接口讓它去完成功能。構(gòu)造入?yún)⒋a舉例如下：

?

是不是很頭大？作為基礎(chǔ)接口提供者，需要將這些復(fù)雜的技術(shù)邏輯封裝好成業(yè)務(wù)領(lǐng)域的接口。實(shí)在是邏輯復(fù)雜也要自己提供靜態(tài)的Builder工具讓客戶端可方便的合成。不要把這些任務(wù)交給調(diào)用方自己去完成。

上面一堆代碼可以通過「策略下沉」將其抽象為一種策略，打個(gè)比方定義為：通用宿主機(jī)正常狀態(tài)選項(xiàng)。把這個(gè)選項(xiàng)做成封裝暴露出去，不是直接讓調(diào)用方來拼這個(gè)入?yún)ⅰ?/span>

?

總結(jié)

少即是多

?

溫故知新

JAVA日志的前世今生

從技術(shù)渣到被要求改行到硅谷程序媛

跑題時(shí)間：接下來5個(gè)月的計(jì)劃

簡明日志規(guī)范

轉(zhuǎn)載于:https://www.cnblogs.com/xiexj/p/10823523.html

總結(jié)

以上是生活随笔為你收集整理的编写代码的「八荣八耻」- 以用户易用为荣，以复杂歧义为耻的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。