如何修改treeBuilder.Dot在NHibernate自定义函数中生成LEFT JOIN而非INNER JOIN

核心原因 #

在自定义LINQ方法中访问实体的可选外键关联时，NHibernate默认可能生成INNER JOIN，导致过滤掉外键为null的记录。这通常是因为自定义方法的HQL构建逻辑未明确指定关联的连接类型，或映射配置未正确标记关联为可选。

解决方案 #

方案一：修正关联映射配置 #

首先确保DistributorAnswer.Distributor关联被标记为可选（允许外键为null）：

XML映射示例

<many-to-one name="Distributor" column="Distributor_id" optional="true" />

Fluent NHibernate示例

References(x => x.Distributor)
    .Column("Distributor_id")
    .Nullable();

若映射配置正确，NHibernate会自动为可选关联生成LEFT JOIN。若仍未生效，使用方案二手动强制左连接。

方案二：在BuildHql中手动构建LEFT JOIN #

通过HqlTreeBuilder手动创建左连接并添加到查询的FROM子句，替代默认的treeBuilder.Dot逻辑：

public override HqlTreeNode BuildHql(MethodInfo method, Expression targetObject,
    ReadOnlyCollection<Expression> arguments,
    HqlTreeBuilder treeBuilder, IHqlExpressionVisitor visitor)
{
    var targetNode = visitor.Visit(targetObject).AsExpression();
    var distributorAlias = "dist";

    // 获取主实体(DistributorAnswer)的FROM元素
    var fromElement = ((HqlAlias)targetNode).FromElement;

    // 创建LEFT JOIN节点，关联Distributor实体
    var join = treeBuilder.LeftJoin(
        fromElement,
        treeBuilder.Path(fromElement, nameof(DistributorAnswer.Distributor)),
        distributorAlias
    );

    // 将左连接添加到查询的FROM子句
    fromElement.AddJoin(join);

    // 若需返回Distributor的具体属性（如Name），可改为：
    // return treeBuilder.Dot(treeBuilder.Ident(distributorAlias), treeBuilder.Ident(nameof(Distributor.Name)));
    return treeBuilder.Ident(distributorAlias);
}

代码解释 #

• ((HqlAlias)targetNode).FromElement：获取当前查询中主实体DistributorAnswer的FROM元素实例。
• treeBuilder.LeftJoin：创建左连接节点，指定关联的源FROM元素、关联路径及关联实体的别名。
• fromElement.AddJoin(join)：将左连接添加到查询的FROM子句，确保SQL生成时包含该左连接。
• 返回的treeBuilder.Ident(distributorAlias)：引用左连接后的Distributor实体，如需访问其属性，用treeBuilder.Dot拼接属性名即可。

验证 #

修改后重新运行LINQ查询，通过SQL Server Profiler查看生成的SQL，会看到LEFT OUTER JOIN替代原有的INNER JOIN，从而包含所有Distributor_id为null的DistributorAnswer记录。

内容的提问来源于stack exchange，提问作者Pretors