需求:
- 使用模版引擎講待處理的模版中的變量替換為最終值
- 模版中需要使用到 list 循環(huán)。需要根據(jù)數(shù)據(jù)列表生成數(shù)量不定的結(jié)果
- 模版中需要使用到 base64 編碼蓄愁,且需要支持嵌套。base64 編碼中需要支持變量替換
base64( base64( "data1": ${data1 } ): base64( "data2": ${data2} ) )
開發(fā)環(huán)境
- Springboot Maven Kotlin k8s
需求調(diào)研
- 搜索了常用的模版引擎,嘗試使用了 jinjava糊治、Freemarker, 由于 jinjava 沒有找到足夠的功能來支持需求侧漓,最終選擇更為常用的 Freemarker.
需求實(shí)現(xiàn)
- 添加依賴
<!-- freemarker -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
- 新建一個自定義(實(shí)現(xiàn)base64編碼)方法類
class Base64Method : TemplateMethodModelEx {
override fun exec(data: MutableList<Any?>): Any {
return String(Base64.getEncoder().encode(data[0].toString().toByteArray(Charsets.UTF_8).clone()))
}
}
- 模版操作
@Test
@Transactional
fun tempalteTest() {
val stringLoader = StringTemplateLoader()
val templateValue: String = "<#list data1 as dataType1>\n" +
"'type1://\${base64(\"\${data1.userName}:\${data1.password}\")}'\n" +
"</#list>\n" +
"<#list data2 as dataType2>\n" +
"'type2://\${base64\"{\"userName\":\"\${data2.nodeName}\",\"password\":\"\${data2.password}\"}\")}'\n" +
"</#list>\n" +
"<#list data3 as dataType2>\n" +
"'type3://\${base64(\"\${data3.userName}@\${data3.password}\")}'\n" +
"</#list>"
stringLoader.putTemplate("myTemplate", templateValue)
val configuration = Configuration(Configuration.getVersion())
configuration.defaultEncoding = "utf-8"
configuration.setSharedVariable("base64", Base64Method());
// configuration.setSharedVariable("base66", Base64Directive()); // 不滿足需求,遺棄
configuration.templateLoader = stringLoader
val template = configuration.getTemplate("myTemplate", "utf-8")
//向數(shù)據(jù)集中添加數(shù)據(jù)
val dataModel: MutableMap<String, MutableList<Map<String, String>>> = mutableMapOf()
val type1: MutableList<Map<String, String>> = mutableListOf()
val type2: MutableList<Map<String, String>> = mutableListOf()
val type3: MutableList<Map<String, String>> = mutableListOf()
val apList = HttpUtil.get("https://xxx.xxx") // 獲取后端數(shù)據(jù)
// 根據(jù)后端結(jié)果apList 初始化數(shù)據(jù)
// type1 初始化
// type2 初始化
// type3 初始化
dataModel["type1"] = type1
dataModel["type2"] = type2
dataModel["type3"] = type3
val out: Writer = StringWriter()
// 第七步:調(diào)用模板對象的process方法輸出文件蛀醉。
template.process(dataModel, out)
// 第八步:關(guān)閉流悬襟。
var test2 = out.toString()
out.flush()
out.close()
}
未能實(shí)現(xiàn)部分
- 嵌套實(shí)現(xiàn)
踩的坑
- 剛開始使用 TemplateDirectiveModel 自定義指令的方式,如果待編碼的內(nèi)容中出現(xiàn)變量拯刁,就會出現(xiàn) base64 編碼的是一段一段的脊岳,也就是先每一小段編碼,在拼接成完成的垛玻。但我需要的效果是先拼接成完整的再進(jìn)行base64割捅。即便是這樣,我也想如果能拿到待編碼 list 的長度帚桩,那等拼接到最后一個再編碼也行亿驾,但并不能拿到這個 list,放棄账嚎。
- 在使用 TemplateMethodModelEx 時莫瞬,如果待編碼內(nèi)容中有使用雙引號這類字符,需要使用 \ 來轉(zhuǎn)義郭蕉,否則會出現(xiàn)數(shù)據(jù)丟失問題乏悄。
- 在測試嵌套時,方法內(nèi)無法使用 <#list> 循環(huán)恳不,故最后的解決方案是:再結(jié)果的基礎(chǔ)上自行 base64檩小。