1. 功能简介
编程免不了要写配置文件,怎么写配置也是一门学问。YAML 是专门用来写配置文件的语言,非常简洁和强大。
了解到一些用户在Cloud Studio
开发项目的时候,环境上需要依赖一些组件,项目中也会使用到编辑器的插件。
而如果这些都需要用户自己去安装和准备,则会非常的繁琐,也不利于用户分享自己的工作空间给其他协作同事创建副本。
因此我们设计出了YAML
模板这个功能,用于解决这个问题。
关于
YAML
的简介,传送门:YAML 语言教程
2. 功能入口
功能的入口在各模板页面的内容右上角:
分为两个功能:
- 手动新建
- 导入
workspcace.yml
3. 手动新建
该表单一共有 7 项可以填充的。
- 环境镜像,顾名思义就是决定你模板的基本环境,提供了大多数语言的的开发环境。
- 额外资源,目前提供 mysql 和 redis 预安装。
- 预装插件,为工作空间默认安装 VSCode 插件,支持选择版本。
- 自定义命令, 支持在不同阶段执行自定义 Shell 命令。
分为:初始化命令,启动命令,关机命令。支持 tab 键跳转下一行。
- 环境变量,免去配置一堆默认环境变量的烦恼。
3.1 导出/导入 workspace.yml
该功能可以选择一个在手动新建阶段导出的workspace.yml
文件,可以解决多人使用同一个配置情况下需要同时配置相同模板的烦恼。
4. 解读 workspace.yml
一个成熟的 workspace.yml
长成这样:
---
# 这是模板名称
name: "react-demo"
# 这是模板描述
description: "一个简易YAML示例"
# 这是模板的用于区分的tag
tags:
- "Node.js"
- "React"
# 模板创建的工作空间打开时自动拉取的代码仓库
repository: "https://e.coding.net/coding-public/cloud-studio-samples/react-quickstart.git"
# 默认拉取的分支
ref: "master"
# 定义的环境变量
envs:
- name: "PROJECT_NAME"
value: "this is a react-demo project"
# 打开工作空间自动安装插件
extensions:
- "[email protected]"
- "[email protected]"
# 定义了生命周期,共分为init、start、destory
lifecycle:
init:
- name: "update apt cache"
command: "apt update"
- name: "install nginx"
command: "apt install -y nginx"
start:
- name: "run nginx"
command: "service nginx start"
# sidecar定义了需要启动的附属组件,目前仅支持mysql和redis
sidecar:
mysql:
enabled: true
password: "123456"
database: "test"
redis:
enabled: true
password: "123456"
# 初始镜像id,请勿手动修改
image_id: 5
让我们来一项项拆解。
envs
: 对应初始环境变量extensions
:
定义的是编辑器中需要使用的插件,比如Maven for Java
等等
lifecycle
:
lifecycle
中定义的是整个项目的生命周期各个阶段需要执行的内容,各个定义的生命周期如下图所示:
init
:首次创建空间后的启动,启动后执行。start
:日常启动空间后执行。destroy
:停止空间前执行。
注意:由于运行时机的原因,init
和 start
阶段的 lifecycle
命令不能使用由代码仓库中的文件、脚本等内容构成的可执行命令
sidecar
常用的组件,支持以sidecar
定义,目前支持的组件有mysql
、redis
,如果你的项目需要使用到这两类组件,则定义enabled
为true
即可,否则可以置为false
。
sidecar
形式运行原理如下图,在工作空间中,用户所能看到的为编辑器部分,而 mysql
、redis
是以同级的方式进行运行,通过网络端口连通。
- 使用
YAML
模板
以电商模版为例说明如何使用
电商模版使用 SpringBoot(2.1.5)
和Java JDK(11)
版本。
---
name: "java-demo"
description: "一个简易YAML 示例"
tags:
- "Java"
ref: "master"
extensions:
- "Pivotal.vscode-spring-boot"
- "[email protected]"
lifecycle:
init:
- name: "update apt cache"
command: "apt update"
- name: "install mysqlclient"
command: "apt-get install -y mysql-client"
start:
sidecar:
mysql:
enabled: true
password: "123456"
database: "uzymall"
redis:
enabled: true
password: "uzymall"
image_id: 4
定义中用到了springboot
和maven
的插件,初始化只需要安装mysqlclient
,用于开发调试时登录数据库查看数据,同时,数据组件中使用到了mysql
组件,因此只打开了mysql
的定义。
项目中对应文件修改:
打开空间后,由于也定义了
.vscode/preview.yml
的内容,因此空间每次打开会执行指定的run
命令,即刻可以预览本电商应用启动后的页面效果。
图示为空间打开完成后的效果:
您可以通过以下两个 链接查看由该功能生成的工作空间,并可以将workspace.yml
复制下来体验使用:
https://cloudstudio.net/templates/hBswiZB0M4Z
https://cloudstudio.net/templates/hQGhL1EYuEF