您还未登录! 登录 | 注册 | 帮助  

您的位置: 首页 > 软件开发专栏 > 开发技术 > 正文

这6种编码方法,你掌握了几个?

发表于:2019-09-18 作者:陈昌毅 来源:阿里技术

Don Roberts 提出的一条重构准则:第一次做某件事时只管去做;第二次做类似的事时会产生反感,但无论如何还是可以去做;第三次再做类似的事时,你就应该重构。


编码也是如此,当多次编写类似的代码时,我们需要考虑是否有一种方法能够提高编码速度,让编码速度“起飞”?高德地图技术专家陈昌毅(常意)多年来致力于敏捷开发,总结了一套编码的方法论,有助于程序员"快速、优质、高效"地进行编码。

方法1:手工编写代码

大多数刚学习 Java 的程序员,都会怀着一种崇敬的仪式感,一字一句地在开发工具上敲出以下代码:


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


没错,这就是经典的"Hello world",这也是大多数人手工编写的第一个程序。

手工编写代码,更能体现一个程序员的基本素质。有很多公司,都把上机编程考试作为面试的重要手段之一。面试者需要根据题目的要求,挑选一款熟悉的编程工具(比如Eclipse),手工编写代码并调试运行通过。在整个过程中,不能通过网络搜索答案,不能查看联机帮助文档,要求面试者必须手工编写代码,主要是考察面试者手工编写代码的能力——语法、函数、逻辑、思维、算法以及动手能力。

手工编写代码,是一个优秀程序员必须具备的基础能力。手工编写代码正如提笔写文章,语法就是遣词造句的方法、函数就是组成文章的词句、类库就是据经引典的掌故、架构就是行文表述的体裁、功能就是写作文章的主旨、算法就是组织语言的逻辑……所以,只要掌握一门程序语言的语法、学习一堆基础类库的函数、引用一些所需的第三方类库、选择一款成熟稳定的架构、明确一下产品需求的功能、挑选一种实现逻辑的算法……手工编写代码就会像写文章一样手到擒来。

方法2:复制粘贴代码

常言道:"熟读唐诗三百首,不会作诗也会吟。"编码也是同样的道理,编码的第一步就是模仿,简单地说就是"抄代码"——复制粘贴代码。复制粘贴代码是一门艺术,用好了编码会事半功倍。但是,没有检验过的东西,终究是不可全信的。当看到需要的代码时,在复制粘贴前,我们都需要仔细研读、认真思考、详细甄别……很多东西,都是仁者见仁、智者见智的东西,适合别的场景但不一定适合你的场景。作为一名合格的程序员,切不可一味地"拿来主义"。

1.为什么要复制粘贴代码

  • 复制粘贴现有代码,可以节省开发时间;
  • 复制粘贴稳定代码,可以降低系统故障风险;
  • 复制粘贴网络代码,可以把别人的成果化为己用。

2.复制粘贴代码带来问题

你对复制的代码理解程度是多少?实现逻辑是否合理?能不能稳定运行?存在多少潜在的 Bug?

这个代码在项目中已经复制粘贴了多少次?根据“三则重构”原则,你是否需要对这些相同代码进行重构?

代码被复制粘贴次数越多,带来的代码维护问题越多。多个代码版本的更改和修正,要保持这些代码的同步,就必须需要在每一处进行同样的修改,增加了维护的成本和风险。

总之,复制粘贴代码,跟其它编码方法一样,没有优劣对错之分。它只是一种方法,你可以善用,也可以滥用。如果我们用到了复制粘贴,我们就必须为结果负责。

方法3:用文本替换生成代码

1.生成代码样例

