【一鍵生成程式碼】從vue到java再到groovy

語言: CN / TW / HK

theme: fancy

「這是我參與2022首次更文挑戰的第4天,活動詳情檢視:2022首次更文挑戰

在我前面的文章,講解了mybatis-plus的整合和使用方式,相信有不少同學還想要它的程式碼生成的教程吧,這次>我不光將教程給你,連原始碼的一併放送。

本文專案程式碼gitee地址: https://gitee.com/wei_rong_xin/rob-necessities.git

一、簡介

我們在平時開發業務程式碼時,必然涉及到大量的拷貝工作,比如新建立的表,要實現增刪改查,如果沒有程式碼生成器,那麼是很痛苦的。

好在mybatis就提供了逆向工程提高我們的編碼效率,在後面的mybatis-plus對其進行了封裝,更加簡化了程式碼生成額流程。

那麼想不想要一條可以在頁面ui操作的程式碼生成器呢?比如說從資料庫結構的groovy檔案,到java程式碼,甚至到前端vue的基礎增刪改查介面?

本文使用mybatis-plus-generator提供的能力,結合velocity模板引擎,實現了上面我們提到的能力,相信對於你自己的管理系統開發過程, 能有很大的幫助。

二、開始幹活

本文是依賴於mybatis-plus,請先確保你的專案已經完成了mybatis-plus的整合,沒有的同學移步我前面的文章。

2.1 工程準備

為什麼有這一小節?因為我的生成程式碼的工程在我的專案中是一個單獨的模組,有獨立的資料庫連線,獨立的依賴等。

這麼做的好處是,此模組作為一個服務,與其他服務解耦,可以註冊在註冊中心,可以被閘道器的介面文件發現到,更可以為我們日後作為可ui操作程式碼生成器做準備。如果你非要和其他專案放在一起也沒有任何問題。

image.png

如上所示是我的工程結構,此工程是作為一個moudle存在的。關於如何建立moudle,這裡不介紹了吧,不知道的可以私聊,我可以手把手教你。或者看本文的原始碼,地址在開篇。

2.2 依賴準備

基於maven,springboot開發的專案,重要的就是依賴,我們先新增需要的依賴。

主要依賴: ```xml com.baomidou mybatis-plus-generator 3.5.0

org.apache.velocity velocity-engine-core 2.3 ```

輔助開發的依賴,如果你不習慣使用可以自己修改成其他工具類: ```xml commons-io commons-io 2.11.0

org.projectlombok lombok 1.18.22

cn.hutool hutool-all 5.7.19 ```

2.3 準備velocity模板

不知道同學們用沒用過velocity模板引擎,從這個名字就能看出來,它是通過模板的形式,定義我們需要的內容,然後通過指定字元變數去替換關鍵字。

其實Freemarker也是比較出名的模板引擎,以前前後端未分離時經常見到,結合mybatis-plus-generator同樣能夠做到本文需要的效果。

我在resources下面建立了一個資料夾template,用來存放我們需要的模板:

image.png

從上到下分別是: * Api.js.vm vue中api.js對應的模板 * Client.java.vm springCloud服務呼叫的Client * Controller.java.vm 控制器 * Convert.java.vm 實體類轉換器,例如DTO <-> DO * DTO.java.vm DTO 介面和頁面傳遞 * Entity.java.vm DO 服務層和資料庫傳遞 * Groovy.vm 針對liquiBase使用者,生成自動初始化資料庫的Groovy檔案(手寫很煩) * Html.vue.vm vue的頁面 * Mapper.java.vm Mapper對映 * Service.java.vm 服務介面 * ServiceImpl.java.vm 介面實現

以上這些都是可以自定義的,需要多少就可以新增多少。

下面看下vue中Api.js的內容: ```js import request from '@/utils/request'

var service_name = '/${serviceName}' /* * @description: 分頁列表 * * @author ${author} * @date ${date} / export function getPage${className}(data) { return request({ url: service_name+ '/${classname}/pageList', method: 'post', data }) }

/* * @description: 新增 * * @author ${author} * @date ${date} / export function create(data) { return request({ url: service_name+ '/${classname}/save', method: 'post', data }) }

/* * @description: 更新 * * @author ${author} * @date ${date} / export function update(data) { return request({ url: service_name+ '/${classname}/update', method: 'post', data }) } `` 如上所示,${serviceName},${classname},${author}`等分別表示服務的駝峰名稱,類的小寫名稱以及作者,程式碼生成是會根據選的表進行替換,這些替換符的名稱也是自己進行指定的。

