Wyjątek MaxJsonLength w ASP.NET MVC podczas JavaScriptSerializer

W jednej z moich akcji kontrolera zwracam bardzo dużą, JsonResultaby wypełnić siatkę.

Otrzymuję następujący InvalidOperationExceptionwyjątek:

Błąd podczas serializacji lub deserializacji przy użyciu JSON JavaScriptSerializer. Długość ciągu przekracza wartość ustawioną we właściwości maxJsonLength.

Ustawienie tej maxJsonLengthwłaściwości na web.configwyższą wartość niestety nie daje żadnego efektu.

<system.web.extensions>
  <scripting>
    <webServices>
      <jsonSerialization maxJsonLength="2147483644"/>
    </webServices>
  </scripting>
</system.web.extensions>

Nie chcę przekazywać go z powrotem jako ciąg, jak wspomniano w tej odpowiedzi SO.

W swoich badaniach trafiłem na ten wpis na blogu, w którym napisanie własnego ActionResult(np. LargeJsonResult : JsonResult) Jest zalecane, aby ominąć to zachowanie.

Czy to jedyne rozwiązanie?
Czy to błąd w ASP.NET MVC?
Czy coś mi brakuje?

Każda pomoc będzie mile widziana.

Wygląda na to, że zostało to naprawione w MVC4.

Możesz to zrobić, co dla mnie zadziałało:

public ActionResult SomeControllerAction()
{
  var jsonResult = Json(veryLargeCollection, JsonRequestBehavior.AllowGet);
  jsonResult.MaxJsonLength = int.MaxValue;
  return jsonResult;
}

Możesz również użyć ContentResultzgodnie z sugestią tutaj zamiast podklasy JsonResult.

var serializer = new JavaScriptSerializer { MaxJsonLength = Int32.MaxValue, RecursionLimit = 100 };

return new ContentResult()
{
    Content = serializer.Serialize(data),
    ContentType = "application/json",
};

Niestety ustawienie web.config jest ignorowane przez domyślną implementację JsonResult . Więc myślę, że będziesz musiał zaimplementować niestandardowy wynik json, aby rozwiązać ten problem.

Nie ma potrzeby posiadania niestandardowej klasy. To wszystko, czego potrzeba:

return new JsonResult { Data = Result, MaxJsonLength = Int32.MaxValue };

gdzie Resultsą te dane, które chcesz serializować.

Jeśli używasz Json.NET do generowania jsonciągu, nie trzeba ustawiać MaxJsonLengthwartości.

return new ContentResult()
{
    Content = Newtonsoft.Json.JsonConvert.SerializeObject(data),
    ContentType = "application/json",
};

Rozwiązałem problem, klikając ten link

namespace System.Web.Mvc
{
public sealed class JsonDotNetValueProviderFactory : ValueProviderFactory
{
    public override IValueProvider GetValueProvider(ControllerContext controllerContext)
    {
        if (controllerContext == null)
            throw new ArgumentNullException("controllerContext");

        if (!controllerContext.HttpContext.Request.ContentType.StartsWith("application/json", StringComparison.OrdinalIgnoreCase))
            return null;

        var reader = new StreamReader(controllerContext.HttpContext.Request.InputStream);
        var bodyText = reader.ReadToEnd();

        return String.IsNullOrEmpty(bodyText) ? null : new DictionaryValueProvider<object>(JsonConvert.DeserializeObject<ExpandoObject>(bodyText, new ExpandoObjectConverter()), CultureInfo.CurrentCulture);
    }
}

}

protected void Application_Start()
    {
        AreaRegistration.RegisterAllAreas();

        RegisterGlobalFilters(GlobalFilters.Filters);
        RegisterRoutes(RouteTable.Routes);

        //Remove and JsonValueProviderFactory and add JsonDotNetValueProviderFactory
        ValueProviderFactories.Factories.Remove(ValueProviderFactories.Factories.OfType<JsonValueProviderFactory>().FirstOrDefault());
        ValueProviderFactories.Factories.Add(new JsonDotNetValueProviderFactory());
    }

