代码生成器

代码生成器概述

背景

基于MVC架构的传统进行模块开发的步骤：

创建数据库表
根据表字段设计对应的实体类(PO)
编写增删改查持久层(dao)代码
根据业务逻辑编写service层代码
controller层代码和前端页面

通常只要知道了一个表的结构，增删改查的前后台代码格式基本上就是固定的，比如controller、service、dao、实体类Po、前端jsp等模块的代码在不同数据库表基础上都具有类似的结构，所以正对这部分代码，可以让计算机自动帮我们生成，让精力聚焦于更复杂业务代码的编写上

需求分析

代码生成器依据公共的模板和数据库表中的信息自动生成代码

传统开发中，由于不同数据库基础增删改查代码结构相似，程序员通常都是将一份已经写好的代码进行复制和修改，再根据不同业务需求在此基础上进行代码的完善，可以将这份代码称之为代码模板
生成的基础代码与对应数据库密切相关，所以除代码模板之外还需要数据库表的信息来对模板相关内容进行填充

基本思路

代码生成自动生成代码的几个重点需要解决的问题

数据库以及表的解析，用于生成实体类以及其他代码

从数据库中解析出数据库中表的名称以及表字段等属性：可以根据表名确定实体类名称，根据字段确定实体类中的属性
模板开发生成代码文件

模板中定义公共的基础代码和需要替换的占位符内容，然后根据解析好的数据库信息进行数据替换并生成对应代码文件
基础框架模板代码的抽取

FreeMaker的使用

FreeMaker概述

FreeMaker是一款模板引擎：一种基于模板的，用来输出文本的通用工具。

它是为Java程序员提供的一个开发包或者类库，它并不面向最终用户，而是面向程序员提供的嵌入他们开发产品过程中的一款应用程序。

FreeMaker最早是用来设计生成HTML网页的。使用 MVC 模式的动态网页的构思使得你可以将前端设计者(编写 HTML)从程序员中分离出来。所有人各司其职，发挥其擅长的一面。网页设计师可以改写页面的显示效果而不受程序员编译代码的影响，因为应用程序的逻辑(Java 程序)和页面设计(FreeMarker 模板)已经分开了。页面模板代码不会受到复杂的程序代码影响。这种分离的思想即便对一个程序员和页面设计师是同一个人的项目来说都是非常有用的，因为分离使得代码保持简洁而且便于维护。

FreeMaker的应用场景

动态页面

基于模板配置和表达式生成页面文件，可以像jsp一样被客户端访问

页面静态化

对于系统中频繁使用数据库进行查询但是内容更新很小的应用，都可以用FreeMarker将网页静态化，这样就避免了大量的数据库访问请求，从而提高网站的性能

代码生成器

可以自动根据后台配置生成页面或者代码

FreeMaker的优势

强大的模板语言：有条件的块，迭代，赋值，字符串和算术运算和格式化，宏和函数，编码等更多的功能；
多用途且轻量：零依赖，输出任何格式，可以从任何地方加载模板（可插拔），配置选项丰富；
智能的国际化和本地化：对区域设置和日期/时间格式敏感；
XML处理功能：将dom-s放入到XML数据模型并遍历它们，甚至处理他们的声明；
通用的数据模型：通过可插拔适配器将java对象暴露于模板作为变量树；

FreeMaker的基本使用

使用FreeMaker的重点

编写模板文件
使用FreeMaker解析模板，并将模板中的对应内容替换掉

导入pom依赖

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.20</version>
</dependency>

FreeMaker使用步骤

编写对应的模板文件

FreeMaker的模板文件一般以.ftl结尾，以什么后缀结尾并不影响最终的处理

模板数据填充替换

解析模板文件，将数据替换到模板中对应位置，并生成需要的文件，此过程一般需要经历以下5个步骤

创建FreeMaker的配置类
指定模板加载器，将模板存入缓存
获取模板
构造数据模型
输出生成的文件

入门案例：文件模板

创建模板文件template01.ftl

在工程src同级目录下新建文件templates/template01.ftl

1	中国欢迎您:${username}

使用FreeMaker进行数据填充，生成指定文件

