Mud.ServiceCodeGenerator 1.1.6

Mud 服务代码生成器

功能介绍

Mud 服务代码生成器是一个基于 Roslyn 的源代码生成器，用于自动生成服务层相关代码，提高开发效率。它包含以下主要功能：

1. 服务类代码生成 - 根据实体类自动生成服务接口和服务实现类
2. 依赖注入代码生成 - 自动为类生成构造函数注入代码，包括日志、缓存、用户管理等常用服务
3. DTO代码生成 - 根据实体类自动生成数据传输对象

项目参数配置

在使用 Mud 服务代码生成器时，可以通过在项目文件中配置以下参数来自定义生成行为：

通用配置参数

<PropertyGroup>
  <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>  
  
  
  <DefaultCacheManagerType>ICacheManager</DefaultCacheManagerType>  
  <DefaultUserManagerType>IUserManager</DefaultUserManagerType>  
  <DefaultLoggerVariable>_logger</DefaultLoggerVariable>  
  <DefaultCacheManagerVariable>_cacheManager</DefaultCacheManagerVariable>  
  <DefaultUserManagerVariable>_userManager</DefaultUserManagerVariable>  
  
  
  <ServiceGenerator>true</ServiceGenerator>  
  <EntitySuffix>Entity</EntitySuffix>  
  <ImpAssembly>Mud.System</ImpAssembly>  
  
  
  <EntityAttachAttributes>SuppressSniffer</EntityAttachAttributes>  
</PropertyGroup>

<ItemGroup>
  <CompilerVisibleProperty Include="DefaultCacheManagerType" />
  <CompilerVisibleProperty Include="DefaultUserManagerType" />
  <CompilerVisibleProperty Include="DefaultLoggerVariable" />
  <CompilerVisibleProperty Include="DefaultCacheManagerVariable" />
  <CompilerVisibleProperty Include="DefaultUserManagerVariable" />
  <CompilerVisibleProperty Include="ServiceGenerator" />
  <CompilerVisibleProperty Include="EntitySuffix" />
  <CompilerVisibleProperty Include="ImpAssembly" />
  <CompilerVisibleProperty Include="EntityAttachAttributes" />
</ItemGroup>

依赖项配置

<ItemGroup>
  
  <PackageReference Include="Mud.ServiceCodeGenerator" Version="1.0.1" PrivateAssets="all" OutputItemType="Analyzer" ReferenceOutputAssembly="false"/>
</ItemGroup>

代码生成功能及样例

1. 服务类代码生成

在服务类程序项目中添加服务代码生成配置：

<PropertyGroup>
  <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
  <EntityAssemblyPrefix>TestClassLibrary</EntityAssemblyPrefix>  
</PropertyGroup>
<ItemGroup>
  <CompilerVisibleProperty Include="EntityAssemblyPrefix" />
</ItemGroup>

在服务中添加服务代码生成特性：

[ServiceGenerator(EntityType = nameof(SysDeptEntity))]
public partial class SysDeptService
{
}

生成的代码将包含基于实体的完整服务接口和实现类。

2. 依赖注入代码生成

使用各种注入特性为类自动生成构造函数注入代码：

[ConstructorInject]  // 字段构造函数注入
[LoggerInject]       // 日志注入
[CacheInject]        // 缓存管理器注入
[UserInject]         // 用户管理器注入
[CustomInject(VarType = "IRepository<SysUser>", VarName = "_userRepository")]  // 自定义注入
public partial class SysUserService
{
    // 生成的代码将包含以下内容：
    // 1. 构造函数参数
    // 2. 私有只读字段
    // 3. 构造函数赋值语句
}

生成的代码示例：

public partial class SysUserService
{
    private readonly ILogger<SysUserService> _logger;
    private readonly ICacheManager _cacheManager;
    private readonly IUserManager _userManager;
    private readonly IRepository<SysUser> _userRepository;

    public SysUserService(
        ILogger<SysUserService> logger,
        ICacheManager cacheManager,
        IUserManager userManager,
        IRepository<SysUser> userRepository)
    {
        _logger = logger;
        _cacheManager = cacheManager;
        _userManager = userManager;
        _userRepository = userRepository;
    }
}

3. DTO代码生成

在实体程序项目中添加DTO代码生成配置：

<PropertyGroup>
  <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
  <EntitySuffix>Entity</EntitySuffix>  
  <EntityAttachAttributes>SuppressSniffer</EntityAttachAttributes>  
</PropertyGroup>
<ItemGroup>
  <CompilerVisibleProperty Include="EntitySuffix" />
  <CompilerVisibleProperty Include="EntityAttachAttributes"/>
</ItemGroup>

在实体中添加DTO代码生成DtoGenerator特性：

[DtoGenerator]
public class SysClientEntity : BaseEntity
{
    // 无需生成DTO代码
    [IgnoreGenerator]
    public string DelFlag { get; set; }
    
    // 其他属性将自动生成到DTO类中
    public string Name { get; set; }
    public string Code { get; set; }
}

维护者

倔强的泥巴

许可证

本项目采用MIT许可证模式：

• MIT 许可证

免责声明

本项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。

不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任。