如何自定义代码生成器（上）

1 概述

1.1 介绍

​ 在项目开发过程中，有很多业务模块的代码是具有一定规律性的，例如controller控制器、service接口、service实现类、mapper接口、model实体类等等，这部分代码可以使用代码生成器生成，我们就可以将更多的时间放在业务逻辑上。

传统的开发步骤：

​ 创建数据库和表
​ 根据表设计实体类
​ 编写mapper接口
​ 编写service接口和实现类
​ 编写controller控制器
​ 编写前端页面
​ 前后端联调

基于代码生成器开发步骤：

​ 创建数据库和表
​ 使用代码生成器生成实体类、mapper、service、controller、前端页面
​ 将生成好的代码拷贝到项目中并做调整
​ 前后端联调

我们只需要知道数据库和表相关信息，就可以结合模版生成各个模块的代码，减少了很多重复工作，也减少出错概率，提高效率。

1.2 实现思路

（1）需要对数据库表解析获取到元数据，包含表字段名称、字段类型等等

（2）将通用的代码编写成模版文件，部分数据需使用占位符替换

（3）将元数据和模版文件结合，使用一些模版引擎工具（例如freemarker）即可生成源代码文件

2 Freemarker

2.1 介绍

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

​ 模板编写为FreeMarker Template Language (FTL)。它是简单的，专用的语言， 在模板中，你可以专注于如何展现数据， 而在模板之外可以专注于要展示什么数据。

2.2 应用场景

（1）动态页面

freemarker可以作为springmvc一种视图格式，像jsp一样被浏览器访问。

（2）页面静态化

对于一些内容比较多，更新频率很小，访问又很频繁的页面，可以使用freemarker静态化，减少DB的压力，提高页面打开速度。

（3）代码生成器

根据配置生成页面和代码，减少重复工作，提高开发效率。

2.3 快速入门

（1）创建freemarker-demo模块，并导入相关依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.itheima</groupId>
    <artifactId>freemarker-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.1.RELEASE</version>
    </parent>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
        <!-- freemarker -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
        </dependency>
        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
</project>

（2）application.yml相关配置

server:
  port: 8881 #服务端口
spring:
  application:
    name: freemarker-demo #指定服务名
  freemarker:
    cache: false #关闭模板缓存，方便测试
    settings:
      template_update_delay: 0 #检查模板更新延迟时间，设置为0表示立即检查，如果时间大于0会有缓存不方便进行模板测试
    suffix: .ftl #指定Freemarker模板文件的后缀名

（3）创建启动类

package com.heima.freemarker;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class FreemarkerDemotApplication {
   
    public static void main(String[] args) {
   
        SpringApplication.run(FreemarkerDemotApplication.class,args);
    }
}

（4）创建Student模型类

package com.itheima.freemarker.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Date;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Student {
   
    private Integer id;
    private String name;//姓名
    private Integer age;//年龄
    private Date birthday;//生日
    private Float money;//钱包
}

（5）创建StudentController

package com.itheima.freemarker.controller;

import com.itheima.freemarker.entity.Student;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import java.util.Date;

@Controller
@RequestMapping("student")
public class StudentController {
   

    @GetMapping("index")
    public String index(Model model){
   
        //1.纯文本形式的参数
        model.addAttribute("name", "Freemarker");

        //2.实体类相关的参数
        Student student = new Student();
        student.setName("黑马");
        student.setAge(18);
        model.addAttribute("stu", student);

        return "01-index";
    }
}

（6）在resources/templates下创建01-index.ftl模版文件

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>首页</title>
</head>
<body>
<b>普通文本 String 展示：</b><br/>
Hello ${name} <br>

<hr>
<b>对象Student中的数据展示：</b><br/>
姓名：${stu.name}<br/>
年龄：${stu.age}
<hr>
</body>
</html>

（7）测试

浏览器访问 http://localhost:8881/student/index

效果如下

2.4 模版

2.4.1 基础语法种类

（1）注释，即<#-- -->，介于其之间的内容会被freemarker忽略

<#--我是一个freemarker注释-->

（2）插值（Interpolation）：即 ${..} 部分,freemarker会用真实的值代替**${..}**

Hello ${name}

（3）FTL指令：和HTML标记类似，名字前加#予以区分，Freemarker会解析标签中的表达式或逻辑。

<# >FTL指令</#> 

（4）文本，仅文本信息，这些不是freemarker的注释、插值、FTL指令的内容会被freemarker忽略解析，直接输出内容。

<#--freemarker中的普通文本-->
我是一个普通的文本

2.4.2 if指令

if 指令即判断指令，是常用的FTL指令，freemarker在解析时遇到if会进行判断，条件为真则输出if中间的内容，否则跳过内容不再输出。

格式如下

<#if condition>
  ....
<#elseif condition2>
  ...
<#elseif condition3>   
  ...
<#else>
  ...
</#if>

需求：根据年龄输出所处的年龄段

童年：0岁—6岁(周岁，下同)
少年：7岁—17岁
青年：18岁—40岁
中年：41—65岁
老年：66岁以后

实例代码：

（1）在01-index.ftl添加如下代码

<#if stu.age <= 6>
童年
<#elseif stu.age <= 17>
少年
<#elseif stu.age <= 40>   
青年
<#elseif stu.age <= 65>   
中年
<#else>
老年
</#if>

（2）测试

浏览器访问http://localhost:8881/student/index

效果如下

2.4.3 list指令

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

格式如下

<#list items as item>
	${item_index + 1}------${item}-----<#if item_has_next>,</#if>
</#list>

迭代集合对象时，包括两个特殊的循环变量：
（1）item_index：当前变量的索引值。
（2）item_has_next:是否存在下一个对象

item_index 和 item_has_nex 中的item为<#list items as item> 中as后面的临时变量

需求：遍历学生集合，输出序号，学生id，姓名，所处的年龄段，是否最后一条数据

（1）在StudentController中增加方法

@GetMapping("list")
public String list(Model model) throws ParseException {
   
    List<Student> list = new ArrayList<>();

    list.add(new Student(1001,"张飞",15