Don Roberts 提出的一條重構(gòu)準(zhǔn)則:第一次做某件事時(shí)只管去做;第二次做類似的事時(shí)會(huì)產(chǎn)生反感,但無論如何還是可以去做;第三次再做類似的事時(shí),你就應(yīng)該重構(gòu)。
編碼也是如此,當(dāng)多次編寫類似的代碼時(shí),我們需要考慮是否有一種方法能夠提高編碼速度,讓編碼速度“起飛”?高德地圖技術(shù)專家陳昌毅(常意)多年來致力于敏捷開發(fā),總結(jié)了一套編碼的方法論,有助于程序員"快速、優(yōu)質(zhì)、高效"地進(jìn)行編碼。
方法1:手工編寫代碼
大多數(shù)剛學(xué)習(xí) Java 的程序員,都會(huì)懷著一種崇敬的儀式感,一字一句地在開發(fā)工具上敲出以下代碼:
沒錯(cuò),這就是經(jīng)典的"Hello world",這也是大多數(shù)人手工編寫的第一個(gè)程序。
手工編寫代碼,更能體現(xiàn)一個(gè)程序員的基本素質(zhì)。有很多公司,都把上機(jī)編程考試作為面試的重要手段之一。面試者需要根據(jù)題目的要求,挑選一款熟悉的編程工具(比如Eclipse),手工編寫代碼并調(diào)試運(yùn)行通過。在整個(gè)過程中,不能通過網(wǎng)絡(luò)搜索答案,不能查看聯(lián)機(jī)幫助文檔,要求面試者必須手工編寫代碼,主要是考察面試者手工編寫代碼的能力——語法、函數(shù)、邏輯、思維、算法以及動(dòng)手能力。
手工編寫代碼,是一個(gè)優(yōu)秀程序員必須具備的基礎(chǔ)能力。手工編寫代碼正如提筆寫文章,語法就是遣詞造句的方法、函數(shù)就是組成文章的詞句、類庫就是據(jù)經(jīng)引典的掌故、架構(gòu)就是行文表述的體裁、功能就是寫作文章的主旨、算法就是組織語言的邏輯……所以,只要掌握一門程序語言的語法、學(xué)習(xí)一堆基礎(chǔ)類庫的函數(shù)、引用一些所需的第三方類庫、選擇一款成熟穩(wěn)定的架構(gòu)、明確一下產(chǎn)品需求的功能、挑選一種實(shí)現(xiàn)邏輯的算法……手工編寫代碼就會(huì)像寫文章一樣手到擒來。
方法2:復(fù)制粘貼代碼
常言道:"熟讀唐詩三百首,不會(huì)作詩也會(huì)吟。"編碼也是同樣的道理,編碼的第一步就是模仿,簡單地說就是"抄代碼"——復(fù)制粘貼代碼。復(fù)制粘貼代碼是一門藝術(shù),用好了編碼會(huì)事半功倍。但是,沒有檢驗(yàn)過的東西,終究是不可全信的。當(dāng)看到需要的代碼時(shí),在復(fù)制粘貼前,我們都需要仔細(xì)研讀、認(rèn)真思考、詳細(xì)甄別……很多東西,都是仁者見仁、智者見智的東西,適合別的場景但不一定適合你的場景。作為一名合格的程序員,切不可一味地"拿來主義"。
1.為什么要復(fù)制粘貼代碼
- 復(fù)制粘貼現(xiàn)有代碼,可以節(jié)省開發(fā)時(shí)間;
- 復(fù)制粘貼穩(wěn)定代碼,可以降低系統(tǒng)故障風(fēng)險(xiǎn);
- 復(fù)制粘貼網(wǎng)絡(luò)代碼,可以把別人的成果化為己用。
2.復(fù)制粘貼代碼帶來問題
你對復(fù)制的代碼理解程度是多少?實(shí)現(xiàn)邏輯是否合理?能不能穩(wěn)定運(yùn)行?存在多少潛在的 Bug?
這個(gè)代碼在項(xiàng)目中已經(jīng)復(fù)制粘貼了多少次?根據(jù)“三則重構(gòu)”原則,你是否需要對這些相同代碼進(jìn)行重構(gòu)?
代碼被復(fù)制粘貼次數(shù)越多,帶來的代碼維護(hù)問題越多。多個(gè)代碼版本的更改和修正,要保持這些代碼的同步,就必須需要在每一處進(jìn)行同樣的修改,增加了維護(hù)的成本和風(fēng)險(xiǎn)。
總之,復(fù)制粘貼代碼,跟其它編碼方法一樣,沒有優(yōu)劣對錯(cuò)之分。它只是一種方法,你可以善用,也可以濫用。如果我們用到了復(fù)制粘貼,我們就必須為結(jié)果負(fù)責(zé)。
方法3:用文本替換生成代碼
1.生成代碼樣例
已經(jīng)編寫好的用戶查詢相關(guān)代碼:
如果我們要編寫公司查詢相關(guān)代碼,其代碼形式與用戶查詢類似,整理出替換關(guān)系如下:
- 把"用戶"替換為"公司";
- 把"User"替換為"Company";
- 把"user"替換為"company"。
利用 Notepad、EditPlus 等文本編輯器,選擇區(qū)分大小寫,進(jìn)行普通文本替換,最終得到結(jié)果如下:
利用文本替換生成代碼,整段代碼生成時(shí)間不會(huì)超過1分鐘。
2.主要優(yōu)缺點(diǎn)
主要優(yōu)點(diǎn):
- 生成代碼速度較快。
主要缺點(diǎn):
- 必須編寫樣例代碼;
- 只適用于文本替換的情景。
方法4:用Excel公式生成代碼
Excel 的公式非常強(qiáng)悍,可以用于編寫一些公式化的代碼。
1.利用 Excel 公式生成模型類
從 WIKI 上拷貝接口模型定義到 Excel 里,樣例數(shù)據(jù)內(nèi)容如下:
編寫 Excel 公式如下:
利用公式生成代碼如下:
創(chuàng)建模型類,整理代碼如下:
2.利用 Excel 公式生成枚舉類
從 WIKI 上拷貝枚舉定義到 Excel 里,樣例數(shù)據(jù)內(nèi)容如下:
編寫 Excel 公式如下:
利用公式生成代碼如下:
創(chuàng)建枚舉類,整理代碼如下:
3.利用 Excel 公式生成數(shù)據(jù)庫語句
用 Excel 整理的公司列表如下,需要整理成 SQL 語句直接插入數(shù)據(jù)庫:
編寫 Excel 公式如下:
利用公式生成 SQL 如下:
添加 into 語句頭,整理 SQL 如下:
4.主要優(yōu)缺點(diǎn)
主要優(yōu)點(diǎn):
- 適用于表格化數(shù)據(jù)的代碼生成;
- 寫好公式后,拖拽生成代碼,生成速度較快。
主要缺點(diǎn):
- 不適用于復(fù)雜功能的代碼生成。
方法5:用工具生成代碼
用工具生成代碼,顧名思義就是借用已有的工具生成代碼。很多開發(fā)工具都提供一些工具生成代碼,比如:生成構(gòu)造函數(shù),重載基類/接口函數(shù),生成 Getter/Setter 函數(shù),生成 toString 函數(shù)……能夠避免很多手敲代碼。還有一些生成代碼插件,也可以生成滿足某些應(yīng)用場景的代碼。
這里以 mybatis-generator 插件生成代碼為例,介紹如何利用工具生成代碼。
1.安裝運(yùn)行插件
具體方法這里不再累述,自行上網(wǎng)搜索文檔了解。
2.生成代碼樣例
★ 2.1.生成模型類代碼
文件 User.java 內(nèi)容:
......public class User { private Long id; private String user; private String password; private Integer age; ......}
★ 2.2.生成映射接口代碼
文件 UserMapper.java 內(nèi)容:
★ 2.3.生成映射XML代碼
文件 UserMapper.xml 內(nèi)容:
3.主要優(yōu)缺點(diǎn)
主要優(yōu)點(diǎn):
- 利用生成代碼插件,生成代碼速度較快;
- 利用插件配置文件,控制生成想要的功能代碼。
主要缺點(diǎn):
- 需要時(shí)間研究和熟悉生成代碼插件的使用;
- 生成的代碼不一定滿足代碼規(guī)范,每次生成后需進(jìn)行代碼合規(guī);
- 重新生成代碼后,容易覆蓋自定義代碼(建議維護(hù)單獨(dú)的生成代碼庫,通過DIFF 工具比較代碼差異,然后再賦值粘貼差異代碼)。
方法6:用代碼生成代碼
用代碼生成代碼,就是自己編寫代碼,按照自己的格式生成代碼。下面,以生成基于 MyBatis 的數(shù)據(jù)庫訪問代碼為例說明。
1.查詢表格信息
首先,我們要從數(shù)據(jù)庫中拿到我們生成代碼所需要的表和列相關(guān)信息。
★ 1.1.查詢表信息
查詢表信息語句:
其中,第1個(gè)問號(hào)賦值數(shù)據(jù)庫名稱,第2個(gè)問號(hào)賦值表名稱。
查詢表信息結(jié)果:
★ 1.2.查詢列信息
查詢列信息語句:
其中,第1個(gè)問號(hào)賦值數(shù)據(jù)庫名稱,第2個(gè)問號(hào)賦值表名稱。
查詢列信息結(jié)果:
2.編寫生成代碼
★ 2.1.編寫生成模型類代碼
★ 2.2.編寫生成 DAO 接口代碼
★ 2.3.編寫生成 DAO 映射代碼
3.生成相關(guān)代碼
★ 3.1.生成的模型類代碼
★ 3.2.生成的 DAO 接口代碼
★ 3.3.生成的 DAO 映射代碼
3.主要優(yōu)缺點(diǎn)
主要優(yōu)點(diǎn):
- 代碼格式可以定制,保證生成代碼合規(guī);
- 代碼功能可以定制,只生成需要的代碼;
- 經(jīng)過前期代碼沉淀后,后期能夠直接使用。
主要缺點(diǎn):
- 需要研究數(shù)據(jù)來源,保證能獲取到生成代碼所需的數(shù)據(jù);
- 需要建立數(shù)據(jù)模型、編寫生成代碼,耗費(fèi)時(shí)間比較長。
終極方法:無招勝有招
編碼的終極方法,是不是直接對著電腦說需求,然后電腦就自動(dòng)生成代碼了?未來科技發(fā)展到一定水平后,這種情況或許會(huì)變成現(xiàn)實(shí)。但是,目前這種情況是不現(xiàn)實(shí)的?,F(xiàn)實(shí)中,想要做到"大口一張、代碼就來",除非你是老板、產(chǎn)品經(jīng)理或者技術(shù)管理者。
編碼的終極方法是“無招勝有招”,"無招"并不是不講究"招式",而是不拘泥于某一"招式",信手拈來合適的"招式"為宜。本文中列舉的各種編碼方法,沒有高低優(yōu)劣之分,只有合不合適之說。所以,靈活地運(yùn)用各種編碼方法,就是編碼的終極方法。
代碼規(guī)范化
在上面的各種編碼方法中,很多方法都需要手工編寫樣例代碼。如果你的代碼不遵循代碼規(guī)范,就很難發(fā)現(xiàn)代碼之間的共性,并抽象出能夠作為標(biāo)準(zhǔn)的樣例代碼;如果作為標(biāo)準(zhǔn)的樣例代碼不滿足代碼規(guī)范,必然導(dǎo)致生成的代碼也不滿足代碼規(guī)范,于是把這些不規(guī)范放大了十倍、百倍甚至千倍。所以,代碼規(guī)范化是編碼的重中之重。
【責(zé)任編輯:武曉燕 TEL:(010)68476606】