spring.turbo.module.misc.mustache.MustacheService Maven / Gradle / Ivy

Go to download
package spring.turbo.module.misc.mustache;

import org.springframework.core.io.Resource;
import org.springframework.lang.Nullable;

import java.io.IOException;
import java.io.UncheckedIOException;

import static java.nio.charset.StandardCharsets.UTF_8;

/**
 * 集成 mustache.java 进行简易的模版渲染。
 *
 * @author 应卓
 * @see mustache.java官方文档
 * @since 3.3.0
 */
public interface MustacheService {

    /**
     * 渲染文本
     *
     * @param classpathTemplateLocation 模板在classpath中的位置
     * @param data                      数据
     * @return 渲染结果
     */
    public String render(String classpathTemplateLocation, @Nullable Object data);

    /**
     * 渲染文本
     *
     * @param template     模板
     * @param templateName 模板名称
     * @param data         数据
     * @return 渲染结果
     */
    public default String render(Resource template, String templateName, @Nullable Object data) {
        try {
            return render(template.getContentAsString(UTF_8), templateName, data);
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

    /**
     * 渲染文本
     *
     * @param templateString 字符串模版
     * @param templateName   模板名称
     * @param data           数据
     * @return 渲染结果
     */
    public String render(String templateString, String templateName, @Nullable Object data);

}