案例--使用freemarker实现代码自动生成

最新推荐文章于 2022-12-20 10:56:39 发布
最新推荐文章于 2022-12-20 10:56:39 发布 800 收藏 4
分类专栏： 软件工具
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/X80757/article/details/107030763
版权

freemarker是一款模板引擎，一种基于模板和数据，并用来生成输出文本（HTML、配置文件，源代码等）的工具。

freemarker模板文件相关语法

1、输出基本数据类型或对象属性
${数据} 或者 ${对象.属性}
如：
    ${name}
    ${user.username}


2.输出集合
<#list userList as item>
    ${item.username}
</#list>

3.if判断
#list userList as item>
    <#if item.username == 'U1'>
        ${item.username},
    <#elseif item.username == 'U2'>
        你好  ${item.username},
    <#else >
        hello  ${item.username} 。
    </#if>
</#list>
----------------------------------
<#list userList as item>
    <#if item_has_next>
        ${item.username},
    <#else >
        ${item.username}
    </#if>
</#list>

4.当存在 '#{' 要保留时如需要转义

 ${r"#{"}

测试实例：

新建maven项目，pom添加freemarker的依赖

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

模板文件hello.ftl

<html>
<HEAD>
    <meta charset="UTF-8">
</HEAD>
<BODY>
hello ${name}
<br />
你好 ${user.username}
<br />
<#list userList as item>
    ${item.username}
</#list>
<br />
<#list userList as item>
    <#if item.username == 'U1'>
        ${item.username},
    <#elseif item.username == 'U2'>
        你好  ${item.username},
    <#else >
        hello  ${item.username} 。
    </#if>
</#list>
<br />
<#list userList as item>
    <#if item_has_next>
        ${item.username},
    <#else >
        ${item.username}
    </#if>
</#list>

</BODY>
</html>

User类：

package cn.code;

public class User {

    private String username;

    private String password;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

测试类：

package cn.code.test;

import cn.code.User;
import freemarker.template.Configuration;
import freemarker.template.Template;

import java.io.File;
import java.io.FileOutputStream;
import java.io.OutputStreamWriter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class Test {

    public static void main(String[] args) throws Exception {

        //创建configuration对象
        Configuration configuration = new Configuration(Configuration.getVersion());

        //设置模板所在路径
        String path = "E:\\IdeaProjects\\generator-demo\\src\\main\\resources\\";
        configuration.setDirectoryForTemplateLoading(new File(path));

        //获取模板对应实例,hello.ftl为模板路径下的模板文件
        Template template = configuration.getTemplate("hello.ftl");

        //指定生成文件的保存路径
        String savePath = "E:\\IdeaProjects\\generator-demo\\src\\main\\java\\cn\\code\\test\\hello.html";
        FileOutputStream stream = new FileOutputStream(savePath);
        OutputStreamWriter outputStreamWriter = new OutputStreamWriter(stream);

        //组装数据
        Map param = new HashMap();
        User user = new User();
        user.setUsername("Lily");
        param.put("name","Tom");
        //输出对象
        param.put("user",user);
        //输出集合
        List<User> userList = new ArrayList<>();
        User user1 = new User();
        user1.setUsername("U1");
        User user2 = new User();
        user2.setUsername("U2");
        User user3 = new User();
        user3.setUsername("U3");

        userList.add(user1);
        userList.add(user2);
        userList.add(user3);

        param.put("userList",userList);

        //传参，生成数据文件
        template.process(param, outputStreamWriter);

    }
}

 

<html>
<HEAD>
    <meta charset="UTF-8">
</HEAD>
<BODY>
hello Tom
<br />
你好 Lily
<br />
    U1
    U2
    U3
<br />
        U1,
        你好  U2,
        hello  U3 。
<br />
        U1,
        U2,
        U3

</BODY>
</html>

生成pojo案例：

1、新建maven项目，pom添加freemarker与mysql连接的依赖，注意版本号要与自己安装的mysql版本一致

    <dependency>
      <groupId>org.freemarker</groupId>
      <artifactId>freemarker</artifactId>
      <version>2.3.23</version>
    </dependency>
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>8.0.15</version>
    </dependency>
 

新增pojo模板文件

package cn.code.beans;

import java.io.Serializable;


public class ${table.className} implements Serializable {

