所謂代碼生成，簡單！我詳細分析給你看！

現在很多開源的腳手架項目一般都會有自己的代碼生成器，能夠幫助快速生成代碼，一般都是根據表結構生成實體，和實體對應的操作類，比如controller、service、mapper等。這些初始新建的類都有個共同點，除了對應的操作實體不一樣之外，其他沒啥區別，所以我們可以統一生成。除了後端的代碼，有些生成器還可以生成頁面，如表單、列表等。

說到這裏，不經想問一下，這代碼生成的原理是啥？

我們來分析一下，因爲涉及到表反向生成代碼，所以需要先設計好表結構。有了表結構之後我們就可以生成對應的實體類，這個過程是怎麼完成的呢？也就是說，後端怎麼知道我有哪些數據表？然後每個數據表又長什麼樣子的呢？

這裏給大家介紹兩種方法：

1、通過默認數據庫information_schema獲取
2、通過show命令查看結構或狀態

首先來說說第一種：

information_schema中獲取

大家在安裝完mysql之後，mysql並不是空的，而是默認自帶了4個數據庫，分別如下：

information_schema
performance_schema
mysql
sys

information_schema

保存整個mysql所有數據庫、表、索引的信息

其中，用紅色框標記出來的就是記錄着所有數據庫表和表字段信息的表。

performance_schema

主要用於收集數據庫服務器性能參數
提供進程等待的詳細信息，包括鎖、互斥變量、文件信息；

mysql

保存MySQL的權限、參數、對象和狀態信息。

sys

sys模式，這是一組幫助DBA和開發人員解釋性能模式收集的數據的對象。sys模式對象可用於典型的調優和診斷用例。

這個sys數據庫雖然只有一個表，但是卻有大量的視圖：

ok，上面我們對mysql中的幾個默認數據庫做了一番認識，那麼現在我們找到答案了嗎？

information_schema數據庫中是不是存有所有的數據表和表字段信息，由此，我們就可以根據數據庫名稱獲取出所有的表，又可以通過表名稱獲取出具體的字段信息。

得出的sql如下：

SELECT
	*
FROM
	information_schema.TABLES
WHERE
	TABLE_SCHEMA = (SELECT DATABASE());

因爲我們項目都是指定數據庫的，所以select database()就是連接的數據庫。結果如下：

上面，我們找出了數據庫third-homework的所有表名稱。

有了表名稱我們是不是就可以生成實體啦？只需要去掉表前綴（如“t”等），然後下劃線轉駝峯，再首字母大寫，這樣useraction就轉成了UserAction實體了。

現在我們獲取到了所有表，那麼接下來就循環獲取出所有表的字段信息。依然還是利用information_schema數據庫。

以user_action表爲例子：

SELECT    
	*
FROM
	information_schema. COLUMNS
WHERE
	TABLE_SCHEMA = (SELECT DATABASE()) AND TABLE_NAME = "user_action";

這樣，我們就又獲取到了字段信息，然後下劃線轉駝峯，就得到我們的實體屬性，然後類型在相對轉換成java的類型，如varchar用String類型等。

第一種方法總結如下：通過mysql的默認數據庫information_schema中的TABLES和COLUMNS表的特性，通過條件查詢出對應的數據表和字段的信息。

show命令查看

ok，接下來我們來看下show命令怎麼來查看到指定數據庫的數據表和字段信息。首先來獲取third-homework數據庫下表的信息：

show table status;

結果如下：

這裏比較巧妙，這條命令的本意是查看所有表的一些狀態信息，所以就有字段是專門說明表名稱的，這樣我們就可以理解成是獲取所有表信息。

那有如何獲取表的字段呢？

show full fields from `user_action`;

結果如下：

所以，我們又可以獲取到表的字段了。是不是挺簡單的？

好啦，上面都是教如何去獲取數據庫表和字段的，那麼獲取到表結構之後又是如何生成實體的呢？帶着這個問題我們繼續往下面去分析。

實體類是個java文件，一般來說我們要生成一個文件，我們需要一些文件操作類，先定義好模板，然後再傳參進去，進行渲染。比如我們要生成Excel、PDF等。但java文件不需要這麼麻煩，java文件其實和一個txt文件的文本格式一樣，通常我們都可以直接把txt文件的後綴改成java後綴。然後html文件其實也算是一個txt文件，他們之間其實都可以相互強轉後綴，不影響打開和使用。

不知道大家有沒用過頁面靜態化？頁面靜態化的意思就是把原本需要動態加載和渲染的節點預先渲染成一個完全靜態的html頁面，這樣我們打開頁面的時候就完全是個靜態的html頁面，不再需要經過後端的動態渲染，這樣可以大大減輕後端服務的壓力，同時提高響應速度。

我們先來看下頁面靜態化是怎麼做到的。首先，我們定義一個動態頁面，controller中傳參過去：

