代码生成器

这篇博客介绍了如何基于FreeMarker来构建一个代码生成器。首先,文章详细解释了FreeMarker的特性和应用场景。接着,讨论了数据库元数据的概念,并展示了如何获取这些元数据。然后,逐步展示了代码生成器的搭建过程,包括环境配置、数据模型构造、模板制作以及自定义数据的处理。最后,文章提供了代码生成器的实现细节和模板制作的约定。
摘要由CSDN通过智能技术生成
1.1:概述
在项目开发过程中,关注点更多是在业务功能的开发及保证业务流程的正确性上,对于重复性的代码编写占据了程
序员大量的时间和精力,而这些代码往往都是具有规律的。就如 controller service serviceImpl dao
daoImpl model jsp 的结构,用户、角色、权限等等模块都有类似的结构。针对这部分代码,就可以使用代码生
成器,让计算机自动帮我们生成代码,将我们的双手解脱出来,减小了手工的重复劳动。
传统的方式程序员进行模块开发步骤如下:
  • 创建数据库表
  • 根据表字段设计实体类
  • 编写增删改查dao
  • 根据业务写service
  • web层代码和前台页面

通常只需要知道了一个表的结构,增删改查的前后台页面的代码格式就是固定的,剩下的就是复杂的业务。而代码
生成工具的目标就是自动生成那部分固定格式的增删改查的代码

代码生成器概述的需求分析:

 

 实现思路:

 

代码生成器的实现有很多种,我们以从 mysql 数据库表结构生成对应代码为例来说明如何实现一个代码生成器。有
以下几个重点:
        1. 数据库和表解析,用于生成 model 及其他代码通过数据库解析获取数据库中表的名称、表字段等属性:可以根据表名称确定实体类名称,根据字段确定实
体类中属性(如: tb_user 表对应的实体类就是 User
        2. 模板开发生成代码文件
模板中定义公共的基础代码和需要替换的占位符内容(如 :${tableName} 最终会根据数据库表替换为 User ), 根据解析好的数据库信息进行数据替换并生成代码文件
        3. 基础框架的模板代码抽取
通过思路分析不难发现,对于代码生成工具而言只需要搞定数据库解析和模板开发。那么代码自动生成也并没有那
么神秘和复杂。那接下来的课程和各位着重从这两个方面开始讲解直至完成属于自己的代码生成器。

深入FreeMarker

什么是FreeMarker:

FreeMarker 是一款模板引擎:一种基于模板的、用来生成输出文本 ( 任何来自于 HTML 格式的文本用来自动生成源 代码) 的通用工具。它是为 Java 程序员提供的一个开发包或者说是类库。它不是面向最终用户,而是为程序员提供 的可以嵌入他们开发产品的一款应用程序。
FreeMarker 的设计实际上是被用来生成 HTML 网页,尤其是通过基于实现了 MVC(ModelView Controller ,模型 - 视图- 控制器 ) 模式的 Servlet 应用程序。使用 MVC 模式的动态网页的构思使得你可以将前端设计者 ( 编写 HTML) 从 程序员中分离出来。所有人各司其职,发挥其擅长的一面。网页设计师可以改写页面的显示效果而不受程序员编译 代码的影响,因为应用程序的逻辑(Java 程序 ) 和页面设计 (FreeMarker 模板 ) 已经分开了。页面模板代码不会受到复
杂的程序代码影响。这种分离的思想即便对一个程序员和页面设计师是同一个人的项目来说都是非常有用的,因为 分离使得代码保持简洁而且便于维护。
尽管 FreeMarker 也有编程能力,但它也不是像 PHP 那样的一种全面的编程语言。反而, Java 程序准备的数据来 显示( 比如 SQL 查询 ) FreeMarker 仅仅使用模板生成文本页面来呈现已经准备好的数据
FreeMarker 不是 Web 应用框架。它是 Web 应用框架中的一个适用的组件,但是 FreeMarker 引擎本身并不知道 HTTP 协议或 Servlet 。它仅仅来生成文本。即便这样,它也非常适用于非 Web 应用环境的开发

 Freemarker的应用场景:

1 )动态页面
基于模板配置和表达式生成页面文件,可以像 jsp 一样被客户端访问
2 )页面静态化
对于系统中频繁使用数据库进行查询但是内容更新很小的应用,都可以用 FreeMarker 将网页静态化,这样就避免 了大量的数据库访问请求,从而提高网站的性能
3 )代码生成器
可以自动根据后台配置生成页面或者代码
        freemarker的特征与亮点
  • 强大的模板语言:有条件的块,迭代,赋值,字符串和算术运算和格式化,宏和函数,编码等更多的功能;
  • 多用途且轻量:零依赖,输出任何格式,可以从任何地方加载模板(可插拔),配置选项丰富;
  • 智能的国际化和本地化:对区域设置和日期/时间格式敏感。
  • XML处理功能:将dom-s放入到XML数据模型并遍历它们,甚至处理他们的声明
  • 通用的数据模型:通过可插拔适配器将java对象暴露于模板作为变量树

Freemarker的基本使用

1 构造环境 :

创建 maven 工程 codeutil ,并引入响应坐标
    <dependencies>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.20</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.6</version>
        </dependency>
    </dependencies>
第一件事定义一个模板:
        与src平级:
        templates=====》template01.ftl
欢迎您: ${username}
第二件事情:测试类:
package cn.itcast.freemarker.test;
/**
 * 第一个FreeMarker程序(数据+模板=文件输出)
 *      1.操作步骤
 */
public class FreeMarkerTest01 {

    @Test
    public void test01() throws Exception {
        //1.创建FreeMarker的配置类
        Configuration cfg = new Configuration();
        //2.指定模板加载器:将模板存入缓存中
        //文件路径加载器
        FileTemplateLoader ftl = new FileTemplateLoader(new File("templates"));
        cfg.setTemplateLoader(ftl);
        //3.获取模板
        Template template = cfg.getTemplate("template01.ftl");
        //4.构造数据模型
        Map<String,Object> dataModel = new HashMap<>();

        //user对象
        dataModel.put("username","ZHangsan");
 dataModel.put("flag",3);

        List<String> list = new ArrayList<>();
        list.add("星期一");
        list.add("星期二");
        list.add("星期三");
        list.add("星期四");

        dataModel.put("weeks",list);
        //5.文件输出
        /**
         * 处理模型
         *      参数一:数据模型
         *      参数二:writer(FileWriter(文件输出),printWriter(控制台输出))
         */
        //template.process(dataModel,new FileWriter(new File("C:\\Users\\ThinkPad\\Desktop\\ihrm\\day12\\test\\a.txt")));   //在指定文件上创建模板文件
        template.process(dataModel,new PrintWriter(System.out));  //打印到控制台上
    }
}

字符串模板:

/**
 * 测试字符串模板
 */
public class FreeMarkerTest02 {
    /**
     *  com.${p1}.${p1}.${p1}.User
     */
    @Test
    public void test() throws Exception {
        //1.创建配置对象
        Configuration cfg = new Configuration();
 
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值