導(dǎo)讀

Don Roberts提出的一條重構(gòu)準(zhǔn)則：

第一次做某件事時只管去做；第二次做類似的事時會產(chǎn)生反感，但無論如何還是可以去做；第三次再做類似的事時，你就應(yīng)該重構(gòu)。

編碼也是如此，當(dāng)多次編寫類似的代碼時，我們需要考慮是否有一種方法能夠提高編碼速度。作者多年來致力于敏捷開發(fā)，總結(jié)了一套編碼的方法論，有助于程序員"快速、優(yōu)質(zhì)、高效"地進(jìn)行編碼。

方法1：手工編寫代碼

大多數(shù)剛學(xué)習(xí)Java的程序員，都會懷著一種崇敬的儀式感，一字一句地在開發(fā)工具上敲出以下代碼：

public class Test {public static void main(String[] args) {System.out.println("Hello world!");} }

沒錯，這就是經(jīng)典的"Hello world"，這也是大多數(shù)人手工編寫的第一個程序。

手工編寫代碼，更能體現(xiàn)一個程序員的基本素質(zhì)。有很多公司，都把上機編程考試作為面試的重要手段之一。面試者需要根據(jù)題目的要求，挑選一款熟悉的編程工具（比如Eclipse），手工編寫代碼并調(diào)試運行通過。在整個過程中，不能通過網(wǎng)絡(luò)搜索答案，不能查看聯(lián)機幫助文檔，要求面試者必須手工編寫代碼，主要是考察面試者手工編寫代碼的能力——語法、函數(shù)、邏輯、思維、算法以及動手能力。

手工編寫代碼，是一個優(yōu)秀程序員必須具備的基礎(chǔ)能力。手工編寫代碼正如提筆寫文章，語法就是遣詞造句的方法、函數(shù)就是組成文章的詞句、類庫就是據(jù)經(jīng)引典的掌故、架構(gòu)就是行文表述的體裁、功能就是寫作文章的主旨、算法就是組織語言的邏輯……所以，只要掌握一門程序語言的語法、學(xué)習(xí)一堆基礎(chǔ)類庫的函數(shù)、引用一些所需的第三方類庫、選擇一款成熟穩(wěn)定的架構(gòu)、明確一下產(chǎn)品需求的功能、挑選一種實現(xiàn)邏輯的算法……手工編寫代碼就會像寫文章一樣手到擒來。

方法2：復(fù)制粘貼代碼

常言道："熟讀唐詩三百首，不會作詩也會吟。"編碼也是同樣的道理，編碼的第一步就是模仿，簡單地說就是"抄代碼"——復(fù)制粘貼代碼。復(fù)制粘貼代碼是一門藝術(shù)，用好了編碼會事半功倍。但是，沒有檢驗過的東西，終究是不可全信的。當(dāng)看到需要的代碼時，在復(fù)制粘貼前，我們都需要仔細(xì)研讀、認(rèn)真思考、詳細(xì)甄別……很多東西，都是仁者見仁、智者見智的東西，適合別的場景但不一定適合你的場景。作為一名合格的程序員，切不可一味地"拿來主義"。

1.為什么要復(fù)制粘貼代碼

復(fù)制粘貼現(xiàn)有代碼，可以節(jié)省開發(fā)時間；

復(fù)制粘貼穩(wěn)定代碼，可以降低系統(tǒng)故障風(fēng)險；

復(fù)制粘貼網(wǎng)絡(luò)代碼，可以把別人的成果化為己用。

2.復(fù)制粘貼代碼帶來問題

你對復(fù)制的代碼理解程度是多少？實現(xiàn)邏輯是否合理？能不能穩(wěn)定運行？存在多少潛在的 Bug?

這個代碼在項目中已經(jīng)復(fù)制粘貼了多少次？根據(jù)“三則重構(gòu)”原則，你是否需要對這些相同代碼進(jìn)行重構(gòu)？

代碼被復(fù)制粘貼次數(shù)越多，帶來的代碼維護(hù)問題越多。多個代碼版本的更改和修正，要保持這些代碼的同步，就必須需要在每一處進(jìn)行同樣的修改，增加了維護(hù)的成本和風(fēng)險。

總之，復(fù)制粘貼代碼，跟其它編碼方法一樣，沒有優(yōu)劣對錯之分。它只是一種方法，你可以善用，也可以濫用。如果我們用到了復(fù)制粘貼，我們就必須為結(jié)果負(fù)責(zé)。

