IDEA助手操作手册（协同开发平台在线构建）

IDEA助手操作手册

1 IDEA助手下载与安装

1.1 IDEA助手下载

（1）下载地址：点此下载

（2）支持版本说明：

IDEA助手目前支持的IDEA版本为支持IntelliJ IDEA  2021.3.x~2023.2.x 版本，本操作手册中的示例，使用的IDEA版本为IntelliJ IDEA 2023.2.5 (Community Edition)，并提前安装中文插件。

1.2 插件安装方法

步骤一：打开IDEA界面，依次点击【文件】【设置】【插件】【小齿轮】【从磁盘安装插件】，如下图：

步骤二：选择本地已提前下载好的插件安装文件，点击【确定】，如下图：

步骤三：待插件安装完毕后，点击【重启IDE】，如下图：

步骤四：当IDEA重启完毕，菜单栏显示【苍穹开发助手】即代表安装成功，如下图：

步骤五：Git软件安装，进入【文件】【设置】【版本控制】【Git】，若当前PC没有提前安装Git版本管理客户端软件，可使用IDEA自带的安装功能进行安装，点击【下载并安装】后，IDEA会自行下载并安装最新版本的Git软件（若自行安装，请使用Git-2.37.1-64-bit版本或以上）如下图：

步骤六：测试本地已安装的Git软件能正常运行，并在IDEA中测试成功，如下图所示：

2 苍穹Gradle工程初始化

功能所支持的场景描述：协同开发平台新增项目，开通代码托管功能后，代码仓只包含四个空目录（code、deatmodel、docs、webapp）及一个工程描述文件（cosmic.json），对于实施用户，可提前进行元数据的上传等的操作，但对于开发人员此刻还无法进行插件代码开发，需要架构师使用IDEA助手的“Gradle工程初始化”功能将插件工程进行初始化并提交至仓库，方便团队成员后期进行协同开发。

2.1 使用IDEA助手初始化工程

步骤一：【文件】【新建】【项目】【北斗项目工程】，依次点击下一步，如下图：

步骤二：进入【代码仓地址配置】界面，填写【代码仓的地址】及【本地项目的名称】及【项目目录】，点击【下一步】，如下图：

步骤三：IDEA助手会自动弹出git仓库的鉴权界面，输入代码仓的用户账号及密码，如下图：

步骤四：当小助手连通代码仓后，会自动进入【工程信息填写】界面，填写完毕后点击【完成】，如下图：

字段填写说明：

1） 苍穹模板：星空旗舰版推荐使用“一个云一个工程”的工程模板，星瀚项目建议选择“一应用一工程”、“一应用多工程”的工程模板；

2） 开发商标识、项目标识：自动从远程代码仓的工程配置文件自动带出，用户无需填写，不能修改；

3） 云标识：用户自定义，填写云编码，必填；

4） 应用标识：用户自定义，填写应用编码，“一个云一个工程”工程模板非必填，其他工程模板必填；

5） 服务器信息：根据实际环境搭建情况，填写开发服务器的资源下载地址（本地工程构建的依赖包需从开发服务器下载）、MC地址、zookeeper地址（链接需带上zk账号和密码）；

步骤五：点击【完成】后，IDEA会自动开始本地工程的创建及配置，主要完成以下操作（全程无需用户干预，以下3个步骤均为工具自动完成）：

1）按用户所选择的工程模板创建Gradle工程目录结构。

2）从用户指定的开发服务器自动下载本地工程所需的构建依赖jar包。

3）自动引入已下载的苍穹工程构建依赖包，并刷新Gradle工程。

2.2 将工程提交至代码仓

步骤一：进入IDEA的Git管理界面，选择需要提交到代码仓的文件。特别提示：如果是第一次初始化代码仓，请将IDEA小助手创建的所有工程文件都提交到代码仓，否则在线构建可能会失败，工程自带默认的.gitignore文件已经为大家过滤了不需要提交的文件，如.idea .gradle等，如下图所示：

步骤二：填写本次commit日志，本示例以“代码仓初始化”为例，并选择【提交并推送】，将代码提交至本地仓库并推送至远程仓库，如下图所示：

步骤三：等待idea提交进程完成后，检查并查看远程仓库日志，检查代码是否已被成功提交，如下图所示：

3 苍穹工程日常团队开发

功能所支持的场景描述：当架构师将代码仓初始化完毕后，团队成员可以通过以下方法进行项目协同开发，实现插件代码开发及本地调试。

3.1 通过IDEA助手拉取已初始化的北斗项目

步骤一：【文件】【新建】【项目】【北斗项目工程】，依次点击下一步，进入代码仓地址填写界面，填写已被初始化的代码仓地址及本地工程存放目录、本地工程名称，如下图所示：

步骤二：输入kingcode账号和密码后，idea助手会自动链接代码仓，自动判断代码仓的状态，如果代码仓已经进行过初始化，则只需要填写简要信息即可完成本地工程搭建，如下图所示：

字段填写说明：

1）苍穹资源目录：用户自定义，指定本地存放构建依赖的目录。

2）苍穹资源地址：根据实际环境搭建情况，填写开发服务器的资源下载地址（本地工程构建的依赖包需从开发服务器下载）

步骤三：上一步点击【完成】后，IDEA助手会自动从开发服务器下载苍穹构建依赖并自动引入依赖关系，待idea后台进程运行完毕，开发者本地工程即搭建完毕，如下图：

3.2 运行本地debug工程

步骤一：打开DebugApplication.java点击【运行】按钮，如下图所示：

注意：一般情况下，同一个项目的开发成员使用的开发服务器是同一个，故DebugApplication.java中的mc地址、zk地址都不需要修改就能直接运行。

    特殊情况下，若同一项目开发成员使用的开发环境不同（不推荐），则需要对DebugApplication.java中的mc地址、zk地址进行修改，并根据对接的开发服务器重新下载并更新构建依赖，才能成功运行debugserver。

步骤二：稍候片刻，待本地debugserver启动后，可通过http://127.0.0.1:8881/ierp/login.html 访问本地环境，如下图所示：

4 三方包的引入（临时方案）

当项目工程若使用到第三方jar包，可以通过以下方式引入：

步骤一：将三方包放到工程code/lib目录下，刷新gradle工程，即可实现三方包的引用：

步骤二：引入三方包后，在本地构建测试成功后，可以将本地工程lib文件夹的文件改动提交至远程仓库后进行在线构建，生成的补丁包会内置工程lib目录内提交的三方包(在zip包的trds目录下)，如下图：

5 工程新增子模块

功能所支持的场景描述：当工程需要新增子模块的时候，可以通过IDEA助手的新增子模块功能进行新增，只需录入新的云编码、应用编码，助手会自动根据工程模板类型，自动添加子模块。以下以“一云一工程”模板为例作演示，其他模板如此类推。

步骤一：【文件】【新建】【新模块】【北斗项目工程】，填写【云标识】后点击【完成】（由于是新增模块，故“开发商标识”、“项目标识”由原工程继承，用户无法修改）

步骤二：静候片刻，待IDEA进程运行完毕，cloud02子模块自动新建完毕，如下图：

6 常见问题

1） 初始化代码仓时，填写了代码仓地址点击【下一步】，没有弹出git仓库的登录认证，助手直接进入了【填写工程信息】界面。

解决方法：无需解决，继续填写工程信息即可。没有弹出登录认证，可能是用户本地已经提前登录过kingcode，凭据已经被存储在本地缓存中所以自动校验通过，windows本地凭证如下图，删除后会重新弹出kingcode的登录认证：