下面在隨便看幾個:

  • Client.java.vm ```java package ${package}.api;

import com.cloud.bssp.util.R; import ${package}.dto.${className}DTO; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestParam;

import java.util.Map;

/* * Description: ${comments} * Create Date: ${date} * Modified By:
* Modified Date:
* Why & What is modified:
* * @author ${author} * @version ${version}
/ @FeignClient(name = "${serviceName}", path = "/${pathName}", contextId = "base") public interface ${className}Client {

/**
 * 分頁列表
 * @param params
 * @return
 */
@PostMapping("/pageList")
R pageList(@RequestBody Map<String, Object> params);

/**
 * list列表
 * @param ${classname}DTO
 * @return
 */
@PostMapping("/list")
R list(@RequestBody ${className}DTO ${classname}DTO);

/**
 * 根據主鍵查詢
 * @param id
 * @return
 */
@GetMapping("/info/getById")
R info(@RequestParam("id") Long id);

/**
 * 新增
 * @param ${classname}DTO
 * @return
 */
@PostMapping("/save")
R save(@RequestBody ${className}DTO ${classname}DTO);

/**
 * 更新
 * @param ${classname}DTO
 * @return
 */
@PostMapping("/update")
R update(@RequestBody ${className}DTO ${classname}DTO);

} ```

  • DTO.java.vm

```java package ${package}.dto;

import com.cloud.bssp.util.BaseDTO; import com.fasterxml.jackson.annotation.JsonFormat; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; #foreach ($column in $columns) #if($column.attrType == 'LocalDate') import java.time.LocalDate; #break #end #end #foreach ($column in $columns) #if($column.attrType == 'LocalDateTime') import java.time.LocalDateTime; #break #end #end import lombok.Data;

/* * Description: ${comments} * Create Date: ${date} * @author ${author} * @version ${version} / @Data @ApiModel(value = "${className}DTO", description = "資料傳輸物件${className}DTO") public class ${className}DTO extends BaseDTO {

#foreach ($column in $columns)
    /**
     * $column.comments
     */
    @ApiModelProperty(notes = "$column.comments")
        #if($column.attrname == 'id' || $column.attrname.indexOf('Id') != -1)
        @JsonFormat(shape = JsonFormat.Shape.STRING)
        #end
        #if ("date" == $column.dataType)
        @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
        #end
        #if ("datetime" == $column.dataType)
        @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss")
        #end
    private $column.attrType $column.attrname;

#end

} ```

2.4 功能分析

下面簡單分析下我的這套程式碼生成器的功能,從程式碼介面層面看主要有兩個:

  • 生成規則

    簡單來說就是生成程式碼時指定的一些內容,比如作者,包路徑,是否去除表字首等等。

    這是一套完成的增刪改查功能,前端可以直接接入。

    實體類如下: ```java /* * Module: GenerateRulesDO.java * * @author weirx * @since JDK 1.8 * @version 1.0 * @date 2020-07-17T10:00:32.925 * @Descriptions: / @Data @TableName(value = "bssp_generate_rules") public class GenerateRulesDO {

    /**
     * 主鍵
     */
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;
    /**
     * 作者
     */
    private String author;
    /**
     * 包名
     */
    private String packageName;
    /**
     * 服務名
     */
    private String serviceName;
    /**
     * 是否忽略字首 1是0否
     */
    private Integer isIgnorePrefix;
    /**
     * 表字首
     */
    private String tablePrefix;
    /**
     * 建立時間
     */
    @TableField(fill = FieldFill.INSERT)
    @JSONField(format = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;
    /**
     * 更新時間
     */
    @TableField(fill = FieldFill.INSERT_UPDATE)
    @JSONField(format = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime updateTime;
    

    } ```

  • 生成程式碼

    生成程式碼的主要過程如下所示:

    此三種都有對應的介面實現。

## 2.5 程式碼邏輯分析