    <#list table.columns as column>
         //${column.remarks}
         private ${column.javaType} ${column.fieldName};
    </#list>

    <#list table.columns as column>
    public void set${column.upperFieldName} (${column.javaType}  ${column.fieldName} ){
        this.${column.fieldName}=${column.fieldName};
    }

    public  ${column.javaType} get${column.upperFieldName}(){
        return this.${column.fieldName};
    }
    </#list>
}

新增数据库表名与列名的描述

package cn.code.module;

import java.util.ArrayList;
import java.util.List;

public class Table {

    //数据库表名
    private String tableName;

    //表名对应的类名
    private String className;

    //表中的列，一对多
    List<Column> columns = new ArrayList<>();

    public String getTableName() {
        return tableName;
    }

    public void setTableName(String tableName) {
        this.tableName = tableName;
    }

    public String getClassName() {
        return className;
    }

    public void setClassName(String className) {
        this.className = className;
    }

    public List<Column> getColumns() {
        return columns;
    }

    public void setColumns(List<Column> columns) {
        this.columns = columns;
    }
}
wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== 
package cn.code.module;

public class Column {

    //列名
    private String columnName;

    //列名对应的属性名
    private String fieldName;

    //首字母大写的属性名
    private String upperFieldName;

    //列类型，数据库类型
    private String columnType;

    //列类型对应的java类型
    private String javaType;

    //备注
    private String remarks;

    public String getRemarks() {
        return remarks;
    }

    public void setRemarks(String remarks) {
        this.remarks = remarks;
    }

    public String getColumnName() {
        return columnName;
    }

    public void setColumnName(String columnName) {
        this.columnName = columnName;
    }

    public String getFieldName() {
        return fieldName;
    }

    public void setFieldName(String fieldName) {
        this.fieldName = fieldName;
    }

    public String getUpperFieldName() {
        return upperFieldName;
    }

    public void setUpperFieldName(String upperFieldName) {
        this.upperFieldName = upperFieldName;
    }

    public String getColumnType() {
        return columnType;
    }

    public void setColumnType(String columnType) {
        this.columnType = columnType;
    }

    public String getJavaType() {
        return javaType;
    }

    public void setJavaType(String javaType) {
        this.javaType = javaType;
    }
}
wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

数据库相关配置文件database.properties,

注意mysql 8x以上，driver的值，url后面添加 &serverTimezone=GMT ，不然会报异常

driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3306/testdb?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT
user=root
password=root

 

相关工具类PropertiesUtils.java 

package cn.code.util;

import java.io.InputStreamReader;
import java.util.Properties;


public class PropertiesUtils {

    private static Properties props;