已经编写好的用户查询相关代码:


  1. /** 查询用户服务函数 */ 
  2. public PageData<UserVO> queryUser(QueryUserParameterVO parameter) { 
  3.     Long totalCount = userDAO.countByParameter(parameter); 
  4.     List<UserVO> userList = null; 
  5.     if (Objects.nonNull(totalCount) && totalCount.compareTo(0L) > 0) { 
  6.         userList = userDAO.queryByParameter(parameter); 
  7.     } 
  8.     return new PageData<>(totalCount, userList); 
  9.  
  10. /** 查询用户控制器函数 */ 
  11. @RequestMapping(path = "/queryUser", method = RequestMethod.POST) 
  12. public Result<PageData<UserVO>> queryUser(@Valid @RequestBody QueryUserParameterVO parameter) { 
  13.     PageData<UserVO> pageData = userService.queryUser(parameter); 
  14.     return Result.success(pageData); 
  15. } 


如果我们要编写公司查询相关代码,其代码形式与用户查询类似,整理出替换关系如下:

  • 把"用户"替换为"公司";
  • 把"User"替换为"Company";
  • 把"user"替换为"company"。

利用 Notepad、EditPlus 等文本编辑器,选择区分大小写,进行普通文本替换,最终得到结果如下:


  1. /** 查询公司服务函数 */ 
  2. public PageData<CompanyVO> queryCompany(QueryCompanyParameterVO parameter) { 
  3.     Long totalCount = companyDAO.countByParameter(parameter); 
  4.     List<CompanyVO> companyList = null; 
  5.     if (Objects.nonNull(totalCount) && totalCount.compareTo(0L) > 0) { 
  6.         companyList = companyDAO.queryByParameter(parameter); 
  7.     } 
  8.     return new PageData<>(totalCount, companyList); 
  9.  
  10. /** 查询公司控制器函数 */ 
  11. @RequestMapping(path = "/queryCompany", method = RequestMethod.POST) 
  12. public Result<PageData<CompanyVO>> queryCompany(@Valid @RequestBody QueryCompanyParameterVO parameter) { 
  13.     PageData<CompanyVO> pageData = companyService.queryCompany(parameter); 
  14.     return Result.success(pageData); 
  15. } 


利用文本替换生成代码,整段代码生成时间不会超过1分钟。

2.主要优缺点

主要优点:

  • 生成代码速度较快。

主要缺点:

  • 必须编写样例代码;
  • 只适用于文本替换的情景。

方法4:用Excel公式生成代码

Excel 的公式非常强悍,可以用于编写一些公式化的代码。

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

从 WIKI 上拷贝接口模型定义到 Excel 里,样例数据内容如下:


编写 Excel 公式如下:


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


利用公式生成代码如下:


  1. /** 用户标识 */ @NotNull private Long id; 
  2. /** 用户名称 */ @NotBlank private String name; 
  3. /** 用户性别(0:未知;1:男;2:女) */ @NotNull private Integer sex; 
  4. /** 用户描述 */  private String description; 


创建模型类,整理代码如下:


  1. /** 用户DO类 */ 
  2. public class UserDO { 
  3.     /** 用户标识 */ 
  4.     @NotNull 
  5.     private Long id; 
  6.     /** 用户名称 */ 
  7.     @NotBlank 
  8.     private String name; 
  9.     /** 用户性别(0:未知;1:男;2:女) */ 
  10.     @NotNull 
  11.     private Integer sex; 
  12.     /** 用户描述 */ 
  13.     private String description; 
  14.     ...... 
  15. } 


2.利用 Excel 公式生成枚举类

从 WIKI 上拷贝枚举定义到 Excel 里,样例数据内容如下:


编写 Excel 公式如下:


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


利用公式生成代码如下:


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


创建枚举类,整理代码如下:


  1. /** 用户性别枚举 */ 
  2. public enum UserSex { 
  3.     /** 枚举定义 */ 
  4.     /** 空(0) */ 
  5.     NONE(0, "空"), 
  6.     /** 男(1) */ 
  7.     MAN(1, "男"), 
  8.     /** 女(2) */ 
  9.     WOMAN(2, "女"); 
  10.     ...... 
  11. } 


3.利用 Excel 公式生成数据库语句

用 Excel 整理的公司列表如下,需要整理成 SQL 语句直接插入数据库:


编写 Excel 公式如下:


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

利用公式生成 SQL 如下:


  1. ('高德', '首开大厦', '(010)11111111', 'gaode@xxx.com'), 
  2. ('阿里云', '绿地中心', '(010)22222222', 'aliyun@xxx.com'), 
  3. ('菜鸟', '阿里中心', '(010)33333333', 'cainiao@xxx.com'), 


添加 into 语句头,整理 SQL 如下:


  1. insert into t_company(name, address, phone, email) values 
  2. ('高德', '首开大厦', '(010)11111111', 'gaode@xxx.com'), 
  3. ('阿里云', '绿地中心', '(010)22222222', 'aliyun@xxx.com'), 
  4. ('菜鸟', '阿里中心', '(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 内容:


  1. ...... 
  2. public class User { 
  3.     private Long id; 
  4.     private String user; 
  5.     private String password; 
  6.     private Integer age; 
  7.     ...... 
  8. } 


★ 2.3.生成映射XML代码

文件 UserMapper.xml 内容:


  1. ...... 
  2. <mapper namespace="com.test.dao.UserMapper" > 
  3.   <resultMap id="BaseResultMap" type="com.test.pojo.User" > 
  4.     <id column="id" property="id" jdbcType="BIGINT" /> 
  5.     <result column="user" property="user" jdbcType="VARCHAR" /> 
  6.     <result column="password" property="password" jdbcType="VARCHAR" /> 
  7.     <result column="age" property="age" jdbcType="INTEGER" /> 
  8.   </resultMap> 
  9.   <sql id="Base_Column_List" > 
  10.     id, user, password, age 
  11.   </sql> 
  12.   <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.Long" > 
  13.     select 
  14.     <include refid="Base_Column_List" /> 
  15.     from test_user 
  16.     where id = #{id,jdbcType=BIGINT} 
  17.   </select> 
  18.   ...... 
  19. </mapper> 


3.主要优缺点

主要优点:

  • 利用生成代码插件,生成代码速度较快;
  • 利用插件配置文件,控制生成想要的功能代码。

主要缺点:

  • 需要时间研究和熟悉生成代码插件的使用;
  • 生成的代码不一定满足代码规范,每次生成后需进行代码合规;
  • 重新生成代码后,容易覆盖自定义代码(建议维护单独的生成代码库,通过DIFF 工具比较代码差异,然后再赋值粘贴差异代码)。

方法6:用代码生成代码

用代码生成代码,就是自己编写代码,按照自己的格式生成代码。下面,以生成基于 MyBatis 的数据库访问代码为例说明。

1.查询表格信息

首先,我们要从数据库中拿到我们生成代码所需要的表和列相关信息。

★ 1.1.查询表信息

查询表信息语句:


  1. select t.table_name as '表名称' 
  2. , t.table_comment as '表备注' 
  3. from information_schema.tables t 
  4. where t.table_schema = ? 
  5. and t.table_type = 'BASE TABLE' 
  6. and t.table_name = ?; 


其中,第1个问号赋值数据库名称,第2个问号赋值表名称。

查询表信息结果:


★ 1.2.查询列信息

查询列信息语句:


  1. select c.column_name as '列名称' 
  2. , c.column_comment as '列备注' 
  3. , c.data_type as '数据类型' 
  4. , c.character_maximum_length as '字符长度' 
  5. , c.numeric_precision as '数字精度' 
  6. , c.numeric_scale as '数字范围' 
  7. , c.column_default as '' 
  8. , c.is_nullable as '是否可空' 
  9. , c.column_key as '列键名' 
  10. from information_schema.columns c 
  11. where c.table_schema = ? 
  12. and c.table_name = ? 
  13. order by c.ordinal_position; 


其中,第1个问号赋值数据库名称,第2个问号赋值表名称。

查询列信息结果:


2.编写生成代码

★ 2.1.编写生成模型类代码


  1. /** 生成模型类文件函数 */ 
  2. private void generateModelClassFile(File dir, Table table, List<Column> columnList) throws Exception { 
  3.     try (PrintWriter writer = new PrintWriter(new File(dir, className + "DO.java"))) { 
  4.         String className = getClassName(table.getTableName()); 
  5.         String classComments = getClassComment(table.getTableComment()); 
  6.         writer.println("package " + groupName + "." + systemName + ".database;"); 
  7.         ...... 
  8.         writer.println("/** " + classComments + "DO类 */"); 
  9.         writer.println("@Getter"); 
  10.         writer.println("@Setter"); 
  11.         writer.println("@ToString"); 
  12.         writer.println("public class " + className + "DO {"); 
  13.         for (Column column : columnList) { 
  14.             String fieldType = getFieldType(column); 
  15.             String fieldName = getFieldName(column.getColumnName()); 
  16.             String fieldComment = getFieldComment(column); 
  17.             writer.println("\t/** " + fieldComment + " */"); 
  18.             writer.println("\tprivate " + fieldType + " " + fieldName + ";"); 
  19.         } 
  20.         writer.println("}"); 
  21.     } 


★ 2.2.编写生成 DAO 接口代码


  1. /** 生成DAO接口文件函数 */ 
  2. private void generateDaoInterfaceFile(File dir, Table table, List<Column> columnList, List<Column> pkColumnList) throws Exception { 
  3.     try (PrintWriter writer = new PrintWriter(new File(dir, className + "DAO.java"))) { 
  4.         String className = getClassName(table.getTableName()); 
  5.         String classComments = getClassComment(table.getTableComment()); 
  6.         writer.println("package " + groupName + "." + systemName + ".database;"); 
  7.         ...... 
  8.         writer.println("/** " + classComments + "DAO接口 */"); 
  9.         writer.println("public interface " + className + "DAO {"); 
  10.         writer.println("\t/** 获取" + classComments + "函数 */"); 
  11.         writer.print("\tpublic " + className + "DO get("); 
  12.         boolean isFirst = true; 
  13.         for (Column pkColumn : pkColumnList) { 
  14.             if (!isFirst) { 
  15.                 writer.print(", "); 
  16.             } else { 
  17.                 isFirst = false; 
  18.             } 
  19.             String fieldType = getFieldType(pkColumn); 
  20.             String fieldName = getFieldName(pkColumn.getColumnName()); 
  21.             writer.print("@Param(\"" + fieldName + "\") " + fieldType + " " + fieldName); 
  22.         } 
  23.         writer.println(");"); 
  24.         ...... 
  25.         writer.println("}"); 
  26.     } 
  27. } 


★ 2.3.编写生成 DAO 映射代码


  1. /** 生成DAO映射文件函数 */ 
  2. private void generateDaoMapperFile(File dir, Table table, List<Column> columnList, List<Column> pkColumnList) throws Exception { 
  3.     try (PrintWriter writer = new PrintWriter(new File(dir, className + "DAO.xml"))) { 
  4.         String className = getClassName(table.getTableName()); 
  5.         String classComments = getClassComment(table.getTableComment()); 
  6.         writer.println("<?xml version=\"1.0\" encoding=\"UTF-8\"?>"); 
  7.         ...... 
  8.         writer.println("<!-- " + classComments + "映射 -->"); 
  9.         writer.println("<mapper namespace=\"" + groupName + "." + systemName + ".database." + className + "DAO\">"); 
  10.         writer.println("\t<!-- 所有字段语句 -->"); 
  11.         writer.println("\t<sql id=\"fields\">"); 
  12.         if (CollectionUtils.isNotEmpty(columnList)) { 
  13.             boolean isFirst = true; 
  14.             String columnName = getColumnName(pkColumn.getColumnName()); 
  15.             for (Column column : columnList) { 
  16.                 if (isFirst) { 
  17.                     isFirst = false; 
  18.                     writer.println("\t\t" + columnName); 
  19.                 } else { 
  20.                     writer.println("\t\t, " + columnName); 
  21.                 } 
  22.             } 
  23.         } 
  24.         writer.println("\t</sql>"); 
  25.         writer.println("\t<!-- 获取" + classComments + "函数语句 -->"); 
  26.         writer.println("\t<select id=\"get\" resultType=\"" + groupName + "." + systemName + ".database." + className + "DO\">"); 
  27.         writer.println("\t\tselect"); 
  28.         writer.println("\t\t<include refid=\"fields\"/>"); 
  29.         writer.println("\t\tfrom " + table.getTableName()); 
  30.         boolean isFirst = true; 
  31.         for (Column pkColumn : pkColumnList) { 
  32.             String columnName = getColumnName(pkColumn.getColumnName()); 
  33.             String fieldName = getFieldName(pkColumn.getColumnName()); 
  34.             writer.print("\t\t"); 
  35.             if (isFirst) { 
  36.                 writer.print("where"); 
  37.                 isFirst = false; 
  38.             } else { 
  39.                 writer.print("and"); 
  40.             } 
  41.             writer.println(" " + columnName + " = #{" + fieldName + "}"); 
  42.         } 
  43.         writer.println("\t</select>"); 
  44.         writer.println("</mapper>"); 
  45.     } 
  46. } 


3.生成相关代码

★ 3.1.生成的模型类代码


  1. /** 组织公司DO类 */ 
  2. @Getter 
  3. @Setter 
  4. @ToString 
  5. public class OrgCompanyDO { 
  6.     /** 公司标识 */ 
  7.     private Long id; 
  8.     /** 公司名称 */ 
  9.     private String name; 
  10.     /** 联系地址 */ 
  11.     private String address; 
  12.     /** 公司描述 */ 
  13.     private String description; 
  14. } 


★ 3.2.生成的 DAO 接口代码


  1. /** 组织公司DAO接口 */ 
  2. public interface OrgCompanyDAO { 
  3.     /** 获取组织公司函数 */ 
  4.     public OrgCompanyDO get(@Param("id") Long id); 


★ 3.3.生成的 DAO 映射代码


  1. <!-- 组织公司映射 --> 
  2. <mapper namespace="xxx.database.OrgCompanyDAO"> 
  3.     <!-- 所有字段语句 --> 
  4.     <sql id="fields"> 
  5.         id 
  6.         , name 
  7.         , address 
  8.         , description 
  9.     </sql> 
  10.     <!-- 获取组织公司函数语句 --> 
  11.     <select id="get" resultType="xxx.database.OrgCompanyDO"> 
  12.         select 
  13.         <include refid="fields"/> 
  14.         from org_company 
  15.         where id = #{id} 
  16.     </select> 
  17. </mapper> 


3.主要优缺点

主要优点:

  • 代码格式可以定制,保证生成代码合规;
  • 代码功能可以定制,只生成需要的代码;
  • 经过前期代码沉淀后,后期能够直接使用。

主要缺点:

  • 需要研究数据来源,保证能获取到生成代码所需的数据;
  • 需要建立数据模型、编写生成代码,耗费时间比较长。

终极方法:无招胜有招

编码的终极方法,是不是直接对着电脑说需求,然后电脑就自动生成代码了?未来科技发展到一定水平后,这种情况或许会变成现实。但是,目前这种情况是不现实的。现实中,想要做到"大口一张、代码就来",除非你是老板、产品经理或者技术管理者。

编码的终极方法是“无招胜有招”,"无招"并不是不讲究"招式",而是不拘泥于某一"招式",信手拈来合适的"招式"为宜。本文中列举的各种编码方法,没有高低优劣之分,只有合不合适之说。所以,灵活地运用各种编码方法,就是编码的终极方法。

代码规范化

在上面的各种编码方法中,很多方法都需要手工编写样例代码。如果你的代码不遵循代码规范,就很难发现代码之间的共性,并抽象出能够作为标准的样例代码;如果作为标准的样例代码不满足代码规范,必然导致生成的代码也不满足代码规范,于是把这些不规范放大了十倍、百倍甚至千倍。所以,代码规范化是编码的重中之重。