SolidWorks二次开发模板：分层架构与COM安全实践

简介：本资源是一套开箱即用的SolidWorks二次开发C#模板工程，面向机械设计工程师、CAD自动化开发者及高校相关专业学习者，解决从零搭建SolidWorks插件开发环境、快速实现COM Add-in注册与基础交互功能的入门难题。压缩包含99个文件，总大小10.24MB，涵盖18个核心C#源码文件（如SwAddin.cs、EventHandling.cs、PMPHandler.cs等）、34个运行依赖DLL、2个Visual Studio解决方案（.sln）与项目文件（.csproj），以及位图图标、资源文件（.resx）、配置清单（.manifest）和调试符号（.pdb）等完整开发构件，结构清晰，模块分工明确，便于理解插件初始化、命令注册、UI集成与事件响应全流程。目前已有726人学习下载，提供可直接编译运行的SwCSharpAddin1示例项目，包含Windows Forms界面定制、SolidWorks API调用封装、自定义工具栏与属性管理器页面（UserPMPage）等实战要素，是掌握SolidWorks SDK开发原理与工程化落地的高价值起点。

1. SolidWorks二次开发模板：不是“写个宏就完事”，而是把建模逻辑固化成可复用、可交接、可升级的工程资产

你有没有遇到过这种场景：A同学花三天写了个自动出工程图的插件，交接给B同学时发现——配置路径硬编码在C:\Users\A\Desktop\temp\里，注册表项没导出，COM组件权限没提权，双击exe直接报错0x80040154；或者更糟，改个标题栏文字都要重编译、重新注册、重启SolidWorks，改五次崩三次。这不是开发，是玄学运维。SolidWorks二次开发模板解决的从来不是“能不能跑”，而是“能不能交给别人跑、能不能明年还跑、能不能加新功能不翻车”。它是一套预置了项目结构、注册机制、日志框架、异常兜底、UI资源管理、版本兼容钩子的Visual Studio工程骨架。适合刚从录制宏跨入C#开发的工程师，也适合带团队做标准化工具链的资深开发者——前者靠它绕开注册表和COM互操作的黑匣子，后者靠它统一团队的代码规范与交付物形态。它不替代API文档，但能让你少查200次ISldWorks::GetUserPreferenceIntegerValue的参数含义。

2. 模板核心结构解析：为什么必须分层？为什么不能只用一个.cs文件？

SolidWorks二次开发不是写控制台程序，它的生命周期由SolidWorks主进程托管，UI线程、COM调用、模型事件回调全部耦合在宿主进程中。一个没有分层的单文件工程，三个月后连作者自己都看不懂哪个try-catch在捕获NullReferenceException，哪个Marshal.ReleaseComObject漏写了导致内存泄漏。这个模板强制拆解为四层，每层职责清晰、边界明确，且全部通过接口契约约束，不是靠注释约定。

2.1 主入口层（AddInMain.cs）：只做三件事，多一行都是负债

这是SolidWorks加载插件时唯一认的入口点，继承自SwAddin。它不做业务逻辑，只完成三件事：初始化全局服务容器、注册SolidWorks事件监听器、暴露命令到菜单/工具栏。所有具体功能必须下沉，否则调试时断点永远卡在ConnectToSW里出不来。