    /**
     * 加载配置文件
     *
     * @param fileName
     */
    private static void readProperties(String fileName) {
        try {
            props = new Properties();
            InputStreamReader inputStream = new InputStreamReader(PropertiesUtils.class.getClassLoader().getResourceAsStream(fileName), "UTF-8");
            props.load(inputStream);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    /**
     * 根据key读取对应的value
     *
     * @param key
     * @return
     */
    public static String get(String fileName,String key) {
        readProperties(fileName);
        //System.out.println(props.getProperty(key));
        return props.getProperty(key);
    }

}
wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== 
package cn.code.util;

public class StringUtils {

    //根据数据库列类型返回相应的java类型
    public static String switchType(String columnName) {
        String javaType = null;

        switch (columnName) {

            case "VARCHAR":
                javaType = "String";
                break;
            case "INT":
                javaType = "Integer";
                break;
            case "DATETIME":
                javaType = "Date";
                break;
            default:
                javaType = "String";

        }

        return javaType;
    }

    /**
     * 字符串首字母大写
     *
     * @param str
     * @return
     */
    public static String captureName(String str) {

        return String.valueOf(str.charAt(0)).toUpperCase() + str.substring(1);
    }

    /**
     * 去除下划线，下划线后的首字母大写
     *
     * @param str
     * @return
     */
    public static String putOffUnderline(String str) {

        int idx = str.indexOf("_");
        if (idx == -1) return str;

        String s1 = str.replaceFirst("_", "");
        String s2 = s1.substring(0, idx) + String.valueOf(s1.charAt(idx)).toUpperCase() + s1.substring(idx + 1);

       /* String[] strings = str.split("_");

        for (int i = 0; i < strings.length; i++) {
            if (i == 0)
                ret += strings[i];
            else
                ret += String.valueOf(strings[i].charAt(0)).toUpperCase() + strings[i].substring(1);
        }*/

        return putOffUnderline(s2);
    }

    public static void main(String[] args) {
        System.out.println(putOffUnderline("tb_test_a"));
    }


}
wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

数据库连接与获取表名，与表名对应的列名TableUtils 

package cn.code.util;

import cn.code.module.Column;
import cn.code.module.Table;
import cn.code.util.PropertiesUtils;

import java.sql.*;
import java.util.ArrayList;
import java.util.List;

public class TableUtils {

    private static String DBDRIVER = PropertiesUtils.get("database.properties", "driver");

    private static String DBURL = PropertiesUtils.get("database.properties", "url");

    private static String DBUSER = PropertiesUtils.get("database.properties", "user");

    private static String DBPASS = PropertiesUtils.get("database.properties", "password");

    private static Connection connection;

    private static DatabaseMetaData dbmd;

    static {

        try {
            //连接数据库
            Class.forName(DBDRIVER);
            connection = DriverManager.getConnection(DBURL, DBUSER, DBPASS);
            //获取metaData
            dbmd = connection.getMetaData();

        } catch (Exception e) {
            e.printStackTrace();
        }

    }

    public static List<Table> getTable() {

        List<Table> tableList = new ArrayList<>();
        //获取数据库连接
        try {
            //获取所有表名的结果集
            ResultSet rs = dbmd.getTables(null, null, null, new String[]{"TABLE"});
            //遍历结果集
            while (rs.next()) {
                Table table = new Table();//tb_test_a -> TbTestA
                String tableName = rs.getString("TABLE_NAME");
                table.setTableName(tableName);
                table.setClassName(StringUtils.captureName(StringUtils.putOffUnderline(tableName)));
                table.setColumns(getColumns(tableName));
                tableList.add(table);

            }

        } catch (Exception e) {
            e.printStackTrace();
        }
        return tableList;
    }

    public static List<Column> getColumns(String tableName) {

        List<Column> columnList = new ArrayList<>();

        try {
            ResultSet rs = dbmd.getColumns(null, "%", tableName, "%");
            while (rs.next()) {
                Column column = new Column();
                String columnName = rs.getString("COLUMN_NAME");
                String columnType = rs.getString("TYPE_NAME");
                String remarks = rs.getString("REMARKS");

                column.setColumnName(columnName);
                column.setColumnType(columnType);
                column.setRemarks(remarks);
                column.setFieldName(columnName);
                column.setUpperFieldName(StringUtils.captureName(columnName));
                column.setJavaType(StringUtils.switchType(columnType));

                columnList.add(column);

            }

        } catch (Exception e) {
            e.printStackTrace();
        }

        return columnList;

    }

    public static void main(String[] args) {
        //getTable();
        //getColumns("tb_test_b");

        //测试
        List<Table> tableList = getTable();
        for (Table table: tableList) {
            System.out.println(table.getTableName());
        }


    }
}

freemarker环境初始化

package cn.code;

import freemarker.template.Configuration;
import freemarker.template.Template;

import java.io.File;
import java.io.FileOutputStream;
import java.io.OutputStreamWriter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class Generator {

    private Configuration configuration;

    //完成环境初始化
    public void init(String path) throws Exception {

        configuration = new Configuration(freemarker.template.Configuration.getVersion());

        //设置模板所在路径
        configuration.setDirectoryForTemplateLoading(new File(path));

    }

    public void process(String tempName, String savePath, Map<String, Object> param) throws Exception {

       

        //获取模板对应实例
        Template template = configuration.getTemplate(tempName);
        //初始化保存路径
        FileOutputStream stream = new FileOutputStream(savePath);
        OutputStreamWriter outputStreamWriter = new OutputStreamWriter(stream);
        //传参，生成数据
        template.process(param, outputStreamWriter);

    }

   
}

传送从数据库读取的数据并生成pojo

package cn.code.ssm;

import cn.code.Generator;
import cn.code.module.Table;
import cn.code.util.TableUtils;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class ModuleHandler {

    private Generator generator = new Generator();

    private String templatePath = this.getClass().getClassLoader().getResource("").getPath()+"\\module\\";

    private String savePath = "E:\\IdeaProjects\\generator-demo\\src\\main\\java\\cn\\code\\beans";

    public void exectue() throws Exception {

        //获取table对应的实例
        List<Table> tableList = TableUtils.getTable();
        Map<String,Object> param = new HashMap<>();

        for (Table table:tableList){
            param.put("table",table);
            generator.init(templatePath);
            generator.process("module.ftl",savePath+"\\"+table.getClassName()+".java",param);
        }
    }

    public static void main(String[] args) throws Exception {
        ModuleHandler moduleHandler = new ModuleHandler();
        moduleHandler.exectue();
    }
}

生成的pojo

X80757
关注
  • 0
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Java FreeMarker+Maven实现代码自动生成
01-13
FreeMarker模板引擎不错，使用非常简单，其实可以做很多事情，比如代码自动生成，按格式生成work文件等，这里简单的实现了按照实体生成建表语句、action、biz、dao和对应的xml文件等
《Java + JDBC + Freemarker引擎实现代码生成器》
06-09
本主要是针对有一定基础的Java学员。本课程主要是围绕着如何根据公司具体的技术架构，手把手的实现一个强大的代码生成器。该生成器主要包括如果根据数据库表，自动生成 Model 文件，DTO 文件，DAO 文件，MyBatis的 Mappter 文件，Service 文件，Controller文件等等，包括基本的增删改查，分页，搜索查询等等接口代码自动生成。
springmvc-mybatis-freemarker:自己实现简单的代码生成
06-03
springmvc-mybatis-freemarker 自己实现简单的代码生成
Java代码自动生成 freemarker
11-13
上次上传是自己手工string拼成实现的代码，这次试用了freemarker模板自动生成，效果是一样的，代码质量提高了
使用Spring boot + FreeMarker 实现代码生成功能的Demo
11-12
使用Spring boot + FreeMarker 实现代码生成功能，完整案例可以查看 eladmin 项目，教程地址： https://www.ydyno.com/archives/1177.html
使用FreeMarker生成代码
focus-unchanged-thing
12-20 390
pom.xml // 引入FreeMarker包。Test.ftl // 指定的模板引擎。Main.java // 生成代码封装。
Freemarker自定义代码生成器
Huangjunqi23的博客
12-17 1821
Freemarker自定义代码生成器：帕斯卡风格进行快速开发dao层
基于FreeMarker的自定义代码生成器
linovce的博客
03-27 455
官方以及民间大佬都提供了一些代码生成器，例如mybatis-generator、Mybatis-plus的代码生成器等，但是可能跟我们平时使用习惯不一样。本文将介绍如何使用FreeMarker定义自己的代码生成器。
freemarker导出word文档（页码和总页数）
weixin_41701049的博客
10-19 4887
在使用freemarker导出word文档时可能会出现需要显示第几页、共几页的字段，比如下图： 这时候没办法往里面插入数据，因为没生成文档之前并不能知道有多少页，但是在制作模板的时候可以使用wps等工具将 第 页 / 共 页 选中 ...
FreeMarker模板导出pdf,页码，页脚，分页等
Try_harder_every_day的博客
12-11 4366
pdf根据freemarker模板导出要添加页眉页脚等如何实现？？？ 通过查询资料===>>需要添加以下样式 <html> <head> <style> div.header { display: block; text-align: center; position: running(header); } div.foot...
基于spring boot freemarker代码生成器
01-26
代码生成器支持model、Mapper、Dao、Service、ServiceImpl、Controller 一次性的生成，支持同时生成多张表,此代码生成器依赖JAR包比较少，除了必用Freemarker 和JDBC之外基本上完全个人编写
freemarker-parser:Freemarker Parser是FreemarkerJavaScript实现
05-22
该项目包含ast树解析器ftl的实验版安装您可以使用安装freemarker-parser ： $ npm install freemarker-parser --save-dev用法在JavaScript内需要freemarker-parser ：解析器<# assign f=1 ><# if f gt 0 > ${...
freemarker实现代码生成器
03-11
freemarker实现代码生成器详细教程
mybatis自动生成代码的模板--freemarker版本.zip
03-11
附件包含了mybatis-plus自动生成代码，基于freemarker的模板。包括常规的curd。 【特点】针对每个接口都有对应的入参和出参，不公用entity。 如，add接口，则入参会自动生成为addEntityReq。具体可下载模板进行查看...
使用Java-freemarker生成word文档.doc
05-09
先创建一个word文档，按照需求在word中填好一个模板，然后将文档保存为xml文档格式，使用文档编辑器打开这个xml格式的文档（这里直接使用eclipse自带的编辑工具），把对应的数据换成变量${xxx}，使用Freemarker读取...
使用 freemarker 制作代码生成器
WS的小屋
10-13 1893
在开发的过程中发现有大量的重复代码，比如 Controller 和 Service 以及 Mapper 和实体类，后两者都可以使用 Mybatis 自动生成，前两者只能自己写。 本文介绍使用 freemarker 制作代码生成器，可以自动生成 Controller 、 Service 、Dto、Vue 代码。 首先解释一下为什么使用 freemarker ？ 他是一个模板语言，模板的特点就是有很多不变的，还有一小部分变的； 观察我们的 controller 层代码，大部分是一样的，变的只是实体类的名字
freemarker生成代码
trinityandneo的博客
12-28 394
mybatis有代码生成器，mybatis-generator,pom引用配置生成位置即可，这个不是重点，网上一搜一大堆，这里不表。为啥呢，不通用，好多公司有自己的编码规范，封装了一些基础组件，不得不按照公司的规范来，那么freemarker就有用武之地了，下面咱们来介绍一下哈。 freemarker需要引用pom依赖： <dependency> <groupId>org.freemarker</groupId> <artifactId>free..
使用Freemarker模板自动生成代码
u010044936的博客
12-30 682
业务代码存在大量的增删改查功能，只是针对不同的表数据而已。这时候就如果能生成固定的模板代码，那么将大大的解放生产力。本文我们将使用Freemarker模板来生成业务模板代码。 FreeMarker FreeMarker是一款模板引擎： 即一种基于模板和要改变的数据， 并用来生成输出文本（HTML网页、电子邮件、配置文件、源代码等）的通用工具。其用法原理类似String的replace方法，或MessageFormat的format方法，都是在一定的代码中改变（替换）某些内容。不过FreeMarker更加强大
基于FreeMarker实现代码生成器(详细教程)
weixin_45541084的博客
05-13 1558
通过FreeMarker实现代码生成器 一、使用方式: 修改 database.properties 配置文件中的 JDBC-URL、userName、password 修改模板路径和文件生成路径 运行程序，生成代码：运行 Gernerator 类 Main 方法 二、具体代码(本人亲测有效): 1.实体类(Cloumn.class,Table.class) Cloumn.class import com.code.constant.TypeConstant; import com.code.util
mybatis-plus自动生成代码的自定义引擎文件
最新发布
04-29
MyBatis-Plus是一款优秀的ORM框架，在实际开发中，我们经常需要用到它的自动生成代码功能。而自动生成的模板文件是通过模板引擎来实现的。在一些特殊的需求场景下，我们可能需要用到自定义的模板引擎来生成自己需要的代码。这时候，我们就需要编写自定义的引擎文件。 自定义引擎文件主要分为两个部分： 1. 模板引擎文件：这是我们自己编写的模板，它包含生成代码的信息和具体的生成细节。引擎文件需要遵守模板引擎的语法规则，采用Freemarker引擎的话还需要注意Freemarker特有的语法标记。 2. 模板引擎适配器：这是一个接口，我们需要实现这个接口来适配我们自己的引擎文件。适配器需要实现TemplateEngine接口，并重写renderTemplateFile方法，该方法接受三个参数：模板路径、数据模型和生成文件路径。 自定义引擎文件的编写相较于普通的生成文件要复杂一些，需要我们在编写引擎文件时考虑更多的细节问题。但是，自定义引擎文件可以让我们获得更大的灵活性和自由度，能够满足一些非常特殊的需求，提高我们的生产效率。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

X80757

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额：-- )
扫码支付
扫码支付：¥2
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、C币套餐、付费专栏及课程。

余额充值