StrongCX.Analyzers 2.0.6

StrongCX.Analyzers

OrnamentERPNew 的代码质量分析器

• 最低要求 Visual Studio 2022 >= 17.10
• 支持 传统项目 和 SDK样式项目

1. BackupModelAnalyzer 备份表分析器
2. ReadOnlyDatabaseAnalyzer 只读库分析器

• Attribute 自定义特性

BackupModelAnalyzers

备份表分析器，用于分析指定表的修改情况，若没有同步修改备份表，则抛出异常，并给出修补方式。

1. 添加项目文件 Analyzers/BackupModelAnalyzer.json

{
  // 是否启用此分析器
  "Enable": true,
  // 需要检查的表
  "BackupTables": [
    {
      // 原始表名
      "OriginalName": "dbo.Sys_HasBackupTest",
      // 备份表名
      "BackupName": "dbo.Sys_HasBackupTest_History",
      // 开始分析的时间
      "StartTime": 202501131049021
    }
  ]
}

2. 修改项目配置

<ItemGroup>
  <AdditionalFiles Include="Analyzers/BackupModelAnalyzer.json" />
</ItemGroup>

3. 可以使用 IgnoreBackupModelAnalyzerAttribute 来忽略备份表分析器的检查。

namespace StrongCX.DataAccess.Migrations
{
    using System;
    using System.Data.Entity.Migrations;

    [StrongCX.Analyzers.Attributes.IgnoreBackupModelAnalyzer]
    public partial class Update379 : DbMigration
    {
        public override void Up()
        {
            AddColumn("dbo.Sys_HasBackupTest", "CustomColumn", c => c.String());
            //AddColumn("Sys_HasBackupTest_History", "CustomColumn", c => c.String());
        }

        public override void Down()
        {
            DropColumn("dbo.Sys_HasBackupTest", "CustomColumn");
        }
    }
}

ReadOnlyDatabaseAnalyzer

只读数据库分析器，用于分析指定的只读数据库中是否添加特定SQL语句，没有添加则抛出异常，并给出修补方式。

1. 添加项目文件 Analyzers/ReadOnlyDatabaseAnalyzer.json

{
  // 是否启用此分析器
  "Enable": true,
  // 需要添加的语句
  "ReadDbSQL": "Sql(ReadDBPublication.TransactionSQL);",
  // 开始分析的时间
  "StartTime": 202501131049021
}

2. 修改项目配置

<ItemGroup>
  <AdditionalFiles Include="Analyzers/ReadOnlyDatabaseAnalyzer.json" />
</ItemGroup>

3. 可以使用 IgnoreReadOnlyDatabaseAnalyzerAttribute 来忽略只读数据库分析器的检查。

namespace StrongCX.DataAccess.Migrations
{
    using System;
    using System.Data.Entity.Migrations;

    [StrongCX.Analyzers.Attributes.IgnoreReadOnlyDatabaseAnalyzer]
    public partial class Update379 : DbMigration
    {
        public override void Up()
        {
            // Sql(ReadDBPublication.TransactionSQL);
        }

        public override void Down()
        {
            
        }
    }
}

Attribute

在项目中定义需要使用的特性，确保命名空间为 StrongCX.Attributes

#pragma warning disable IDE0130
namespace StrongCX.Attributes
{
    /// <summary>
    /// 忽略备份表分析。
    /// </summary>
    [System.AttributeUsage(System.AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
    public sealed class IgnoreBackupModelAnalyzerAttribute : System.Attribute { }

    /// <summary>
    /// 忽略只读库分析。
    /// </summary>
    [System.AttributeUsage(System.AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
    public sealed class IgnoreReadOnlyDatabaseAnalyzerAttribute : System.Attribute { }
}