在 MVC Razor 中的 C# 和 Javascript 之间共享常量

Question

我想在服务器上的 C# 和客户端上的 Javascript 中都使用字符串常量。 我将常量封装在 C# 类中，

namespace MyModel
{
        public static class Constants
        {
            public const string T_URL = "url";
            public const string T_TEXT = "text";
     . . .
        }
}

我找到了一种使用 Razor 语法在 Javascript 中使用这些常量的方法，但对我来说看起来很奇怪：

@using MyModel
        <script type="text/javascript">

            var T_URL = '@Constants.T_URL';  
            var T_TEXT = '@Constants.T_TEXT';
     . . .
            var selValue = $('select#idTagType').val();
            if (selValue == T_TEXT) { ... 

是否有更“优雅”的方式在 C# 和 Javascript 之间共享常量？ （或者至少更加自动化，所以我不必在两个文件中进行更改）

Answer 1

你使用它的方式是危险的。想象一下您的某些常量包含引号，或者更糟糕的是其他一些危险字符 =>那会破坏你的JavaScript。

我建议您编写一个控制器操作，它将所有常量作为 javascript: 提供服务

public ActionResult Constants()
{
    var constants = typeof(Constants)
        .GetFields()
        .ToDictionary(x => x.Name, x => x.GetValue(null));
    var json = new JavaScriptSerializer().Serialize(constants);
    return JavaScript("var constants = " + json + ";");
}

，然后在您的布局中引用此脚本：

<script type="text/javascript" src="@Url.Action("Constants")"></script>

现在，每当您在脚本中需要常量时，只需按名称使用它即可：

<script type="text/javascript">
    alert(constants.T_URL);
</script>

Answer 2

您可以使用 HTML 帮助程序输出必要的脚本，并使用反射来获取字段及其值，以便它自动更新。

    public static HtmlString GetConstants(this HtmlHelper helper)
    {
        System.Text.StringBuilder sb = new System.Text.StringBuilder();

        sb.AppendLine("<script type=\"text/javascript\">");

        foreach (var prop in typeof(Constants).GetFields())
        {
            sb.AppendLine(string.Format("    var {0} = '{1}'", prop.Name, prop.GetValue(null).ToString()));
        }

        sb.AppendLine("</script>");
        return new HtmlString(sb.ToString());
    }

Answer 3

不要将常量数据存储在 C# 类中，而是将其存储在静态配置/常量文件中。

// Constants.json
{
    "T_URL": "url",
    "T_TEXT": "text"
}

// Constants.cs

// load the json from a file stream into a constants object

// Constants.js

window.Constants = $.getJSON(url);

只需将其存储为某种文件格式（json、xml、cvs 等），然后从客户端和客户端加载它即可。服务器。

这意味着您要么在运行时使用黑魔法反射在 C# 中动态创建一个类，要么只拥有一个包含键下常量的哈希表/字典。

jQuery.getJSON, JsonReaderWriterFactor

Answer 4

我的版本是从不可变的 C# 常量创建命名空间的 javascript 对象：

public static HtmlString GetConstants<T>()
        {
            StringBuilder jsConstant = new StringBuilder();
                jsConstant.Append("myApp." + typeof(T).Name + " = Object.freeze({");
            foreach(var item in typeof(T).GetFields())
            {
                jsConstant.Append(string.Format("{0}:'{1}'",item.Name,item.GetValue(null).ToString()) + ",");
            }
            jsConstant.Remove(jsConstant.Length - 1, 1);
            jsConstant.Append("})");
            return new HtmlString(jsConstant.ToString());
        }

在 Razor 中像这样使用：

@(HtmlHelpers.GetConstants<MyApp.Infrastructure.ApplicationConstants.SomeConstants>())

Answer 5

另一种选择是将常量作为 data- 值添加到调用 JavaScript 代码的按钮/链接中。

您的观点：

<button data-url="@T_URL" ...>

您的脚本：

$('button').click(function(event) {
    var url = $(this).data('url');
    ...