重构(attribute): 重构RegionInject属性用法

RRQM · RRQM · commit cb2ae337e2cd · 2025-09-15T23:29:13.000+08:00
重构RegionInject属性为属性初始化器语法，移除构造函数，提升代码可读性与灵活性。
更新README.md，增加属性初始化器用法示例，建议最佳实践。
优化CodeInjectIncrementalSourceGenerator逻辑，优先解析命名参数，保留旧版兼容性。
简化RegionInjectAttribute设计，移除构造函数，改用无参构造与属性初始化器。
更新Program.cs，替换构造函数调用为属性初始化器。
diff --git a/README.md b/README.md
@@ -61,11 +61,10 @@ public async Task<{ReturnType}> Create{EntityName}Async({ReturnType} entity)
 ### 2. Apply the attribute
 
 ```csharp
-using CodeRegionSourceGenerator;
+using CodeInject;
 
-[RegionInject("Templates/ApiTemplate.cs", "ApiMethods", 
-    "ReturnType", "User", 
-    "EntityName", "User")]
+[RegionInject(FilePath = "Templates/ApiTemplate.cs", RegionName = "ApiMethods", 
+    Placeholders = new[] { "ReturnType", "User", "EntityName", "User" })]
 public partial class UserService
 {
     private readonly IRepository _repository;
@@ -105,19 +104,34 @@ partial class UserService
 ### Multiple Injections
 
 ```csharp
-[RegionInject("Templates/CrudTemplate.cs", "CreateMethods", "Entity", "Product")]
-[RegionInject("Templates/CrudTemplate.cs", "UpdateMethods", "Entity", "Product")]
-[RegionInject("Templates/ValidationTemplate.cs", "Validators", "Type", "Product")]
+[RegionInject(FilePath = "Templates/CrudTemplate.cs", RegionName = "CreateMethods", 
+    Placeholders = new[] { "Entity", "Product" })]
+[RegionInject(FilePath = "Templates/CrudTemplate.cs", RegionName = "UpdateMethods", 
+    Placeholders = new[] { "Entity", "Product" })]
+[RegionInject(FilePath = "Templates/ValidationTemplate.cs", RegionName = "Validators", 
+    Placeholders = new[] { "Type", "Product" })]
 public partial class ProductService
 {
     // Multiple code regions will be injected
 }
 ```
 
-### Using Placeholders Property
+### Search All Files for Region
+
+If you don't specify the `FilePath`, the generator will search all available files for the specified region:
 
 ```csharp
