huahaofeng
/
aspnetcore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Avoid throwing if serializer settings is null (#12207) 

Also adds some docs that suggest what needs to be passed as an argument instance
This commit is contained in:
Pranav K 2019-07-15 17:48:26 -07:00 committed by GitHub
parent 7b56439ca1
commit 94edcbf65b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/Mvc/Mvc.Core/src/JsonResult.cs
View File

@ -2,8 +2,8 @@
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Text.Json;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc.Core;
using Microsoft.AspNetCore.Mvc.Infrastructure;
using Microsoft.Extensions.DependencyInjection;
@ -27,14 +27,17 @@ namespace Microsoft.AspNetCore.Mvc
/// Creates a new <see cref="JsonResult"/> with the given <paramref name="value"/>.
/// </summary>
/// <param name="value">The value to format as JSON.</param>
/// <param name="serializerSettings">The serializer settings to be used by the formatter.</param>
/// <param name="serializerSettings">
/// The serializer settings to be used by the formatter.
/// <para>
/// When using <c>System.Text.Json</c>, this should be an instance of <see cref="JsonSerializerOptions" />.
/// </para>
/// <para>
/// When using <c>Newtonsoft.Json</c>, this should be an instance of <c>JsonSerializerSettings</c>.
/// </para>
/// </param>
public JsonResult(object value, object serializerSettings)
{
if (serializerSettings == null)
{
throw new ArgumentNullException(nameof(serializerSettings));
}
Value = value;
SerializerSettings = serializerSettings;
}
@ -46,6 +49,12 @@ namespace Microsoft.AspNetCore.Mvc
/// <summary>
/// Gets or sets the serializer settings.
/// <para>
/// When using <c>System.Text.Json</c>, this should be an instance of <see cref="JsonSerializerOptions" />
/// </para>
/// <para>
/// When using <c>Newtonsoft.Json</c>, this should be an instance of <c>JsonSerializerSettings</c>.
/// </para>
/// </summary>
public object SerializerSettings { get; set; }

15
src/Mvc/Mvc.ViewFeatures/src/Controller.cs
View File

@ -2,6 +2,7 @@
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Text.Json;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.AspNetCore.Mvc.ModelBinding;
@ -298,7 +299,14 @@ namespace Microsoft.AspNetCore.Mvc
/// to JSON.
/// </summary>
/// <param name="data">The object to serialize.</param>
/// <param name="serializerSettings">The serializer settings to be used by the formatter.</param>
/// <param name="serializerSettings">The serializer settings to be used by the formatter.
/// <para>
/// When using <c>System.Text.Json</c>, this should be an instance of <see cref="JsonSerializerOptions" />.
/// </para>
/// <para>
/// When using <c>Newtonsoft.Json</c>, this should be an instance of <c>JsonSerializerSettings</c>.
/// </para>
/// </param>
/// <returns>The created <see cref="JsonResult"/> that serializes the specified <paramref name="data"/>
/// as JSON format for the response.</returns>
/// <remarks>Callers should cache an instance of serializer settings to avoid
@ -306,11 +314,6 @@ namespace Microsoft.AspNetCore.Mvc
[NonAction]
public virtual JsonResult Json(object data, object serializerSettings)
{
if (serializerSettings == null)
{
throw new ArgumentNullException(nameof(serializerSettings));
}
return new JsonResult(data, serializerSettings);
}