.Net Core 2.1 - 在 javascript 文件中读取 appsettings.json

Question

我在 .net Core 2.1 中有一个使用 signalR 的 Web 应用程序。我需要将 HubUrl 传递到自定义 javascript 文件中。这在 .net Core 中可行吗？

js代码示例：

const connection = new signalR.HubConnectionBuilder()
.withUrl('http://localhost:5000/hub') //Here I need to read appSettings.json to get value from there
.configureLogging(signalR.LogLevel.Information)
.build();

Answer 1

appsettings.json 位于服务器上。因此，您需要将端点添加到返回所需值的控制器。

控制器：

public class MyController:Controller{
    private readonly IConfiguration configuration;

    public MyController(IConfiguration configuration){
         this.configuration = configuration;
    }

    [HTTPGet]
    public ActionResult GetConfigurationValue(string sectionName, string paramName){
        var parameterValue= configuration[$"{sectionName}:{paramName}"];
        return Json(new { parameter= parameterValue});
    }
}

客户端：

$.ajax({
    type:"GET",
    url: "/MyController/GetConfigurationValue"
    data:{
        sectionName = "MySection",
        paramName = "MyParameter"
    }
}).done(
    function(parameterValue){
        //do what you need
});

在 appsettings.json 中：

{
    "MySection":{
        "MyParameter":"value that I want to get"
    }
}

Answer 2

在appsettings.json

"ApiUrls": {
    "commonUrl": "https://localhost:44348/api/"    
  }

在_Layout.cshtml

@using Microsoft.Extensions.Configuration
@inject IConfiguration Configuration

<script>      
        const commonUrl = @Json.Serialize(@Configuration.GetSection("ApiUrls").GetSection("commonUrl").Value)
</script>

现在这就像一个可供所有 js 文件访问的全局变量

Answer 3

执行此操作的一种非常安全且灵活的方法是在视图中的 <script> 块内公开 URL。这样，您就不会暴露应用程序配置（您必须很好地保护哪些访问），而只是显式地暴露一个安全值。

它还有一个额外的好处，即您不需要向端点发出请求（您实际上还需要在脚本中知道哪个地址），而是在需要时立即获得价值。

为此，您可以简单地渲染一个在全局范围内定义值的<script> 标记。例如，您可以在布局中包含以下内容：

<script>
window._signalRAddress = @Json.Serialize(ViewData["SignalRAddress"]);
</script>
<script src="~/your-custom-script.js"></script>

然后您只需在脚本中使用window._signalRAddress。

Answer 4

在带有 webpack 的 SPA 中，您只需导入 appsettings.json 并通过您导入的便利类使其可用；

例如

appsettings.js：

appsettingsjson = process.env.NODE_ENV === 'development'
    ? require('./appsettings.Development.json')
    : require('./appsettings.json');

class AppConfig {

    constructor() {
    }

    static Settings() {
        return appsettingsjson;
    }
}

module.exports = AppConfig;

然后在您需要的地方，只需导入和使用。例如：

const AppConfig = require("./appsettings");
console.log(AppConfig.Settings().YourSection.YourParameter)

Answer 5

尊重“Maxemelian”的答案，通过添加验证案例来扩展答案

1. 如果部分名称为空
2. 忽略秘密

private readonly IConfiguration configuration;

public MyController(IConfiguration configuration){
     this.configuration = configuration;
}

[HttpGet("[action]")]
public ActionResult GetConfigurationValue(string sectionName, string paramName)
{
    if (paramName.ToLower().Contains("secret")) {
        return null;
    }

    var parameterValue = (!string.IsNullOrEmpty(sectionName)) ? config[$"{sectionName}:{paramName}"] : config[$"{paramName}"];
    return Json(new { parameter = parameterValue });
}