Java代码生成器01-FreeMarker+JDBC逆向

阅读数:0次

1. 为什么用FreeMarker

简介: FreeMarker 是一款 模板引擎： 即一种基于模板和要改变的数据， 并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。 它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。

总之: 就是使用FreeMarker可以基于模版生成我们所需要的任何文件，并且可以将我们需要的参数引入进去。

2. 如何在Java项目中使用

2.1 引入依赖(pom.xml)

1
2
3
4
5
6
7
8
9
10
11
12
13
<!--普通Java项目-->
<dependency>
  <groupId>org.freemarker</groupId>
  <artifactId>freemarker</artifactId>
  <version>2.3.31</version>
</dependency>

<!--SpringBoot项目可以使用-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-freemarker</artifactId>
  <version>2.6.1</version>
</dependency>

2.2 文件模版

2.2.1 创建模版文件(hello.ftl)

.ftl一般是freemarker模版的常用后缀

image-20211218034855492

2.2.2 简单编写模版内容(hello.ftl)

1
你好：${username}

2.2.3 编写测试代码(Test.java)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
@Test
void contextLoads() throws Exception {
  //创建FreeMarker配置类
  Configuration configuration = new Configuration();
  //初始化模版
  Template template =null;
  try {
    //指定模版加载器
    configuration.setDirectoryForTemplateLoading(new File("项目绝对路径/src/main/resources/templates/"));
    configuration.setObjectWrapper(new DefaultObjectWrapper());
    configuration.setDefaultEncoding("UTF-8");   //设置编码
    //获取模板文件
    template=configuration.getTemplate( "hello.ftl");
    //构造数据模型
    HashMap<String, Object> stringObjectHashMap = new HashMap<>();
    stringObjectHashMap.put("username","zhangsan");
    //模型处理，输出为文件
    template.process(stringObjectHashMap,new FileWriter("项目绝对路径/src/main/resources/hello.txt"));
  } catch (IOException e) {
    e.printStackTrace();
  }
}

2.3 字符串模版

2.3.1 编写测试代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Test
void contextLoads() throws Exception {
  //创建配置对象
  Configuration configuration = new Configuration();
  //制定加载器
  Template template =null;
  //创建字符串模版
  configuration.setTemplateLoader(new StringTemplateLoader());
  //通过字符串创建模版
  String templateString = "欢迎您:${username}";
  template = new Template("name1", new StringReader(templateString), configuration);
  //构造数据
  HashMap<String, Object> stringObjectHashMap = new HashMap<>();
  stringObjectHashMap.put("username","zhangsan");
  //处理模版,在控制台输出
  template.process(stringObjectHashMap,new PrintWriter(System.out));
}

3. FreeMarker FTL常用指令

3.1 if指令

规则

1
2
3
4
5
6
7
<#if 条件>
	xxx
  <#elseif>
  xxx
  <#else>
  xxx
</#if>

测试

1
2
3
4
5
6
7
8
9
10
11
<#--测试模版-->
<#if num=0>
    数字0
<#elseif num=1>
    数字1
<#else>
    数字其他
</#if>
  
<#--测试输入num=1，输出结果-->
    数字1

3.2 list指令

规则

1
2
3
4
5
<#--数据名称 as 别名-->
<#list 数据名称 as 别名>
  ${别名}
</#list>

测试

1
2
3
4
5
6
//java测试代码中例子
ArrayList<String> strings = new ArrayList<>();
strings.add("张三");
strings.add("李四");
strings.add("王五");
stringObjectHashMap.put("list",strings);
1
2
3
4
5
6
7
8
<#--list指令：循环迭代 语法: 数据名称 as 别名-->
<#list list as abc>
    ${abc}
</#list>
<#--测试结果-->
    张三
    李四
    王五

3.3 include指令

规则

1
2
<#--模版包含-->
<#inlcude "另一个模版">

测试

1
2
3
4
5
6
7
8
<#--include-->
<#include "hello.ftl">
<#--模版2-->
模版2
${model2}
<#--测试结果-->
模版2
垃圾堆

3.4 assign指令

规则

1
2
3
4
<#--定义-->
<#assign 变量名=变量值>
<#--引用-->
${变量名}

测试

1
2
3
4
<#assign model2="zhangsan">
${model2}
<#--测试输出-->
zhangsan

