Photo @getdrawings.comjava
文 | 陈昌毅程序员
导读
web
第一次作某件事时只管去作； 第二次作相似的事时会产生反感，但不管如何仍是能够去作； 第三次再作相似的事时，你就应该重构。
方法1：手工编写代码
public class Test {
public static void main(String[] args) {
System.out.println("Hello world!");
}
}
方法2：复制粘贴代码
1.为何要复制粘贴代码
复制粘贴现有代码，能够节省开发时间；面试
复制粘贴稳定代码，能够下降系统故障风险；算法
复制粘贴网络代码，能够把别人的成果化为己用。sql
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"。
/** 查询公司服务函数 */
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);
}
2.主要优缺点
生成代码速度较快。
必须编写样例代码；
只适用于文本替换的情景。
方法4：用Excel公式生成代码
1.利用 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 公式生成枚举类
="/** "&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 公式生成数据库语句
= "('"&B2&"', '"&C2&"', '"&D2&"', '"&E2&"'),"
('高德', '首开大厦', '(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：用工具生成代码
1.安装运行插件
2.生成代码样例
2.1.生成模型类代码
......
public class User {
private Long id;
private String user;
private String password;
private Integer age;
......
}
2.2.生成映射接口代码
......
public interface UserMapper {
User selectByPrimaryKey(Long id);
......
}
2.3.生成映射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：用代码生成代码
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 = ?;
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>
3.主要优缺点
代码格式能够定制，保证生成代码合规；
代码功能能够定制，只生成须要的代码；
通过前期代码沉淀后，后期可以直接使用。
须要研究数据来源，保证能获取到生成代码所需的数据；
须要创建数据模型、编写生成代码，耗费时间比较长。
终极方法：无招胜有招
代码规范化
后记
本文做者：
陈昌毅，花名常意，高德地图技术专家。
1
END
1
推 荐 阅 读
3. Java面经——SE基础
4. 详谈类加载的全过程
6. 深刻理解synchronized底层原理，一篇文章就够了！
本文分享自微信公众号 - 北风IT之路（beifengtz）。
若有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一块儿分享。