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源創計劃」，歡迎正在閱讀的你也加入，一塊兒分享。