Jestem zaskoczony, że nikt nie zasugerował użycia filtra wyników. To najczystszy sposób globalnego podłączenia się do potoku akcji / wyników:

public class JsonResultFilter : IResultFilter
{
    public int? MaxJsonLength { get; set; }

    public int? RecursionLimit { get; set; }

    public void OnResultExecuting(ResultExecutingContext filterContext)
    {
        if (filterContext.Result is JsonResult jsonResult)
        {
            // override properties only if they're not set
            jsonResult.MaxJsonLength = jsonResult.MaxJsonLength ?? MaxJsonLength;
            jsonResult.RecursionLimit = jsonResult.RecursionLimit ?? RecursionLimit;
        }
    }

    public void OnResultExecuted(ResultExecutedContext filterContext)
    {
    }
}

Następnie zarejestruj instancję tej klasy za pomocą GlobalFilters.Filters:

GlobalFilters.Filters.Add(new JsonResultFilter { MaxJsonLength = int.MaxValue });

Możesz spróbować zdefiniować w wyrażeniu LINQ tylko te pola, które będą potrzebne.

Przykład. Wyobraź sobie, że masz model z identyfikatorem, nazwą, telefonem i obrazem (tablica bajtów) i musisz załadować z json do listy wyboru.

Zapytanie LINQ:

var listItems = (from u in Users where u.name.Contains(term) select u).ToList();

Problem polega na tym, że „ select u ” powoduje pobranie wszystkich pól. Więc jeśli masz duże zdjęcia, booomm.

Jak rozwiązać? bardzo, bardzo proste.

var listItems = (from u in Users where u.name.Contains(term) select new {u.Id, u.Name}).ToList();

Najlepsze praktyki to wybór tylko tego pola, którego będziesz używać.

Zapamiętaj. To prosta wskazówka, ale może pomóc wielu programistom ASP.NET MVC.

Alternatywna poprawka ASP.NET MVC 5:

W moim przypadku błąd wystąpił podczas żądania. Najlepszym podejściem w moim scenariuszu jest modyfikacja rzeczywistego, JsonValueProviderFactoryktóry stosuje poprawkę do projektu globalnego i można to zrobić, edytując global.csplik jako taki.

JsonValueProviderConfig.Config(ValueProviderFactories.Factories);

dodaj wpis web.config:

<add key="aspnet:MaxJsonLength" value="20971520" />

a następnie utwórz dwie następujące klasy

public class JsonValueProviderConfig
{
    public static void Config(ValueProviderFactoryCollection factories)
    {
        var jsonProviderFactory = factories.OfType<JsonValueProviderFactory>().Single();
        factories.Remove(jsonProviderFactory);
        factories.Add(new CustomJsonValueProviderFactory());
    }
}

Jest to w zasadzie dokładna kopia domyślnej implementacji znalezionej w programie, System.Web.Mvcale z dodatkiem konfigurowalnej wartości appsetting web.config aspnet:MaxJsonLength.

public class CustomJsonValueProviderFactory : ValueProviderFactory
{

    /// <summary>Returns a JSON value-provider object for the specified controller context.</summary>
    /// <returns>A JSON value-provider object for the specified controller context.</returns>
    /// <param name="controllerContext">The controller context.</param>
    public override IValueProvider GetValueProvider(ControllerContext controllerContext)
    {
        if (controllerContext == null)
            throw new ArgumentNullException("controllerContext");

        object deserializedObject = CustomJsonValueProviderFactory.GetDeserializedObject(controllerContext);
        if (deserializedObject == null)
            return null;

        Dictionary<string, object> strs = new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase);
        CustomJsonValueProviderFactory.AddToBackingStore(new CustomJsonValueProviderFactory.EntryLimitedDictionary(strs), string.Empty, deserializedObject);

