华为云CodeArts IDE Online对接使用完全指南:从零搭建云端开发环境
引言:云原生时代的开发新范式
在云原生与DevOps深度融合的软件开发浪潮中,传统的本地集成开发环境正面临着诸多挑战:环境配置复杂、跨设备开发困难、团队协作不便、本地资源受限等。华为云CodeArts IDE Online作为一款云端开发环境服务,正是为解决这些问题而生。开发者通过浏览器即可极速获取云端开发环境,支持编码、调试、运行、预览,还可访问代码仓库和执行命令行,同时支持丰富的插件扩展。本文将从零开始,系统讲解华为云CodeArts IDE Online的对接与使用方法,帮助开发者快速上手并充分利用这一强大的云端开发工具。
需要先登录华为云控制台,点击:华为云控制台,还没有账号,点击:注册并关联,已有账号点击:登录后关联
一、CodeArts IDE Online产品概述
1.1 什么是CodeArts IDE Online
CodeArts IDE Online是华为云提供的云端开发环境服务,向开发者提供按需配置、快速获取的工作空间(包含编辑器和运行环境),支持完成环境配置、代码阅读、编写代码、构建、运行、调试、预览等操作,并支持对接多种代码仓库。其核心价值在于将开发环境从本地桌面迁移到云端,使开发者能够随时随地通过浏览器进行软件开发。
该服务依托华为云的计算和存储资源,实现云化开发环境供给,用户工作空间基于全容器技术,极短时间即可按用户所需配置启动并提供服务,用后可随时释放。这种按需使用的模式彻底改变了传统开发环境“预支”资源的方式,转变为真正的“按需”获取。
1.2 核心特性
CodeArts IDE Online具备以下核心特性:
- 一键式环境获取:只需十秒即可获得一个支持编码、调试、运行、测试的云上开发环境。开发者无需手动安装编译器、配置环境变量、安装依赖库,所有环境准备工作由系统自动完成。
- 浏览器访问,跨平台开发:通过浏览器即可访问不同计算架构(ARM和X86)的开发环境,不限设备和操作系统,不需安装软件不占内存。一个开发者可以同时使用多个开发环境,不受限于本地配置。
- 多语言与技术栈支持:支持100多种语言的语法高亮,支持主流开发语言的语法提示和自动补齐。预置了Java、C/C++、Python、Node.js、Go、All in One、Blockchain等多种技术栈。All in One技术栈集成了Java、C/C++、Python、Node.js、Go多种语言,如果只需要使用某一种语言开发项目,建议选择对应的技术栈类型,效率更高。
- 在线运行和调试:支持在线调试和在线运行,构建和运行配置可修改,断点调试能力与本地IDE保持一致。容器化的运行环境可以构建和执行代码,并可查看运行结果及输出日志。
- 无缝对接代码仓库:无缝对接CodeArts代码托管服务,同时支持其他Git类的配置管理系统。支持对接Git配置库,实现Commit、Branch、Push等操作,支持第三方代码仓库(如GitHub)。
- 企业权限管控:针对企业租户提供资源使用管控和实例访问授权能力,支持简化的黑名单和白名单权限管理。提供基于黑白名单的访问控制能力,为企业租户提供掌控子用户行为的管理面。
- 插件生态扩展:兼容业界最广泛使用的插件标准,提供独立的插件市场,支持注册发布商,支持插件开发所需的开放标准、开源框架、打包工具和插件全生命周期管理。开发环境桌面支持不同配色风格,插件位置可根据需要自由编排。
1.3 适用场景
CodeArts IDE Online主要适用于以下场景:
- 服务化Web应用开发:开发者受限于无本地环境无法开发时,通过Web直接访问CodeArts IDE Online,实现随时随地开发。
- 快速搭建一致的开发环境:适用于基于容器的服务化Web应用开发,保障快速搭建一致的开发环境,随时在线编写代码。
- 团队协作与代码检视:代码检视者可以一键打开代码查看和运行,集成于代码托管仓库。
- 临时性开发任务:对于短期项目、原型验证、Bug修复等临时性开发任务,无需搭建本地环境即可快速投入工作。
二、使用前的准备工作
2.1 注册华为云账号并实名认证
在使用CodeArts IDE Online之前,需要先完成以下两项准备工作。如果您已有一个华为云账号,请忽略这一步。如果您还没有华为云账号,请参考以下步骤创建:
- 登录华为云官网,单击右上角“注册”。
- 根据提示信息完成注册,注册成功后系统会自动跳转至您的个人信息界面。
- 参考实名认证完成个人或企业账号实名认证。
2.2 为账户充值
您可以免费试用CodeArts IDE Online。若您决定正式使用,享受完整功能的服务,您需要确保账户有足够的金额。关于CodeArts IDE Online价格,请参见价格详情。关于充值,请参见账户充值。
2.3 了解权限管理
在使用CodeArts IDE Online服务之前,您需要先了解本服务的相关权限说明以及如何进行权限管理。如果华为云账号可以满足用户对权限管理的需求,则不需要创建独立的IAM用户。如果需要精细的权限管理,可以使用统一身份认证服务(IAM),通过IAM可以:根据企业的业务组织,在华为云账号中给不同职能部门的员工创建IAM用户,让员工拥有唯一安全凭证使用CodeArts IDE Online资源。
三、创建与配置IDE实例
3.1 进入CodeArts IDE Online管理控制台
登录CodeArts IDE Online管理控制台。进入CodeArts IDE Online服务“我的IDE”页签。
3.2 新建IDE实例
单击左上角“新建实例”,创建IDE实例。进入到“基础配置”页面,参考下表配置参数:
基础配置参数说明
- 名称:自定义实例名称。支持输入数字、字母、“_”、“.”和“-”,以数字、字母开头和结尾,长度为3~100。
- 描述:可选参数,对实例的描述,长度不超过100个字符。
- 技术栈:根据实际需求选择技术栈类型。目前支持的技术栈类型包括:All in One、Java、C/C++、Python、NodeJS、Go、Blockchain。选择技术栈标签作为过滤条件,标签可以单独选择,也可以组合使用。
- CPU架构:支持两种CPU架构——鲲鹏计算(精简指令集RISC)和X86计算(复杂指令集CISC)。
- CPU/内存:系统根据所选技术栈默认匹配对应配置。arm架构支持4U8G,x86架构支持1U1G、2U4G、2U8G。
- 存储容量:支持三种存储容量:5GB、10GB、20GB。
- 自动休眠:实例无操作超过一段时间后将会被自动休眠,如需操作实例需重新启动实例。支持配置五种休眠时间:30分钟、60分钟、4小时、24小时、永不休眠。arm架构自动休眠时长只能设置成30或60分钟;x86架构可取值为30、60、240、1440和-1(-1表示实例不会自动停止)。
3.3 工程配置
单击“下一步”,进入“工程配置”页面。请根据需要选择工程来源:
- 样例工程:选择系统预置的工程模板,快速创建示例项目。工程名称可以输入字母、数字、连字符、下划线,字符介于1~127之间。根据上一步选择的“技术栈”类型不同,对应的“工程模板”也不同。
- 私有仓库:从代码托管服务中已有的代码仓库导入项目。需要选择项目名称(来源于需求管理服务中已创建或具有权限的项目)、仓库地址(来源于代码托管中的代码仓库,需选择同一Region下的代码仓库)和分支。
- 不创建工程:跳过创建工程,直接创建空白实例。
设置完参数单击“确定”,IDE实例创建完成,系统自动进入CodeArts IDE Online工作界面。
3.4 实例管理操作
创建IDE实例后会自动启动IDE实例,也可以在CodeArts IDE Online服务“我的IDE”页签单击实例卡片上的启动按钮来启动IDE实例。进入CodeArts IDE Online首页可以查看已创建的IDE实例列表。可以单击IDE实例所在区域的编辑按钮对实例进行修改。需要注意的是,IDE实例只有创建者可见,IDE实例删除后数据不可恢复。
四、代码仓库对接
4.1 对接CodeArts Repo代码托管服务
CodeArts IDE Online无缝对接CodeArts代码托管服务。在创建IDE实例的工程配置阶段,选择“私有仓库”作为工程来源,即可从CodeArts Repo中导入项目代码。
具体操作步骤如下:
- 进入CodeArts项目,单击导航“代码 > 代码托管”。
- 在代码托管服务中创建或导入代码仓库。
- 在CodeArts IDE Online新建实例的工程配置中,选择“私有仓库”。
- 选择对应的项目名称、仓库地址和分支。
- 完成实例创建后,代码将自动导入到IDE工作空间中。
4.2 对接第三方Git仓库
CodeArts IDE Online支持对接第三方代码仓库(如GitHub)。开发者可以在IDE实例中通过Git命令或图形化操作来克隆、提交和推送代码到第三方仓库。
在IDE实例中操作第三方Git仓库的基本流程:
# 在IDE终端中克隆第三方仓库
git clone https://github.com/username/repository.git
# 进入项目目录
cd repository
# 查看远程仓库配置
git remote -v
# 添加新的远程仓库(如需要)
git remote add upstream https://github.com/upstream/repository.git
# 提交本地更改
git add .
git commit -m "提交信息"
# 推送到远程仓库
git push origin main
如果用户已经克隆了一个远程Git仓库,那么与原始克隆位置链接的远程仓库将自动配置,但用户可以添加任意多个远程仓库。建议设置一个凭据助手,以避免每次CodeArts IDE与Git远程仓库通信时都被要求输入凭据。
4.3 代码提交与同步
CodeArts IDE状态栏允许用户运行“同步更改”命令,将远程更改拉取到本地仓库,然后将本地更改的代码提交推送到上游分支。用户还可以通过状态栏创建新分支并在分支之间切换。在CodeArts IDE Online中,可以编写代码,并对代码进行提交、构建和运行。
五、通过ROMA Connect连接器对接
5.1 连接器概述
CodeArts IDE Online连接器用于对接华为云CodeArts IDE Online服务。通过ROMA Connect平台,可以将CodeArts IDE Online集成到更广泛的企业应用与数据集成场景中。
5.2 创建CodeArts IDE Online连接
在ROMA Connect中创建CodeArts IDE Online连接器的步骤如下:
- 登录ROMA Connect管理控制台。
- 在左侧导航栏选择“连接器”,在连接器页面单击“新建连接”。
- 选择“CodeArts IDE Online”连接器。
- 在弹窗中配置连接器信息。
连接器配置参数说明:
- 连接名称:填写连接器实例名称。
- 描述:填写连接器的描述信息,用于识别不同的连接器。
- Access Key:当前账号的AK(Access Key ID)。请参考访问密钥获取AK,如果已生成过AK/SK,找到原来已下载的AK/SK文件,文件名一般为credentials.csv。
- Secret Access Key:当前账号的SK(Secret Access Key)。请参考访问密钥获取SK。
5.3 支持的操作
通过CodeArts IDE Online连接器,可以执行以下操作:
- 查询IDE实例列表
- 创建IDE实例
- 查询某个租户下的IDE实例列表
- 停止IDE实例
- 启动IDE实例
- 删除IDE实例
- 修改IDE实例
- 查询某个IDE实例
- 查询IDE实例名是否重复
5.4 连接器配置参数
CodeArts IDE Online连接器支持丰富的配置参数:
- region_id:区域ID
- limit:每页显示的条目数量,最大值为100,最小值为1
- offset:偏移量,表示从此偏移量开始查询
- is_temporary:是否页面显示(以标签配置为准)
- label:标签
- search:关键字查询(根据实例名、描述模糊查询)
- sort_dir:排序方式 asc/desc
- sort_key:排序字段(display_name、status、pvc_quantity、created_time、stack_id)
- org_id:租户ID(对应华为云账号的domainId)
- arch:CPU架构,x86或arm
- cpu_memory:CPU规格
- description:描述
- display_name:实例名
- plugin_enable_list:预装插件列表
- plugin_vars:预装插件参数(请注意敏感信息保护)
- pvc_quantity:PVC规格,如5GB|10GB|20GB
- refresh_interval:自动休眠时长
六、基于REST API的对接开发
6.1 API概述
CodeArts IDE Online提供了REST风格API,支持您通过HTTPS请求调用。您可以在API Explorer中调用API,查看API请求和返回结果。此外,API Explorer会自动生成相应API调用示例,帮助您使用API。
6.2 核心API接口
CodeArts IDE Online提供的主要API接口包括:
- 创建自定义IDE实例(CreateIDEInstance):帮助您根据特定需求配置开发环境。
- 设置IDE实例对插件的授权(CreateExtensionAuthorization):设置IDE实例对插件的授权,包含同意、不同意、未知(下次重新询问)等信息。
- 创建Shell实例(CreateShellInstance):根据传递场景参数创建Shell实例。
- 查询某个IDE实例对应技术栈部署(ShowInstanceTechStack):查询某个IDE实例对应技术栈部署的详细信息。
- 获取当前用户下的发布商列表(ListPublisher):在CodeArts IDE Online中,可以通过插件市场获取当前用户下的发布商列表。
- 查询插件列表(ListExtensions):在CodeArts IDE Online的插件市场中查看插件列表。
6.3 API调用示例
以下是一个使用curl调用CodeArts IDE Online API的示例,展示如何查询IDE实例列表:
# 设置访问密钥和区域
ACCESS_KEY="your-access-key"
SECRET_KEY="your-secret-key"
REGION="cn-north-4"
PROJECT_ID="your-project-id"
# 获取Token
curl -X POST https://iam.${REGION}.myhuaweicloud.com/v3/auth/tokens \
-H "Content-Type: application/json" \
-d '{
"auth": {
"identity": {
"methods": ["password"],
"password": {
"user": {
"name": "your-username",
"password": "your-password",
"domain": {
"name": "your-domain-name"
}
}
}
},
"scope": {
"project": {
"name": "'${REGION}'"
}
}
}
}'
# 使用Token查询IDE实例列表
TOKEN="获取到的Token值"
curl -X GET https://cloudide.${REGION}.myhuaweicloud.com/v2/${PROJECT_ID}/instances \
-H "Content-Type: application/json" \
-H "X-Auth-Token: ${TOKEN}" \
-d '{
"limit": 10,
"offset": 0
}'
如果使用账号下的IAM用户调用API,该IAM用户需具备相应的身份策略权限。
七、插件扩展机制
7.1 插件概述
插件是CodeArts提供给使用者的一个扩展方式,用户可以通过插件自定义或扩展CodeArts的应用体验。CodeArts IDE Online支持插件扩展,并且提供了相应的插件开发框架,具备丰富的API和Command、前后端相互调用、事件订阅以及国际化等能力。
7.2 插件开发
用户可以使用标准的前端技术栈(如HTML、JavaScript、CSS)来开发UI插件,同时也可以通过CodeArts提供的REST API Client实现插件与各服务的交互。开发好的插件可以上传到CodeArts中,生成一个可访问的HTML页面,通过“扩展插件”服务可以获取并安装。
创建Plugin项目的步骤:
- 参考启动IDE实例,进入到CodeArts IDE Online工作界面。
- 单击左上角菜单,选择“Plugin”。
- 在左侧导航栏选择“Plugin”,参考参数说明填写信息。
在开始扩展开发之前,需要在本地命令行客户端或CodeArts IDE终端中检查是否已安装Node.js 16.10.0或以上版本。
7.3 插件市场与发布
CodeArts IDE Online提供独立的插件市场,支持开发者注册成为发布商,方便用户搜索和安装高质量的插件。支持插件开发所需的开放标准、开源框架和打包工具,帮助开发者高效地创建和维护插件。提供插件的全生命周期管理,从开发、测试到发布。
开发者可以按照以下流程发布插件:
- 参考《CodeArts IDE插件市场帮助文档》,前往插件市场创建一个发布商。
- 开发完成的插件打包上传到插件市场。
- 用户通过内置的插件市场搜索和安装各种插件。
八、权限管理与安全控制
8.1 IAM权限管理
IAM服务提供用户身份认证、权限分配、访问控制等功能,可以帮助您安全地控制CodeArts IDE Online资源的访问。通过IAM,您可以在华为云账号中给员工创建IAM用户,并使用策略来控制其对华为云资源的访问范围。
CodeArts IDE Online支持通过权限控制(IAM权限)进行访问控制。IAM权限是作用于云资源的,IAM权限定义了允许和拒绝的访问操作,以此实现云资源权限访问控制。默认情况下,管理员创建的IAM用户没有任何权限,需要将其加入用户组,并给用户组授予策略或角色,才能使得用户组中的用户获得对应的权限。
如果需要对CodeArts IDE Online进行精细的权限管理,可以使用统一身份认证服务(IAM)。如果华为云账号已经能满足您的要求,不需要创建独立的IAM用户,可以跳过此步骤。
8.2 企业租户权限管控
CodeArts IDE Online针对企业租户提供资源使用管控和实例访问授权能力。提供基于黑白名单的访问控制能力,为企业租户提供掌控子用户行为的管理面。这种企业级的权限管控机制确保了在多人协作开发场景下的资源安全和访问合规。
九、开发实践:在IDE Online中完成Java项目开发
9.1 创建Java实例
以下是在CodeArts IDE Online上创建Java实例并完成开发的完整流程:
- 进入CodeArts IDE Online首页。
- 单击“新建实例”,进入“新建实例”页面。
- 填写实例名称(如“demo”),选择技术栈为“Java”。
- 选择CPU架构(如“X86计算”)和CPU/内存配置(如“2U4G”)。
- 选择存储容量(如“5GB”)和自动休眠时间(如“30分钟”)。
- 单击“下一步”,进入工程配置。选择“样例工程”,并选择一个java-web-spring-sample样例模板。
- 单击“确定”,IDE实例创建完成,系统自动进入CodeArts IDE Online工作界面。
9.2 编写与运行代码
在CodeArts IDE Online工作界面中,可以在src/main/java路径下查看已经导入的样例代码。以下是一个简单的Java示例:
// HelloWorld.java
package com.example.demo;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloWorld {
@GetMapping("/hello")
public String sayHello() {
return "Hello World from CodeArts IDE Online!";
}
public static void main(String[] args) {
System.out.println("Hello World!");
}
}
单击顶部的运行按钮,即可运行代码并查看输出结果。
9.3 调试代码
CodeArts IDE Online的调试能力与本地IDE保持一致。开发者可以设置断点、单步执行、查看变量值、监控表达式等。在CodeArts IDE Online中,运行已提交的代码后,可以对代码进行在线调试。代码调试功能可支持Java等语言的在线代码调试。
十、最佳实践与注意事项
10.1 合理配置自动休眠策略
自动休眠是CodeArts IDE Online节省资源消耗的重要机制。实例无操作超过设定的自动休眠时长后,将会被暂停,已保存的数据不会被删除。对于频繁使用的开发场景,建议设置为较长的休眠时间(如24小时)以避免频繁重新启动;对于临时性任务,建议设置为较短的休眠时间(如30分钟)以节省资源。
10.2 选择合适的技术栈
All in One技术栈虽然集成了多种语言,但在启动与加载过程中需要等待较长时间。如果只需要使用某一种语言开发项目,建议选择对应的单一技术栈类型,效率更高。
10.3 存储容量规划
CodeArts IDE Online支持5GB、10GB、20GB三种存储容量。开发者应根据项目规模和依赖库大小合理选择存储容量。对于大型项目或包含大量依赖的项目,建议选择较大的存储容量以避免空间不足。
10.4 安全注意事项
- AK/SK是重要的身份凭证,应妥善保管,避免泄露。
- 预装插件参数中若涉及敏感信息,请自行加密。
- IDE实例删除后数据不可恢复,删除前请确认数据已备份。
- 建议使用IAM子账号进行日常开发操作,避免使用主账号。
10.5 团队协作建议
- 通过代码仓库(CodeArts Repo或GitHub)进行版本管理和团队协作。
- 利用CodeArts IDE Online的跨平台特性,团队成员可以使用不同设备接入同一个开发环境。
- 通过企业租户权限管控功能,实现对团队成员访问权限的精细化管理。
十一、常见问题解答
问1:CodeArts IDE Online和桌面版CodeArts IDE有什么区别?
CodeArts IDE Online是基于浏览器的云端开发环境,无需安装,通过浏览器即可访问,适合快速启动、协同开发、无需本地环境配置的场景。桌面版CodeArts IDE(华为云码道IDE)是本地安装的桌面应用程序,支持Windows、macOS、Linux等操作系统,适合需要离线开发、本地调试的场景。
问2:如何解决无法创建IDE实例的问题?
如果无法创建实例,需要完成按需开通CodeArts IDE Online服务。请确保账号已完成实名认证且账户余额充足。同时检查是否已开通CodeArts IDE Online服务权限。
问3:IDE实例会自动停止吗?数据会丢失吗?
是的,IDE实例在无操作超过设定的自动休眠时长后会自动暂停。但已保存的数据不会被删除,重新启动实例后可以继续工作。如果设置为“-1”,实例不会自动停止。需要注意的是,IDE实例删除后数据不可恢复。
问4:CodeArts IDE Online支持哪些编程语言?
CodeArts IDE Online支持100多种语言的语法高亮,支持主流开发语言的语法提示和自动补齐。预置的技术栈包括Java、C/C++、Python、Node.js、Go、All in One、Blockchain等。
问5:如何将本地代码迁移到CodeArts IDE Online?
可以通过两种方式将本地代码迁移到CodeArts IDE Online:一是在创建IDE实例时选择“私有仓库”,从代码托管服务中导入已有代码仓库;二是在IDE实例中使用Git命令克隆第三方代码仓库。
问6:CodeArts IDE Online是否支持团队协作?
支持。CodeArts IDE Online提供了企业租户权限管控功能,支持基于黑白名单的访问控制。同时支持对接Git代码仓库,实现代码的版本管理和团队协作。团队成员可以通过浏览器访问同一个代码仓库,实现协同开发。



