How to add embedded resource JSON file to ConfigurationBuilder without creating a temporary file?

Question

I have appsettings.json with build action set to Embedded Resource. I usually extract the file and make a new copy of it as follows.

string jsonFullPath = Path.Combine(FileSystem.AppDataDirectory, "namespace.directory.appsettings.json");
Assembly assembly = Assembly.GetExecutingAssembly();

using (Stream resourceFileStream = assembly.GetManifestResourceStream(resourceFilename))
{
    if (resourceFileStream != null)
    {
        using (FileStream fileStream = File.Create(jsonFullPath))
        {
            resourceFileStream.CopyTo(fileStream);
        }
    }
}

And add the copy to an instance of ConfigurationBuilder as follows.

Configuration = new ConfigurationBuilder()
    .AddJsonFile(jsonFullPath, optional: true, reloadOnChange: true)
    .Build();

Question

Is it possible to make ConfigurationBuilder use the embedded JSON file directly without creating a new temporary file as I did above? If yes, how to do so?

Andrew Truckle · Accepted Answer · 2024-04-05 05:52:23Z

4

I would suggest that use AddJsonStream instead of AddJsonfile.

Useful resource here with sample code:

public static void AddEmbeddedJsonFile(this IConfigurationBuilder configuration, string resourceName)
{
    var host = Assembly.GetEntryAssembly();
    if (host == null)
        return;

    var fullFileName = $"{host.GetName().Name}.{resourceName}";
    using var input = host.GetManifestResourceStream(fullFileName);
    if (input != null)
    {
        configuration.AddJsonStream(input);
    }
}

edited Apr 5, 2024 at 5:52

Andrew Truckle

19.4k17 gold badges93 silver badges230 bronze badges

answered Feb 16, 2020 at 14:57

dotnetstep

17.5k6 gold badges61 silver badges80 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

TheLegendaryCopyCoder · Accepted Answer · 2022-02-10 11:09:00Z

1

In ASP.NET Core 6, streaming the appsettings.ini from an embedded resource is done as follows:

var builder = WebApplication.CreateBuilder(new WebApplicationOptions
{
    ContentRootPath = AppContext.BaseDirectory,//Path.GetFullPath(Directory.GetCurrentDirectory()),
    Args = args,
});

builder.Host.ConfigureAppConfiguration((hostingContext, config) =>
{    
    using (var resourceStream = this.GetType().Assembly.GetManifestResourceStream("Namespace.filename.ext"))
    {
        config.AddJsonStream(resourceStream);
    }
}
...

answered Feb 10, 2022 at 11:09

TheLegendaryCopyCoder

1,8523 gold badges27 silver badges50 bronze badges

Comments

oglehb · Accepted Answer · 2024-08-06 14:36:15Z

If you use a ManifestEmbeddedFileProvider, then you can continue using AddJsonFile without any other changes.

<!-- MyService.csproj -->

<PropertyGroup>
  <!-- https://learn.microsoft.com/en-us/aspnet/core/fundamentals/file-providers?view=aspnetcore-8.0#manifest-embedded-file-provider -->
  <GenerateEmbeddedFilesManifest>true</GenerateEmbeddedFilesManifest>
</PropertyGroup>

<ItemGroup>
  <!-- glob patterns are allowed here -->
  <EmbeddedResource Include="*appsettings.json" />
</ItemGroup>

// Program.cs

IConfigurationBuilder configBuilder = new ConfigurationBuilder();

// Get the default file provider.
IFileProvider defaultFileProvider = configBuilder.GetFileProvider();

// Initialize the embedded resource file provider.
var manifestEmbeddedFileProvider = new ManifestEmbeddedFileProvider(Assembly.GetExecutingAssembly());

// Create a composite file provider to retain the default behavior,
// but also enable loading files embedded in the assembly manifest.
var compositeFileProvider = new CompositeFileProvider(defaultFileProvider, manifestEmbeddedFileProvider);

configBuilder.SetFileProvider(compositeFileProvider);

// Add the JSON file embedded in the assembly.
configBuilder.AddJsonFile("namespace.directory.appsettings.json");

IConfiguration config = configBuilder.Build();

Collectives™ on Stack Overflow

How to add embedded resource JSON file to ConfigurationBuilder without creating a temporary file?

Question

3 Answers 3

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

Question

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related