Java之利用FreeMarker引擎实现枚举和脚本自动生成

开心一笑

【天气热了 翻箱倒柜找了半天短袖 结果找出来一看 全是些名牌短袖 感觉穿出去太高调了 比如什么中国电信啊 天翼4G啊 太太乐鸡精啊 莲花味精啊 海天酱油啊。。最珍贵的一件 要属那件史丹利复合肥 跟刘能同款 哎头大了纠结该穿哪个好呢?穿出去不会被人说我炫富吧】

对不起

提出问题

如何利用Java + FreeMarker 生成枚举类和相关的数据库脚本???

解决问题

业务场景

做业务开发的时候,我们通常要定义很多枚举类,写好java枚举类时候,还要在数据库插入相对应的字典值等,然后生成 sql 文件提交到SVN的增量脚本里面。为了解决这些问题,有必要开发一个枚举和脚本自动生成的工具类, 自动生成枚举类和增量脚本,避免简单和不必要的错误。

分享的这个工具类,并不是适合每个公司,因为每家公司有每家公司的框架,只是想传达一种实现:多开发一些适合你们公司的工具类,减少重复性的工作,把跟多的时间和精力投入到重要的事情上。

代码实现

EnumGenerateUtils工具类

在我们的项目中,枚举是有分类的。

package com.evada.inno.pm.code.generate.util;
import com.evada.inno.pm.code.generate.model.EnumDictCategoryDefinition;
import com.evada.inno.pm.code.generate.model.EnumInfoDefinition;
import freemarker.template.Template;
import java.io.*;
import java.text.SimpleDateFormat;
import java.util.*;

/**
 * 描述:枚举类代码生成工具
 * Created by Ay on 2017/5/5.
 */
public class EnumGenerateUtils {

    //枚举需要生成到那个包下面
    private final String packageName = "com.evada.pm.process.manage";
    //枚举分类的code 和 字典表中的 categoryCode必须一致
    private final String enumCategoryCode = "TM_XXXX_XXXX_XXXX";
    private final String enumCategoryName = "项目管理-管控模式-枚举";
    //枚举类名称
    private final String enumClassName = "Color";
    //枚举类生成后类上的注解
    private final String enumAnnotation = "颜色";
    //这里比较重要
    private final String[][] ENUM_INFO = {
            {"BLUE","蓝色"},
            {"YELLOW","黄色"},
            {"BLACK","黑色"}
    };
    //类上的作者
    private final String AUTHOR = "Ay";
    //类上的日期
    private final String CURRENT_DATE = new SimpleDateFormat("yyyy-MM-dd").format(new Date());

    public static void main(String[] args) throws Exception{
        EnumGenerateUtils enumGenerateUtils = new EnumGenerateUtils();
        //生成枚举类java文件
        enumGenerateUtils.generateEnumClassFile();
        //生成sql脚本文件
        enumGenerateUtils.generateEnumSqlFile();
    }


    private void generateEnumSqlFile() throws Exception{
        final String suffix = ".sql";
        final String path = "D://" + CURRENT_DATE + suffix;
        final String templateName = "EnumSQL.ftl";
        File mapperFile = new File(path);
        Map<String,Object> dataMap = new HashMap<>();
        List<EnumInfoDefinition> enumInfoDefinitionList = new ArrayList<>();
        EnumInfoDefinition enumInfoDefinition = null;
        for(int i=0;i < ENUM_INFO.length;i++){
            enumInfoDefinition = new EnumInfoDefinition();
            enumInfoDefinition.setEnumUuid(EnumGenerateUtils.generateUUID());
            enumInfoDefinition.setEnumCode(ENUM_INFO[i][0]);
            enumInfoDefinition.setEnumName(ENUM_INFO[i][1]);
            enumInfoDefinition.setEnumCategoryCode(enumCategoryCode);
            enumInfoDefinition.setEnumNumber(i + 1 + "");
            enumInfoDefinition.setEnumSortOrder(i + 1 + "");
            enumInfoDefinitionList.add(enumInfoDefinition);
        }
        EnumDictCategoryDefinition dictCategory = new EnumDictCategoryDefinition();
        dictCategory.setEnumUuid(EnumGenerateUtils.generateUUID());
        dictCategory.setEnumCategoryCode(enumCategoryCode);
        dictCategory.setEnumCategoryName(enumCategoryName);
        dataMap.put("enum_dict_catagory",dictCategory);
        dataMap.put("enum_list", enumInfoDefinitionList);
        generateFileByTemplate(templateName,mapperFile,dataMap);
    }