public class AddInMain : SwAddin { private IServiceProvider _serviceProvider; public override bool ConnectToSW(object ThisSW, int Cookie) { // 1. 构建服务容器（依赖注入起点） _serviceProvider = new ServiceContainer(); RegisterServices(_serviceProvider); // 2. 订阅关键事件（模型打开、保存、关闭） swApp = (SldWorks)ThisSW; swApp.FileOpenPostNotify += OnFileOpenPost; swApp.ActiveDocChangeNotify += OnActiveDocChange; // 3. 注册命令（菜单/工具栏按钮） CommandManager.RegisterCommand( "AutoBOM", "自动生成BOM表", () => _serviceProvider.GetService<IBomGenerator>().Execute()); return true; } }

提示：RegisterCommand是模板封装的方法，内部自动处理ICommandGroup创建、图标资源加载、命令ID分配。你只需传入命令名、描述、执行委托——避免手写CreateCommandGroup2时因BitmapPath路径错误导致图标显示为白方块。

2.2 服务层（Services目录）：把“操作SolidWorks”变成“调用接口”

这一层定义所有业务能力的抽象接口（如IBomGenerator,IDrawingExporter），并在实现类中封装具体的API调用。好处是：单元测试可Mock（不用启动SolidWorks）、功能替换零侵入（换BOM算法只需换实现类）、线程安全可控（所有COM调用统一在InvokeOnMainThread中调度）。

public interface IBomGenerator { Task<BomResult> ExecuteAsync(IModelDoc2 model, BomConfig config); } public class BomGeneratorImpl : IBomGenerator { private readonly SldWorks _swApp; private readonly IMainThreadInvoker _invoker; public BomGeneratorImpl(SldWorks swApp, IMainThreadInvoker invoker) { _swApp = swApp; _invoker = invoker; } public async Task<BomResult> ExecuteAsync(IModelDoc2 model, BomConfig config) { // 所有COM调用必须在主线程执行 return await _invoker.InvokeOnMainThreadAsync(() => { var bom = new BomResult(); // 此处调用model.GetBomTableAnnotations()等API return bom; }); } }

参数说明：BomConfig是纯数据类（无COM对象），含IncludeHiddenComponents: bool、SortBy: "PartNumber"等字段，避免将UI控件（如CheckBox）直接传入服务层，造成依赖污染。

2.3 UI层（Views目录）：WPF窗体与ViewModel分离，支持热重载

模板默认使用WPF而非WinForm，因WPF对高DPI适配更好，且INotifyPropertyChanged天然支持属性绑定。所有窗体（.xaml）与逻辑（.xaml.cs）严格分离，业务逻辑全在ViewModel中，且ViewModel通过构造函数注入服务层接口，彻底解耦。

<!-- BOMConfigView.xaml --> <TextBox Text="{Binding Config.PartNumberPrefix, UpdateSourceTrigger=PropertyChanged}" /> <CheckBox IsChecked="{Binding Config.IncludeStandardParts}" Content="包含标准件" /> <Button Command="{Binding GenerateCommand}" Content="生成BOM" />

// BOMConfigViewModel.cs public class BOMConfigViewModel : ViewModelBase { private readonly IBomGenerator _bomGenerator; private BomConfig _config; public BomConfigViewModel(IBomGenerator bomGenerator) { _bomGenerator = bomGenerator; _config = new BomConfig(); GenerateCommand = new RelayCommand(OnGenerate); } public BomConfig Config { get => _config; set => SetProperty(ref _config, value); // ViewModelBase基类提供INPC } private async void OnGenerate() { try { var result = await _bomGenerator.ExecuteAsync(CurrentModel, Config); MessageBox.Show($"生成成功：{result.RowCount}行"); } catch (Exception ex) { // 模板内置全局异常处理器，自动记录到日志并弹窗 Logger.Error(ex, "BOM生成失败"); } } }

注意：CurrentModel是ViewModel基类提供的IModelDoc2代理属性，由模板在窗体激活时自动注入当前活动文档，避免手动调用swApp.IActiveDoc2引发空引用。

2.4 基础设施层（Infrastructure目录）：解决90%新手卡点的底层支撑

这一层封装了所有“不该让业务代码操心”的脏活：

• COMObjectWrapper：自动Marshal.ReleaseComObject，避免内存泄漏（实测未释放IModelDoc2会导致SolidWorks内存占用每操作一次涨2MB）；
• RegistryHelper：按SolidWorks版本（2020/2022/2024）自动写入正确的注册表路径（HKEY_CURRENT_USER\Software\SolidWorks\AddIns64\{GUID}）；
• Logger：基于Serilog，日志文件按日期滚动，路径固定在%APPDATA%\SolidWorksAddIns\Logs\，方便售后排查；
• MainThreadInvoker：确保所有COM调用在UI线程执行，避免InvalidCastException（跨线程调用COM对象）。

// COMObjectWrapper.cs 使用示例 public class ModelWrapper : COMObjectWrapper<IModelDoc2> { public ModelWrapper(IModelDoc2 model) : base(model) { } public string GetTitle() => SafeInvoke(() => Target.GetTitle()); // 内部自动try-catch COM异常 } // 在服务中这样用： var model = new ModelWrapper(swApp.IActiveDoc2); string title = model.GetTitle(); // 即使Target为null，也不抛NullReferenceException

关键设计：COMObjectWrapper的SafeInvoke方法会捕获COMException并返回默认值（如string.Empty），而不是让异常穿透到上层业务逻辑——这是血泪经验：SolidWorks API在模型未完全加载时调用GetTitle()会抛0x80020009，不兜底则整个插件崩溃。

3. 快速上手：从新建项目到SolidWorks菜单出现按钮，三步走通

模板已预置完整VS项目（.csproj），支持.NET Framework 4.7.2+（SolidWorks 2018+要求），无需手动配置COM互操作、目标平台或引用路径。以下步骤在Visual Studio 2022中验证通过，全程无需管理员权限（注册表写入由安装程序完成，开发阶段用调试模式）。

3.1 步骤一：加载模板并修改标识信息

下载解压后，用Visual Studio打开SolidWorksAddInTemplate.sln。必须先修改三处标识，否则SolidWorks无法识别为合法插件：

1. 项目属性 → 应用程序 → 程序集信息：修改AssemblyTitle（如“某公司BOM工具V2.1”）、AssemblyDescription（如“自动生成符合GB/T 19001的BOM表”）；
2. AddInMain.cs →ConnectToSW方法内：修改Cookie值（整数，建议用年份+序号，如202401），此值需与注册表键名一致；
3. 项目属性 → 签名 → 为程序集签名：勾选“为程序集签名”，选择Key.snk（模板已提供），不可跳过——未签名的程序集在SolidWorks 2022+中会被拒绝加载。

提示：Key.snk是模板自带的强名称密钥，仅用于开发调试。正式发布时需替换为企业级证书，否则用户安装时会弹出“未知发布者”警告。

3.2 步骤二：编译并注册（调试模式）

右键项目 → “设为启动项目”，按F5启动调试。此时模板会自动执行：

• 编译生成SolidWorksAddInTemplate.dll；
• 调用RegAsm.exe注册DLL（路径取自VS安装目录，如C:\Program Files\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.8 Tools\RegAsm.exe）；
• 向注册表写入HKEY_CURRENT_USER\Software\SolidWorks\AddIns64\{GUID}，其中LoadAtStartup=1、Enabled=1；
• 启动SolidWorks（若未运行）并加载插件。

# 若F5失败，可手动执行注册（以管理员身份运行VS开发人员命令提示符） RegAsm.exe /codebase /tlb "bin\Debug\SolidWorksAddInTemplate.dll"

参数说明：/codebase写入DLL绝对路径到注册表，/tlb生成类型库供其他语言调用。模板已将此命令集成到项目“生成后事件”，正常情况无需手动。

3.3 步骤三：在SolidWorks中验证并触发命令

启动SolidWorks后：

• 查看菜单栏：应出现“工具 → 加载项 → SolidWorksAddInTemplate”（名称取自AssemblyTitle）；
• 查看工具栏：右侧应出现模板预置的“Hello World”按钮（图标为模板自带Resources\icon.png）；
• 点击按钮，弹出MessageBox显示“插件已加载”，证明COM注册、事件监听、命令路由全部通路。

验证技巧：若菜单不出现，检查注册表HKEY_CURRENT_USER\Software\SolidWorks\AddIns64\{GUID}下LoadAtStartup是否为1（DWORD值），Description是否为空（为空则SolidWorks忽略该插件）。

4. 避坑指南：五个让90%开发者停在第一步的真实问题

这些不是理论风险，是我在三个不同客户现场亲眼见过的翻车现场。每个问题都对应一个具体现象、根本原因和可立即执行的解决方案，照着做就能救活你的插件。

4.1 现象：SolidWorks启动后菜单无插件，注册表键存在但Enabled=0

原因：SolidWorks在启动时读取注册表，若发现插件DLL路径不存在、或DLL未签名、或DLL依赖的.NET Framework版本不匹配，会自动将Enabled设为0并静默失败。
解决：

1. 用Dependency Walker（或dotnet-dump）检查SolidWorksAddInTemplate.dll是否缺失System.Windows.Forms.dll等依赖；
2. 在注册表中手动将Enabled改为1，然后重启SolidWorks；
3. 永久方案：在项目属性 → 发布 → 启用“为ClickOnce应用程序启用可信发布者”，并勾选“.NET Framework 4.7.2”作为必备组件。

4.2 现象：点击按钮后SolidWorks无响应（假死），任务管理器中SLDWORKS.exeCPU占满100%

原因：在非UI线程中直接调用SolidWorks API（如model.Extension.SelectByID2），触发COM线程模型冲突，导致消息循环阻塞。
解决：

• 检查所有服务实现类，确保COM调用均包裹在_invoker.InvokeOnMainThreadAsync中；
• 禁用任何Task.Run(() => { /* COM调用 */ })写法；
• 在AddInMain.cs的ConnectToSW中添加日志：Logger.Info("主线程ID: {ThreadId}", Thread.CurrentThread.ManagedThreadId)，确认插件确实在UI线程初始化。

4.3 现象：窗体打开后显示空白，或控件位置错乱，高DPI缩放失效

原因：WPF窗体未声明DPI感知，Windows将其虚拟化为96dpi渲染，再放大像素，导致模糊和布局偏移。
解决：

• 在项目app.manifest中取消注释以下行：

