利用字符串模板表来用最小代码记录操作日志

公司的crm系统有新增了一个需求，需要在所有模块都显示操作日志，复杂点在于不是记录一个字符串，而是操作日志显示要求不统一。

image.png

比如：

• 小张新建了销售机会，操作的人名的是动态的,销售机会是固定内容。
• 小王增加了标签:
  重要客户，
  客户标签，
  时间：2025-12-12 21:00，这个需要支持多行文字
• 小王删除了订单2100224488，订单号是个链接可以点到订单页。
  如果不去设计直接写代码的化，所有记录的地方都会是硬编码的方式各种拼接字符串，而且必然有大量重复代码。

分析一下不同日志的异同异同点：

• 相同点是需要拼接字符串：操作用户名+操作内容
• 不同点是不同记录需求有需要外部传入的变量个数不同，内容也不同

所以主体思路是把日志的结构定义成模板，然后调用时候用传入变量来替换占位符，这样来简化调用处的代码量来实现复用

$符号表示变量，后面的数子标识是第几个变量

1. $1增加了订单<a href='/show/order/$1'>$1<a/>
2. $1增加了标签$2:<BR/>$3<BR/>$4

//获取记用户名和订单号
genText('创建订单','小王',123456)
genText('新建销售机会','小王'）

//genText内部逻辑可以是这样：
public void genText(String moduleName,String... args) {
   //获取该模块的模板字符串
   String templateStr = ''//省略...
    for(int x = 1; x < args.lengh; x = x+1) {
         templateStr  = templateStr.replace("$"+i,arg[i-1]);
      }
}

动态的内容如何处理

其实还有种情况没考虑到， 比如
小王批量删除了用户，用户1，用户2，用户3，用户4。。。
这种用字符串模板要实现就太复杂，硬要设计出来，模板规则就太复杂，所以这里不是一个技术问题，而是一个方案复杂度的取舍问题。
这里我建议特殊处理，对这个日志直接用写代码实现。

所以这里我们用设计去降低复杂度不光要关注通用性，也需要有边界意识的灵活组合，模板可以解决90%的问题，10%的问题用其他方式，而不是说为了这个功能去设计一个100%通用的模板，那样反而会耗费更多的时间。