導讀
Don Roberts 提出的一條重構準則：
第一次做某件事時隻管去做；
第二次做類似的事時會産生反感，
但無論如何還是可以去做；第三次再做類似的事時，你就應該重構。
編碼也是如此，當多次編寫類似的代碼時，我們需要考慮是否有一種方法能夠提高編碼速度，讓編碼速度“起飛”？高德地圖技術專家陳昌毅（常意）多年來緻力于靈活開發，總結了一套編碼的方法論，有助于程式員"快速、優質、高效"地進行編碼。
方法1：手工編寫代碼
大多數剛學習 Java 的程式員，都會懷着一種崇敬的儀式感，一字一句地在開發工具上敲出以下代碼：
public class Test {
public static void main(String[] args) {
System.out.println("Hello world!");
}
} 沒錯，這就是經典的"Hello world"，這也是大多數人手工編寫的第一個程式。
手工編寫代碼，更能展現一個程式員的基本素質。有很多公司，都把上機程式設計考試作為面試的重要手段之一。
面試者需要根據題目的要求，挑選一款熟悉的程式設計工具（比如Eclipse），手工編寫代碼并調試運作通過。在整個過程中，不能通過網絡搜尋答案，不能檢視聯機幫助文檔，要求面試者必須手工編寫代碼，主要是考察面試者手工編寫代碼的能力——文法、函數、邏輯、思維、算法以及動手能力。
手工編寫代碼，是一個優秀程式員必須具備的基礎能力。
手工編寫代碼正如提筆寫文章，文法就是遣詞造句的方法、函數就是組成文章的詞句、類庫就是據經引典的掌故、架構就是行文表述的體裁、功能就是寫作文章的主旨、算法就是組織語言的邏輯……
是以，隻要掌握一門程式語言的文法、學習一堆基礎類庫的函數、引用一些所需的第三方類庫、選擇一款成熟穩定的架構、明确一下産品需求的功能、挑選一種實作邏輯的算法……手工編寫代碼就會像寫文章一樣手到擒來。
方法2：複制粘貼代碼
常言道："熟讀唐詩三百首，不會作詩也會吟。"編碼也是同樣的道理，編碼的第一步就是模仿，簡單地說就是"抄代碼"——複制粘貼代碼。
複制粘貼代碼是一門藝術，用好了編碼會事半功倍。但是，沒有檢驗過的東西，終究是不可全信的。
當看到需要的代碼時，在複制粘貼前，我們都需要仔細研讀、認真思考、詳細甄别……很多東西，都是仁者見仁、智者見智的東西，适合别的場景但不一定适合你的場景。作為一名合格的程式員，切不可一味地"拿來主義"。
1.為什麼要複制粘貼代碼
複制粘貼現有代碼，可以節省開發時間；
複制粘貼穩定代碼，可以降低系統故障風險；
複制粘貼網絡代碼，可以把别人的成果化為己用。
2.複制粘貼代碼帶來問題
你對複制的代碼了解程度是多少？
實作邏輯是否合理？
能不能穩定運作？
存在多少潛在的 Bug?
這個代碼在項目中已經複制粘貼了多少次？
根據“三則重構”原則，你是否需要對這些相同代碼進行重構？
代碼被複制粘貼次數越多，帶來的代碼維護問題越多。
多個代碼版本的更改和修正，要保持這些代碼的同步，就必須需要在每一處進行同樣的修改，增加了維護的成本和風險。
總之，複制粘貼代碼，跟其它編碼方法一樣，沒有優劣對錯之分。它隻是一種方法，你可以善用，也可以濫用。
如果我們用到了複制粘貼，我們就必須為結果負責。
方法3：用文本替換生成代碼
1.生成代碼樣例
已經編寫好的使用者查詢相關代碼：
/** 查詢使用者服務函數 */
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);
}
/** 查詢使用者控制器函數 */
@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);
} 如果我們要編寫公司查詢相關代碼，其代碼形式與使用者查詢類似，整理出替換關系如下：
把"使用者"替換為"公司";
把"User"替換為"Company";
把"user"替換為"company"。
利用 Notepad、EditPlus 等文本編輯器，選擇區分大小寫，進行普通文本替換，最終得到結果如下：
/** 查詢公司服務函數 */
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);
}
/** 查詢公司控制器函數 */
@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.主要優缺點
主要優點：
生成代碼速度較快。
主要缺點：
必須編寫樣例代碼；
隻适用于文本替換的情景。
方法4：用Excel公式生成代碼
Excel 的公式非常強悍，可以用于編寫一些公式化的代碼。
1.利用 Excel 公式生成模型類
從 WIKI 上拷貝接口模型定義到 Excel 裡，樣例資料内容如下：
編寫 Excel 公式如下：
= "/** "&D6&IF(ISBLANK(F6), "", "("&F6&")")&" */ "&IF(E6 = "否", IF(C6 = "String", "@NotBlank", "@NotNull"), "")&" private "&C6&" "&B6&";" 利用公式生成代碼如下：
/** 使用者辨別 */ @NotNull private Long id;
/** 使用者名稱 */ @NotBlank private String name;
/** 使用者性别(0:未知;1:男;2:女) */ @NotNull private Integer sex;
/** 使用者描述 */ private String description; 建立模型類，整理代碼如下：
/** 使用者DO類 */
public class UserDO {
/** 使用者辨別 */
@NotNull
private Long id;
/** 使用者名稱 */
@NotBlank
private String name;
/** 使用者性别(0:未知;1:男;2:女) */
@NotNull
private Integer sex;
/** 使用者描述 */
private String description;
......
} 2.利用 Excel 公式生成枚舉類
從 WIKI 上拷貝枚舉定義到 Excel 裡，樣例資料内容如下：
="/** "&D2&"("&B2&") */"&C2&"("&B2&", """&D2&""")," /** 空(0) */NONE(0, "空"),
/** 男(1) */MAN(1, "男"),
/** 女(2) */WOMAN(2, "女"), 建立枚舉類，整理代碼如下：
/** 使用者性别枚舉 */
public enum UserSex {
/** 枚舉定義 */
/** 空(0) */
NONE(0, "空"),
/** 男(1) */
MAN(1, "男"),
/** 女(2) */
WOMAN(2, "女");
......
} 3.利用 Excel 公式生成資料庫語句
用 Excel 整理的公司清單如下，需要整理成 SQL 語句直接插入資料庫：
= "('"&B2&"', '"&C2&"', '"&D2&"', '"&E2&"')," 利用公式生成 SQL 如下：
('高德', '首開大廈', '(010)11111111', '[email protected]'),
('阿裡雲', '綠地中心', '(010)22222222', '[email protected]'),
('菜鳥', '阿裡中心', '(010)33333333', '[email protected]'), 添加 into 語句頭，整理 SQL 如下：
insert into t_company(name, address, phone, email) values
('高德', '首開大廈', '(010)11111111', '[email protected]'),
('阿裡雲', '綠地中心', '(010)22222222', '[email protected]'),
('菜鳥', '阿裡中心', '(010)33333333', '[email protected]'); 4.主要優缺點
适用于表格化資料的代碼生成；
寫好公式後，拖拽生成代碼，生成速度較快。
不适用于複雜功能的代碼生成。
方法5：用工具生成代碼
用工具生成代碼，顧名思義就是借用已有的工具生成代碼。很多開發工具都提供一些工具生成代碼，比如：生成構造函數，重載基類/接口函數，生成 Getter/Setter 函數，生成 toString 函數……能夠避免很多手敲代碼。還有一些生成代碼插件，也可以生成滿足某些應用場景的代碼。
這裡以 mybatis-generator 插件生成代碼為例，介紹如何利用工具生成代碼。
1.安裝運作插件
具體方法這裡不再累述，自行上網搜尋文檔了解。
2.生成代碼樣例
2.1.生成模型類代碼
檔案 User.java 内容：
......
public class User {
private Long id;
private String user;
private String password;
private Integer age;
...... }
2.2.生成映射接口代碼
檔案 UserMapper.java 内容：
public interface UserMapper {
User selectByPrimaryKey(Long id);
......
} 2.3.生成映射XML代碼
檔案 UserMapper.xml 内容：
<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_user
where id = #{id,jdbcType=BIGINT}
</select>
......
</mapper> 3.主要優缺點
利用生成代碼插件，生成代碼速度較快；
利用插件配置檔案，控制生成想要的功能代碼。
需要時間研究和熟悉生成代碼插件的使用；
生成的代碼不一定滿足代碼規範，每次生成後需進行代碼合規；
重新生成代碼後，容易覆寫自定義代碼（建議維護單獨的生成代碼庫，通過DIFF 工具比較代碼差異，然後再指派粘貼差異代碼）。
方法6：用代碼生成代碼
用代碼生成代碼，就是自己編寫代碼，按照自己的格式生成代碼。下面，以生成基于 MyBatis 的資料庫通路代碼為例說明。
1.查詢表格資訊
首先，我們要從資料庫中拿到我們生成代碼所需要的表和列相關資訊。
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個問号指派資料庫名稱，第2個問号指派表名稱。
查詢表資訊結果：
1.2.查詢列資訊
查詢列資訊語句：
select c.column_name as '列名稱'
, c.column_comment as '列備注'
, c.data_type as '資料類型'
, c.character_maximum_length as '字元長度'
, c.numeric_precision as '數字精度'
, c.numeric_scale as '數字範圍'
, 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; 查詢列資訊結果：
2.編寫生成代碼
2.1.編寫生成模型類代碼
/** 生成模型類檔案函數 */
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接口檔案函數 */
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 + "函數 */");
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映射檔案函數 */
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 + "函數語句 -->");
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.生成相關代碼
3.1.生成的模型類代碼
/* 組織公司DO類 /
@Getter
@Setter
@ToString
public class OrgCompanyDO {
/** 公司辨別 */
private Long id;
/** 公司名稱 */
private String name;
/** 聯系位址 */
private String address;
/** 公司描述 */
private String description; 3.2.生成的 DAO 接口代碼
/** 組織公司DAO接口 */
public interface OrgCompanyDAO {
/** 擷取組織公司函數 */
public OrgCompanyDO get(@Param("id") Long id);
} ** 3.3.生成的 DAO 映射代碼
**
<!-- 組織公司映射 -->
<mapper namespace="xxx.database.OrgCompanyDAO">
<!-- 所有字段語句 -->
<sql id="fields">
id
, name
, address
, description
</sql>
<!-- 擷取組織公司函數語句 -->
<select id="get" resultType="xxx.database.OrgCompanyDO">
select
<include refid="fields"/>
from org_company
where id = #{id}
</select>
</mapper> 代碼格式可以定制，保證生成代碼合規；
代碼功能可以定制，隻生成需要的代碼；
經過前期代碼沉澱後，後期能夠直接使用。
- 需要研究資料來源，保證能擷取到生成代碼所需的資料；
- 需要建立資料模型、編寫生成代碼，耗費時間比較長。
終極方法：無招勝有招
編碼的終極方法，是不是直接對着電腦說需求，然後電腦就自動生成代碼了？
未來科技發展到一定水準後，這種情況或許會變成現實。但是，目前這種情況是不現實的。
現實中，想要做到"大口一張、代碼就來"，除非你是老闆、産品經理或者技術管理者。
編碼的終極方法是“無招勝有招”，"無招"并不是不講究"招式"，而是不拘泥于某一"招式"，信手拈來合适的"招式"為宜。
本文中列舉的各種編碼方法，沒有高低優劣之分，隻有合不合适之說。
是以，靈活地運用各種編碼方法，就是編碼的終極方法。
代碼規範化
在上面的各種編碼方法中，很多方法都需要手工編寫樣例代碼。
如果你的代碼不遵循代碼規範，就很難發現代碼之間的共性，并抽象出能夠作為标準的樣例代碼；如果作為标準的樣例代碼不滿足代碼規範，必然導緻生成的代碼也不滿足代碼規範，于是把這些不規範放大了十倍、百倍甚至千倍。
是以，代碼規範化是編碼的重中之重。