page contents

Java SpringBoot整合Velocity实现代码预览和文件生成教程

本文讲述了Java SpringBoot整合Velocity实现代码预览和文件生成教程!具有很好的参考价值,希望对大家有所帮助。一起跟随六星小编过来看看吧,具体如下:

attachments-2023-07-ewsaSykD64c46b8c9f4d8.png本文讲述了Java SpringBoot整合Velocity实现代码预览和文件生成教程!具有很好的参考价值,希望对大家有所帮助。一起跟随六星小编过来看看吧,具体如下:

这里做一个简单的示例DEMO,实现一键打包zip,提供一种解决方案,实际需求可以按需所改,代码就三四个文件不上传上来了,下面贴出完整代码:

文件目录如下:

attachments-2023-07-8F1jXOTs64c46b26e235f.png实体类User.java

省略 getter 和 setter 方法

package com.fun.demo.model;

/**

 * @author MrDJun 2020/10/21

 */

public class User {


    private Integer age;


    private String name;



    public User(Integer age, String name) {


        this.age = age;


        this.name = name;


    }



    public User(){}


}


VelocityUtils.java


package com.fun.demo.tool;



import com.fun.demo.model.User;


import org.apache.velocity.Template;


import org.apache.velocity.VelocityContext;


import org.apache.velocity.app.Velocity;


import org.slf4j.Logger;


import org.slf4j.LoggerFactory;


import org.apache.commons.io.IOUtils;



import java.io.ByteArrayOutputStream;


import java.io.IOException;


import java.io.StringWriter;


import java.util.Properties;


import java.util.zip.ZipEntry;


import java.util.zip.ZipOutputStream;



/**


 * @author MrDJun 2020/10/21


 */


public class VelocityUtils {


    private final static Logger log = LoggerFactory.getLogger(VelocityUtils.class);



    public static String previewCode() {


        initVelocity();


        User user = new User(18, "mrdjun");


        VelocityContext context = VelocityUtils.prepareContext(user);


        StringWriter sw = new StringWriter();


        Template tpl = Velocity.getTemplate("vm/xml/article.xml.vm", "UTF-8");


        tpl.merge(context, sw);


        return sw.toString();


    }



    public static byte[] downloadCode() {


        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();


        ZipOutputStream zip = new ZipOutputStream(outputStream);


        generatorCode(zip);


        IOUtils.closeQuietly(zip);


        return outputStream.toByteArray();


    }



    public static void generatorCode(ZipOutputStream zip) {


        User user = new User(18, "mrdjun");


        initVelocity();


        VelocityContext context = VelocityUtils.prepareContext(user);



        StringWriter sw = new StringWriter();


        Template tpl = Velocity.getTemplate("vm/xml/article.xml.vm", "UTF-8");


        tpl.merge(context, sw);


        try {


            // 添加到zip


            zip.putNextEntry(new ZipEntry("article.xml"));


            IOUtils.write(sw.toString(), zip, "UTF-8");


            IOUtils.closeQuietly(sw);


            zip.flush();


            zip.closeEntry();


        } catch (IOException e) {


            log.error("渲染模板失败:{0}", e);


        }



    }



    public static VelocityContext prepareContext(User user) {


        VelocityContext velocityContext = new VelocityContext();


        velocityContext.put("age", user.getAge());


        velocityContext.put("name", user.getName());


        return velocityContext;


    }



    public static void initVelocity() {


        Properties p = new Properties();


        try {


            // 加载classpath目录下的vm文件


            p.setProperty("file.resource.loader.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader");


            // 定义字符集


            p.setProperty(Velocity.ENCODING_DEFAULT, "UTF-8");


            p.setProperty(Velocity.OUTPUT_ENCODING, "UTF-8");


            // 初始化Velocity引擎,指定配置Properties


            Velocity.init(p);


        } catch (Exception e) {


            throw new RuntimeException(e);


        }


    }


}


CodeController.java


package com.fun.demo.controller;



import com.fun.demo.tool.VelocityUtils;


import org.apache.commons.io.IOUtils;


import org.springframework.web.bind.annotation.RequestMapping;


import org.springframework.web.bind.annotation.RestController;



import javax.servlet.http.HttpServletResponse;


import java.io.IOException;



/**


 * @author MrDJun 2020/10/21


 */


@RestController

public class CodeController {

    @RequestMapping("/download")

    public void download(HttpServletResponse response) throws IOException {

       byte[] data = VelocityUtils.downloadCode();

        genCode(response, data);

    }

    /**

     * 生成zip文件

     */

    private void genCode(HttpServletResponse response, byte[] data) throws IOException {

       response.reset();

        response.setHeader("Content-Disposition", "attachment; filename=\"fun.zip\"");

       response.addHeader("Content-Length", "" + data.length);

        response.setContentType("application/octet-stream; charset=UTF-8");

        IOUtils.write(data, response.getOutputStream());

    }

}

在创建一个SpringBoot的启动类

在resources下面创建一个vm文件夹,article.xml.vm

<?xml version="1.0" encoding="utf-8"?>

<DOCUMENT>

    我叫${name},今年${age}岁

</DOCUMENT>

pom.xml

我这里的全部依赖如下,按需所取:

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <parent>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-parent</artifactId>

        <version>2.1.5.RELEASE</version>

        <relativePath/>

    </parent>

    <groupId>com.fun</groupId>

    <artifactId>demo</artifactId>

    <version>0.0.1-SNAPSHOT</version>

    <name>demo</name>

    <description>Demo project for Spring Boot</description>

    <properties>

        <java.version>1.8</java.version>

    </properties>

    <dependencies>

        <!-- SpringBoot 核心包 -->

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter</artifactId>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-web</artifactId>

        </dependency>

        <!--Spring框架基本的核心工具-->

        <dependency>

            <groupId>org.springframework</groupId>

            <artifactId>spring-context-support</artifactId>

        </dependency>

        <!--常用工具类 -->

        <dependency>

            <groupId>org.apache.commons</groupId>

            <artifactId>commons-lang3</artifactId>

        </dependency>

       <!--io常用工具类 -->

        <dependency>

            <groupId>commons-io</groupId>

            <artifactId>commons-io</artifactId>

            <version>2.5</version>

        </dependency>

        <!--velocity代码生成使用模板 -->

        <dependency>

            <groupId>org.apache.velocity</groupId>

            <artifactId>velocity</artifactId>

            <version>1.7</version>

        </dependency>

        <!-- SpringBoot 测试 -->

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-test</artifactId>

            <scope>test</scope>

        </dependency>

    </dependencies>

    <build>

        <plugins>

            <plugin>

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

            </plugin>

        </plugins>

    </build>

</project>

更多相关技术内容咨询欢迎前往并持续关注六星社区了解详情。

想高效系统的学习Java编程语言,推荐大家关注一个微信公众号:Java圈子。每天分享行业资讯、技术干货供大家阅读,关注即可免费领取整套Java入门到进阶的学习资料以及教程,感兴趣的小伙伴赶紧行动起来吧。

attachments-2023-03-2AoKIjPQ64014b4ad30a3.jpg

  • 发表于 2023-07-29 09:32
  • 阅读 ( 150 )
  • 分类:Java开发

你可能感兴趣的文章

相关问题

0 条评论

请先 登录 后评论
轩辕小不懂
轩辕小不懂

2403 篇文章

作家榜 »

  1. 轩辕小不懂 2403 文章
  2. 小柒 1316 文章
  3. Pack 1135 文章
  4. Nen 576 文章
  5. 王昭君 209 文章
  6. 文双 71 文章
  7. 小威 64 文章
  8. Cara 36 文章