如何去除Hangfire任务结果中的JSON转义字符并优化显示？

问题根源 #

你遇到的核心问题是：

• 当直接返回对象时，Hangfire默认的序列化器会将其转为JSON字符串，但Dashboard默认直接输出原始存储的序列化结果（无格式化）；
• 若自行序列化后返回字符串，Hangfire会对该字符串二次序列化，导致最终显示带转义字符的嵌套字符串。

解决方案 #

方案1：配置Hangfire序列化器输出格式化JSON（推荐）

直接修改Hangfire的JSON序列化配置，让它存储带缩进、换行的格式化JSON，Dashboard会直接展示可读的结构：

在Hangfire初始化代码中添加序列化设置：

GlobalConfiguration.Configuration
    .UseJsonSerializerSettings(new Newtonsoft.Json.JsonSerializerSettings
    {
        Formatting = Newtonsoft.Json.Formatting.Indented, // 开启缩进格式化
        ContractResolver = new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver() // 可选：驼峰命名输出
    });

配置完成后，直接返回Person对象即可：

var person = new Person
{
    Name = "john",
    Description = "male",
    Role = "manager"
};
return person;

此时Dashboard的Result字段会显示格式化后的JSON，无转义字符，且有换行缩进。

方案2：避免自行序列化后的二次转义（若必须返回字符串）

如果因业务需求需要提前序列化对象，不要直接返回字符串，而是返回JObject类型（来自Newtonsoft.Json.Linq），让Hangfire正确识别JSON结构：

using Newtonsoft.Json.Linq;

var person = new Person
{
    Name = "john",
    Description = "male",
    Role = "manager"
};
var jsonObj = JObject.FromObject(person);
return jsonObj;

方案3：自定义Dashboard显示模板（进阶）

若上述方法无法满足需求，可自定义Dashboard的JobDetails模板，让它自动解析并格式化JSON字符串：

1. 复制Hangfire默认的JobDetails.cshtml模板到你的项目自定义视图目录；
2. 修改模板中Result字段的渲染逻辑：

@if (Model.Result != null)
{
    <div class="panel panel-default">
        <div class="panel-heading">
            <h3 class="panel-title">Result</h3>
        </div>
        <div class="panel-body">
            @{
                var resultStr = Model.Result.ToString();
                try
                {
                    var json = Newtonsoft.Json.Linq.JToken.Parse(resultStr);
                    <pre>@json.ToString(Newtonsoft.Json.Formatting.Indented)</pre>
                }
                catch
                {
                    <pre>@resultStr</pre>
                }
            }
        </div>
    </div>
}

3. 配置Hangfire使用自定义视图：

app.UseHangfireDashboard("/hangfire", new DashboardOptions
{
    ViewPath = "~/Hangfire/CustomViews" // 指向你的自定义视图目录
});

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