方法3：用文本替換生成代碼

1.生成代碼樣例

已經(jīng)編寫好的用戶查詢相關(guān)代碼：

/** 查詢用戶服務(wù)函數(shù) */ public PageData<UserVO> queryUser(QueryUserParameterVO parameter) {Long totalCount = userDAO.countByParameter(parameter);List<UserVO> userList = null;if (Objects.nonNull(totalCount) && totalCount.compareTo(0L) > 0) {userList = userDAO.queryByParameter(parameter);}return new PageData<>(totalCount, userList); }/** 查詢用戶控制器函數(shù) */ @RequestMapping(path = "/queryUser", method = RequestMethod.POST) public Result<PageData<UserVO>> queryUser(@Valid @RequestBody QueryUserParameterVO parameter) {PageData<UserVO> pageData = userService.queryUser(parameter);return Result.success(pageData); }

如果我們要編寫公司查詢相關(guān)代碼，其代碼形式與用戶查詢類似，整理出替換關(guān)系如下：

把"用戶"替換為"公司";

把"User"替換為"Company";

把"user"替換為"company"。

利用Notepad、EditPlus等文本編輯器，選擇區(qū)分大小寫，進(jìn)行普通文本替換，最終得到結(jié)果如下：

/** 查詢公司服務(wù)函數(shù) */ public PageData<CompanyVO> queryCompany(QueryCompanyParameterVO parameter) {Long totalCount = companyDAO.countByParameter(parameter);List<CompanyVO> companyList = null;if (Objects.nonNull(totalCount) && totalCount.compareTo(0L) > 0) {companyList = companyDAO.queryByParameter(parameter);}return new PageData<>(totalCount, companyList); }/** 查詢公司控制器函數(shù) */ @RequestMapping(path = "/queryCompany", method = RequestMethod.POST) public Result<PageData<CompanyVO>> queryCompany(@Valid @RequestBody QueryCompanyParameterVO parameter) {PageData<CompanyVO> pageData = companyService.queryCompany(parameter);return Result.success(pageData); }

利用文本替換生成代碼，整段代碼生成時間不會超過1分鐘。

2.主要優(yōu)缺點

主要優(yōu)點：

生成代碼速度較快。

主要缺點：

必須編寫樣例代碼；

只適用于文本替換的情景。

方法4：用Excel公式生成代碼

Excel的公式非常強悍，可以用于編寫一些公式化的代碼。

1.利用Excel公式生成模型類

從WIKI上拷貝接口模型定義到Excel里，樣例數(shù)據(jù)內(nèi)容如下：

?ABCDEF

1	序號	字段名稱	字段類型	字段描述	是否可空	附加信息
2	1	id	Long	用戶標(biāo)識	否	?
3	2	name	String	用戶名稱	否	?
4	3	sex	Integer	用戶性別	否	0:未知;1:男;2:女
5	4	description	String	用戶描述	是	?

編寫Excel公式如下：

= "/** "&D6&IF(ISBLANK(F6), "", "("&F6&")")&" */ "&IF(E6 = "否", IF(C6 = "String", "@NotBlank", "@NotNull"), "")&" private "&C6&" "&B6&";"

利用公式生成代碼如下：

/** 用戶標(biāo)識 */ @NotNull private Long id; /** 用戶名稱 */ @NotBlank private String name; /** 用戶性別(0:未知;1:男;2:女) */ @NotNull private Integer sex; /** 用戶描述 */ private String description;

創(chuàng)建模型類，整理代碼如下：

/** 用戶DO類 */ public class UserDO {/** 用戶標(biāo)識 */@NotNullprivate Long id;/** 用戶名稱 */@NotBlankprivate String name;/** 用戶性別(0:未知;1:男;2:女) */@NotNullprivate Integer sex;/** 用戶描述 */private String description;...... }

2.利用Excel公式生成枚舉類

從WIKI上拷貝枚舉定義到Excel里，樣例數(shù)據(jù)內(nèi)容如下：

?ABCD

1	序號	字段取值	字段名稱	字段描述
2	1	0	NONE	空
3	2	1	MAN	男
4	3	2	WOMAN	女

編寫Excel公式如下：