public class FreeMakerParse {
    public static void main(String[] args) throws IOException, TemplateException {
        //1.创建FreeMaker配置类
        Configuration cfg = new Configuration();
        //2.选择模板加载器
        //2.1指定模板路径
        String templateFolder = "templates";
        //2.2选择文件模板加载器
        FileTemplateLoader loader = new FileTemplateLoader(new File(templateFolder));
        //2.3设置模板加载器
        cfg.setTemplateLoader(loader);
        //3.获取模板
        String templatePath = "template01.ftl";
        Template template = cfg.getTemplate(templatePath);
        //4.构造数据模型,FreeMaker中数据模型以HashMap的形式存在,key为模板中占位符,value为替换数据
        Map<String, Object> dataMap = new HashMap<>();
        dataMap.put("username","李白");
        //5.处理模板,输出文件
        /**
         * process参数:
         *     参数1:数据模型,HashMap
         *     参数2:writer对象，可以输出到文件或者控制台
         *       文件用: new FileWriter(文件名)
         *       控制台用: new PrintWriter()
         */
        //输出到控制台
        //template.process(dataMap,new PrintWriter(System.out));
        //写入文件
        //文件路径
        String outPath = "Files/out1.txt";
        template.process(dataMap,new FileWriter(new File(outPath)));
    }
}

项目目录结构

入门案例：字符模板

模板通过字符串的形式在代码中直接定义

public class FreeMakerStringParse {
    public static void main(String[] args) throws IOException, TemplateException {
        //1.创建FreeMaker配置类
        Configuration cfg = new Configuration();
        //2.选择模板加载器
        cfg.setTemplateLoader(new StringTemplateLoader());
        //3.创建模板
        //3.1定义字模板字符串
        String templateStr = "你来自于哪个城市:${cityName}";
        //3.2创建模板
        //第一参数:模板名 第二个参数:读取字符模板 第三个参数:配置类
        Template template = new Template("strYemplate", new StringReader(templateStr), cfg);
        //4.构造数据模型,FreeMaker中数据模型以HashMap的形式存在,key为模板中占位符,value为替换数据
        Map<String, Object> dataMap = new HashMap<>();
        dataMap.put("cityName","安徽");
        //5.输出文件
        /**
         * process参数:
         *     参数1:数据模型,HashMap
         *     参数2:writer对象，可以输出到文件或者控制台
         *       文件用: new FileWriter(文件名)
         *       控制台用: new PrintWriter()
         */
        //输出到控制台
        template.process(dataMap,new PrintWriter(System.out));
        //写入文件
        //文件路径
//        String outPath = "Files/out1.txt";
//        template.process(dataMap,new FileWriter(new File(outPath)));
    }
}

FreeMaker模板

经过前面案例，明显感觉到FreeMaker的Java代码部分编写的步骤比较固定，FreeMaker的重点部分在于模板的创建编写

概述

FreeMaker模板文件主要由以下5个部分组成：

数据模型：模板中用到的数据
文本：直接输出的部分
注释：模板中的注释格式<#-- 注释内容 -->
插值：即${}或者#{}部分，将会使用数据模型中的部分来对这部分进行替换
FTL指令：FreeMaker指令，和HTML标记类似，名字前面加#区分，不会输出

数据模型

FreeMarker（还有模板开发者）并不关心数据是如何计算的，FreeMarker 只是知道真实的数据是什么。模板能用的所有数据被包装成 data-model 数据模型

数据模型结构

比如要获取user数据，模板中应该写为:${user}，要获取url数据，模板中应该写为：${latestProduct.url}

模板常用标签

${}，插值(占位符)，FreeMaker在输出时，会用数据模型中的实际值进行替代
<#..>: FTL标记，类似于HTML标记，#主要是为了与HTML进行区分
<@>：宏，自定义标签
<#-- -->注释符

模板中常用的指令(FTL标记)

if指令

条件分支控制语句

在<#内写的占位符，无需用#{}包裹

<#if flag=1>
    传入的数据是1
    <#elseif flag=2>
    传入的数据据是2
    <#else>
    传入的数据是其他
</#if>

对应的FreeMaker解析的代码

public class FreeMakerParse {
    public static void main(String[] args) throws IOException, TemplateException {
        //1.创建FreeMaker配置类
        Configuration cfg = new Configuration();
        //2.选择模板加载器
        //2.1指定模板路径
        String templateFolder = "templates";
        //2.2选择文件模板加载器
        FileTemplateLoader loader = new FileTemplateLoader(new File(templateFolder));
        //2.3设置模板加载器
        cfg.setTemplateLoader(loader);
        //3.获取模板
        String templatePath = "template01.ftl";
        Template template = cfg.getTemplate(templatePath);
        //4.构造数据模型,FreeMaker中数据模型以HashMap的形式存在,key为模板中占位符,value为替换数据
        Map<String, Object> dataMap = new HashMap<>();
        dataMap.put("username","李白");
        dataMap.put("flag",3);
        //5.输出文件
        /**
         * process参数:
         *     参数1:数据模型,HashMap
         *     参数2:writer对象，可以输出到文件或者控制台
         *       文件用: new FileWriter(文件名)
         *       控制台用: new PrintWriter()
         */
        //输出到控制台
        template.process(dataMap,new PrintWriter(System.out));
        //写入文件
        //文件路径
//        String outPath = "Files/out1.txt";
//        template.process(dataMap,new FileWriter(new File(outPath)));

    }
}

