利用T4模板生成ASP.NET Core控制器的构造函数和参数

前言

在ASP.NET Core中引入了DI，并且通过构造函数注入参数，控制器中会大量使用DI注入各种的配置参数，如果配置注入的参数比较多，而且各个控制器需要的配置参数都基本一样的话，那么不断重复的复制黏贴代码提供相应的构造函数，效率低效也，因此使用T4模板生成控制器的构造函数 ，这也得益于C#对分部类(partial)的支持。

 

T4模板生成控制器构造函数

图中CtrlTemplate.tt为模板文件，CtrlNames.txt为需要使用T4生成代码的控制器名称文件，CtrlTemplate.cs为T4模板生成的文件。

CtrlNames.txt文件内容：

Values
Account

CtrlTemplate.tt代码：

<#@ template language="C#" debug="false" hostspecific="true"#>
<#@ assembly name="System.Core" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Text" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ output extension=".cs" #>
using ApiCoreTest;
using EFDbContext;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;

namespace ApiCoreTest.Controllers
{
<#
    //获取项目的根目录
    var solutionsPath = Host.ResolveAssemblyReference("$(SolutionDir)");  
    //获取配置文件
    var lines = System.IO.File.ReadAllLines(solutionsPath + @"/src/ApiCoreTest/Controllers/Template/CtrlNames.txt");
    foreach(var name in lines)
    {#>
    public partial class <#= name#>Controller : Controller
    {   
        IOptions<ConfigModel> _config;
        ILogger<<#= name#>Controller> _logger;
        ApplicationDbContext _db;
        public <#= name#>Controller(IOptions<ConfigModel> config, ILogger<<#= name#>Controller> logger, ApplicationDbContext db)
        {
            _config = config;
            _logger = logger;
            _db = db;
        }
    }
<#}#>
}

 模板生成的文件CtrlTemplate.cs 内容：

using ApiCoreTest;
using EFDbContext;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;

namespace ApiCoreTest.Controllers
{
    public partial class ValuesController : Controller
    {   
        IOptions<ConfigModel> _config;
        ILogger<ValuesController> _logger;
        ApplicationDbContext _db;
        public ValuesController(IOptions<ConfigModel> config, ILogger<ValuesController> logger, ApplicationDbContext db)
        {
            _config = config;
            _logger = logger;
            _db = db;
        }
    }
    public partial class AccountController : Controller
    {   
        IOptions<ConfigModel> _config;
        ILogger<AccountController> _logger;
        ApplicationDbContext _db;
        public AccountController(IOptions<ConfigModel> config, ILogger<AccountController> logger, ApplicationDbContext db)
        {
            _config = config;
            _logger = logger;
            _db = db;
        }
    }
}

使用了模板的控制器：

namespace ApiCoreTest.Controllers
{
    [Route("api/[controller]")]
    public partial class ValuesController : Controller
    {
        [HttpGet]
        public string Gets()
        {
            var val = JsonConvert.SerializeObject(_config.Value);
            _logger.LogDebug(val);
            return val;
        }
    }
}

namespace ApiCoreTest.Controllers
{
    public partial class AccountController : Controller
    {
        public IActionResult Test()
        {
            var val = JsonConvert.SerializeObject(_config.Value);
            _logger.LogDebug(val);
            return Content(val);
        }
    }
}

注意

使用了T4模板的控制器必须设置为分部类，而且命名空间要一致。