💢 🌎 🚋 .NET 5 + Generador de código fuente = Javascript 📐 💸 ♊️

La tarea es implementar la generación de aplicaciones SPA (Vue / React) basadas en modelos y controladores C #.

.NET 5 presenta un generador de fuentes. Haremos esto con su ayuda. Este artículo cubrirá los principales problemas que encontré al usar el generador de fuente y sus soluciones. La generación de la interfaz de usuario en sí está fuera del alcance de este artículo. Utilizado por Visual Studio 2019.

Entonces, lo que se requiere para esto:

1. Capacidad para generar archivos js / vue / jsx

2. Acceso al directorio principal del proyecto

3. Acceso al archivo de configuración

4. Uso de bibliotecas de terceros dentro del generador, por ejemplo Newtonsoft.Json

5. Usando mis otros ensamblajes dentro del generador

6. Acceso a clases / tipos de controladores y modelos ubicados en diferentes ensamblajes

7. Depuración

Algunas palabras sobre T4

.NET 4.x tiene un generador de código T4. Inicialmente, traté de resolver mi problema con él. Hubo una serie de problemas, principalmente relacionados con la carga de bibliotecas del sistema, que se resolvieron con diferente éxito. Pero cuando se trataba de manejar un ensamblado .NET 5 con controladores, que se refiere a una biblioteca AspNetCore ajena (para el tiempo de ejecución .NET 4.x), mi cerebro se atascó. T4 no quería encontrarlo y cargarlo de ninguna manera.

Estructura del proyecto

Todas las nuevas tecnologías de Microsoft comienzan con Hello World, donde todo funciona bien. Pero cuando comienzas a usarlos en un proyecto real, te encuentras con muchos problemas. Uno de ellos es la estructura del proyecto. En Hello World, este es un ensamblado. Y en un proyecto real hay varios de ellos.

Mi proyecto incluye cuatro ensamblajes condicionales:

1. NetGenerator5.Web - la aplicación web principal lanzada (net5.0), contiene controladores, un ensamblaje con modelos y el generador mismo están conectados a él.

2. NetGenerator5.Model - ensamblaje con modelos (net5.0)

3. NetGenerator5.Generator - ensamblaje con generador (netstandard2.0)

4. NetGenerator5.Generator.Dependency: ensamblado condicional que se usa dentro del generador (netstandard2.0)

Generador

La clase de generador implementa la interfaz ISourceGenerator con dos métodos, Initialize y Execute. El método Execute se ejecutará directamente durante la compilación del proyecto al que está conectado el generador.

El propio proyecto generador

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <LangVersion>preview</LangVersion>
    <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
    <IncludeBuildOutput>false</IncludeBuildOutput>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="3.8.0" PrivateAssets="all" />
    <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.2" PrivateAssets="all" />
  </ItemGroup>

</Project>

¿Cómo conectarlo? Es necesario en el proyecto principal (NetGenerator5.Web), registrar lo siguiente:

<PropertyGroup>
  <TargetFramework>net5.0</TargetFramework>
  <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
  <CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GeneratedFiles</CompilerGeneratedFilesOutputPath>
</PropertyGroup>

<ItemGroup>
  <ProjectReference Include="..\NetGenerator5.Generator\NetGenerator5.Generator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
</ItemGroup>

Capacidad para generar archivos js / vue / jsx

Inicialmente, el generador genera archivos cs con código C #. Para ello, dentro del método Execute, se utiliza el método de contexto GeneratorExecutionContext.AddSource. Por lo que tengo entendido, es imposible cambiar su extensión y estos archivos también se compilan. Por lo tanto, no es posible poner código en ningún otro idioma allí. Visual Studio comienza a generar errores de compilación.

Por lo tanto, necesitamos un enfoque diferente para guardar archivos js / vue / jsx. El habitual System.IO.File.WriteAllText me ayudó. Pero para esto, necesita saber exactamente dónde necesita guardar los archivos generados, es decir, conocer el directorio del proyecto principal.

Acceso al directorio principal del proyecto

Se puede obtener de la siguiente manera:

En el proyecto principal NetGenerator5.Web, escriba lo siguiente:

<ItemGroup>
  <CompilerVisibleProperty Include="MSBuildProjectDirectory" />
</ItemGroup>

Esto hará visible la variable del sistema para el generador de origen.

Y en el propio generador accederemos a él en el método Execute de la siguiente manera:

context.AnalyzerConfigOptions.GlobalOptions.TryGetValue("build_property.MSBuildProjectDirectory", out var projectDirectory)

Además, necesitamos saber exactamente dónde colocar los archivos generados dentro del propio proyecto web (por ejemplo, en wwwroot / js). Se me ocurrió pasar esto a través del archivo de configuración generatorsettings.json en el proyecto principal. Pero ahora de alguna manera necesito contarle al generador sobre él.

Accediendo al archivo de configuración