list指令

list指令是迭代输出指令，用于迭代输出数据模型中的集合数据

1
2
3

<#list userList as user>
    当前登录用户:${user}
</#list>

对应的FreeMaker解析的代码

public class FreeMakerParse {
    public static void main(String[] args) throws IOException, TemplateException {
        //1.创建FreeMaker配置类
        Configuration cfg = new Configuration();
        //2.选择模板加载器
        //2.1指定模板路径
        String templateFolder = "templates";
        //2.2选择文件模板加载器
        FileTemplateLoader loader = new FileTemplateLoader(new File(templateFolder));
        //2.3设置模板加载器
        cfg.setTemplateLoader(loader);
        //3.获取模板
        String templatePath = "template01.ftl";
        Template template = cfg.getTemplate(templatePath);
        //4.构造数据模型,FreeMaker中数据模型以HashMap的形式存在,key为模板中占位符,value为替换数据
        Map<String, Object> dataMap = new HashMap<>();
        dataMap.put("username","李白");
        dataMap.put("flag",3);
        ArrayList<String> list = new ArrayList<>();
        list.add("曹阿满");
        list.add("刘大耳");
        list.add("孙十万");
        list.add("诸葛村夫");
        dataMap.put("userList",list);
        //5.输出文件
        /**
         * process参数:
         *     参数1:数据模型,HashMap
         *     参数2:writer对象，可以输出到文件或者控制台
         *       文件用: new FileWriter(文件名)
         *       控制台用: new PrintWriter()
         */
        //输出到控制台
        template.process(dataMap,new PrintWriter(System.out));
        //写入文件
        //文件路径
//        String outPath = "Files/out1.txt";
//        template.process(dataMap,new FileWriter(new File(outPath)));

    }
}

执行结果

list结合break指令使用

<#list userList as user>
    当前登录用户:${user},当前用户编号:${user_index+1}
    <#if user_has_next>=========</#if>
    <#if user="孙十万"><#break></#if>

</#list>

xxx_index：当前变量的索引值
xxx_has_next：是否存在下一个对象
<#break>：跳出循环迭代

运行结果

include指令

模板包含，一个模板中包含另一个模板内容

1	<#include "需要导入包含模板路径，支持相对路径的写法，只是要用引号括起来">

assign指令

assign指令用于在模板中自定义个变量，可以存储到数据模型中，在模板其他部分引用

1	<#assign age=27>

模板其他位置可以通过${age}来引用该变量

内置函数

FreeMarker还提供了一些内建函数来转换输出，可以在任何变量后紧跟?,?后紧跟内建函数，就可通过内建函数来转换输出变量。

使用语法:${username?upper_case}

下面是常用的内建的字符串函数：

?html:html字符转义
?cap_first: 字符串的第一个字母变为大写形式
?lower_case :字符串的小写形式
?upper_case :字符串的大写形式
?trim:去掉字符串首尾的空格
?substring:截字符串
?lenth: 取长度
?size: 序列中元素的个数
?int : 数字的整数部分（比如- 1.9?int 就是- 1）
?replace:字符串替换

数据库元数据

背景

什么是数据库元数据

元数据(meta data)是指定义数据结构的数据，数据库元数据是指定义数据库各类对象结构的数据，例如数据库中的数据库名、表名、列名、用户名、版本名以及从SQL语句得到的结果中大部分字符串都是元数据

数据库元数据作用

在应用设计时，能够充分利用数据库元数据
深入理解了数据库组织结构，再去理解数据访问相关框架的实现原理会更加容易

如何获取数据库元数据

JDBC来处理数据库的接口主要有三个，即Connection，PreparedStatement和ResultSet这三个，而对于这三个接口，还可以获取不同类型的元数据，通过这些元数据类获得一些数据库的信息。

数据库元数据

概述