  <application xmlns="urn:schemas-microsoft-com:asm.v3"> <windowsSettings> <dpiAware xmlns="http://schemas.microsoft.com/SMI/2005/WindowsSettings">true</dpiAware> <dpiAwareness xmlns="http://schemas.microsoft.com/SMI/2016/WindowsSettings">PerMonitorV2</dpiAwareness> </windowsSettings> </application>

• 在App.xaml.cs的OnStartup中添加：

  System.Windows.Forms.Application.EnableVisualStyles();

4.4 现象：生成的BOM表中文乱码，或Excel导出后字体为宋体而非指定微软雅黑

原因：SolidWorks API返回的字符串是UTF-16，但部分导出方法（如ExportToExcel）默认用系统ANSI编码写入，中文字符被截断。
解决：

• 所有文本导出必须显式指定编码：

  File.WriteAllText(filePath, bomContent, Encoding.UTF8); // 替代默认Encoding.Default

• Excel导出时，用Microsoft.Office.Interop.Excel而非SolidWorks原生方法，并设置Range.Font.Name = "Microsoft YaHei"。

4.5 现象：插件在SolidWorks 2022中正常，升级到2024后报System.Runtime.InteropServices.COMException (0x80040154)

原因：SolidWorks 2024将部分API移至新命名空间（如ISwDrawingsManager替代旧版IDrawingDoc），但模板引用的P/Invoke头文件未更新。
解决：

• 下载SolidWorks 2024 SDK，替换项目中Interop.SOLIDWORKS.dll（位于References节点）；
• 在AddInMain.cs顶部添加条件编译：

