MVC: как вернуть строку в формате JSON

Question

Стремясь сделать процесс отчетности о прогрессе немного более надежным и отделить его от запроса / ответа, я выполняю обработку в службе Windows и сохраняю предполагаемый ответ в файле. Когда клиент начинает опрос обновлений, предполагается, что контроллер возвращает содержимое файла, каким бы оно ни было, в виде строки JSON.

Содержимое файла предварительно сериализовано в JSON. Это делается для того, чтобы ничто не стояло на пути ответа. Для получения ответа обработка не требуется (за исключением чтения содержимого файла в строку и его возврата).

Я изначально, хотя это было бы довольно просто, но это не так.

В настоящее время мой метод контроллера выглядит так:

Контроллер

Обновлено

[HttpPost]
public JsonResult UpdateBatchSearchMembers()
{
    string path = Properties.Settings.Default.ResponsePath;
    string returntext;
    if (!System.IO.File.Exists(path))
        returntext = Properties.Settings.Default.EmptyBatchSearchUpdate;
    else
        returntext = System.IO.File.ReadAllText(path);

    return this.Json(returntext);
}

И Фиддлер возвращает это как необработанный ответ

HTTP/1.1 200 OK
Server: ASP.NET Development Server/10.0.0.0
Date: Mon, 19 Mar 2012 20:30:05 GMT
X-AspNet-Version: 4.0.30319
X-AspNetMvc-Version: 3.0
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Length: 81
Connection: Close

"{\"StopPolling\":false,\"BatchSearchProgressReports\":[],\"MemberStatuses\":[]}"

AJAX

Обновлено

Следующее, вероятно, будет изменено позже, но сейчас это работало, когда я генерировал класс ответа и возвращал его как JSON, как обычный человек.

this.CheckForUpdate = function () {
var parent = this;

if (this.BatchSearchId != null && WorkflowState.SelectedSearchList != "") {
    showAjaxLoader = false;
    if (progressPending != true) {
        progressPending = true;
        $.ajax({
            url: WorkflowState.UpdateBatchLink + "?SearchListID=" + WorkflowState.SelectedSearchList,
            type: 'POST',
            contentType: 'application/json; charset=utf-8',
            cache: false,
            success: function (data) {
                for (var i = 0; i < data.MemberStatuses.length; i++) {
                    var response = data.MemberStatuses[i];
                    parent.UpdateCellStatus(response);
                }
                if (data.StopPolling = true) {
                    parent.StopPullingForUpdates();
                }
                showAjaxLoader = true;
            }
        });
        progressPending = false;
    }
}

Answer 1

Проблема, на мой взгляд, заключается в том, что результат действия Json предназначен для получения объекта (вашей модели) и создания ответа HTTP с содержимым в виде данных в формате JSON из вашего объекта модели.

Чтотем не менее, вы переходите к методу Json контроллера, который является строковым объектом в формате JSON, поэтому он «сериализует» строковый объект в JSON, поэтому содержимое HTTP-ответа окружено двойным-quotes (я предполагаю, что это проблема).

Я думаю, что вы можете рассмотреть использование результата действия Content в качестве альтернативы результату действия Json, поскольку у вас уже есть необработанный контент для HTTPдоступен ответ.

return this.Content(returntext, "application/json");
// not sure off-hand if you should also specify "charset=utf-8" here, 
//  or if that is done automatically

Другой альтернативой может быть десериализация результата JSON из службы в объект, а затем передача этого объекта в метод Json контроллера, но недостатком является то, что вы будете десериализоватьа затем повторно сериализовать данные, которые могут оказаться ненужными для ваших целей.

Answer 2

Вам просто нужно вернуть стандартный ContentResult и установить ContentType на «application / json».Вы можете создать собственный ActionResult для него:

public class JsonStringResult : ContentResult
{
    public JsonStringResult(string json)
    {
        Content = json;
        ContentType = "application/json";
    }
}

, а затем вернуть его экземпляр:

[HttpPost]
public JsonResult UpdateBatchSearchMembers()
{
    string returntext;
    if (!System.IO.File.Exists(path))
        returntext = Properties.Settings.Default.EmptyBatchSearchUpdate;
    else
        returntext = Properties.Settings.Default.ResponsePath;

    return new JsonStringResult(returntext);
}

Answer 3

Да, все без проблем, чтобы избежать необработанной строки json, вот и все.

    public ActionResult GetJson()
    {
        var json = System.IO.File.ReadAllText(
            Server.MapPath(@"~/App_Data/content.json"));

        return new ContentResult
        {
            Content = json,
            ContentType = "application/json",
            ContentEncoding = Encoding.UTF8
        };
    } 

ПРИМЕЧАНИЕ: обратите внимание, что метод возврата типа JsonResult не работает для меня, поскольку JsonResult и ContentResult оба наследуют ActionResult, но между ними нет никакой связи.

Answer 4

Используйте следующий код в вашем контроллере:

return Json(new { success = string }, JsonRequestBehavior.AllowGet);

и в JavaScript:

success: function (data) {
    var response = data.success;
    ....
}

Answer 5

Все ответы здесь дают хороший и рабочий код.Но кто-то будет недоволен тем, что все они используют ContentType в качестве возвращаемого типа, а не JsonResult.

К сожалению JsonResult использует JavaScriptSerializer без опции, чтобы отключить его.Лучший способ обойти это - унаследовать JsonResult.

. Я скопировал большую часть кода из исходного JsonResult и создал класс JsonStringResult, который возвращает переданную строку как application/json.Код для этого класса ниже

public class JsonStringResult : JsonResult
    {
        public JsonStringResult(string data)
        {
            JsonRequestBehavior = JsonRequestBehavior.DenyGet;
            Data = data;
        }

        public override void ExecuteResult(ControllerContext context)
        {
            if (context == null)
            {
                throw new ArgumentNullException("context");
            }
            if (JsonRequestBehavior == JsonRequestBehavior.DenyGet &&
                String.Equals(context.HttpContext.Request.HttpMethod, "GET", StringComparison.OrdinalIgnoreCase))
            {
                throw new InvalidOperationException("Get request is not allowed!");
            }

            HttpResponseBase response = context.HttpContext.Response;

            if (!String.IsNullOrEmpty(ContentType))
            {
                response.ContentType = ContentType;
            }
            else
            {
                response.ContentType = "application/json";
            }
            if (ContentEncoding != null)
            {
                response.ContentEncoding = ContentEncoding;
            }
            if (Data != null)
            {
                response.Write(Data);
            }
        }
    }

Пример использования:

var json = JsonConvert.SerializeObject(data);
return new JsonStringResult(json);