VS Method 开发插件:脱离浏览器的专业代码编写
在 Aras 基础开发中,服务端(C#)和客户端(JS)的代码被称为 Method(方法)。系统默认提供的编写方式是在 Aras 客户端网页浏览器中的富文本输入框内直接敲代码。
这种传统网页编写方式存在严重的效率和质量问题:
- 无智能提示 (No IntelliSense):无法自动提示 Aras.IOM 的 API 方法和参数。
- 编译报错不友好:只有把代码提交到数据库并执行时,才能在错误弹窗里看到行号,且错误定位往往不准确。
- 无法离线编辑:无法利用专业的 Git 工具对单一 Method 文件进行细粒度的版本比对。
为了解决这些痛点,Aras 官方提供了 Visual Studio Method Developer Plugin (VS 插件),使开发人员能在专业的 IDE 下享受工业级的开发体验。
1. 插件安装与项目创建
1.1 安装插件
- 启动 Visual Studio(支持 VS 2019/2022)。
- 在扩展菜单(Extensions)中搜索 “Aras Innovator Method Developer Tool” 并下载安装(也可从官方提供的
.vsix文件本地安装)。 - 安装完成后,重启 Visual Studio。
1.2 创建 Method 项目
- 在 VS 中点击
Create a new project(新建项目)。 - 在模板列表里选择 Aras Innovator Method Project。
- 输入项目名称和存放路径(建议将该路径直接作为本地 LDE 对应 Git 分支目录下的子文件夹,方便代码纳入版本管控)。
2. 项目物理结构
项目创建成功后,VS 会自动生成标准的工程目录结构:
text
MyArasMethods/
├── MyArasMethods.sln # Visual Studio 解决方案文件
├── MyArasMethods.csproj # C# 项目工程文件
├── App.config # 存储 Aras Server 连接信息的配置文件
├── ServerMethods/ # 存放 C# 服务端方法的目录
│ ├── CalculatePrice/
│ │ ├── method.cs # 核心 C# 逻辑代码物理文件
│ │ └── method.metadata.xml # 该 Method 在 Aras 中的元数据定义(执行类型、事件等)
└── ClientMethods/ # 存放 JS 客户端方法的目录
└── ValidateInput/
├── method.js # 核心 JS 逻辑代码物理文件
└── method.metadata.xml- C# 物理文件 (
.cs):开发人员可以在其中编写符合 .NET Framework / .NET Core 规范的逻辑。所有的智能感知(IntelliSense)、命名空间引用(如using Aras.IOM;)都能完美支持。 - 元数据 XML (
.metadata.xml):这是一种描述性文件,记录了该方法在 Aras 数据库中的一些非代码属性,例如它的类型(C#、VB或JavaScript)、它的模板分类、以及它所需的执行权限控制等。
3. 配置服务器连接与双环境认证
要想在 VS 和 Aras Innovator 之间架起双向通信桥梁,必须在插件中配置连接配置:
- 打开插件工具栏:在 VS 菜单中选择
Tools -> Aras Method Editor -> Connection Config。 - 填写连接详情 (Connection Details):
- Server URL:本地开发环境的 Innovator 地址(如
http://localhost/InnovatorServer)。 - Database:本地 LDE 的数据库名称(如
InnovatorDB)。 - Username / Password:通常填
admin或具有开发者权限的特定账号。
- Server URL:本地开发环境的 Innovator 地址(如
- 测试连接成功后,配置会被安全地保存在本地
App.config中,此配置文件在提交到 Git 团队主仓库时应被排除(通过.gitignore),因为每个开发者的本地连接参数可能有差异。
4. 核心工作流:拉取、编写与同步
使用插件开发的核心流程,总结为“本地拉取、离线修改、一键同步、Git 提交”:
4.1 拉取方法 (Download Method)
- 在 VS 中右键项目,选择
Open Method from Aras。 - 在弹出的检索网格中,输入关键字搜索已存在的 Method。
- 插件会自动把服务器上的这段代码打包成本地的
.cs(或.js)和.metadata.xml文件,并自动加入当前项目管理。
4.2 编写与调试
- 你可以使用 VS 完整的重构功能、变量改名提示。
- 可以通过单元测试工程引用该 Method,或直接在本地 LDE IIS 上附加进程(Attach to Process
w3wp.exe)对 Method 的执行流进行断点调试。
4.3 同步更新 (Upload Method)
- 代码修改完成并通过本地语法编译后,右键该文件选择
Upload Method to Aras。 - 插件会在后台快速构建一个 AML 请求,通过 IOM API 直接覆盖服务器上对应的 Method 内容。数据库里的逻辑会立即更新,用户在网页端刷新操作便能立刻体验到最新代码效果。