    private void generateEnumClassFile() throws Exception{
        final String suffix = "Enum.java";
        final String path = "D://" + enumClassName + suffix;
        final String templateName = "EnumClass.ftl";
        File mapperFile = new File(path);
        Map<String,Object> dataMap = new HashMap<>();
        List<EnumInfoDefinition> enumInfoDefinitionList = new ArrayList<>();
        EnumInfoDefinition enumInfoDefinition = null;
        for(int i=0;i < ENUM_INFO.length;i++){
            enumInfoDefinition = new EnumInfoDefinition();
            enumInfoDefinition.setEnumUuid(EnumGenerateUtils.generateUUID());
            enumInfoDefinition.setEnumCode(ENUM_INFO[i][0]);
            enumInfoDefinition.setEnumName(ENUM_INFO[i][1]);
            enumInfoDefinition.setEnumNumber(i + 1 + "");
            enumInfoDefinition.setEnumSortOrder(i + 1 + "");
            enumInfoDefinition.setEnumCategoryCode(enumCategoryCode);
            enumInfoDefinitionList.add(enumInfoDefinition);
        }
        dataMap.put("enum_list", enumInfoDefinitionList);
        generateFileByTemplate(templateName,mapperFile,dataMap);
    }

    private void generateFileByTemplate(final String templateName,File file,Map<String,Object> dataMap) throws Exception{
        Template template = FreeMarkerTemplateUtils.getTemplate(templateName);
        FileOutputStream fos = new FileOutputStream(file);
        dataMap.put("author",AUTHOR);
        dataMap.put("date",CURRENT_DATE);
        dataMap.put("package_name",packageName);
        dataMap.put("enum_annotation",enumAnnotation);
        dataMap.put("enum_class_name",enumClassName);
        Writer out = new BufferedWriter(new OutputStreamWriter(fos, "utf-8"),10240);
        template.process(dataMap,out);
    }

    public static String generateUUID(){
        return UUID.randomUUID().toString().replace("-", "");
    }

}

EnumClass.ftl类

package ${package_name}.enums;

/**
* 描述:${enum_annotation}类型枚举
* @author ${author}
* @date ${date}
*/
public enum ${enum_class_name}Enum {

<#if enum_list?exists>
    <#list enum_list as enum>
    ${enum.enumCode}("${enum.enumNumber}","${enum.enumName}")<#if enum_index == ((enum_list?size) - 1)>;<#else >,</#if>
    </#list>
</#if>


    private final String code;

    private final String name;

    ${enum_class_name}Enum(String code, String name) {
        this.code = code;
        this.name = name;
    }

    public String getName() {
        return this.name;
    }

    @Override
    public String toString() {
        return this.code;
    }
}

EnumSQL.ftl类

-- ${enum_annotation}枚举字典
<#if enum_list?exists>
    <#list enum_list as enum>
INSERT INTO "public"."sys_dict" ("id", "name", "code", "category_code", "parent_code", "sort_order", "is_updatable", "status")
VALUES ('${enum.enumUuid}', '${enum.enumName}', '${enum.enumCode}', '${enum.enumCategoryCode}', NULL, '${enum.enumSortOrder}', NULL, '1');
    </#list>
</#if>

-- ${enum_annotation}枚举字典分类
<#if enum_dict_catagory?exists>
INSERT INTO "public"."sys_dict_category" ("id", "name", "code", "parent_code", "sort_order", "description", "is_updatable", "status")
VALUES ('${enum_dict_catagory.enumUuid}', '${enum_dict_catagory.enumCategoryName}', '${enum_dict_catagory.enumCategoryCode}', '', '0', NULL, '0', '1');
</#if>

读书感悟

来自但丁《神曲》

  • 没有比回忆过去的幸福更为痛苦的事了。
  • 走自己的路,让别人说去。
  • 如果爱,请干净地爱,把爱情献给爱情。
  • 当一件事情愈加完美,它的痛苦和喜悦也就更多。

经典故事

【有一次和朋友去海洋馆。
有个旅客问管理员说:“这只鲨鱼会长多大?”
管理员指着水族箱说:“要看你的水族箱多大。”
旅客又问:“会跟水族箱一样大吗?”
管理员仔细地说:“如果在水族箱,鲨鱼只能局限在几公尺的大小,如果在海洋,就会大到一口吞下一只狮子。”
大道理:环境可以改变一个人的思想。环境能限制人的思想,人也可以限制自己的思想。不要给自己加框,无法改变环境时,就从改变自己开始。】

生活常识

运动后不宜做的六件事:

  • 不要蹲坐休息
  • 不要贪吃冷饮
  • 不要立即吃饭
  • 不要骤降体温
  • 不要吸烟
  • 不要立即喝水

大神文章

其他

如果有带给你一丝丝小快乐,就让快乐继续传递下去,欢迎点赞、顶、欢迎留下宝贵的意见、多谢支持!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 210,978评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 89,954评论 2 384
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,623评论 0 345
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,324评论 1 282
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,390评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,741评论 1 289
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,892评论 3 405
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,655评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,104评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,451评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,569评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,254评论 4 328
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,834评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,725评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,950评论 1 264
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,260评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,446评论 2 348

推荐阅读更多精彩内容