MVC项目中C#类与JS文件共享静态数据，避免重复编译与运行时重建

我刚好处理过类似的场景，咱们先把核心需求再捋一遍，确保方向没偏差：

• 有一批变更频率极低、修改后需重新编译的静态配置（比如URI、哈希值），要同时给C#代码和部分JavaScript代码使用
• 绝对不能重复存储这些数据，否则极易出现不一致，排查相关Bug会非常头疼
• 优先考虑在构建阶段直接从C#类提取数据生成JS文件，实在不行再退而求其次，且要尽量少引入新工具，保持现有项目的简洁性

下面针对你调研的三个方案逐一分析，再给出实操建议：

1. T4文本模板方案 #

T4作为VS原生的代码生成工具，理论上完全能实现从C#类提取数据生成JS的需求。你找不到访问现有项目类的方法，大概率是没配置好模板的运行上下文。给你个入门思路：

• 确保你的C#配置类已经编译完成（比如放在单独的类库，或者Web项目的已编译输出目录中）
• 在.tt文件里添加引用：<#@ assembly name="$(TargetPath)" #>，用来引入项目的编译输出DLL
• 再导入配置类的命名空间：<#@ import namespace="YourNamespace.Configuration" #>
• 之后就可以直接在模板里访问静态配置类的属性，循环生成JS对象了

不过T4的学习曲线确实有点陡，如果团队里没人熟悉的话，后续维护可能会有门槛。

2. Gulp工具方案 #

这个方案我之前也试过，确实能通过正则匹配从C#文件里提取配置生成JS，但正如你所说，引入Gulp意味着要额外维护Node.js环境、Gulp脚本，还要调整现有的构建流程（比如和TFS部署集成）。对于已经稳定的项目来说，这种“为了一个小需求动整个工具链”的做法性价比太低，而且后续新人接手还要额外学习Gulp，维护成本过高，完全不推荐。

3. 运行时构建并缓存JS文件方案 #

这也是我最推荐的方案，完全贴合你“简洁、易理解、无额外依赖”的需求，而且实现起来非常简单：

具体实现步骤 #

• 创建一个MVC控制器，比如ConfigController，里面新增一个GetConfigJs的Action
• 在Action中读取你的C#静态配置类的所有属性，拼接成一个全局JS对象（比如window.AppConfig = { ... }）
• 用MVC原生的OutputCache特性缓存这个Action的输出，因为配置是静态的，直接设置Duration为一个超大值（比如3652460），同时设置Location = OutputCacheLocation.ServerAndClient，让服务器和客户端都缓存该文件
• 最后在页面中直接引用这个Action的URL，比如<script src="@Url.Action("GetConfigJs", "Config")"></script>

示例代码 #

public class ConfigController : Controller
{
    [OutputCache(Duration = 31536000, Location = OutputCacheLocation.ServerAndClient, VaryByParam = "*")]
    public ActionResult GetConfigJs()
    {
        // 假设你的静态配置类是AppStaticConfig
        var config = new
        {
            ApiBaseUrl = AppStaticConfig.ApiBaseUrl,
            AssetHash = AppStaticConfig.AssetHash,
            // 其他需要共享的配置项...
        };

        // 拼接JS内容
        var jsContent = $"window.AppConfig = {Newtonsoft.Json.JsonConvert.SerializeObject(config)};";

        // 返回JS类型的响应
        return Content(jsContent, "application/javascript");
    }
}

这个方案的优势很明显：

• 完全基于MVC原生特性，不需要引入任何第三方工具或库
• 代码逻辑简单直白，新人一看就懂，维护成本极低
• 首次请求后会被服务器和客户端双重缓存，后续请求直接读取缓存，性能几乎和直接访问静态JS文件无异
• 唯一的小缺点是第一次请求需要服务器生成一次，但因为配置是静态的，这个成本可以忽略不计

内容的提问来源于stack exchange，提问作者GazB