        return new DictionaryValueProvider<object>(strs, CultureInfo.CurrentCulture);
    }

    private static object GetDeserializedObject(ControllerContext controllerContext)
    {
        if (!controllerContext.HttpContext.Request.ContentType.StartsWith("application/json", StringComparison.OrdinalIgnoreCase))
            return null;

        string fullStreamString = (new StreamReader(controllerContext.HttpContext.Request.InputStream)).ReadToEnd();
        if (string.IsNullOrEmpty(fullStreamString))
            return null;

        var serializer = new JavaScriptSerializer()
        {
            MaxJsonLength = CustomJsonValueProviderFactory.GetMaxJsonLength()
        };
        return serializer.DeserializeObject(fullStreamString);
    }

    private static void AddToBackingStore(EntryLimitedDictionary backingStore, string prefix, object value)
    {
        IDictionary<string, object> strs = value as IDictionary<string, object>;
        if (strs != null)
        {
            foreach (KeyValuePair<string, object> keyValuePair in strs)
                CustomJsonValueProviderFactory.AddToBackingStore(backingStore, CustomJsonValueProviderFactory.MakePropertyKey(prefix, keyValuePair.Key), keyValuePair.Value);

            return;
        }

        IList lists = value as IList;
        if (lists == null)
        {
            backingStore.Add(prefix, value);
            return;
        }

        for (int i = 0; i < lists.Count; i++)
        {
            CustomJsonValueProviderFactory.AddToBackingStore(backingStore, CustomJsonValueProviderFactory.MakeArrayKey(prefix, i), lists[i]);
        }
    }

    private class EntryLimitedDictionary
    {
        private static int _maximumDepth;

        private readonly IDictionary<string, object> _innerDictionary;

        private int _itemCount;

        static EntryLimitedDictionary()
        {
            _maximumDepth = CustomJsonValueProviderFactory.GetMaximumDepth();
        }

        public EntryLimitedDictionary(IDictionary<string, object> innerDictionary)
        {
            this._innerDictionary = innerDictionary;
        }

        public void Add(string key, object value)
        {
            int num = this._itemCount + 1;
            this._itemCount = num;
            if (num > _maximumDepth)
            {
                throw new InvalidOperationException("The length of the string exceeds the value set on the maxJsonLength property.");
            }
            this._innerDictionary.Add(key, value);
        }
    }

    private static string MakeArrayKey(string prefix, int index)
    {
        return string.Concat(prefix, "[", index.ToString(CultureInfo.InvariantCulture), "]");
    }

    private static string MakePropertyKey(string prefix, string propertyName)
    {
        if (string.IsNullOrEmpty(prefix))
        {
            return propertyName;
        }
        return string.Concat(prefix, ".", propertyName);
    }

    private static int GetMaximumDepth()
    {
        int num;
        NameValueCollection appSettings = ConfigurationManager.AppSettings;
        if (appSettings != null)
        {
            string[] values = appSettings.GetValues("aspnet:MaxJsonDeserializerMembers");
            if (values != null && values.Length != 0 && int.TryParse(values[0], out num))
            {
                return num;
            }
        }
        return 1000;
    }

    private static int GetMaxJsonLength()
    {
        int num;
        NameValueCollection appSettings = ConfigurationManager.AppSettings;
        if (appSettings != null)
        {
            string[] values = appSettings.GetValues("aspnet:MaxJsonLength");
            if (values != null && values.Length != 0 && int.TryParse(values[0], out num))
            {
                return num;
            }
        }
        return 1000;
    }
}

