模式开发之旅(26):解释器模式
2010-09-29 11:01:03解释器模式:为某个语言定义它的语法(或者叫文法)表示,并定义一个解释器用来处理这个语法。
解释器模式为某个语言定义它的语法(或者叫文法)表示,并定义一个解释器用来处理这个语法。实际上,这里的“语言”不仅仅指我们平时说的中、英、日、法等各种语言。从广义上来讲,只要是能承载信息的载体,我们都可以称之为“语言”,比如,古代的结绳记事、盲文、哑语、摩斯密码等。
要想了解“语言”要表达的信息,我们就必须定义相应的语法规则。这样,书写者就可以根据语法规则来书写“句子”(专业点的叫法应该是“表达式”),阅读者根据语法规则来阅读“句子”,这样才能做到信息的正确传递。而我们要讲的解释器模式,其实就是用来实现根据语法规则解读“句子”的解释器。
解释器模式的代码实现比较灵活,没有固定的模板。应用设计模式主要是应对代码的复杂性,解释器模式也不例外。它的代码实现的核心思想,就是将语法解析的工作拆分到各个小类中,以此来避免大而全的解析类。一般的做法是,将语法规则拆分一些小的独立的单元,然后对每个单元进行解析,最终合并为对整个语法规则的解析。
实战
接下来我们用解释起模式来实现一个自定义的接口告警规则:
在我们平时的项目开发中,监控系统非常重要,它可以时刻监控业务系统的运行情况,及时将异常报告给开发者。比如,如果每分钟接口出错数超过 100,监控系统就通过短信、微信、邮件等方式发送告警给开发者。
一般来讲,监控系统支持开发者自定义告警规则,比如我们可以用下面这样一个表达式,来表示一个告警规则,它表达的意思是:每分钟 API 总出错数超过 100 或者每分钟 API 总调用数超过 10000 就触发告警。
api_error_per_minute > 100 || api_count_per_minute > 10000
在监控系统中,告警模块只负责根据统计数据和告警规则,判断是否触发告警。至于每分钟 API 接口出错数、每分钟接口调用数等统计数据的计算,是由其他模块来负责的。其他模块将统计数据放到一个字典中(数据的格式如下所示),发送给告警模块。接下来,我们只关注告警模块。
为了简化讲解和代码实现,我们假设自定义的告警规则只包含“||、&&、>、<、==”这五个运算符,其中,“>、<、==”运算符的优先级高于“||、&&”运算符,“&&”运算符优先级高于“||”。在表达式中,任意元素之间需要通过空格来分隔。除此之外,用户可以自定义要监控的 key,比如前面的 api_error_per_minute、api_count_per_minute。
public interface Expression
{
bool Interpret(Dictionary<string, int> stats);
}
public class GreaterExpression : Expression {
private string key;
private long value;
public GreaterExpression(string strExpression)
{
String[] elements = strExpression.Trim().Split("\\s+");
if (elements.Length != 3 || !elements[1].Trim().Equals(">"))
{
throw new Exception("Expression is invalid: " + strExpression);
}
this.key = elements[0].Trim();
this.value = long.Parse(elements[2].Trim());
}
public GreaterExpression(string key, long value)
{
this.key = key;
this.value = value;
}
public bool Interpret(Dictionary<string, int> stats) {
if (!stats.ContainsKey(key))
{
return false;
}
long statValue = stats[key];
return statValue > value;
}
}
// LessExpression/EqualExpression跟GreaterExpression代码类似,这里就省略了
public class AndExpression : Expression {
private List<Expression> expressions = new List<Expression>();
public AndExpression(string strAndExpression)
{
string[] strExpressions = strAndExpression.Split("&&");
foreach (var strExpr in strExpressions)
{
if (strExpr.Contains(">"))
{
expressions.Add(new GreaterExpression(strExpr));
}
else if (strExpr.Contains("<"))
{
expressions.Add(new LessExpression(strExpr));
}
else if (strExpr.Contains("=="))
{
expressions.Add(new EqualExpression(strExpr));
}
else
{
throw new Exception("Expression is invalid: " + strAndExpression);
}
}
}
public AndExpression(List<Expression> expressions)
{
this.expressions.AddRange(expressions);
}
public bool Interpret(Dictionary<string, int> stats)
{
foreach (var expr in expressions)
{
if (!expr.Interpret(stats))
{
return false;
}
}
return true;
}
}
public class OrExpression : Expression
{
private List<Expression> expressions = new List<Expression>();
public OrExpression(string strOrExpression)
{
string[] andExpressions = strOrExpression.Split("||");
foreach (var andExpr in andExpressions)
{
expressions.Add(new AndExpression(andExpr));
}
}
public OrExpression(List<Expression> expressions)
{
this.expressions.AddRange(expressions);
}
public bool Interpret(Dictionary<string, int> stats)
{
foreach (var expr in expressions)
{
if (!expr.Interpret(stats))
{
return false;
}
}
return true;
}
}
public class AlertRuleInterpreter
{
private Expression expression;
public AlertRuleInterpreter(string ruleExpression)
{
this.expression = new OrExpression(ruleExpression);
}
public bool interpret(Dictionary<string, int> stats)
{
return expression.Interpret(stats);
}
}