關於程式碼邏輯分析,我已生成本地zip為例,簡單講解主要的邏輯。

  • 定義原生代碼生成位置

    ``` yml

    程式碼生成路徑

    generator: code: path: rob-necessities-generator/src/main/resources/generate/code.zip 引用:java @Value("${generator.code.path}") private String generatorCodePath; ```

  • 生成介面入口位置

    java /** * 程式碼生成-返回zip * * @param tableDTO * @return */ @ApiOperation(value = "程式碼生成-生成zip到專案") @PostMapping("/generateCodeZip") public void generateCodeZip(@RequestBody TableDTO tableDTO) { try { ByteArrayOutputStream outputStream = generateService.generateCode(TableDoConvert.dtoToDo(tableDTO)); FileOutputStream fos = new FileOutputStream(generatorCodePath); outputStream.writeTo(fos); fos.close(); outputStream.close(); } catch (IOException e) { e.printStackTrace(); } } 此處的引數是TableDTO當中的表名陣列,支援多個同時生成: java /** * 表名稱陣列 */ @ApiModelProperty(notes = "建立時間") private String[] tableNames;

  • 生成程式碼介面實現 ```java @Override public ByteArrayOutputStream generateCode(TableDO tableDO) throws IOException { // 獲取生成規則 List list = generateRulesService.list(); if (CollectionUtils.isEmpty(list)) { return null; } ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); ZipOutputStream zip = new ZipOutputStream(outputStream); // 遍歷表名 for (String tableName : tableDO.getTableNames()) { // 根據表名查詢,獲取表的結構 TableDO table = generateMapper.queryTable(tableName); // 獲取表字段 List columns = generateMapper.queryColumns(tableName); // 生成邏輯 this.generatorCode(table, list.get(0), columns, zip); } // 關閉流 IOUtils.closeQuietly(zip); return outputStream;

    } ```

    主要分為以下幾個步驟:

    • 獲取生成規則
    • 根據表名查詢,獲取表的結構

      實際是通過如下的sql查詢: java /** * Description: 根據表名獲取表資訊 * Created date: 2020/7/15 * @param tableName 表名 * @return java.util.Map<com.cloud.bssp.generator.entity.TableDO> * @author weirx */ @Select("select table_name tableName, engine, table_comment tableComment, create_time createTime from information_schema.tables where table_schema = (SELECT DATABASE()) and table_name = #{tableName}") TableDO queryTable(String tableName); * 獲取表字段

      通過下面的SQL獲取: java /** * Description: 根據表名獲取表字段 * Created date: 2020/7/15 * @param tableName 表名 * @return java.util.List<com.cloud.bssp.generator.entity.TableColumnDO> * @author weirx */ @Select("select column_name columnName, data_type dataType, column_comment columnComment, column_key columnKey,is_nullable,column_type,column_default, extra from information_schema.columns where table_name =#{tableName} and table_schema = (SELECT DATABASE()) order by ordinal_position") List<TableColumnDO> queryColumns(String tableName); * 生成邏輯

  • 生成邏輯

    這個程式碼很多,不貼程式碼了,給個流程吧,實現包含但是不限於這些:

    未命名檔案 (2).png

關於程式碼大家自己去gitee上面看吧,文章不多說。

三、成果展示

  • 前面做了那麼多,都是為了成果,我們首先看下介面文件的介面,本文與Knife4j整合,想用的可以看我前面寫的整合文章,或者直接看程式碼。

    image.png

    介面呼叫:

    image.png

  • 頁面ui操作,本文提供的程式碼沒有,不過我可以展示下以前完成的效果圖:

    image.png

    預覽:

    image.png

  • 生成的程式碼檔案:

    image.png

    • java檔案:

    image.png

    • vue檔案

    image.png


關於文章生成的Groovy是幹什麼用的,後面咱們專門一篇文章介紹liquibase元件,你就明白了,資料庫初始化的神器。

另外,如果需要使用的同學,在明白原理後需要自己去修改模板內容,以符合自己的編碼風格。

關於整合的介紹就這麼多,大家需要的去看原始碼,關於文章中涉及到的內容都有。不明白的可以結合本文和前面我寫的文章去參考。

另外此倉庫的原始碼會持續更新整合常用的、新興的元件,歡迎大家關注學習。

本文專案程式碼gitee地址: https://gitee.com/wei_rong_xin/rob-necessities.git