編碼方法論，賦能你我他

時間  2019-11-09
標籤 編碼 方法論 你我 欄目 字符編碼 简体版
原文   原文鏈接

導讀
Don Roberts提出的一條重構準則：java

第一次作某件事時只管去作；第二次作相似的事時會產生反感，但不管如何仍是能夠去作；第三次再作相似的事時，你就應該重構。程序員

編碼也是如此，當屢次編寫相似的代碼時，咱們須要考慮是否有一種方法可以提升編碼速度。做者多年來致力於敏捷開發，總結了一套編碼的方法論，有助於程序員"快速、優質、高效"地進行編碼。面試

方法1：手工編寫代碼
大多數剛學習Java的程序員，都會懷着一種崇敬的儀式感，一字一句地在開發工具上敲出如下代碼：算法

public class Test {sql

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

}
沒錯，這就是經典的"Hello world"，這也是大多數人手工編寫的第一個程序。數據庫

手工編寫代碼，更能體現一個程序員的基本素質。有不少公司，都把上機編程考試做爲面試的重要手段之一。面試者須要根據題目的要求，挑選一款熟悉的編程工具（好比Eclipse），手工編寫代碼並調試運行經過。在整個過程當中，不能經過網絡搜索答案，不能查看聯機幫助文檔，要求面試者必須手工編寫代碼，主要是考察面試者手工編寫代碼的能力——語法、函數、邏輯、思惟、算法以及動手能力。編程

手工編寫代碼，是一個優秀程序員必須具有的基礎能力。手工編寫代碼正如提筆寫文章，語法就是遣詞造句的方法、函數就是組成文章的詞句、類庫就是據經引典的掌故、架構就是行文表述的體裁、功能就是寫做文章的主旨、算法就是組織語言的邏輯……因此，只要掌握一門程序語言的語法、學習一堆基礎類庫的函數、引用一些所需的第三方類庫、選擇一款成熟穩定的架構、明確一下產品需求的功能、挑選一種實現邏輯的算法……手工編寫代碼就會像寫文章同樣手到擒來。網絡

方法2：複製粘貼代碼
常言道："熟讀唐詩三百首，不會做詩也會吟。"編碼也是一樣的道理，編碼的第一步就是模仿，簡單地說就是"抄代碼"——複製粘貼代碼。複製粘貼代碼是一門藝術，用好了編碼會事半功倍。可是，沒有檢驗過的東西，終究是不可全信的。當看到須要的代碼時，在複製粘貼前，咱們都須要仔細研讀、認真思考、詳細甄別……不少東西，都是仁者見仁、智者見智的東西，適合別的場景但不必定適合你的場景。做爲一名合格的程序員，切不可一味地"拿來主義"。mybatis

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裏，樣例數據內容以下：

圖片描述
編寫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語句直接插入數據庫：

圖片描述
編寫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.主要優缺點
主要優勢：

適用於表格化數據的代碼生成；
寫好公式後，拖拽生成代碼，生成速度較快。
主要缺點：

不適用於複雜功能的代碼生成。
方法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;
其中，第1個問號賦值數據庫名稱，第2個問號賦值表名稱。

查詢列信息結果：

圖片描述
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>
3.主要優缺點
主要優勢：

代碼格式能夠定製，保證生成代碼合規；
代碼功能能夠定製，只生成須要的代碼；
通過前期代碼沉澱後，後期可以直接使用。
主要缺點：

須要研究數據來源，保證能獲取到生成代碼所需的數據；
須要創建數據模型、編寫生成代碼，耗費時間比較長。
終極方法：無招勝有招
編碼的終極方法，是否是直接對着電腦說需求，而後電腦就自動生成代碼了？將來科技發展到必定水平後，這種狀況或許會變成現實。可是，目前這種狀況是不現實的。現實中，想要作到"大口一張、代碼就來"，除非你是老闆、產品經理或者技術管理者。

編碼的終極方法是「無招勝有招」，"無招"並非不講究"招式"，而是不拘泥於某一"招式"，信手拈來合適的"招式"爲宜。本文中列舉的各類編碼方法，沒有高低優劣之分，只有合不合適之說。因此，靈活地運用各類編碼方法，就是編碼的終極方法。

代碼規範化
在上面的各類編碼方法中，不少方法都須要手工編寫樣例代碼。若是你的代碼不遵循代碼規範，就很難發現代碼之間的共性，並抽象出可以做爲標準的樣例代碼；若是做爲標準的樣例代碼不知足代碼規範，必然致使生成的代碼也不知足代碼規範，因而把這些不規範放大了十倍、百倍甚至千倍。 因此，代碼規範化是編碼的重中之重。

後記
在構思這篇文章的時候，在網上看見這麼一個梗：一位網友諷刺一位阿里人的簡歷，滿篇都是"沉澱了一套XX方法論，爲XX業務賦能。"，用了流行語"賦能"顯得很"高大上"。姑且不論他的簡歷如何，可以從方法論上着手的人，必定有值得咱們學習的地方。這裏，我也來蹭一下這個梗，就取一個高大上的名字《編碼方法論，賦能你我他》。

本文做者：陳昌毅，花名常意，高德地圖技術專家，2018年加入阿里巴巴，一直從事地圖數據採集的相關工做。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程