CodeGenerator代碼生成器
CodeGenerator是一個(gè)JavaEE代碼生成器,它可以幫助我們生成一個(gè)可以直接運(yùn)行的JavaWeb工程。
1 生成的文件
這個(gè)代碼生成器生成的代碼包括簡單的增刪改查代碼、配置文件和SwaggerUI頁面。具體生成的文件包括：
- 代碼文件：
- 持久化對象PO類
- 使用SpringMVC編寫的Controller文件
- Service層接口文件
- 使用Spring編寫的ServiceImpl實(shí)現(xiàn)類
- Dao層接口文件
- 使用Hibernate編寫的DaoImpl實(shí)現(xiàn)類
- 配置文件：
- SpringMVC的配置文件
- Spring的配置文件
- Hibernate的配置文件
- web.xml文件
- pom.xml文件
- 頁面文件：SwaggerUI頁面
2 實(shí)現(xiàn)原理
2.1 代碼文件的生成
參照mybatis-generator-core-1.3.2.jar的實(shí)現(xiàn)原理，抽取出插件中對Java文件的封裝和生成的核心代碼，然后根據(jù)個(gè)人需求對它們進(jìn)行精簡和改寫，使其能夠生成控制層、業(yè)務(wù)層和持久層的Java代碼。
2.2 配置文件的生成
使用FreeMarker模板引擎來生成配置文件。因?yàn)樵谂渲梦募?需要?jiǎng)討B(tài)改變的內(nèi)容很少，所以我認(rèn)為使用模板引擎技術(shù)來生成比較方便。
2.3 UI文件的生成
UI文件的生成過程就是一個(gè)文件夾拷貝操作。我將預(yù)先準(zhǔn)備好的SwaggerUI文件放到生成器工程下,程序運(yùn)行時(shí)就會將這些文件拷貝到新生成的工程下面。這樣做的好處是不用自己去Swagger官網(wǎng)下載文件，然后手動將文件拷貝過去。
3 使用方式
3.1 下載源碼
源碼地址：https://github.com/GitHub-LiChengPeng/CodeGenerator
3.2 添加數(shù)據(jù)庫信息
找到生成器源碼的入口類(core.Main)，修改主方法中指定的MySQL數(shù)據(jù)庫的用戶名、密碼和數(shù)據(jù)庫名。
3.3 生成代碼
要生成正確的代碼需要滿足兩個(gè)條件：一、數(shù)據(jù)庫表必須有主鍵，而且主鍵必須滿足單一、整型、自增三個(gè)特點(diǎn)。二、只能在Windows系統(tǒng)上運(yùn)行程序，因?yàn)槁窂絾栴}。
我們可以先在數(shù)據(jù)庫中新建一張表(如用戶表)，SQL語句如下：
CREATE TABLE `user` (
`user_id` int(11) NOT NULL AUTO_INCREMENT COMMENT '用戶主鍵' ,
`user_name` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '用戶名' ,
`user_birthday` date NULL DEFAULT NULL COMMENT '用戶生日' ,
PRIMARY KEY (`user_id`)
)
ENGINE=InnoDB
DEFAULT CHARACTER SET=utf8 COLLATE=utf8_general_ci
COMMENT='用戶表'
AUTO_INCREMENT=5
ROW_FORMAT=COMPACT;
然后運(yùn)行程序，程序會讀取指定數(shù)據(jù)庫下的所有表格，然后針對每個(gè)表格生成基本的增刪改查代碼。程序執(zhí)行完畢后，我們可以在桌面上找到一個(gè)新生成的名字為Project的工程。
最后我們使用IntelliJ IDEA打開(Open)剛生成的工程，可以看到工程中的代碼結(jié)構(gòu)如下圖所示：
3.4 修改工程設(shè)置
需要修改兩個(gè)地方：第一個(gè)是讓編譯器找到web.xml，第二個(gè)是讓編譯器知道web目錄所在的路徑。具體操作如下：
3.5 添加Tomcat服務(wù)器
3.6 啟動服務(wù)器
Tomcat服務(wù)器成功啟動后，瀏覽器自動會打開SwaggerUI的頁面。我們可以在頁面中看到生成器為用戶表生成的增刪改查API。
3.7 測試增刪改查方法
3.7.1 測試增加用戶：
3.7.2 測試刪除用戶
3.7.3 測試修改用戶：
3.7.4 測試按主鍵查用戶：
3.7.5 測試查詢所有用戶：
4 使用場景
因?yàn)槟壳斑€沒有對生成器源碼進(jìn)行重構(gòu)，所以它的擴(kuò)展性很差。我覺得這個(gè)生成器現(xiàn)在只能用在教學(xué)和娛樂場景。