com.example.IndexController#index

@GetMapping({"", "/", "index"})
public String index(HttpServletRequest req) {    
    req.setAttribute("name", "呂一明");    
    return "index";
}

然後頁面如下：

templates/index.ftl

<!DOCTYPE html>
<html lang="zh-CN">
    <head>    
        <meta charset="utf-8">    
        <title>公衆號：java思維導圖</title>
    </head>
    <body>
        <div>我是：<strong>${name}</strong></div>
    </body>
</html>

得到的頁面效果如下：

那麼有沒有辦法，不需要經過controller，然後直接得出最後的這個頁面渲染結果呢？答案就是我們剛纔說到的提前靜態化。因爲我們頁面用的是模板引擎freemaker，所以用起來就簡單了。

百科介紹：FreeMarker是一款模板引擎：即一種基於模板和要改變的數據，並用來生成輸出文本（ HTML 網頁、電子郵件、配置文件、源代碼等）的通用工具。

所以我們使用freemaker，其實底層原理就是在後端預先把參數和模板進行渲染之後得到網頁再傳給瀏覽器顯示的。所以我們人爲先把底層的渲染步驟先提取出來，代碼如下：

com.example.IndexController#toHtml

@ResponseBody@RequestMapping("/toHtml/{id}")
public Object toHtml(@PathVariable Long id, HttpServletRequest req) throws IOException {    
    Template template = configuration.getTemplate("/index.ftl");
    String fileName = id + ".html"; 
    String htmlDir = "D:\\git-job\\open-demo\\src\\main\\resources\\static\\html"; 
    Map<String, Object> params = new HashMap<>(); 
    params.put("name", "呂一明" + id);    
    return FreemarkerUtil.printToFile(template, htmlDir, fileName, params);
}

而FreemarkerUtil.printToFile代碼比較長，就不貼出來了，原理就是先定義一個輸出流，然後使用模板把參數和流渲染得到文件。關鍵代碼如下：

//創建輸出流
File file = new File(fileDir +File.separator+ fileName);    

Writer writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file),"UTF-8"));
//輸出模板和數據模型都對應的文件
template.process(params, writer);

梳理一下，上面的代碼意思是我從templates中獲取index.ftl頁面，然後指定了一個params的map交給Template進行渲染，得到的html頁面放在指定的static/html文件夾下。

於是我們訪問 http://localhost:8080/toHtml/1234 就得到如下結果：

就可以通過 http://localhost:8080/html/1234.html 訪問到靜態頁面。

以上就是利用模板引擎頁面靜態化的原理。那麼這和我們代碼生成有什麼關聯呢？其實大部分的代碼都是類似這樣生成的，優先定義好模板，然後再往模板中塞字段信息等，最後渲染出一個java文件。

mybatis plus代碼生成器

接下來，我們去分析一下mybatis plus的代碼生成器。官網代碼生成器說明：

https://mybatis.plus/guide/generator.html

(這裏有個動圖，但插入不進來，大家進入鏈接看吧)

上面是代碼生成的演示，可以看到輸入一些參數之後，自動幫我們生成controller、service等。

我們先貼出生成器代碼，比較長：