El generador tiene la capacidad de acceder a archivos a través de la colección de contexto GeneratorExecutionContext.AdditionalFiles dentro del método Execute. Para que mi archivo de configuración esté allí, debe establecer la propiedad de archivo adicional Build Action = C # analyzer en él, o así:

<ItemGroup>
  <AdditionalFiles Include="generatorsettings.json" />
</ItemGroup>

Después de eso, el contenido del archivo se puede leer de la siguiente manera

var content = context.AdditionalFiles.First(e => e.Path.EndsWith("generatorsettings.json")).GetText(context.CancellationToken);

A continuación, surge un problema: es json, pero ¿cómo puedo analizarlo?

Usar bibliotecas de terceros dentro del generador

Utilice una biblioteca externa. Por ejemplo Newtonsoft.Json. Aquí es donde algo realmente salió mal. Lo conecté a través de nuget, pero el generador no quería ver esta biblioteca de ninguna manera.

Exception was of type 'FileNotFoundException' with message 'Could not load file or assembly 'Newtonsoft.Json, Version=12.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed' or one of its dependencies.

y aunque te rompas.

El libro de cocina tiene una sección dedicada a esto.

Incluso hay un poco más de información sobre cómo diseñar su generador como un paquete nuget. Por alguna razón, no me ayudó.

Como resultado, al principio me decidí de una manera extraña. Estúpidamente agregué la biblioteca directamente al proyecto como un archivo y especifiqué Copiar al directorio de salida = Copiar siempre / Copiar si es más nuevo para él y todo funcionó. Pero luego obtuve una respuesta a una pregunta en la sección de discusión de Roslyn. El consejo me ayudó. Es necesario registrarse en el proyecto del generador exactamente así:

<ItemGroup>
    <!-- Generator dependencies -->
    <PackageReference Include="Newtonsoft.Json" Version="12.0.3" GeneratePathProperty="true" PrivateAssets="all" />
  </ItemGroup>

  <ItemGroup>
    <ProjectReference Include="..\NetGenerator5.Generator.Dependency\NetGenerator5.Generator.Dependency.csproj" />
  </ItemGroup>

  <PropertyGroup>
    <GetTargetPathDependsOn>$(GetTargetPathDependsOn);GetDependencyTargetPaths</GetTargetPathDependsOn>
  </PropertyGroup>

  <Target Name="GetDependencyTargetPaths">
    <ItemGroup>
      <TargetPathWithTargetPlatformMoniker Include="$(PKGNewtonsoft_Json)\lib\netstandard2.0\Newtonsoft.Json.dll" IncludeRuntimeDependency="false" />
    </ItemGroup>
  </Target>

O, alternativamente, utilice el System.Text.Json integrado.

Usando mis otros ensamblajes dentro del generador

Además, sería bueno usar mis otros ensamblajes dentro del generador. Por ejemplo, sería bueno distribuir las clases auxiliares para Vue y React en dos ensamblajes diferentes y conectarlos al generador según sea necesario.

Por extraño que parezca, todo me fue bien aquí. Acabo de conectar NetGenerator5.Generator.Dependency a través de Dependencies - Add Project Reference. Aunque algunos tuvieron problemas.

Acceso a clases / tipos de controladores y modelos ubicados en diferentes ensamblajes

Ahora vayamos a la parte divertida. Para generar archivos, necesitaba acceso a clases / tipos de controladores y modelos. Microsoft recomienda usar SyntaxReceiver

Pero solo tiene acceso a las clases del proyecto compilado actualmente (es decir, en mi caso NetGenerator5.Web), y las clases NetGenerator5.Model no están allí.

En la misma sección de discusión de Roslyn, se encontró una solución . Dentro del contexto de GeneratorExecutionContext, está Compilation.GlobalNamespace. Puede repasarlo de forma recursiva y obtener descripciones de todos los tipos, incluido el ensamblado compilado actual y el ensamblado con modelos.

Depuración

Para depurar, basta con escribir en la clase generadora en el método Initialize

#if DEBUG
  if (!Debugger.IsAttached)
  {
    Debugger.Launch();
  }
#endif

Al iniciar la compilación del proyecto principal, se abre una ventana con una propuesta para iniciar el depurador. Si hace clic en Aceptar, se iniciará otra instancia de Visual Studio y el modo de depuración de este generador estará en ella. Puede ir dentro de todas las otras clases y métodos, incluso aquellos que están en un ensamblado separado NetGenerator5.Generator.Dependency

Salir

Después de la compilación NetGenerator5.Web / wwwroot / js archivo se generated.js y NetGenerator5.Web \ obj \ GeneratedFiles \ NetGenerator5.Generator \ NetGenerator5.Generator.SourceGenerator ARCHIVAREMOS generated.cs ficticias

código fuente completo se puede ver aquí

.NET 5 + Generador de código fuente = Javascript