数据库元数据（DatabaseMetaData）：是由Connection对象通过getMetaData方法获取而来，主要封装了是对数据库本身的一些整体综合信息，例如数据库的产品名称，数据库的版本号，数据库的URL，是否支持事务等等

下面是getMetaData的一些常用方法:

getDatabaseProductName：获取数据库的产品名称
getDatabaseProductVersion：获取数据库的版本号
getUserName：获取数据库的用户名
getURL：获取数据库连接的URL
getDriverName：获取数据库的驱动名称
driverVersion：获取数据库的驱动版本号
isReadOnly：查看数据库是否只允许读操作
supportsTransactions：查看数据库是否支持事务

使用案例

引入pom依赖

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.6</version>
</dependency>

获取数据库连接

private Connection conn;
    //建立数据库连接
    @Before
    public void init() throws Exception {
        //1.注册驱动
        Class.forName("com.mysql.jdbc.Driver");
        //2.配置连接基本属性
        //url不指定数据据库名，便于获取当前服务器下所有数据库
        String url = "jdbc:mysql://127.0.0.1:3306?useUnicode=true&characterEncoding=utf8";
        String userName = "train_member";
        String passWd = "wu123456";
        Properties props = new Properties();
        props.put("user",userName);
        props.put("password",passWd);
        props.put("remarksReporting","true"); //获取表的REMARK(备注信息)
        //3.获取连接
        conn = (Connection) DriverManager.getConnection(url, props);
    }

获取数据库综合信息

//获取数据库综合信息
    @Test
    public void test01() throws SQLException {
        //获取数据库元数据
        DatabaseMetaData metaData = conn.getMetaData();
        //获取数据库产品名称
        System.out.println(metaData.getDatabaseProductName());
        //获取数据库版本号
        System.out.println(metaData.getDatabaseProductVersion());
        //获取数据库的用户名
        System.out.println(metaData.getUserName());
        //获取数据库连接的URL
        System.out.println(metaData.getURL());
        //获取数据库的驱动名称
        System.out.println(metaData.getDriverName());
        //获取数据库的驱动版本号
        System.out.println(metaData.getDriverVersion());
        //查看数据库是否只允许读操作
        System.out.println(metaData.isReadOnly());
        //查看数据库是否支持事务
        System.out.println(metaData.supportsTransactions());
    }

#运行结果
MySQL
5.7.35-log
train_member@localhost
jdbc:mysql://127.0.0.1:3306?useUnicode=true&characterEncoding=utf8
MySQL-AB JDBC Driver
mysql-connector-java-5.1.6 ( Revision: ${svn.Revision} )
false
true

获取数据库列表

//获取数据列表
    @Test
    public void test2() throws SQLException {
        //获取元数据
        DatabaseMetaData metaData = conn.getMetaData();
        //获取数据库列表
        ResultSet catalogs = metaData.getCatalogs();
        //年里数据库列表
        while (catalogs.next()){
            System.out.println(catalogs.getString(1));
        }
        //释放资源
        catalogs.close();
        conn.close();
    }

1
2
3

#运行结果
information_schema
train_member

获取数据库中表信息

//获取数据库表的信息
    @Test
    public void test03() throws SQLException {
        //1.获取元数据
        DatabaseMetaData metaData = conn.getMetaData();
        //2.数据库表信息
        /**
         * getTables有四个参数:
         *      String catalog: 数据库名称
         *      String schemaPattern: mysql此项参数为空
*               String tableNamePattern：表名,为空则为所有表
*               String types[]：表类型，可以为 TABLE:数据库表 VIEW:视图
         */
        ResultSet rs = metaData.getTables("train_member", null, null, new String[]{"TABLE"});
        while (rs.next()){
            //所属数据库
            System.out.println(rs.getString(1));
            //所属schema
            System.out.println(rs.getString(2));
            //表名
            System.out.println(rs.getString(3));
            //数据库表类型
            System.out.println(rs.getString(4));
            //数据库备注
            System.out.println(rs.getString(5));
        }

    }

#运行结果
train_member
null
member
TABLE

train_member
null
passenger
TABLE

train_member
null
ticket
TABLE

获取指定表中的字段信息

//获取数据库表字段信息
    @Test
    public void test04() throws SQLException {
        //获取元数据
        DatabaseMetaData metaData = conn.getMetaData();
        /*
        getColumns有四个参数
        String catalog: 数据库名
        String schemaPattern: mysql可以为空
        String tableNamePattern: 表名
        String columnNamePattern: 列名
         */
        ResultSet rs = metaData.getColumns("train_member", null, "passenger", null);
        while (rs.next()){
            //rs结果集中对应属性获取建议参考JDK官方文档
            System.out.println(rs.getString("COLUMN_NAME")); //字段名获取
        }
        //关闭资源
        rs.close();
        conn.close();

    }