4.内置函数

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

5. 数据库元数据

5.1 什么是元数据

元数据(MetaData),是指定义数据结构的数据。那么数据库元数据就是指定义数据库各类对象结构的数据。例如数据库名称 、表名 、列名 、用户名 、版本名 以及从SQL语句得到的结果中的大部分字符串 是元数据。

5.2 数据库元数据的作用

  • 在应用设计时可以充分利用数据库元数据
  • 深入数据库组织结构，理解数据访问相关实现原理。

5.3 如何获取元数据

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

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

5.3.1 数据库元数据常用方法

  • getDatabaseProductName: 获取数据库的产品名称
  • getDatabaseProductName: 获取数据库的版本号
  • getUserName: 获取数据库的用户名
  • getURL: 获取数据库连接的URL
  • getDriverName: 获取数据库驱动名称
  • driverVersion: 获取数据库的驱动版本号
  • isReadOnly: 查看数据库是否只读
  • supportTransactions: 查看数据库是否支持事务

5.3.2 构建环境

1
2
3
4
5
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
  	<version>5.1.6</version>
</dependency>

5.3.3 获取数据库基本信息

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@Test
void testDatabase(){

    String driver="com.mysql.cj.jdbc.Driver";
    String url = "jdbc:mysql://localhost:3306?useUnicode=true&characterEncoding=utf8";
    String username ="root";
    String password = "123456";
    Properties properties = new Properties();
    properties.put("remarksReporting","true");//获取数据库的备注信息
    properties.put("user",username);
    properties.put("password",password);
    try {
        //1. 获取连接
        Class.forName(driver);
        //此处需要使用properties配置文件的形式，不然获取备注的时候会为空
        Connection connection = DriverManager.getConnection(url,properties);

        //2.获取元数据
        DatabaseMetaData metaData = connection.getMetaData();
        //3.获取数据库基本信息
        System.out.println(metaData.getUserName());
        //是否支持事务
        System.out.println(metaData.supportsTransactions());
				//获取数据库名称
        System.out.println(metaData.getDatabaseProductName());

    } catch (ClassNotFoundException e) {
        e.printStackTrace();
    } catch (SQLException throwables) {
        throwables.printStackTrace();
    }
}

5.3.4 获取所有数据库名称

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@Test
void testDatabase(){

    String driver="com.mysql.cj.jdbc.Driver";
    String url = "jdbc:mysql://localhost:3306?useUnicode=true&characterEncoding=utf8";
    String username ="root";
    String password = "123456";
    Properties properties = new Properties();
    properties.put("remarksReporting","true");//获取数据库的备注信息
    properties.put("user",username);
    properties.put("password",password);
    try {
        //1. 获取连接
        Class.forName(driver);
        //此处需要使用properties配置文件的形式，不然获取备注的时候会为空
        Connection connection = DriverManager.getConnection(url,properties);

        //2.获取元数据
        DatabaseMetaData metaData = connection.getMetaData();

        //3.获取数据库列表
        ResultSet rs = metaData.getCatalogs();
        while(rs.next()){
            System.out.println(rs.getString(1));
        }
        rs.close();
        connection.close();

    } catch (ClassNotFoundException e) {
        e.printStackTrace();
    } catch (SQLException throwables) {
        throwables.printStackTrace();
    }
}

5.3.5 获取指定数据库表信息

ResultSet getTables(String catalog, String schemaPattern,String tableNamePattern, String types[])

  • catalog
    • mysql: 当前操作的数据库
    • oralce: 当前操作的数据库
  • schemaPattern
    • mysql: null
    • oracle: 用户名(大写)
  • tableNamePattern
    • null: 查询所有表
    • 非空: 查询目标表
  • types
    • TABLE: 表
    • VIEW: 视图
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@Test
void testDatabase(){

  String driver="com.mysql.cj.jdbc.Driver";
  String url = "jdbc:mysql://localhost:3306?useUnicode=true&characterEncoding=utf8";
  String username ="root";
  String password = "123456";
  Properties properties = new Properties();
  properties.put("remarksReporting","true");//获取数据库的备注信息
  properties.put("user",username);
  properties.put("password",password);
  try {
    //1. 获取连接
    Class.forName(driver);
    //此处需要使用properties配置文件的形式，不然获取备注的时候会为空
    Connection connection = DriverManager.getConnection(url,properties);

    //2.获取元数据
    DatabaseMetaData metaData = connection.getMetaData();

    //ResultSet getTables(String catalog, String schemaPattern,String tableNamePattern, String types[]) throws SQLException;
    ResultSet tables = metaData.getTables("abc", null, null, new String[]{"TABLE"});
    while(tables.next()){
      System.out.println(tables.getString("TABLE_NAME"));
    }

  } catch (ClassNotFoundException e) {
    e.printStackTrace();
  } catch (SQLException throwables) {
    throwables.printStackTrace();
  }
}

