这6种编码方法,你掌握了几个?
作者:CQITer小编 时间:2019-09-20 01:45
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 公式如下:



