RazorViewEngineOptions for FileProviders in ASP.NET Core 3.0

[guardrex]

Moved from #14586 (EDIT by @guardrex to place code block into remark).

@zhou881117 remarks ...

services.Configure(options =>
{
    options.FileProviders.Add(
        new EmbeddedFileProvider(typeof(MySharedController).GetTypeInfo().Assembly));
});

.net core 3.0 RazorViewEngineOptions changed. without FileProviders to locate view

@Rick-Anderson
tks!

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 8d8787c1-1a02-ae68-aa59-7c0e2e823dde
• Version Independent ID: 3e799e5d-a89c-cd03-999f-92ae431f4657
• Content: File Providers in ASP.NET Core
• Content Source: aspnetcore/fundamentals/file-providers.md
• Product: aspnet-core
• Technology: aspnetcore-fundamentals
• GitHub Login: @guardrex
• Microsoft Alias: riande

[guardrex]

This topic+sample was updated for 3.0 on #14027.

I'll take a look, but I'm 🏃 at the moment and won't be able to get to this for perhaps a week or two.

[Rick-Anderson]

5.5 K PV/month.

[zhou881117]

Ah... 3.0 could solve it?

[oleksandrkyselov]

Perhaps this solution will work.

.NET Core 2 by installing Microsoft.AspNetCore.Mvc.Razor nuget package

services.Configure<RazorViewEngineOptions>(options => {
	options.FileProviders.Clear();
	options.FileProviders.Add(new PhysicalFileProvider(appDirectory));
});

.NET Core 3 by installing Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation nuget package

services.Configure<MvcRazorRuntimeCompilationOptions>(options => {
	options.FileProviders.Clear();
	options.FileProviders.Add(new PhysicalFileProvider(appDirectory));
});

[zhou881117]

Perhaps this solution will work.

.NET Core 2 by installing Microsoft.AspNetCore.Mvc.Razor nuget package

services.Configure<RazorViewEngineOptions>(options => {
	options.FileProviders.Clear();
	options.FileProviders.Add(new PhysicalFileProvider(appDirectory));
});

.NET Core 3 by installing Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation nuget package

services.Configure<MvcRazorRuntimeCompilationOptions>(options => {
	options.FileProviders.Clear();
	options.FileProviders.Add(new PhysicalFileProvider(appDirectory));
});

services.Configure<Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation.MvcRazorRuntimeCompilationOptions>(options =>
{
options.FileProviders.Clear();
options.FileProviders.Add(new PhysicalFileProvider(AppContext.BaseDirectory));
options.FileProviders.Add(new EmbeddedFileProvider(typeof(IntelligentFactory.Web.PluginAdmin.AdminProfile).Assembly));
//new PhysicalFileProvider(appDirectory));
});

MvcRazorRuntimeCompilationOptions is also not work.
may this is not runtime razor.

[nexon33]

for me, MvcRazorRuntimeCompilationOptions also doesn't work, although I can successfully add the code and it throws no error, the views are not found during runtime.

[nexon33]

After a lot of searching managed to solve it, the above code stated is correct. But you will also need to change services.AddRazorPages(); to services.AddRazorPages().AddRazorRuntimeCompilation(); because else you end up configuring something that isn't used anywhere in the project.

[guardrex]

This is misplaced here ... my bad. This is for the View Complication topic, where some of the updates for 3.0 were made and one update doesn't seem correct based on the announcement. I'll move this issue over and ping all of you on the new issue.

[zhou881117]

how to run app-parts correct .net core 3.0?
this is my question.

the demo dosen't not work well for .net core 3.0
https://github.com/aspnet/AspNetCore.Docs/tree/5bbb2f5c459cf9bcc1159278a52555cc0f4bb3f6/aspnetcore/mvc/advanced/app-parts
@guardrex

Maybe they are the seem question #14800 ?

[jjxtra]

Trying this but get a ton of errors. I've already put in my csproj the suggested value...

One or more compilation references may be missing. If you're seeing this in a published application, set 'CopyRefAssembliesToPublishDirectory' to true in your project file to ensure files in the refs directory are published.

... thousands of missing type errors ...

[jjxtra]

Going back to .net core 2.2, this is a mess...

[Rick-Anderson]

@jjxtra can you open an issue at https://github.com/aspnet/AspNetCore with the simplest possible repo? This is a closed issue in the doc's repo, not the asp.net core code repo.

[littlesmilelove]

After a lot of searching managed to solve it, the above code stated is correct. But you will also need to change services.AddRazorPages(); to services.AddRazorPages().AddRazorRuntimeCompilation(); because else you end up configuring something that isn't used anywhere in the project.

After doing that, I get a new exception : Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation.CompilationFailedException: One or more compilation failures occurred
rq42brze.pko(4,20): error CS0400: The type or namespace name 'Microsoft' could not be found in the global namespace (are you missing an assembly reference?)

[littlesmilelove]

how to run app-parts correct .net core 3.0?
this is my question.

the demo dosen't not work well for .net core 3.0
https://github.com/aspnet/AspNetCore.Docs/tree/5bbb2f5c459cf9bcc1159278a52555cc0f4bb3f6/aspnetcore/mvc/advanced/app-parts
@guardrex

Maybe they are the seem question #14800 ?

The same issue, app-parts with razor views can't work in .net core 3.0.

[jjxtra]

There is some voodoo involved, I have solved most of it with this (except unit testing razor) here: dotnet/aspnetcore#14952

[Rick-Anderson]

@Tratcher what's the trick to get the following code to compile in 3.0?

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<RazorViewEngineOptions>(options =>
    {
        options.FileProviders.Add(   // <-------
         new EmbeddedFileProvider(typeof(MySharedController).GetTypeInfo().Assembly));
    });
}

'RazorViewEngineOptions' does not contain a definition for 'FileProviders' and no accessible extension method 'FileProviders' accepting a first argument of type 'RazorViewEngineOptions' could be found

cc @serpent5 @guardrex

[Rick-Anderson]

Never mind
MvcRazorRuntimeCompilationOptions works

[Rick-Anderson]

@serpent5 now I get
The type or namespace name 'MvcRazorRuntimeCompilationOptions' could not be found (are you missing a using directive or an assembly reference?)

[Rick-Anderson]

aspnet/Announcements#343

[serpent5]

Have you got it working now?

[Rick-Anderson]

No

[serpent5]

You need the Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation NuGet package and these usings:

using System.Reflection;
using Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation;
using Microsoft.Extensions.FileProviders;

Here's the code itself for completeness:

services.Configure<MvcRazorRuntimeCompilationOptions>(options =>
{
    options.FileProviders.Add(
        new EmbeddedFileProvider(typeof(MySharedController).GetTypeInfo().Assembly));
});

[zhou881117]

yes,it's ok.

public void ConfigureServices(IServiceCollection services)
{
services.Configure<Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation.MvcRazorRuntimeCompilationOptions>(options =>
{
options.FileProviders.Add(
new EmbeddedFileProvider(typeof(MySharedController).GetTypeInfo().Assembly));
});
// Requires using System.Reflection;
var assembly = typeof(MySharedController).GetTypeInfo().Assembly;
services.AddMvc().AddRazorRuntimeCompilation()
.AddApplicationPart(assembly)
.SetCompatibilityVersion(CompatibilityVersion.Version_3_0);
}

All of

MvcRazorRuntimeCompilationOptions 、AddRazorRuntimeCompilation、EmbeddedResource Include="Views***.cshtml"

https://github.com/aspnet/AspNetCore.Docs/tree/master/aspnetcore/mvc/advanced/app-parts