FreeSql 动态查询条件转换为 SQL 语句的实现方案
背景介绍
在使用 FreeSql 进行数据库操作时,我们经常会遇到需要根据前端传入的动态条件构建 SQL 查询语句的需求。FreeSql 提供了 DynamicFilterInfo
类型来表示动态查询条件,但在直接执行原生 SQL 时,无法直接使用 WhereDynamicFilter
方法。本文将介绍如何将 DynamicFilterInfo
转换为 SQL 条件语句的完整解决方案。
核心实现思路
实现动态查询条件转换为 SQL 语句的核心思路是递归解析 DynamicFilterInfo
结构,并根据不同的操作符生成对应的 SQL 条件表达式。同时需要考虑参数化查询,防止 SQL 注入。
完整实现代码
以下是完整的实现代码,包含查询条件生成、参数处理以及排序条件生成等功能:
public class QueryHelper
{
public static (string, Dictionary<string, object>, string) GenerateWhereString(DynamicFilterInfo filterInfo)
{
string order = "Id desc";
var lstValues = new Dictionary<string, object>();
int index = 0;
var whereClause = GenerateWhereClause(filterInfo, ref index);
filterInfo.Travel((filterInfo) => lstValues.Add(lstValues.Count.ToString(), GetValue(filterInfo)));
return (whereClause, lstValues, order);
}
public static string GenerateOrder(QueryCondition queryCondition)
{
string order = "Id desc";
if (queryCondition.sort.Count > 0)
{
order = string.Empty;
foreach (var item in queryCondition.sort)
{
order += $"{item.field} {item.order},";
}
order = order.Trim(',');
}
return order;
}
static bool isArray = false;
static DateTime[] dates;
static bool isDate1 = false;
protected static string GenerateWhereClause(DynamicFilterInfo filterInfo, ref int index)
{
var lstConditions = new List<string>();
if (filterInfo.Value != null && filterInfo.Value.ToString().Trim() != string.Empty)
{
if (filterInfo.Value.GetType() == typeof(JArray))
{
isArray = true;
dates = Newtonsoft.Json.JsonConvert.DeserializeObject<DateTime[]>(filterInfo.Value.ToString());
isDate1 = true;
lstConditions.Add(ConvertToCondition(filterInfo, index++));
}
isArray = false;
lstConditions.Add(ConvertToCondition(filterInfo, index++));
}
if (filterInfo.Filters != null && filterInfo.Filters.Count > 0)
{
foreach (var subGroup in filterInfo.Filters)
{
if (subGroup.Value != null && subGroup.Value.ToString().Trim() != string.Empty)
{
lstConditions.Add(GenerateWhereClause(subGroup, ref index));
}
}
}
return $"({lstConditions.JoinAsString(filterInfo.Logic.ToString().ToLower() == "and" ? " and " : " or ")})";
}
protected static string ConvertToCondition(DynamicFilterInfo condition, int index)
{
string left = GetLeft(condition, index);
string right = GetRight(condition, index);
switch (condition.Operator.ToString().ToLower())
{
case "equals":
case "equal":
case "eq":
case "=":
case "==":
return $"{left} = {right}";
case "<>":
case "!=":
case "notequal":
return $"{left} <> {right}";
case "greater":
case "greaterthan":
case ">":
return $"{left} > {right}";
case "greaterorequal":
case "greaterthanorequal":
case ">=":
return $"{left} >= {right}";
case "less":
case "lessthan":
case "<":
return $"{left} < {right}";
case "lessorequal":
case "lessthanorequal":
case "<=":
return $"{left} <= {right}";
case "startwith":
return $"{left} like {right}";
case "notstartwith":
return $"{left} not like {right}";
case "endwith":
return $"{left} like {right}";
case "notendwith":
return $"{left} not like {right}";
case "contain":
case "contains":
case "like":
return $"{left} like {right}";
case "notcontains":
return $"{left} not like {right}";
case "range":
return $"{left} in({right})";
case "daterange":
if (isArray)
{
return $"{left} >={right}";
}
else
{
return $"{left} <={right}";
}
case "in":
case "any":
return $"{left} in({right})";
case "notany":
case "notcontain":
return $"{left} not in({right})";
default:
throw new InvalidOperationException($"Unknown dynamic query operator: {condition.Operator}");
}
}
protected static object GetValue(DynamicFilterInfo condition)
{
switch (condition.Operator.ToString().ToLower())
{
case "startwith":
case "notstartwith":
return $"{condition.Value}%";
case "endwith":
case "notendwith":
return $"%{condition.Value}";
case "contain":
case "contains":
case "like":
case "notcontains":
return $"%{condition.Value}%";
case "daterange":
if (isDate1)
{
isDate1 = false;
return dates[0];
}
else
{
return dates[1];
}
default:
return condition.Value;
}
}
protected static string GetLeft(DynamicFilterInfo condition, int index)
{
return condition.Field;
}
protected static string GetRight(DynamicFilterInfo condition, int index)
{
return $"@{index}";
}
}
public static class FilterExtensions
{
public static void Travel(this DynamicFilterInfo dynamicFilterInfo, Action<DynamicFilterInfo> conditionAction)
{
if (dynamicFilterInfo.Value != null && dynamicFilterInfo.Value.ToString().Trim() != string.Empty)
{
if (dynamicFilterInfo.Value.GetType() == typeof(JArray))
{
conditionAction(dynamicFilterInfo);
}
conditionAction(dynamicFilterInfo);
}
if (dynamicFilterInfo.Filters != null && dynamicFilterInfo.Filters.Count > 0)
{
foreach (var subGroup in dynamicFilterInfo.Filters)
{
Travel(subGroup, conditionAction);
}
}
}
public static string JoinAsString<T>(this IEnumerable<T> source, string separator)
{
return string.Join(separator, source);
}
}
使用示例
var (predicate, args, order) = QueryHelper.GenerateWhereString(search.FilterInfo);
var sql = "select * from table"; // 你的SQL语句
if (args.Count > 0)
{
if (sql.IndexOf("where", StringComparison.OrdinalIgnoreCase) > 0)
{
sql = sql + predicate;
}
else
{
sql = $"{sql} where {predicate}";
}
DbParameter[] cmdParms = _reportRepository.FreeSql.Ado.GetDbParamtersByObject(args);
var cmdType = System.Data.CommandType.Text;
var dynamics = _reportRepository.FreeSql.Ado.Query<dynamic>(cmdType, sql, cmdParms);
}
实现解析
-
递归解析查询条件:
GenerateWhereClause
方法递归遍历DynamicFilterInfo
结构,处理嵌套的查询条件。 -
操作符转换:
ConvertToCondition
方法将各种操作符(如 equals、contains 等)转换为对应的 SQL 表达式。 -
参数处理:
GetValue
方法根据不同的操作符对参数值进行适当处理,例如为 like 查询添加 % 通配符。 -
日期范围处理:特别处理了日期范围查询,支持数组形式的日期范围参数。
-
扩展方法:
FilterExtensions
提供了遍历DynamicFilterInfo
的扩展方法,方便收集所有参数值。
注意事项
-
此实现支持大多数常见的查询操作符,但可能需要根据实际需求进行扩展。
-
对于复杂的嵌套查询条件,确保逻辑运算符(AND/OR)的正确应用。
-
日期范围查询需要特殊处理,确保传入的参数是有效的日期数组。
-
使用参数化查询可以有效防止 SQL 注入攻击。
总结
通过上述实现,我们可以轻松地将 FreeSql 的动态查询条件转换为原生 SQL 语句,同时保持参数化查询的安全性。这种方法特别适用于需要直接执行原生 SQL 但又希望利用 FreeSql 动态查询功能的场景。开发者可以根据实际需求对代码进行扩展和优化,以适应更复杂的查询需求。
Hunyuan3D-Part
腾讯混元3D-Part00Hunyuan3D-Omni
腾讯混元3D-Omni:3D版ControlNet突破多模态控制,实现高精度3D资产生成00GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0274community
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息010Hunyuan3D-2
Hunyuan3D 2.0:高分辨率三维生成系统,支持精准形状建模与生动纹理合成,简化资产再创作流程。Python00Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile09
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选









