.net Core 3 [JsonIgnore] не работает при запросе одного ресурса
В моем.net Core 3.0 Api атрибут [JsonIgnore] не работает как исключение. Я используюSystem.Text.Json
вместо старого Newtonsoft.Json
Когда я использую свой ресурс, который возвращает список объектов, например:
/api/Object/
объекты сериализуются следующим образом:
[
{
"id": 1,
"date": "2020-02-12T08:45:51.502",
"userId": 1,
"tags": [
{
"name": "string"
}
]
}
]
Но когда я запрашиваю единственный результат
/api/Object/{id}
полный объект сериализуется следующим образом:
{
"user": {
"hasAccess": false,
"id": 1,
"userName": "***",
"normalizedUserName": "***",
"email": "***",
"normalizedEmail": "***",
"emailConfirmed": true,
"passwordHash": "***",
"concurrencyStamp": "***",
"phoneNumberConfirmed": false,
"twoFactorEnabled": false,
"lockoutEnabled": true,
"accessFailedCount": 0
},
"lazyLoader": {},
"id": 1,
"date": "2020-02-12T08:45:51.502",
"userId": 1,
"tags": [
{
"name": "string"
}
]
}
Класс с атрибутом JsonIgnore выглядит так:
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq;
using System.Text.Json.Serialization;
public class Object
{
[Key]
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
public int Id { get; set; }
public DateTime Date { get; set; }
[ForeignKey("User")]
public int UserId { get; set; }
[JsonIgnore]
public virtual User User { get; set; }
}
Это мой класс контроллера WebApi:
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using Models;
using Services;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
[Route("api/object")]
[ApiController]
[Authorize(Roles = Roles.ACCESS_GRANTED)]
public class ObjectController : AbstractController
{
private readonly ObjectService objectService;
public ObjectController(IDataService<Object> service, ExtendedUserManager manager) : base(manager)
{
objectService = (ObjectService)service;
}
// GET: api/Object
[HttpGet]
public IActionResult Get()
{
List<Object> object = objectService.GetAll();
return Ok(object);
}
// GET: api/Object/5
[HttpGet("{id}", Name = "GetObject")]
public IActionResult Get(int id)
{
Object object = objectService.Get(id);
if (object == null)
{
return NotFound(string.Format("Object with Id {0} could not be found", id));
}
return Ok(object);
}
}
Мой файл csproj:
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>netcoreapp3.1</TargetFramework>
<TypeScriptCompileBlocked>true</TypeScriptCompileBlocked>
<TypeScriptToolsVersion>Latest</TypeScriptToolsVersion>
<IsPackable>false</IsPackable>
<SpaRoot>ClientApp\</SpaRoot>
<DefaultItemExcludes>$(DefaultItemExcludes);$(SpaRoot)node_modules\**</DefaultItemExcludes>
<!-- Set this to true if you enable server-side prerendering -->
<BuildServerSideRenderer>false</BuildServerSideRenderer>
<RootNamespace>Project</RootNamespace>
<Configurations>Debug;Release;</Configurations>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="7.0.0" />
<PackageReference Include="log4net" Version="2.0.8" />
<PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="3.1.1" />
<PackageReference Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" Version="3.1.1" />
<PackageReference Include="Microsoft.AspNetCore.SpaServices.Extensions" Version="3.1.1" />
<PackageReference Include="Microsoft.EntityFrameworkCore" Version="3.1.1" />
<PackageReference Include="Microsoft.EntityFrameworkCore.Proxies" Version="3.1.1" />
<PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="3.1.1" />
<PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="3.1.1" />
<PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="3.1.1">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="3.1.1" />
<PackageReference Include="Microsoft.Extensions.Logging.Log4Net.AspNetCore" Version="3.0.3" />
<PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="3.1.1" />
<PackageReference Include="SendGrid" Version="9.12.6" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="5.0.0" />
<PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="5.6.0" />
</ItemGroup>
<ItemGroup>
<!-- Don't publish the SPA source files, but do show them in the project files list -->
<Content Remove="$(SpaRoot)**" />
<None Remove="$(SpaRoot)**" />
<None Include="$(SpaRoot)**" Exclude="$(SpaRoot)node_modules\**" />
</ItemGroup>
<Target Name="Restore">
<MSBuild Projects="$.\open-success.sln" Targets="Restore" />
</Target>
<Target Name="DebugEnsureNodeEnv" BeforeTargets="Build" Condition=" '$(Configuration)' == 'Debug' And !Exists('$(SpaRoot)node_modules') ">
<!-- Ensure Node.js is installed -->
<Exec Command="node --version" ContinueOnError="true">
<Output TaskParameter="ExitCode" PropertyName="ErrorCode" />
</Exec>
<Error Condition="'$(ErrorCode)' != '0'" Text="Node.js is required to build and run this project. To continue, please install Node.js from https://nodejs.org/, and then restart your command prompt or IDE." />
<Message Importance="high" Text="Restoring dependencies using 'npm'. This may take several minutes..." />
<Exec WorkingDirectory="$(SpaRoot)" Command="npm install" />
</Target>
<Target Name="PublishRunWebpack" AfterTargets="ComputeFilesToPublish">
<!-- As part of publishing, ensure the JS resources are freshly built in production mode -->
<Exec WorkingDirectory="$(SpaRoot)" Command="npm install" />
<!-- Include the newly-built files in the publish output -->
<ItemGroup>
<DistFiles Include="$(SpaRoot)dist\**; $(SpaRoot)dist-server\**" />
<DistFiles Include="$(SpaRoot)node_modules\**" Condition="'$(BuildServerSideRenderer)' == 'true'" />
<ResolvedFileToPublish Include="@(DistFiles->'%(FullPath)')" Exclude="@(ResolvedFileToPublish)">
<RelativePath>%(DistFiles.Identity)</RelativePath>
<CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
<ExcludeFromSingleFile>true</ExcludeFromSingleFile>
</ResolvedFileToPublish>
</ItemGroup>
</Target>
</Project>
И мой стартап:
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services.AddCors();
services.AddControllers();
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.UseCors(builder => builder.AllowAnyHeader().AllowAnyOrigin().WithMethods("*"));
app.UseDeveloperExceptionPage();
app.UseHttpsRedirection();
app.UseRouting();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller}/{action=Index}/{id?}");
});
}
}
Я что-то упустил или это ошибка?
Обновить:
Я заметил другое странное поведение: когда я возвращаю только что созданный объект вместо объекта из базы данных, все работает отлично.
[HttpGet("{id}", Name = "GetObject")]
public IActionResult Get(int id)
{
// Object object= objectService.Get(id);
Object object= new Object ();
object.User = new User();
if (object== null)
{
return NotFound(string.Format("object with Id {0} could not be found", id));
}
return Ok(object);
}
7 ответов
Тебе нужно:
using Newtonsoft.Json;
Вместо того:
using System.Text.Json.Serialization;
Пакет nuget - это https://www.nuget.org/packages/Microsoft.AspNetCore.Mvc.NewtonsoftJson/. Он больше не включен в ядро .net.
Вы можете использовать
[JsonIgnore]
из System.Text.Json, и он будет работать, если вы вызовете методы серлизации / десериализации вручную. Тем не мение; встроенная система выделения ядра.net, т.е. для контроллеров,
httpclient.GetFromJsonAsync
.. и т.д. Атрибут [JsonIgnore] на сегодняшний день не работает.
Похоже, внутренняя сериализация не используется
System.Text.Json
и
JsonIgnore
атрибут еще не адаптирован. В таком случае используйте
[IgnoreDataMember]
attribute и внутренняя система ядра.net будут игнорировать такие свойства, и это будет хорошо работать.
Я только что подал отчет об ошибке по этому поводу . Это происходит при использовании прокси-серверов с отложенной загрузкой с System.Text.Json.
Обходной путь (если вы не хотите переключиться на Newtonsoft) состоит в том, чтобы вызвать сериализатор вручную и вернуть
Content()
. Например:
[HttpGet("{id}")]
public ActionResult Get(int id)
{
var result = _context.Table.Find(id);
return Content(JsonSerializer.Serialize(result), "application/json");
}
Не забудьте указать те же параметры сериализатора, которые вы настроили через
AddJsonOptions
в
Startup
(если есть)
Вам нужно добавить приведенный ниже код в Startup.cs внутри метода ConfigureServices.
services.AddControllers()
.AddNewtonsoftJson(options =>
{
options.SerializerSettings.ContractResolver =
new DefaultContractResolver();
});
и конечно же вам понадобится пакет Microsoft.AspNetCore.Mvc.NewtonsoftJson
Для меня проблема вызвана lazyLoadingProxies. Загрузка пользователя из базы данных относится не к типу User, а к типу Castle.Proxies.UserProxy, к которому не применяется атрибут JsonIgnore. Я вижу 3 решения
- используйте ILazyLoader вместо прокси, как описано здесь:https://www.learnentityframeworkcore.com/lazy-loading
- Всегда отображать лениво загруженные свойства
- Не используйте ленивую загрузку вообще (лучше не использовать ее в EF Core)
Для меня я обнаружил, что если вы возвращаете объект, а не явный JsonResult, он будет игнорировать атрибут JsonIngore, и вы получите исключение. Если вы измените тип возвращаемого значения на JsonResult, он будет учитывать атрибут.
Выдает исключение -
[HttpGet]
public async Task<PurchaseOrder> Order(string orderNumber)
Уважает атрибут [JsonIgnore] —
[HttpGet]
public async Task<JsonResult> Order(string orderNumber)
Я использую
.NetCore 3.1
а также
System.Text.Json.Serialization v6.0.0.0
[JsonIgnore]
у меня работает нормально