springboot1.5.x 版本后使用 velocity 模板

由于springboot在1.5.x版本开始不支持velocity(https://jira.spring.io/browse/SPR-13235),之后的版本若想使用要自己配置。

image.png

但是由于客观因素需要,在此简要记录我的配置方法,springboot版本以 2.1.4.RELEASE 为例。
说白了就是缺啥补啥。

1. 指定 spring-boot-starter-velocity 的 maven 配置版本

由于1.5.x后默认不支持,所以要手动指定。如下图:


image.png

2. 添加类库中删除的文件

由于有关velocity配置以及渲染的类都来源于spring-context-support.jar以及spring-webmvc.jar这两个包中。而在这两个包最新的版本中,所有有关velocity的类全都删除了,所以要手动添加相关的类文件。我这里使用4.3.x的包版本,要添加的包括

  1. https://github.com/spring-projects/spring-framework/tree/4.3.x/spring-context-support/src/main/java/org/springframework/ui/velocity
  2. https://github.com/spring-projects/spring-framework/tree/4.3.x/spring-webmvc/src/main/java/org/springframework/web/servlet/view/velocity
    以上两个路径下的文件,添加后工程目录结构如图:
    image.png

    然后各种依赖关系以及package的路径梳理清楚

3. 添加spring.vm并更改路径

https://github.com/spring-projects/spring-framework/tree/4.3.x/spring-webmvc/src/main/resources/org/springframework/web/servlet/view/velocity
路径下有一个 spring.vm 的模板文件,由于我们加入的类中启动用到了这个,所以需要添加到工程中(其实改一下类文件不要用到也行,但是懒得改了,加进来就好了)。我添加到了 /resources/templates/ 目录下。
添加后要注意修改 VelocityConfigurer 类中的 SPRING_MACRO_LIBRARY 常量配置,改为自己添加该文件的路径。如下图:

image.png

4. 添加自己的 velocity 相关配置

自定义 VelocityConfigurer 和 VelocityViewResolver 并添加为 bean。具体的配置代码如下:

@Configuration
public class MyVelocityConfig extends WebMvcConfigurerAdapter {
    //配置 velocity bean
    @SuppressWarnings("deprecation")
    @Bean
    public VelocityConfigurer velocityConfigurer(ApplicationContext context) {
        VelocityConfigurer config = new VelocityConfigurer();
        Properties properties = new Properties();
        properties.put("input.encoding", "UTF-8");
        properties.put("output.encoding", "UTF-8");
        config.setVelocityProperties(properties);
        return config;
    }

    //配置 velocity 视图解析器
    @SuppressWarnings("deprecation")
    @Bean
    public VelocityViewResolver velocityResolver() {
        VelocityViewResolver resolver = new VelocityViewResolver();
        resolver.setCache(false);
        resolver.setPrefix("/templates/");
        resolver.setSuffix(".vm");
        resolver.setContentType("text/html;charset=UTF-8");
        resolver.setExposeSpringMacroHelpers(true);
        resolver.setExposeRequestAttributes(true);
        //设置RequestContext在视图页面中的变量名,以便使用${request}获取
        resolver.setRequestContextAttribute("request");
        return resolver;
    }
}

也可以将配置写在专门的配置文件中,用 setConfigLocation 的方式引入。

5. 配置完成,写测试类,进行测试。

结果如图:


image.png

极简版(只为了velocity测试)的demo已经上传 https://github.com/LiangliangW/velocity
,可以自行取需。

提醒:这样强行适配可能产生一定性能问题,如并发量较低,请结合自身业务取用,生产环境一定提前压测。最佳建议还是使用其他更新的模板。

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

推荐阅读更多精彩内容