磐石微服务开发辅助工具介绍

概述

磐石微服务开发辅助工具是一个面向中南院内部开发团队的 Visual Studio 扩展插件，主要用于提升日常开发效率、统一项目初始化流程，并辅助常见的工程配置维护工作。

插件当前运行于 Visual Studio 扩展体系中，提供了创建项目、配置文件维护、技能包更新、包版本更新、环境清理和日志查看等能力，适合作为内部项目研发过程中的辅助工具。

插件入口

插件安装后，会在 Visual Studio 的“扩展”菜单中提供 磐石微服务开发辅助工具 主菜单。

当前菜单结构如下：

• 创建项目
• 项目配置管理
  • 数据库配置
  • Redis 配置
  • MongoDB 配置
• 技能更新
• Zny 包更新
• 打开最新日志

核心功能

1. 创建项目

用于基于预置模板快速创建项目。

主要能力：

• 自动识别当前是否已打开解决方案
• 支持在当前解决方案目录下创建项目
• 在未打开解决方案时支持手动选择目标目录
• 通过对话框收集项目初始化所需信息

适用场景：

• 快速初始化符合团队规范的新项目
• 减少重复的目录搭建和模板拷贝工作

2. 数据库配置

用于修改目标配置文件中的数据库连接配置。

主要能力：

• 自动扫描可配置的 appsettings*.json 文件
• 支持多种数据库类型配置
• 根据数据库类型调整可填写字段
• 将数据库连接信息写回目标配置文件
• 支持带注释的 JSON 配置文件读取

适用场景：

• 本地调试环境数据库切换
• 项目配置初始化和连接串维护

3. Redis 配置

用于修改目标配置文件中的 Redis 相关配置。

主要能力：

• 选择目标配置文件
• 支持启用或关闭 Redis
• 启用时填写服务地址、端口、密码和缓存 DB 号
• 自动写入以下配置项：
  • AppSettings:EnableRedis
  • AppSettings:RedisCacheDB
  • AppSettings:RedisExchangeHosts
• 当未启用 Redis 时，仅写入启用开关

适用场景：

• 本地或测试环境的 Redis 开关控制
• Redis 连接参数统一维护

4. MongoDB 配置

用于修改目标配置文件中的 MongoDB 连接配置。

主要能力：

• 选择目标配置文件
• 支持启用或关闭 MongoDB
• 启用时填写服务地址、端口、用户、密码、认证库和可选参数
• 自动写入：
  • AppSettings:EnableMongoDB
  • AppSettings:MongoServerSettingString
• 自动生成标准 MongoDB 连接字符串
• 对用户、密码、认证库中的特殊字符进行 URL 编码
• 当未启用 MongoDB 时，仅写入启用开关

适用场景：

• MongoDB 本地连接参数维护
• 包含特殊字符账号密码的连接串生成
• 多环境配置切换

5. 技能更新

用于维护并更新本地技能包配置。

主要能力：

• 读取本地技能包清单
• 支持通过对话框编辑技能包 ID
• 保存技能包配置
• 执行技能包更新并输出结果摘要

适用场景：

• 更新本地开发辅助技能
• 保持技能包配置与团队要求一致

6. Zny 包更新

用于更新当前项目中的 Zny 相关 NuGet 包。

主要能力：

• 面向当前项目执行包版本更新
• 汇总更新结果并显示给用户
• 同时写入日志，便于后续追踪

适用场景：

• 对当前项目进行依赖升级
• 统一维护 Zny 系列包版本

7. 打开最新日志

用于快速打开插件最近生成的日志文件。

主要能力：

• 定位最新日志文件
• 使用系统默认方式打开日志文件
• 打开失败时给出提示信息

适用场景：

• 排查插件执行失败原因
• 查看命令执行过程和输出记录

配置文件处理特性

当前插件在配置类功能中具备以下统一能力：

• 自动扫描 appsettings*.json
• 支持带注释和尾随逗号的 JSON 配置读取
• 使用统一的配置文件发现与写入逻辑
• 通过对话框方式完成配置项编辑

日志与错误提示

插件中的部分命令会记录执行日志，并在出现问题时通过弹窗给出明确提示。

当前日志能力主要用于：

• 记录命令开始与结束
• 记录保存结果
• 记录异常或失败原因

这有助于快速定位插件执行过程中的问题。

适用人群

ZnyTools 主要适用于：

• 中南院内部开发人员