From 9ad764c05ec5db2225d1622a452387f8986edae3 Mon Sep 17 00:00:00 2001 From: Looly Date: Fri, 31 Mar 2023 12:49:36 +0800 Subject: [PATCH] fix code --- .../template/engine/enjoy/EnjoyTemplate.java | 4 +- .../engine/pebble/PebbleTemplate.java | 64 +++++++++---- .../engine/pebble/PebbleTemplateEngine.java | 89 ++++++++++--------- .../template/engine/pebble/package-info.java | 12 +++ .../cn.hutool.extra.template.TemplateEngine | 1 + .../extra/template/TemplateUtilTest.java | 4 +- 6 files changed, 111 insertions(+), 63 deletions(-) diff --git a/hutool-extra/src/main/java/cn/hutool/extra/template/engine/enjoy/EnjoyTemplate.java b/hutool-extra/src/main/java/cn/hutool/extra/template/engine/enjoy/EnjoyTemplate.java index a0155255e..ab7a55904 100644 --- a/hutool-extra/src/main/java/cn/hutool/extra/template/engine/enjoy/EnjoyTemplate.java +++ b/hutool-extra/src/main/java/cn/hutool/extra/template/engine/enjoy/EnjoyTemplate.java @@ -28,8 +28,6 @@ import java.util.Map; public class EnjoyTemplate implements Template, Serializable { private static final long serialVersionUID = 1L; - private final com.jfinal.template.Template rawTemplate; - /** * 包装Enjoy模板 * @@ -40,6 +38,8 @@ public class EnjoyTemplate implements Template, Serializable { return (null == EnjoyTemplate) ? null : new EnjoyTemplate(EnjoyTemplate); } + private final com.jfinal.template.Template rawTemplate; + /** * 构造 * diff --git a/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/PebbleTemplate.java b/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/PebbleTemplate.java index 12a3ebcfe..469fb0ca9 100644 --- a/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/PebbleTemplate.java +++ b/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/PebbleTemplate.java @@ -1,62 +1,88 @@ +/* + * Copyright (c) 2023 looly(loolly@aliyun.com) + * Hutool is licensed under Mulan PSL v2. + * You can use this software according to the terms and conditions of the Mulan PSL v2. + * You may obtain a copy of Mulan PSL v2 at: + * http://license.coscl.org.cn/MulanPSL2 + * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, + * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, + * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. + * See the Mulan PSL v2 for more details. + */ + package cn.hutool.extra.template.engine.pebble; import cn.hutool.core.convert.Convert; import cn.hutool.core.reflect.TypeReference; import cn.hutool.extra.template.Template; import cn.hutool.extra.template.TemplateException; -import cn.hutool.extra.template.engine.velocity.VelocityTemplate; -import java.io.*; +import java.io.OutputStream; +import java.io.OutputStreamWriter; +import java.io.Writer; import java.util.Map; /** - * @author：zooooooooy + * Pebble模板实现 + * + * @author zooooooooy + * @since 6.0.0 */ public class PebbleTemplate implements Template { - private final io.pebbletemplates.pebble.template.PebbleTemplate template; - - public PebbleTemplate(io.pebbletemplates.pebble.template.PebbleTemplate template) { - this.template = template; - } - /** * 包装pebbleTemplate模板 - * @param template - * @return + * + * @param template {@link io.pebbletemplates.pebble.template.PebbleTemplate} + * @return PebbleTemplate */ public static PebbleTemplate wrap(final io.pebbletemplates.pebble.template.PebbleTemplate template) { return (null == template) ? null : new PebbleTemplate(template); } + private final io.pebbletemplates.pebble.template.PebbleTemplate template; + + /** + * 构造 + * + * @param template {@link io.pebbletemplates.pebble.template.PebbleTemplate} + */ + public PebbleTemplate(final io.pebbletemplates.pebble.template.PebbleTemplate template) { + this.template = template; + } + /** * 渲染对象 + * * @param bindingMap 绑定的参数，此Map中的参数会替换模板中的变量 - * @param writer 输出 + * @param writer 输出 */ @Override - public void render(Map bindingMap, Writer writer) { + public void render(final Map bindingMap, final Writer writer) { - final Map map = Convert.convert(new TypeReference>() {}, bindingMap); + final Map map = Convert.convert(new TypeReference>() { + }, bindingMap); try { this.template.evaluate(writer, map); - } catch (Exception e) { + } catch (final Exception e) { throw new TemplateException("pebble template parse failed, cause by: ", e); } } /** * 渲染对象 + * * @param bindingMap 绑定的参数，此Map中的参数会替换模板中的变量 - * @param out 输出 + * @param out 输出 */ @Override - public void render(Map bindingMap, OutputStream out) { + public void render(final Map bindingMap, final OutputStream out) { - final Map map = Convert.convert(new TypeReference>() {}, bindingMap); + final Map map = Convert.convert(new TypeReference>() { + }, bindingMap); try { this.template.evaluate(new OutputStreamWriter(out), map); - } catch (Exception e) { + } catch (final Exception e) { throw new TemplateException("pebble template parse failed, cause by: ", e); } diff --git a/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/PebbleTemplateEngine.java b/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/PebbleTemplateEngine.java index ea85109e2..29b620625 100644 --- a/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/PebbleTemplateEngine.java +++ b/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/PebbleTemplateEngine.java @@ -1,5 +1,18 @@ +/* + * Copyright (c) 2023 looly(loolly@aliyun.com) + * Hutool is licensed under Mulan PSL v2. + * You can use this software according to the terms and conditions of the Mulan PSL v2. + * You may obtain a copy of Mulan PSL v2 at: + * http://license.coscl.org.cn/MulanPSL2 + * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, + * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, + * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. + * See the Mulan PSL v2 for more details. + */ + package cn.hutool.extra.template.engine.pebble; +import cn.hutool.core.collection.ListUtil; import cn.hutool.core.io.file.FileUtil; import cn.hutool.core.text.StrUtil; import cn.hutool.extra.template.Template; @@ -8,9 +21,7 @@ import cn.hutool.extra.template.TemplateEngine; import cn.hutool.extra.template.TemplateException; import io.pebbletemplates.pebble.PebbleEngine; import io.pebbletemplates.pebble.error.PebbleException; -import io.pebbletemplates.pebble.loader.ClasspathLoader; -import io.pebbletemplates.pebble.loader.FileLoader; -import io.pebbletemplates.pebble.loader.StringLoader; +import io.pebbletemplates.pebble.loader.*; import org.beetl.core.GroupTemplate; /** @@ -20,24 +31,33 @@ public class PebbleTemplateEngine implements TemplateEngine { private PebbleEngine engine; + /** + * 构造，不初始化 + */ public PebbleTemplateEngine() { } - public PebbleTemplateEngine(TemplateConfig config) { + /** + * 构造 + * + * @param config 配置 + */ + public PebbleTemplateEngine(final TemplateConfig config) { init(config); } @Override - public TemplateEngine init(TemplateConfig config) { + public TemplateEngine init(final TemplateConfig config) { init(createEngine(config)); return this; } /** * 初始化引擎 + * * @param engine 引擎 */ - private void init(PebbleEngine engine){ + private void init(final PebbleEngine engine) { this.engine = engine; } @@ -52,60 +72,49 @@ public class PebbleTemplateEngine implements TemplateEngine { config = TemplateConfig.DEFAULT; } - PebbleEngine pebbleEngine; + Loader loader = null; switch (config.getResourceMode()) { case CLASSPATH: - ClasspathLoader classpathLoader = new ClasspathLoader(); - classpathLoader.setPrefix(StrUtil.addSuffixIfNot(config.getPath(), "/")); - pebbleEngine = new PebbleEngine.Builder() - .loader(classpathLoader) - .autoEscaping(false) - .build(); + loader = new ClasspathLoader(); + loader.setPrefix(StrUtil.addSuffixIfNot(config.getPath(), StrUtil.SLASH)); break; case FILE: - FileLoader fileLoader = new FileLoader(); - fileLoader.setPrefix(StrUtil.addSuffixIfNot(config.getPath(), "/")); - pebbleEngine = new PebbleEngine.Builder() - .loader(fileLoader) - .autoEscaping(false) - .build(); + loader = new FileLoader(); + loader.setPrefix(StrUtil.addSuffixIfNot(config.getPath(), StrUtil.SLASH)); break; case WEB_ROOT: - fileLoader = new FileLoader(); - fileLoader.setPrefix(StrUtil.addSuffixIfNot(FileUtil.getAbsolutePath(FileUtil.file(FileUtil.getWebRoot(), config.getPath())), "/")); - pebbleEngine = new PebbleEngine.Builder() - .loader(fileLoader) - .autoEscaping(false) - .build(); + loader = new FileLoader(); + loader.setPrefix(StrUtil.addSuffixIfNot( + FileUtil.getAbsolutePath(FileUtil.file(FileUtil.getWebRoot(), config.getPath())), StrUtil.SLASH)); break; case STRING: - StringLoader stringLoader = new StringLoader(); - stringLoader.setPrefix(StrUtil.addSuffixIfNot(config.getPath(), "/")); - pebbleEngine = new PebbleEngine.Builder() - .loader(stringLoader) - .autoEscaping(false) - .build(); + loader = new StringLoader(); break; + case COMPOSITE: + loader = new DelegatingLoader(ListUtil.of( + new ClasspathLoader(), + new FileLoader(), + new StringLoader() + )); default: - classpathLoader = new ClasspathLoader(); - classpathLoader.setPrefix(StrUtil.addSuffixIfNot(config.getPath(), "/")); - pebbleEngine = new PebbleEngine.Builder() - .loader(classpathLoader) - .autoEscaping(false) - .build(); + // 默认null表示使用DelegatingLoader break; } - return pebbleEngine; + return new PebbleEngine.Builder() + .loader(loader) + .autoEscaping(false) + .build(); } /** * 通过路径获取对应模板操作类 + * * @param resource 资源，根据实现不同，此资源可以是模板本身，也可以是模板的相对路径 - * @return + * @return {@link Template} */ @Override - public Template getTemplate(String resource) { + public Template getTemplate(final String resource) { if (null == this.engine) { init(TemplateConfig.DEFAULT); diff --git a/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/package-info.java b/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/package-info.java index 5a4ad81bc..3c8f73643 100644 --- a/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/package-info.java +++ b/hutool-extra/src/main/java/cn/hutool/extra/template/engine/pebble/package-info.java @@ -1,3 +1,15 @@ +/* + * Copyright (c) 2023 looly(loolly@aliyun.com) + * Hutool is licensed under Mulan PSL v2. + * You can use this software according to the terms and conditions of the Mulan PSL v2. + * You may obtain a copy of Mulan PSL v2 at: + * http://license.coscl.org.cn/MulanPSL2 + * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, + * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, + * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. + * See the Mulan PSL v2 for more details. + */ + /** * pebble template实现，模板引擎介绍见：https://github.com/PebbleTemplates/pebble * diff --git a/hutool-extra/src/main/resources/META-INF/services/cn.hutool.extra.template.TemplateEngine b/hutool-extra/src/main/resources/META-INF/services/cn.hutool.extra.template.TemplateEngine index 425e6cda2..ab395b1a3 100644 --- a/hutool-extra/src/main/resources/META-INF/services/cn.hutool.extra.template.TemplateEngine +++ b/hutool-extra/src/main/resources/META-INF/services/cn.hutool.extra.template.TemplateEngine @@ -18,3 +18,4 @@ cn.hutool.extra.template.engine.enjoy.EnjoyEngine cn.hutool.extra.template.engine.thymeleaf.ThymeleafEngine cn.hutool.extra.template.engine.wit.WitEngine cn.hutool.extra.template.engine.jetbrick.JetbrickEngine +cn.hutool.extra.template.engine.pebble.PebbleTemplateEngine diff --git a/hutool-extra/src/test/java/cn/hutool/extra/template/TemplateUtilTest.java b/hutool-extra/src/test/java/cn/hutool/extra/template/TemplateUtilTest.java index 533650162..651c96f56 100755 --- a/hutool-extra/src/test/java/cn/hutool/extra/template/TemplateUtilTest.java +++ b/hutool-extra/src/test/java/cn/hutool/extra/template/TemplateUtilTest.java @@ -153,13 +153,13 @@ public class TemplateUtilTest { TemplateEngine engine = TemplateUtil.createEngine(new TemplateConfig("templates").setCustomEngine(PebbleTemplateEngine.class)); Template template = engine.getTemplate("

{{ message }}

"); String result = template.render(Dict.of().set("message", "Hutool")); - Assert.assertEquals("

Hutool

", result); + Assertions.assertEquals("

Hutool

", result); //ClassPath模板 engine = TemplateUtil.createEngine(new TemplateConfig("templates", ResourceMode.CLASSPATH).setCustomEngine(PebbleTemplateEngine.class)); template = engine.getTemplate("pebble_test.peb"); result = template.render(Dict.of().set("name", "Hutool")); - Assert.assertEquals("hello, Hutool", result); + Assertions.assertEquals("hello, Hutool", result); } @Test