  #if SW2024 using SwApi = SolidWorks.Interop.sldworks2024; #else using SwApi = SolidWorks.Interop.sldworks; #endif

• 关键动作：在项目属性 → 生成 → 条件编译符号中添加SW2024，按SolidWorks版本切换。

5. 进阶实战：如何把模板变成你团队的“标准开发流水线”

模板的价值不在开箱即用，而在可定制、可扩展、可审计。我带过的某高校实验室曾用此模板支撑7个学生项目，从零件库自动建模到焊接工艺仿真，全部基于同一套骨架。他们落地的关键不是功能多，而是建立了三条铁律：所有新功能必须通过接口注入、所有UI变更必须经Figma评审、所有COM调用必须有超时熔断。下面分享一个真实落地技巧——如何用模板快速构建“参数化建模向导”，并规避最隐蔽的坑。

5.1 场景：为某型减速器设计参数化建模向导（输入中心距、传动比，自动生成齿轮箱体）

传统做法是写一堆IFeatureManager::FeatureExtrusion3调用，但维护成本极高。我们改用模板的“向导引擎”模式：将建模步骤拆解为独立IStepExecutor，每个步骤专注一件事（如“创建基准面”、“拉伸箱体”、“打孔”），并通过IWizardContext共享参数与模型状态。

public interface IStepExecutor { string StepName { get; } // 显示在向导页标题 bool CanExecute(IWizardContext context); // 判断是否满足执行条件 Task ExecuteAsync(IWizardContext context, IProgress<StepProgress> progress); } // 具体步骤实现 public class CreateBoxBodyStep : IStepExecutor { public string StepName => "创建箱体"; public async Task ExecuteAsync(IWizardContext context, IProgress<StepProgress> progress) { var model = context.CurrentModel; var params = context.Parameters; // 1. 创建前视基准面（确保在XY平面） var sketch = await _sketchService.CreateSketchOnPlane(model, "Front Plane"); // 2. 绘制矩形（使用参数化尺寸） await sketch.DrawRectangle(params.CenterDistance * 1.2, params.CenterDistance * 0.8); // 3. 拉伸（厚度取参数） await _featureService.Extrude(sketch, params.BodyThickness); progress?.Report(new StepProgress { Message = "箱体创建完成", Percent = 100 }); } }

核心设计：IWizardContext是线程安全的共享上下文，内部用ConcurrentDictionary<string, object>存储参数，避免多步骤间用静态变量传值——这是血泪教训：某次学生在CanExecute中修改了静态bool isReady，导致向导页状态错乱。

5.2 防御性编程：为每个COM调用添加超时与重试

SolidWorks在大型装配体中执行FeatureExtrusion3可能卡住10秒以上，若无超时，整个向导冻结。模板的COMObjectWrapper已预留TimeoutMs参数，但需在调用时显式启用：

public class FeatureService : IFeatureService { private readonly COMObjectWrapper<IModelDoc2> _modelWrapper; public FeatureService(IModelDoc2 model) { _modelWrapper = new COMObjectWrapper<IModelDoc2>(model, timeoutMs: 5000); // 5秒超时 } public async Task<IModelDoc2> Extrude(ISketch sketch, double thickness) { return await _modelWrapper.SafeInvokeAsync( () => sketch.FeatureExtrusion3(...), // 实际API调用 onTimeout: () => { Logger.Warn("Extrude超时，尝试重试..."); return sketch.FeatureExtrusion3(...); // 重试一次 }); } }

参数说明：SafeInvokeAsync是模板扩展方法，内部用CancellationTokenSource控制超时，并捕获COMException与TimeoutException。onTimeout委托在超时后执行，此处设计为重试一次——实测80%的超时是SolidWorks临时卡顿，重试即可恢复。

5.3 可审计性：所有建模操作自动记录到JSON日志

向导执行完毕后，生成model_log_20240520.json，内容含时间戳、参数快照、每步耗时、COM调用堆栈。这不仅是调试依据，更是交付物的一部分（客户要求“证明建模过程符合ISO 12345”）。

{ "timestamp": "2024-05-20T14:22:31.123Z", "parameters": { "centerDistance": 120.0, "gearRatio": 3.5 }, "steps": [ { "name": "创建箱体", "durationMs": 2340, "comCalls": ["CreateSketchOnPlane", "DrawRectangle", "FeatureExtrusion3"] } ], "solidworksVersion": "SOLIDWORKS 2024 SP2.0" }

实现方式：在IWizardEngine的RunAsync方法中，用Stopwatch计时每步，并在finally块中序列化日志：

public async Task RunAsync(IReadOnlyList<IStepExecutor> steps) { var log = new WizardLog { Timestamp = DateTime.UtcNow, Parameters = _context.Parameters }; foreach (var step in steps) { var watch = Stopwatch.StartNew(); try { await step.ExecuteAsync(_context, _progress); } finally { watch.Stop(); log.Steps.Add(new StepLog { Name = step.StepName, DurationMs = watch.ElapsedMilliseconds }); } } File.WriteAllText( Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "SolidWorksAddIns", "Logs", $"model_log_{DateTime.Now:yyyyMMdd}.json"), JsonSerializer.Serialize(log, new JsonSerializerOptions { WriteIndented = true }) ); }

从那以后我每次启动新项目，都强制走一遍dotnet restore→build→regasm→SolidWorks启动验证全流程，哪怕只是改了一个字符串。因为SolidWorks二次开发的后悔药，从来不是Ctrl+Z，而是日志里那一行COMException (0x80020009)的堆栈。希望帮到你。

本文还有配套的精品资源，点击获取