="/** "&D2&"("&B2&") */"&C2&"("&B2&", """&D2&"""),"

利用公式生成代碼如下：

/** 空(0) */NONE(0, "空"), /** 男(1) */MAN(1, "男"), /** 女(2) */WOMAN(2, "女"),

創(chuàng)建枚舉類，整理代碼如下：

/** 用戶性別枚舉 */ public enum UserSex {/** 枚舉定義 *//** 空(0) */NONE(0, "空"),/** 男(1) */MAN(1, "男"),/** 女(2) */WOMAN(2, "女");...... }

3.利用Excel公式生成數(shù)據(jù)庫語句

用Excel整理的公司列表如下，需要整理成SQL語句直接插入數(shù)據(jù)庫：

?ABCDE

1	序號	公司名稱	公司地址	公司電話	公司郵箱
2	1	高德	首開大廈	(010)11111111	gaode@xxx.com
3	2	阿里云	綠地中心	(010)22222222	aliyun@xxx.com
4	3	菜鳥	阿里中心	(010)33333333	cainiao@xxx.com

編寫Excel公式如下：

= "('"&B2&"', '"&C2&"', '"&D2&"', '"&E2&"'),"

利用公式生成SQL如下：

('高德', '首開大廈', '(010)11111111', 'gaode@xxx.com'), ('阿里云', '綠地中心', '(010)22222222', 'aliyun@xxx.com'), ('菜鳥', '阿里中心', '(010)33333333', 'cainiao@xxx.com'),

添加into語句頭，整理SQL如下：

insert into t_company(name, address, phone, email) values ('高德', '首開大廈', '(010)11111111', 'gaode@xxx.com'), ('阿里云', '綠地中心', '(010)22222222', 'aliyun@xxx.com'), ('菜鳥', '阿里中心', '(010)33333333', 'cainiao@xxx.com');

4.主要優(yōu)缺點

主要優(yōu)點：

適用于表格化數(shù)據(jù)的代碼生成；

寫好公式后，拖拽生成代碼，生成速度較快。

主要缺點：

不適用于復(fù)雜功能的代碼生成。

方法5：用工具生成代碼

用工具生成代碼，顧名思義就是借用已有的工具生成代碼。很多開發(fā)工具都提供一些工具生成代碼，比如：生成構(gòu)造函數(shù)，重載基類/接口函數(shù)，生成Getter/Setter函數(shù)，生成toString函數(shù)……能夠避免很多手敲代碼。還有一些生成代碼插件，也可以生成滿足某些應(yīng)用場景的代碼。

這里以mybatis-generator插件生成代碼為例，介紹如何利用工具生成代碼。

1.安裝運行插件

具體方法這里不再累述，自行上網(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)容：

...... public interface UserMapper {User selectByPrimaryKey(Long id);...... }

2.3.生成映射XML代碼

文件UserMapper.xml內(nèi)容：

...... <mapper namespace="com.test.dao.UserMapper" ><resultMap id="BaseResultMap" type="com.test.pojo.User" ><id column="id" property="id" jdbcType="BIGINT" /><result column="user" property="user" jdbcType="VARCHAR" /><result column="password" property="password" jdbcType="VARCHAR" /><result column="age" property="age" jdbcType="INTEGER" /></resultMap><sql id="Base_Column_List" >id, user, password, age</sql><select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Long" >select <include refid="Base_Column_List" />from test_userwhere id = #{id,jdbcType=BIGINT}</select>...... </mapper>

3.主要優(yōu)缺點

主要優(yōu)點：

利用生成代碼插件，生成代碼速度較快；

利用插件配置文件，控制生成想要的功能代碼。

主要缺點：

需要時間研究和熟悉生成代碼插件的使用；

生成的代碼不一定滿足代碼規(guī)范，每次生成后需進(jìn)行代碼合規(guī)；

重新生成代碼后，容易覆蓋自定義代碼（建議維護(hù)單獨的生成代碼庫，通過DIFF工具比較代碼差異，然后再賦值粘貼差異代碼）。

方法6：用代碼生成代碼

用代碼生成代碼，就是自己編寫代碼，按照自己的格式生成代碼。下面，以生成基于MyBatis的數(shù)據(jù)庫訪問代碼為例說明。

1.查詢表格信息

首先，我們要從數(shù)據(jù)庫中拿到我們生成代碼所需要的表和列相關(guān)信息。

1.1.查詢表信息

查詢表信息語句：

select t.table_name as '表名稱' , t.table_comment as '表備注' from information_schema.tables t where t.table_schema = ? and t.table_type = 'BASE TABLE' and t.table_name = ?;

其中，第1個問號賦值數(shù)據(jù)庫名稱，第2個問號賦值表名稱。

查詢表信息結(jié)果：

序號表名稱表備注

1	org_company	組織公司表

1.2.查詢列信息

查詢列信息語句：

select c.column_name as '列名稱' , c.column_comment as '列備注' , c.data_type as '數(shù)據(jù)類型' , c.character_maximum_length as '字符長度' , c.numeric_precision as '數(shù)字精度' , c.numeric_scale as '數(shù)字范圍' , c.column_default as '' , c.is_nullable as '是否可空' , c.column_key as '列鍵名' from information_schema.columns c where c.table_schema = ? and c.table_name = ? order by c.ordinal_position;

其中，第1個問號賦值數(shù)據(jù)庫名稱，第2個問號賦值表名稱。

查詢列信息結(jié)果：

序號列名稱列備注數(shù)據(jù)類型字符長度數(shù)字精度數(shù)字范圍是否可空列鍵名

1	id	公司標(biāo)識	bigint	?	19	0	NO	PRI
2	name	公司名稱	varchar	50	?	?	NO	?
3	address	聯(lián)系地址	varchar	200	?	?	YES	?
4	description	公司描述	text	65535	?	?	YES	?

2.編寫生成代碼

2.1.編寫生成模型類代碼

/** 生成模型類文件函數(shù) */ private void generateModelClassFile(File dir, Table table, List<Column> columnList) throws Exception {try (PrintWriter writer = new PrintWriter(new File(dir, className + "DO.java"))) {String className = getClassName(table.getTableName());String classComments = getClassComment(table.getTableComment());writer.println("package " + groupName + "." + systemName + ".database;");......writer.println("/** " + classComments + "DO類 */");writer.println("@Getter");writer.println("@Setter");writer.println("@ToString");writer.println("public class " + className + "DO {");for (Column column : columnList) {String fieldType = getFieldType(column);String fieldName = getFieldName(column.getColumnName());String fieldComment = getFieldComment(column);writer.println("\t/** " + fieldComment + " */");writer.println("\tprivate " + fieldType + " " + fieldName + ";");}writer.println("}");} }

2.2.編寫生成DAO接口代碼

/** 生成DAO接口文件函數(shù) */ private void generateDaoInterfaceFile(File dir, Table table, List<Column> columnList, List<Column> pkColumnList) throws Exception {try (PrintWriter writer = new PrintWriter(new File(dir, className + "DAO.java"))) {String className = getClassName(table.getTableName());String classComments = getClassComment(table.getTableComment());writer.println("package " + groupName + "." + systemName + ".database;");......writer.println("/** " + classComments + "DAO接口 */");writer.println("public interface " + className + "DAO {");writer.println("\t/** 獲取" + classComments + "函數(shù) */");writer.print("\tpublic " + className + "DO get(");boolean isFirst = true;for (Column pkColumn : pkColumnList) {if (!isFirst) {writer.print(", ");} else {isFirst = false;}String fieldType = getFieldType(pkColumn);String fieldName = getFieldName(pkColumn.getColumnName());writer.print("@Param(\"" + fieldName + "\") " + fieldType + " " + fieldName);}writer.println(");");......writer.println("}");} }

2.3.編寫生成DAO映射代碼

/** 生成DAO映射文件函數(shù) */ private void generateDaoMapperFile(File dir, Table table, List<Column> columnList, List<Column> pkColumnList) throws Exception {try (PrintWriter writer = new PrintWriter(new File(dir, className + "DAO.xml"))) {String className = getClassName(table.getTableName());String classComments = getClassComment(table.getTableComment());writer.println("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");......writer.println("<!-- " + classComments + "映射 -->");writer.println("<mapper namespace=\"" + groupName + "." + systemName + ".database." + className + "DAO\">");writer.println("\t<!-- 所有字段語句 -->");writer.println("\t<sql id=\"fields\">");if (CollectionUtils.isNotEmpty(columnList)) {boolean isFirst = true;String columnName = getColumnName(pkColumn.getColumnName());for (Column column : columnList) {if (isFirst) {isFirst = false;writer.println("\t\t" + columnName);} else {writer.println("\t\t, " + columnName);}}}writer.println("\t</sql>");writer.println("\t<!-- 獲取" + classComments + "函數(shù)語句 -->");writer.println("\t<select id=\"get\" resultType=\"" + groupName + "." + systemName + ".database." + className + "DO\">");writer.println("\t\tselect");writer.println("\t\t<include refid=\"fields\"/>");writer.println("\t\tfrom " + table.getTableName());boolean isFirst = true;for (Column pkColumn : pkColumnList) {String columnName = getColumnName(pkColumn.getColumnName());String fieldName = getFieldName(pkColumn.getColumnName());writer.print("\t\t");if (isFirst) {writer.print("where");isFirst = false;} else {writer.print("and");}writer.println(" " + columnName + " = #{" + fieldName + "}");}writer.println("\t</select>");writer.println("</mapper>");} }

3.生成相關(guān)代碼

3.1.生成的模型類代碼

/** 組織公司DO類 */ @Getter @Setter @ToString public class OrgCompanyDO {/** 公司標(biāo)識 */private Long id;/** 公司名稱 */private String name;/** 聯(lián)系地址 */private String address;/** 公司描述 */private String description; }

3.2.生成的DAO接口代碼

/** 組織公司DAO接口 */ public interface OrgCompanyDAO {/** 獲取組織公司函數(shù) */public OrgCompanyDO get(@Param("id") Long id); }

3.3.生成的DAO映射代碼

<!-- 組織公司映射 --> <mapper namespace="xxx.database.OrgCompanyDAO"><!-- 所有字段語句 --><sql id="fields">id, name, address, description</sql><!-- 獲取組織公司函數(shù)語句 --><select id="get" resultType="xxx.database.OrgCompanyDO">select<include refid="fields"/>from org_companywhere id = #{id}</select> </mapper>

3.主要優(yōu)缺點

主要優(yōu)點：

代碼格式可以定制，保證生成代碼合規(guī)；

代碼功能可以定制，只生成需要的代碼；

經(jīng)過前期代碼沉淀后，后期能夠直接使用。

主要缺點：

需要研究數(shù)據(jù)來源，保證能獲取到生成代碼所需的數(shù)據(jù)；

需要建立數(shù)據(jù)模型、編寫生成代碼，耗費時間比較長。

終極方法：無招勝有招

編碼的終極方法，是不是直接對著電腦說需求，然后電腦就自動生成代碼了？未來科技發(fā)展到一定水平后，這種情況或許會變成現(xiàn)實。但是，目前這種情況是不現(xiàn)實的。現(xiàn)實中，想要做到"大口一張、代碼就來"，除非你是老板、產(chǎn)品經(jīng)理或者技術(shù)管理者。

編碼的終極方法是“無招勝有招”，"無招"并不是不講究"招式"，而是不拘泥于某一"招式"，信手拈來合適的"招式"為宜。本文中列舉的各種編碼方法，沒有高低優(yōu)劣之分，只有合不合適之說。所以，靈活地運用各種編碼方法，就是編碼的終極方法。

代碼規(guī)范化

在上面的各種編碼方法中，很多方法都需要手工編寫樣例代碼。如果你的代碼不遵循代碼規(guī)范，就很難發(fā)現(xiàn)代碼之間的共性，并抽象出能夠作為標(biāo)準(zhǔn)的樣例代碼；如果作為標(biāo)準(zhǔn)的樣例代碼不滿足代碼規(guī)范，必然導(dǎo)致生成的代碼也不滿足代碼規(guī)范，于是把這些不規(guī)范放大了十倍、百倍甚至千倍。 所以，代碼規(guī)范化是編碼的重中之重。

請參考阿里集團(tuán)的開發(fā)規(guī)約：

《阿里經(jīng)濟(jì)體開發(fā)規(guī)約》

我寫的一些代碼規(guī)范化建議：

《Java函數(shù)優(yōu)雅之道》

《那些年，我們見過的Java服務(wù)端“亂象”》

后記

在構(gòu)思這篇文章的時候，在網(wǎng)上看見這么一個梗：一位網(wǎng)友諷刺一位阿里人的簡歷，滿篇都是"沉淀了一套XX方法論，為XX業(yè)務(wù)賦能。"，用了流行語"賦能"顯得很"高大上"。姑且不論他的簡歷如何，能夠從方法論上著手的人，一定有值得我們學(xué)習(xí)的地方。這里，我也來蹭一下這個梗，就取一個高大上的名字《編碼方法論，賦能你我他》。

原文鏈接
本文為云棲社區(qū)原創(chuàng)內(nèi)容，未經(jīng)允許不得轉(zhuǎn)載。

總結(jié)

以上是生活随笔為你收集整理的编码方法论，赋能你我他的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

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