// 演示例子，執行 main 方法控制檯輸入模塊表名回車自動生成對應項目目錄中
public class CodeGenerator {
    /**
     * <p>
     * 讀取控制檯內容
     * </p>
     */    
    public static String scanner(String tip) {  
        Scanner scanner = new Scanner(System.in);  
        StringBuilder help = new StringBuilder();    
        help.append("請輸入" + tip + "：");        
        System.out.println(help.toString());    
        if (scanner.hasNext()) {       
            String ipt = scanner.next();    
            if (StringUtils.isNotEmpty(ipt)) {   
                return ipt;        
            }   
        }    
        throw new MybatisPlusException("請輸入正確的" + tip + "！"); 
    }  
    public static void main(String[] args) {   
        // 代碼生成器    
        AutoGenerator mpg = new AutoGenerator();    
        // 全局配置      
        GlobalConfig gc = new GlobalConfig();   
        String projectPath = System.getProperty("user.dir");     
        gc.setOutputDir(projectPath + "/src/main/java");   
        gc.setAuthor("jobob");  
        gc.setOpen(false);     
        // gc.setSwagger2(true); 實體屬性 Swagger2 註解      
        mpg.setGlobalConfig(gc);      
        // 數據源配置     
        DataSourceConfig dsc = new DataSourceConfig();    
        dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8"); 
        // dsc.setSchemaName("public");        
        dsc.setDriverName("com.mysql.jdbc.Driver");    
        dsc.setUsername("root");      
        dsc.setPassword("密碼");     
        mpg.setDataSource(dsc);    
        // 包配置    
        PackageConfig pc = new PackageConfig();    
        pc.setModuleName(scanner("模塊名"));       
        pc.setParent("com.baomidou.ant");     
        mpg.setPackageInfo(pc);     
        // 自定義配置      
        InjectionConfig cfg = new InjectionConfig() {   
            @Override         
            public void initMap() {   
                // to do nothing     
            }     
        };      
        // 如果模板引擎是 freemarker   
        String templatePath = "/templates/mapper.xml.ftl";   
        // 如果模板引擎是 velocity    
        // String templatePath = "/templates/mapper.xml.vm";    
        // 自定義輸出配置      
        List<FileOutConfig> focList = new ArrayList<>();     
        // 自定義配置會被優先輸出     
        focList.add(new FileOutConfig(templatePath) {   
            @Override         
            public String outputFile(TableInfo tableInfo) {      
                // 自定義輸出文件名 ， 如果你 Entity 設置了前後綴、此處注意 xml 的名稱會跟着發生變化！！             
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()        
                    + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;        
            }      
        });     
        /*      
        cfg.setFileCreate(new IFileCreate() {    
        	@Override         
        	public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {       
                // 判斷自定義文件夾是否需要創建        
                checkDir("調用默認方法創建的目錄");     
                return false;       
        	}      
        });     
        */       
        cfg.setFileOutConfigList(focList);   
        mpg.setCfg(cfg);    
        // 配置模板     
        TemplateConfig templateConfig = new TemplateConfig();   
        // 配置自定義輸出模板     
        //指定自定義模板路徑，注意不要帶上.ftl/.vm, 會根據使用的模板引擎自動識別       
        // templateConfig.setEntity("templates/entity2.java");     
        // templateConfig.setService();      
        // templateConfig.setController();     
        templateConfig.setXml(null);     
        mpg.setTemplate(templateConfig);    
        // 策略配置       
        StrategyConfig strategy = new StrategyConfig();  
        strategy.setNaming(NamingStrategy.underline_to_camel);  
        strategy.setColumnNaming(NamingStrategy.underline_to_camel); 
        strategy.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");  
        strategy.setEntityLombokModel(true);       
        strategy.setRestControllerStyle(true);     
        // 公共父類
        strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController"); 
        // 寫於父類中的公共字段    
        strategy.setSuperEntityColumns("id");     
        strategy.setInclude(scanner("表名，多個英文逗號分割").split(","));  
        strategy.setControllerMappingHyphenStyle(true);       
        strategy.setTablePrefix(pc.getModuleName() + "_");    
        mpg.setStrategy(strategy);    
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());  
        mpg.execute();   
    }
}

上面做了一些配置，比如全局配置基本參數、數據源配置、輸出路徑配置、自定義模板配置、策略配置（配置超類、公共字段等）。有了這些配置，就可以定義自己想要生成的效果，我們再來看看底層核心代碼。mpg.execute();方法裏面核心的代碼如下：

// 模板引擎初始化執行文件輸出
templateEngine.init(this.pretreatmentConfigBuilder(config)).mkdirs().batchOutput().open();

init方法初始化環境，
mkdirs方法創建文件夾，
batchOutput批量生成代碼
open打開文件夾

所以核心的代碼再batchOutput方法中，我們去看看：

上面代碼中，開頭就一個for循環，循環所有的表，所以每個表都會生成controller等類，下面是獲取自定義的那些配置getObjectMap（tableInfo）方法；可以看下獲取到的參數：

上面初始化了很多參數，有了這些參數，然後我們進入writer方法中進行渲染。我們看看writer方法：

@Override
public void writer(Map<String, Object> objectMap, String templatePath, String outputFile) throws Exception {  
    Template template = configuration.getTemplate(templatePath);  
    try (FileOutputStream fileOutputStream = new FileOutputStream(outputFile)) {  
        template.process(objectMap, new OutputStreamWriter(fileOutputStream, ConstVal.UTF8)); 
    }    
    logger.debug("模板:" + templatePath + ";  文件:" + outputFile);
}

看到這個方法，是不是和之前我們頁面靜態化的處理方式一樣的，通過template.process處理模板和參數得到文件。我們看看其中一個模板是怎麼定義的，比如

mapper.java.ftl

package ${package.Mapper};
import ${package.Entity}.${entity};
import ${superMapperClassPackage};
/** 
* <p> * ${table.comment!} Mapper 接口 * </p> * * @author ${author} * @since ${date} */
<#if kotlin>
interface ${table.mapperName} : ${superMapperClass}<${entity}>
<#else>
public interface ${table.mapperName} extends ${superMapperClass}<${entity}> {

}
</#if>

我們再對比一下mapper.java.ftl還有之前初始化的參數，渲染之後輸出爲java文件，是不是就達到了我們代碼生成的效果了。

結束

好了，今天文章先到這裏了。

轉載自公衆號：java思維導圖

所謂代碼生成，簡單！我詳細分析給你看！