具体详细用法，可以参考JDK官方文档

参数元数据

参数元数据（ParameterMetaData）：是由PreparedStatement对象通过getParameterMetaData方法获取而来，主要是针对PreparedStatement对象和其预编译的SQL命令语句提供一些信息，ParameterMetaData能提供占位符参数的个数，获取指定位置占位符的SQL类型等等

参数元数据在实际应用场景中一般很少用到，只需了解即可，主要常用方法:

getParameterCount：获取预编译SQL语句中占位符参数的个数

//参数元数据简单使用
    @Test
    public void test05() throws Exception {
        //1.注册驱动
        Class.forName("com.mysql.jdbc.Driver");
        //2.配置连接基本属性
        //url不指定数据据库名，便于获取当前服务器下所有数据库
        String url = "jdbc:mysql://127.0.0.1:3306/train_member?useUnicode=true&characterEncoding=utf8";
        String userName = "train_member";
        String passWd = "wu123456";
        Properties props = new Properties();
        props.put("user",userName);
        props.put("password",passWd);
        props.put("remarksReporting","true"); //获取表的REMARK(备注信息)
        //3.获取连接
        conn = (Connection) DriverManager.getConnection(url, props);
        //4.编写SQL语句
        String sql = "select * from passenger where id=?";
        //5.编译SQL
        PreparedStatement pstm = conn.prepareStatement(sql);
        //6.填充参数
        pstm.setString(1,"1733754970974588928");
        //7.获取参数元数据
        ParameterMetaData parameterMetaData = pstm.getParameterMetaData();
        //8.获取参数个数
        int count = parameterMetaData.getParameterCount();
        System.out.println(count);//1

    }

结果集元数据

结果集元数据（ResultSetMetaData）：是由ResultSet对象通过getMetaData方法获取而来，主要是针对由数据库执行的SQL脚本命令获取的结果集对象ResultSet中提供的一些信息，比如结果集中的列数、指定列的名称、指定列的SQL类型等等，可以说这个是对于框架来说非常重要的一个对象

关于ResultSetMetaData的常用方法：

getColumnCount：获取结果集中列项的个数
.getColumnName：获取列名
getColumnTypeName：getColumnTypeName：获取指定列的SQL数据类型
getColumnClassName：获取指定列SQL类型对应于Java中的数据类型(包名加类名)

//结果集元数据
    @Test
    public void test06() throws Exception {
        //1.注册驱动
        Class.forName("com.mysql.jdbc.Driver");
        //2.配置连接基本属性
        //url不指定数据据库名，便于获取当前服务器下所有数据库
        String url = "jdbc:mysql://127.0.0.1:3306/train_member?useUnicode=true&characterEncoding=utf8";
        String userName = "train_member";
        String passWd = "wu123456";
        Properties props = new Properties();
        props.put("user",userName);
        props.put("password",passWd);
        props.put("remarksReporting","true"); //获取表的REMARK(备注信息)
        //3.获取连接
        conn = (Connection) DriverManager.getConnection(url, props);
        //4.编写SQL语句
        String sql = "select * from passenger where id=?";
        //5.编译SQL
        PreparedStatement pstm = conn.prepareStatement(sql);
        //6.填充参数
        pstm.setString(1,"1733754970974588928");
        //7.执行获取结果集
        ResultSet rs = pstm.executeQuery();
        //8.获取结果集元数据
        ResultSetMetaData metaData = rs.getMetaData();
        //获取列个数
        int columnCount = metaData.getColumnCount();
        //获取列信息
        for(int i=1;i<=columnCount;i++){
            //1.获取列名
            System.out.println(metaData.getColumnName(i));
            //2.获取列对应的SQL数据类型
            System.out.println(metaData.getColumnTypeName(i));
            //3.获取列对应Java数据类型
            System.out.println(metaData.getColumnClassName(i));
            System.out.println("================================");
        }
    }

#运行结果
id
BIGINT
java.lang.Long
================================
member_id
BIGINT
java.lang.Long
================================
name
VARCHAR
java.lang.String
================================
id_card
VARCHAR
java.lang.String
================================
type
CHAR
java.lang.String
================================
create_time
DATETIME
java.sql.Timestamp
================================
update_time
DATETIME
java.sql.Timestamp
================================