springboot整合velocity模板自动生成java代码

使用springboot,整合velocity模板,将数据库中的字典表生成java的枚举代码,
实现controller发送get,然后生成java代码文件并将文件压缩至zip压缩包,前端浏览器访问该地址直接下载zip压缩包

1:引入maven

     <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.3</version>
        </dependency>

2:创建controller

@RestController
@RequestMapping("/gen")
public class GenController {


    @Autowired
    GenService genService;

    @GetMapping("/dict.gen")
    public void batchGenCode(HttpServletResponse response, @RequestParam List<String> req) throws IOException {

        byte[] data = genService.dictGen(req);
        genCode(response, data);
    }



    /**
     * 生成zip文件
     */
    private void genCode(HttpServletResponse response, byte[] data) throws IOException {
        response.reset();
        response.setHeader("Content-Disposition", "attachment; filename=\"code.zip\"");
        response.addHeader("Content-Length", "" + data.length);
        response.setContentType("application/octet-stream; charset=UTF-8");
        IOUtils.write(data, response.getOutputStream());
    }
}

3:逻辑代码

@Component
public class GenService {

    @Resource
    SysDictTypeMapper dictTypeMapper;

    public byte[] dictGen(List<String> req) {
        List<DictRes> dictRes = dictTypeMapper.selectDict(req);

        List<VelocityContext> velocityContexts = new ArrayList<>();
        for (DictRes dictRe : dictRes) {
            VelocityContext velocityContext = new VelocityContext();
            boolean add = true;
            if (velocityContexts.size() > 0 && velocityContexts.stream().anyMatch(v -> v.get("dictId").toString().equals(dictRe.getDictId()))) {
                velocityContext = velocityContexts.stream().filter(v -> v.get("dictId").toString().equals(dictRe.getDictId())).findFirst().get();
                add = false;
            }
            String fileName = toCamelCase(dictRe.getDictType());
            velocityContext.put("fileName", fileName + ".java");
            velocityContext.put("class", fileName);
            velocityContext.put("desc", dictRe.getDictName());
            velocityContext.put("dictId", dictRe.getDictId());

            List<DictRes> dicts = new ArrayList<>();
            if (velocityContext.containsKey("dicts")) {
                dicts = JSON.parseArray(JSON.toJSONString(velocityContext.get("dicts")), DictRes.class);
            }
            dicts.add(dictRe);
            velocityContext.put("dicts", dicts);
            if (add) {
                velocityContexts.add(velocityContext);

            }
        }
        return downloadCode("vm/dict.java.vm", velocityContexts);


    }


    public byte[] downloadCode(String path, List<VelocityContext> velocityContexts) {
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
        ZipOutputStream zip = new ZipOutputStream(outputStream);
        for (VelocityContext velocityContext : velocityContexts) {
            if (!velocityContext.containsKey("fileName")) {
                throw new RuntimeException("VelocityContext中必须指定fileName");
            }
            generatorCode(path, zip, velocityContext);
        }
        IOUtils.closeQuietly(zip);
        return outputStream.toByteArray();
    }

    private void generatorCode(String path, ZipOutputStream zip, VelocityContext velocityContext) {

        VelocityInitializer.initVelocity();

        // 获取模板文件
        Template template = Velocity.getTemplate(path);

        // 输出渲染后的结果
        StringWriter stringWriter = new StringWriter();
        template.merge(velocityContext, stringWriter);
        // 添加到zip
        try {
            zip.putNextEntry(new ZipEntry(velocityContext.get("fileName").toString()));
            IOUtils.write(stringWriter.toString(), zip, Constants.UTF8);
            IOUtils.closeQuietly(stringWriter);
            zip.flush();
            zip.closeEntry();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }


    }

    /**
     * 下划线
     */
    private static final char SEPARATOR = '_';

    /**
     * 驼峰式命名法
     * 例如:user_name->userName
     */
    public static String toCamelCase(String s) {
        if (s == null) {
            return null;
        }
        s = s.toLowerCase();
        StringBuilder sb = new StringBuilder(s.length());
        boolean upperCase = false;
        for (int i = 0; i < s.length(); i++) {
            char c = s.charAt(i);

            if (i == 0) {
                sb.append(Character.toUpperCase(c));
                continue;
            }

            if (c == SEPARATOR) {
                upperCase = true;
            } else if (upperCase) {
                sb.append(Character.toUpperCase(c));
                upperCase = false;
            } else {
                sb.append(c);
            }
        }
        return sb.toString();
    }


}

4:用到的实体类

@Data
public class DictRes {

    @ApiModelProperty("主键")
    private String dictId;

    @ApiModelProperty("字典名称")
    private String dictName;

    @ApiModelProperty("字典类型")
    private String dictType;

    @ApiModelProperty("字典枚举名称")
    private String dictLabel;

    @ApiModelProperty("字典枚举代码")
    private String dictValue;
}

5:用到的velocity模板工厂类

public class VelocityInitializer
{
    /**
     * 初始化vm方法
     */
    public static void initVelocity()
    {
        Properties p = new Properties();
        try
        {
            // 加载classpath目录下的vm文件
            p.setProperty("resource.loader.file.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader");
            // 定义字符集
            p.setProperty(Velocity.INPUT_ENCODING, Constants.UTF8);
            // 初始化Velocity引擎,指定配置Properties
            Velocity.init(p);
        }
        catch (Exception e)
        {
            throw new RuntimeException(e);
        }
    }
}

6: 用到的vm模板文件,需要将文件命名 dict.java.vm 并放到项目的 resource/vm 目录下


import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import lombok.Getter;
import lombok.Setter;

//${desc}
public enum ${class} {

    #foreach($key in ${dicts})
        ${key.dictValue}("${key.dictValue}", "${key.dictLabel}"),
    #end
        ;

    @JsonValue
    @Getter
    @Setter
    private String code;

    @Getter
    @Setter
    private String info;

    ${class}(String code, String info) {
        this.code = code;
        this.info = info;
    }

    @JsonCreator
    public static ${class} getEnumByValue(String code) {
        for (${class} bt : values()) {
            if (bt.getCode().equals(code)) {
                return bt;
            }
        }
        return null;
    }

    public static String getValue(String info) {
        for (${class} s : ${class}.values()) {
            if (s.getInfo().equals(info)) {
                return s.getCode();
            }
        }
        return "";
    }

    public static String getName(String code) {
        for (${class} s : ${class}.values()) {
            if (s.getCode().equals(code)) return s.getInfo();
        }
        return "";
    }

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

推荐阅读更多精彩内容