5.3.6 获取表中的字段信息

ResultSet getColumns(String catalog, String schemaPattern,String tableNamePattern, String columnNamePattern)

可以debug去看

  • catalog
    • mysql: 当前数据库
    • oracle: 当前数据库
  • schemaPattern
    • mysql: none
    • oracle: 用户名(大写)
  • tableNamePattern: 表名
  • columnNamePattern
    • null: 所有列名
    • 非空: 某一列名
参数 描述
TABLE_CAT 表的目录
TABLE_SCHEM 模式的目录
TABLE_NAME 表名
COLUMN_NAME 列名
TYPE_NAME 列的数据类型名称
COLUMN_SIZE 列的大小
COLUMN_DEF 列的默认值
ORDINAL_POSITION 表中列的索引
IS_AUTOINCREMENT 如果列是自动递增的，则返回yes；如果列不是自动递增的，则返回false；如果无法确定，则返回一个空的String（“”）。
IS_GENERATEDCOLUMN 如果该列是生成的列，则返回yes；如果该列不是生成的列，则返回false；如果无法确定，则返回一个空的String（“”）。
REMARKS 列备注 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@Test
    void testDatabase(){

        String driver="com.mysql.cj.jdbc.Driver";
        String url = "jdbc:mysql://localhost:3306?useUnicode=true&characterEncoding=utf8";
        String username ="root";
        String password = "123456";
        Properties properties = new Properties();
        properties.put("remarksReporting","true");//获取数据库的备注信息
        properties.put("user",username);
        properties.put("password",password);
        try {
            //1. 获取连接
            Class.forName(driver);
            //此处需要使用properties配置文件的形式，不然获取备注的时候会为空
            Connection connection = DriverManager.getConnection(url,properties);

            //2.获取元数据
            DatabaseMetaData metaData = connection.getMetaData();
          
            ResultSet book = metaData.getColumns("abc", null, "book", null);
            while(book.next()){
                System.out.println("列名"+book.getString("COLUMN_NAME"));
                System.out.println("类型名称"+book.getString("TYPE_NAME"));
                System.out.println("字段大小"+book.getString("COLUMN_SIZE"));
                System.out.println("备注"+book.getString("REMARKS"));
            }

        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (SQLException throwables) {
            throwables.printStackTrace();
        }
    }

5.4 参数元数据

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

方法有多个，但是有作用的只有这一个，其余的不准确

  • getParameterCount: 获取预编译SQL语句中占位符参数的个数
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@Test
void PreparedStatementTest(){
    String driver="com.mysql.cj.jdbc.Driver";
    String url = "jdbc:mysql://localhost:3306/x-admin?useUnicode=true&characterEncoding=utf8";
    String username ="root";
    String password = "123456";
    Properties properties = new Properties();
    properties.put("remarksReporting","true");//获取数据库的备注信息
    properties.put("user",username);
    properties.put("password",password);
    try {
        //1. 获取连接
        Class.forName(driver);
        //此处需要使用properties配置文件的形式，不然获取备注的时候会为空
        Connection connection = DriverManager.getConnection(url,properties);
        //预编译SQL
        String sql = "select * from book where id=?";
        PreparedStatement preparedStatement = connection.prepareStatement(sql);
        preparedStatement.setString(1,"2");
        //获取参数元数据
        ParameterMetaData parameterMetaData = preparedStatement.getParameterMetaData();
        int parameterCount = parameterMetaData.getParameterCount();
        System.out.println(parameterCount);

    } catch (ClassNotFoundException e) {
        e.printStackTrace();
    } catch (SQLException throwables) {
        throwables.printStackTrace();
    }
}

5.5 结果集元数据

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

以下是有关ResultSetMetaData的常用方法:

  • getColumnCount：获取结果集中列的个数
  • getColumnType：获取指定列的SQL类型对应于Java中Types类的字段
  • getColumnTypeName：获取指定列的SQL类型
  • getClassName：获取指定列SQL类型对应于Java中的类型(包加类名)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
@Test
void PreparedStatementTest(){
  String driver="com.mysql.cj.jdbc.Driver";
  String url = "jdbc:mysql://localhost:3306/x-admin?useUnicode=true&characterEncoding=utf8";
  String username ="root";
  String password = "123456";
  Properties properties = new Properties();
  properties.put("remarksReporting","true");//获取数据库的备注信息
  properties.put("user",username);
  properties.put("password",password);
  try {
    //1. 获取连接
    Class.forName(driver);
    //此处需要使用properties配置文件的形式，不然获取备注的时候会为空
    Connection connection = DriverManager.getConnection(url,properties);
    //预编译SQL
    String sql = "select * from book where id=?";
    PreparedStatement preparedStatement = connection.prepareStatement(sql);
    preparedStatement.setString(1,"2");
    
    ResultSet resultSet = preparedStatement.executeQuery();
    //获取结果集元数据
    ResultSetMetaData metaData = resultSet.getMetaData();
    //获取查询字段个数
    int columnCount = metaData.getColumnCount();
    System.out.println(columnCount);
    //获取所有的返回值列名
    for (int i = 1;i <= columnCount; i++) {
    String columnName = metaData.getColumnName(i);
    //获取字段类型 sql类型(数字=字段)
    int columnType = metaData.getColumnType(i);
    //获取列类型名字
    String columnTypeName = metaData.getColumnTypeName(i);
    //获取Java类型
    String columnClassName = metaData.getColumnClassName(i);
    System.out.println(columnName+"--"+columnType+"---"+columnTypeName+"--"+columnClassName);
    }
  } catch (ClassNotFoundException e) {
 		 e.printStackTrace();
  } catch (SQLException throwables) {
  	throwables.printStackTrace();
  }
}
//结果
//3
//id---5---BIGINT--java.lang.Long
//name--12---VARCHAR--java.lang.String
//price--3---DECIMAL--java.math.BigDecimal

6. 代码生成器分析逻辑

  1. 用户填写的数据库信息，工程搭建信息需要构造到实体类对象中方便操作
  2. 数据库表信息，数据库字段信息需要构造到实体类中
  3. 构造Freemarker数据模型，将数据库表对象和基本配置存入到Map集合中
  4. 借助Freemarker完成代码生成
  5. 自定义公共代码模块

7.抽象出的实体类

7.1 数据库实体类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
public class Database {
    //数据库类型
    private String dbType;

    //驱动
    private String driver;

    private String username;

    private String password;

    private String url;

    public Database() {
        this("MYSQL","127.0.0.1","3306","");
    }

    public Database(String dbType,String db){
        this(dbType,"127.0.0.1","3306",db);
    }

    public Database(String dbType) {
        this(dbType,"127.0.0.1","3306","");
    }

    public Database(String dbType,String ip,String port,String db){
        this.dbType = dbType;
        if("MYSQL".endsWith(dbType.toUpperCase())){
            this.driver = "com.mysql.cj.jdbc.Driver";
            this.url = "jdbc:mysql://"+ip+":"+port+"/"+db+"?useUnicode=true&amp;characterEncoding=utf8";
        }else {
            this.driver = "oracle.jdbc.driver.OracleDriver";
            this.url = "jdbc:oracle:thin:@"+ip+":"+port+":"+db;
        }
    }
}

7.2 表实体类

1
2
3
4
5
6
7
public class Table {
    private String tableName;//表名称
    private String dealingTableName; //处理后的表名称
    private String comment; //介绍
    private String key; //主键
    private List<Column> columns;//列集合
}

7.3 列实体类

1
2
3
4
5
6
7
8
public class Column {
    private String columnName;//主键
    private String DealingColumnName;//列名称(处理后的列名称)
    private String columnType; //列类型
    private String columnDbType;//列数据库类型
    private String columnComment; //列备注
    private String columnKey; //是否为主键
}
赏

谢谢你请我吃糖果

支付宝
微信

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

很惭愧<br><br>只做了一点微小的工作<br>谢谢大家