-[RegionInject("Templates/ApiTemplate.cs", "ApiMethods", 
+[RegionInject(RegionName = "CommonMethods")]
+public partial class BaseService
+{
+    // Generator will search all files for "CommonMethods" region
+}
+```
+
+### Using Property Initializers
+
+```csharp
+[RegionInject(FilePath = "Templates/ApiTemplate.cs", RegionName = "ApiMethods", 
     Placeholders = new[] { "ReturnType", "Order", "EntityName", "Order" })]
 public partial class OrderService
 {
@@ -176,6 +190,16 @@ public async Task<ActionResult<{EntityType}>> Create{EntityName}({EntityType} {e
 #endregion
 ```
 
+Usage:
+```csharp
+[RegionInject(FilePath = "Templates/ControllerTemplate.cs", RegionName = "CrudActions",
+    Placeholders = new[] { "EntityType", "Product", "EntityName", "Product", "entityName", "product" })]
+public partial class ProductController : ControllerBase
+{
+    // Generated CRUD actions will be injected here
+}
+```
+
 ### 2. Repository Pattern Templates
 
 ```csharp
@@ -200,6 +224,16 @@ public async Task<{EntityType}> Create{EntityName}Async({EntityType} entity)
 #endregion
 ```
 
+Usage:
+```csharp
+[RegionInject(FilePath = "Templates/RepositoryTemplate.cs", RegionName = "RepositoryMethods",
+    Placeholders = new[] { "EntityType", "User", "EntityName", "User" })]
+public partial class UserRepository
+{
+    // Generated repository methods will be injected here
+}
+```
+
 ## 🔍 Diagnostics
 
 The source generator provides the following diagnostic information:
@@ -212,8 +246,9 @@ The source generator provides the following diagnostic information:
 
 1. **Organize templates**: Keep template files in a dedicated `Templates` folder
 2. **Naming conventions**: Use descriptive region names like `CrudMethods`, `ValidationRules`
-3. **Placeholder naming**: Use uppercase placeholder names like `ENTITY_NAME`, `RETURN_TYPE`
+3. **Placeholder naming**: Use consistent placeholder names like `EntityType`, `EntityName`
 4. **Modularization**: Group related functionality into different regions
+5. **Property-based syntax**: Use the new property-based initialization for better readability
 
 ## 📋 Requirements
 
diff --git a/demo/CodeRegionExamplesConsoleApp/Program.cs b/demo/CodeRegionExamplesConsoleApp/Program.cs
@@ -15,8 +15,8 @@
 
 namespace CodeRegionExamplesConsoleApp;
 
-[RegionInject("./CodeRegionTemplateConsoleApp/Program.cs", "Show")]
-[RegionInject("./CodeRegionTemplateConsoleApp/Program.cs", "Show1","Show123","Show222")]
+[RegionInject(RegionName = "Show")]
+[RegionInject(RegionName = "Show1", Placeholders = new[] { "Show123", "Show222" })]
 internal partial class ExampleProgram
 {
     static void Main(string[] args)
diff --git a/src/CodeInjectSourceGenerator/CodeInjectIncrementalSourceGenerator.cs b/src/CodeInjectSourceGenerator/CodeInjectIncrementalSourceGenerator.cs
@@ -151,9 +151,39 @@ private static ClassToGenerate GetSemanticTargetForGeneration(GeneratorSyntaxCon
 
                 string filePath = null;
                 string regionName = null;
+                var placeholders = new List<string>();
+
+                // 首先从命名参数（属性）获取值
+                foreach (var namedArgument in attributeData.NamedArguments)
+                {
+                    switch (namedArgument.Key)
+                    {
+                        case "FilePath":
+                            filePath = namedArgument.Value.Value?.ToString();
+                            break;
+                        case "RegionName":
+                            regionName = namedArgument.Value.Value?.ToString();
+                            break;
+                        case "Placeholders":
+                            var value = namedArgument.Value;
+                            if (value.Kind == TypedConstantKind.Array && !value.IsNull)
+                            {
+                                var arrayValues = value.Values;
+                                foreach (var item in arrayValues)
+                                {
+                                    var stringValue = item.Value?.ToString();
+                                    if (!string.IsNullOrEmpty(stringValue))
+                                    {
+                                        placeholders.Add(stringValue);
+                                    }
+                                }
+                            }
+                            break;
+                    }
+                }
 
-                // 处理不同的构造函数重载
-                if (attributeData.ConstructorArguments.Length >= 1)
+                // 如果没有从属性获取到值，尝试从构造函数参数获取（向后兼容）
+                if (string.IsNullOrEmpty(regionName) && attributeData.ConstructorArguments.Length >= 1)
                 {
                     var firstArg = attributeData.ConstructorArguments[0].Value?.ToString();
                     
@@ -169,62 +199,34 @@ private static ClassToGenerate GetSemanticTargetForGeneration(GeneratorSyntaxCon
                         filePath = firstArg;
                         regionName = attributeData.ConstructorArguments[1].Value?.ToString();
                     }
-                }
 
-                if (string.IsNullOrEmpty(regionName))
-                {
-                    continue;
-                }
-
-                var placeholders = new List<string>();
-
-                // 从构造函数参数获取占位符
-                if (attributeData.ConstructorArguments.Length >= 3)
-                {
-                    // 第3个参数可能是 params string[] placeholders
-                    var placeholdersArg = attributeData.ConstructorArguments[2];
-                    if (placeholdersArg.Kind == TypedConstantKind.Array && !placeholdersArg.IsNull)
-                    {
-                        var arrayValues = placeholdersArg.Values;
-                        foreach (var item in arrayValues)
-                        {
-                            var stringValue = item.Value?.ToString();
-                            if (!string.IsNullOrEmpty(stringValue))
-                            {
-                                placeholders.Add(stringValue);
-                            }
-                        }
-                    }
-                }
-                else if (attributeData.ConstructorArguments.Length == 2 && string.IsNullOrEmpty(filePath))
-                {
-                    // 可能是 RegionInjectAttribute(regionName, params string[] placeholders)
-                    var secondArg = attributeData.ConstructorArguments[1];
-                    if (secondArg.Kind == TypedConstantKind.Array && !secondArg.IsNull)
+                    // 从构造函数参数获取占位符（如果属性中没有设置）
+                    if (placeholders.Count == 0)
                     {
-                        var arrayValues = secondArg.Values;
-                        foreach (var item in arrayValues)
+                        if (attributeData.ConstructorArguments.Length >= 3)
                         {
-                            var stringValue = item.Value?.ToString();
-                            if (!string.IsNullOrEmpty(stringValue))
+                            // 第3个参数可能是 params string[] placeholders
+                            var placeholdersArg = attributeData.ConstructorArguments[2];
+                            if (placeholdersArg.Kind == TypedConstantKind.Array && !placeholdersArg.IsNull)
                             {
-                                placeholders.Add(stringValue);
+                                var arrayValues = placeholdersArg.Values;
+                                foreach (var item in arrayValues)
+                                {
+                                    var stringValue = item.Value?.ToString();
+                                    if (!string.IsNullOrEmpty(stringValue))
+                                    {
+                                        placeholders.Add(stringValue);
+                                    }
+                                }
                             }
                         }
-                    }
-                }
-
-                // 如果构造函数中没有占位符，再从 Placeholders 属性获取
-                if (placeholders.Count == 0)
-                {
-                    foreach (var namedArgument in attributeData.NamedArguments)
-                    {
-                        if (namedArgument.Key == "Placeholders")
+                        else if (attributeData.ConstructorArguments.Length == 2 && string.IsNullOrEmpty(filePath))
                         {
-                            var value = namedArgument.Value;
-                            if (value.Kind == TypedConstantKind.Array && !value.IsNull)
+                            // 可能是 RegionInjectAttribute(regionName, params string[] placeholders)
+                            var secondArg = attributeData.ConstructorArguments[1];
+                            if (secondArg.Kind == TypedConstantKind.Array && !secondArg.IsNull)
                             {
-                                var arrayValues = value.Values;
+                                var arrayValues = secondArg.Values;
                                 foreach (var item in arrayValues)
                                 {
                                     var stringValue = item.Value?.ToString();
@@ -238,6 +240,11 @@ private static ClassToGenerate GetSemanticTargetForGeneration(GeneratorSyntaxCon
                     }
                 }
 
+                if (string.IsNullOrEmpty(regionName))
+                {
+                    continue;
+                }
+
                 // 获取属性的位置信息
                 var attributeLocation = attributeData.ApplicationSyntaxReference?.GetSyntax().GetLocation() ?? Location.None;
 
@@ -701,32 +708,12 @@ namespace CodeInject
     [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
     public class RegionInjectAttribute : Attribute
     {
-        public string FilePath { get; }
-        public string RegionName { get; }
+        public string FilePath { get; set; }
+        public string RegionName { get; set; }
         public string[] Placeholders { get; set; } = new string[0];
         
-        public RegionInjectAttribute(string regionName)
-        {
-            FilePath = null;
-            RegionName = regionName ?? throw new ArgumentNullException(nameof(regionName));
-        }
-        
-        public RegionInjectAttribute(string regionName, params string[] placeholders)
-            : this(regionName)
-        {
-            Placeholders = placeholders ?? new string[0];
-        }
-        
-        public RegionInjectAttribute(string filePath, string regionName)
-        {
-            FilePath = filePath ?? throw new ArgumentNullException(nameof(filePath));
-            RegionName = regionName ?? throw new ArgumentNullException(nameof(regionName));
-        }
-        
-        public RegionInjectAttribute(string filePath, string regionName, params string[] placeholders)
-            : this(filePath, regionName)
+        public RegionInjectAttribute()
         {
-            Placeholders = placeholders ?? new string[0];
         }
     }
 }";
diff --git a/src/CodeInjectSourceGenerator/RegionInjectAttribute.cs b/src/CodeInjectSourceGenerator/RegionInjectAttribute.cs
@@ -21,64 +21,18 @@ namespace CodeInject
     public sealed class RegionInjectAttribute : Attribute
     {
         /// <summary>
-        /// 获取要注入的文件路径。如果为null或空字符串，则搜索所有可用文件。
+        /// 获取或设置要注入的文件路径。如果为null或空字符串，则搜索所有可用文件。
         /// </summary>
-        public string FilePath { get; }
+        public string FilePath { get; set; }
 
         /// <summary>
-        /// 获取要注入的区域名称。
+        /// 获取或设置要注入的区域名称。
         /// </summary>
-        public string RegionName { get; }
+        public string RegionName { get; set; }
 
         /// <summary>
         /// 获取或设置用于替换的占位符数组。
         /// </summary>
         public string[] Placeholders { get; set; } = new string[0];
-
-        /// <summary>
-        /// 初始化 <see cref="RegionInjectAttribute"/> 类的新实例，仅指定区域名称。
-        /// 当不指定文件路径时，生成器将搜索所有AdditionalFiles和编译文件。
-        /// </summary>
-        /// <param name="regionName">要注入的区域名称。</param>
-        public RegionInjectAttribute(string regionName)
-        {
-            this.FilePath = null;
-            this.RegionName = regionName ?? throw new ArgumentNullException(nameof(regionName));
-        }
-
-        /// <summary>
-        /// 初始化 <see cref="RegionInjectAttribute"/> 类的新实例，指定区域名称和占位符。
-        /// 当不指定文件路径时，生成器将搜索所有AdditionalFiles和编译文件。
-        /// </summary>
-        /// <param name="regionName">要注入的区域名称。</param>
-        /// <param name="placeholders">用于替换的占位符数组。</param>
-        public RegionInjectAttribute(string regionName, params string[] placeholders)
-            : this(regionName)
-        {
-            this.Placeholders = placeholders ?? new string[0];
-        }
-
-        /// <summary>
-        /// 初始化 <see cref="RegionInjectAttribute"/> 类的新实例。
-        /// </summary>
-        /// <param name="filePath">要注入的文件路径。</param>
-        /// <param name="regionName">要注入的区域名称。</param>
-        public RegionInjectAttribute(string filePath, string regionName)
-        {
-            this.FilePath = filePath ?? throw new ArgumentNullException(nameof(filePath));
-            this.RegionName = regionName ?? throw new ArgumentNullException(nameof(regionName));
-        }
-
-        /// <summary>
-        /// 初始化 <see cref="RegionInjectAttribute"/> 类的新实例，并指定占位符。
-        /// </summary>
-        /// <param name="filePath">要注入的文件路径。</param>
-        /// <param name="regionName">要注入的区域名称。</param>
-        /// <param name="placeholders">用于替换的占位符数组。</param>
-        public RegionInjectAttribute(string filePath, string regionName, params string[] placeholders)
-            : this(filePath, regionName)
-        {
-            this.Placeholders = placeholders ?? new string[0];
-        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,8 @@`
`15`	`15`
`16`	`16`	`namespace CodeRegionExamplesConsoleApp;`
`17`	`17`
`18`		`-[RegionInject("./CodeRegionTemplateConsoleApp/Program.cs", "Show")]`
`19`		`-[RegionInject("./CodeRegionTemplateConsoleApp/Program.cs", "Show1","Show123","Show222")]`
	`18`	`+[RegionInject(RegionName = "Show")]`
	`19`	`+[RegionInject(RegionName = "Show1", Placeholders = new[] { "Show123", "Show222" })]`
`20`	`20`	`internal partial class ExampleProgram`
`21`	`21`	`{`
`22`	`22`	`static void Main(string[] args)`