Żadne z powyższych nie zadziałało, dopóki nie zmieniłem Akcji na [HttpPost]. i ustawiono typ AJAX jako POST.

    [HttpPost]
    public JsonResult GetSelectedSignalData(string signal1,...)
    {
         JsonResult result = new JsonResult();
         var signalData = GetTheData();
         try
         {
              var serializer = new System.Web.Script.Serialization.JavaScriptSerializer { MaxJsonLength = Int32.MaxValue, RecursionLimit = 100 };

            result.Data = serializer.Serialize(signalData);
            return Json(result, JsonRequestBehavior.AllowGet);
            ..
            ..
            ...

    }

A wywołanie AJAX jako

$.ajax({
    type: "POST",
    url: some_url,
    data: JSON.stringify({  signal1: signal1,.. }),
    contentType: "application/json; charset=utf-8",
    success: function (data) {
        if (data !== null) {
            setValue();
        }

    },
    failure: function (data) {
        $('#errMessage').text("Error...");
    },
    error: function (data) {
        $('#errMessage').text("Error...");
    }
});

    protected override JsonResult Json(object data, string contentType, System.Text.Encoding contentEncoding, JsonRequestBehavior behavior)
    {
        return new JsonResult()
        {
            Data = data,
            ContentType = contentType,
            ContentEncoding = contentEncoding,
            JsonRequestBehavior = behavior,
            MaxJsonLength = Int32.MaxValue
        };
    }

Czy była dla mnie poprawka w MVC 4.

Musisz ręcznie odczytać z sekcji konfiguracji, zanim kod zwróci obiekt JsonResult. Po prostu przeczytaj z web.config w jednej linii:

        var jsonResult = Json(resultsForAjaxUI);
        jsonResult.MaxJsonLength = (ConfigurationManager.GetSection("system.web.extensions/scripting/webServices/jsonSerialization") as System.Web.Configuration.ScriptingJsonSerializationSection).MaxJsonLength;
        return jsonResult;

Upewnij się, że zdefiniowałeś element konfiguracji w web.config

to działało dla mnie

        JsonSerializerSettings json = new JsonSerializerSettings
        {
            ReferenceLoopHandling = ReferenceLoopHandling.Ignore
        };
        var result = JsonConvert.SerializeObject(list, Formatting.Indented, json);
        return new JsonResult { Data = result, MaxJsonLength = int.MaxValue };

jest trochę inny przypadek - dane są przesyłane od klienta do serwera. gdy używasz metody kontrolera, a model jest ogromny:

    [HttpPost]
    public ActionResult AddOrUpdateConsumerFile(FileMetaDataModelView inputModel)
    {
        if (inputModel == null) return null;
     ....
    }

system zgłasza wyjątek taki jak ten „Błąd podczas serializacji lub deserializacji przy użyciu JSON JavaScriptSerializer. Długość ciągu przekracza wartość ustawioną we właściwości maxJsonLength. Nazwa parametru: input”

Tylko zmiana ustawień Web.config nie wystarczy, aby pomóc w tym przypadku. Możesz dodatkowo zastąpić serializator mvc json do obsługi dużych rozmiarów modeli danych lub ręcznie deserializować model z Request. Twoja metoda kontrolera to:

   [HttpPost]
    public ActionResult AddOrUpdateConsumerFile()
    {
        FileMetaDataModelView inputModel = RequestManager.GetModelFromJsonRequest<FileMetaDataModelView>(HttpContext.Request);
        if (inputModel == null) return null;
        ......
    }

   public static T GetModelFromJsonRequest<T>(HttpRequestBase request)
    {
        string result = "";
        using (Stream req = request.InputStream)
        {
            req.Seek(0, System.IO.SeekOrigin.Begin);
            result = new StreamReader(req).ReadToEnd();
        }
        return JsonConvert.DeserializeObject<T>(result);
    }

Możesz umieścić ten kod w cshtml, jeśli zwracasz widok z kontrolera i chcesz zwiększyć długość danych widoku worka podczas kodowania w json w cshtml

@{
    var jss = new System.Web.Script.Serialization.JavaScriptSerializer();
    jss.MaxJsonLength = Int32.MaxValue;
    var userInfoJson = jss.Serialize(ViewBag.ActionObj);
}

var dataJsonOnActionGrid1 = @Html.Raw(userInfoJson);

Teraz dataJsonOnActionGrid1 będzie dostępny na stronie js i uzyskasz właściwy wynik.

Dzięki