Skip to content

Commit 3527da8

Browse files
authored
添加一个更易操作的windows上vscode中docker环境的配置文件 (#493)
### What problem were solved in this pull request? 在这个新文件中,简化了”在windows上通过docker配置环境并利用vscode调试代码(手把手版)”这个文件的操作流程,并且也可以实现vscode自带的调试功能,使环境配置更加容易。 以更简便的方式实现了“在windows上通过docker配置环境并利用vscode调试代码(手把手版)”+”基于Windows+docker容器在本地利用VSCode编辑、开发及调试miniob”这两个文件的功能。 Issue Number: close #xxx Problem: ### What is changed and how it works? ### Other information
1 parent 6079097 commit 3527da8

11 files changed

+65
-0
lines changed
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# 在windows上通过docker配置环境并利用vscode编辑、开发、调试代码(简易版)
2+
3+
# 步骤:
4+
## 1.下载docker
5+
6+
[Get Started | Docker](https://www.docker.com/get-started/)
7+
8+
## 2.获取oceanbase/miniob的docker环境
9+
10+
在任意位置启动 终端(cmd或者powershell),运行以下代码:
11+
12+
```bash
13+
# 下面的命令三选一即可
14+
docker pull oceanbase/miniob # pull from docker hub
15+
docker pull ghcr.io/oceanbase/miniob && docker tag ghcr.io/oceanbase/miniob oceanbase/miniob # pull from github
16+
docker pull quay.io/oceanbase/miniob && docker tag quay.io/oceanbase/miniob oceanbase/miniob # pull from github # pull from quay.io
17+
```
18+
19+
## 3.在本地克隆miniob代码
20+
21+
在本地新建一个空的文件夹,打开该文件夹右键在终端打开,输入以下命令克隆miniob:
22+
```bash
23+
git clone https://github.com/oceanbase/miniob.git
24+
```
25+
26+
若输出以下信息代表克隆成功(对克隆成功的判定标准详情可见下面文章的第3步第2小点)
27+
[在windows上通过docker配置环境并利用vscode调试代码(手把手版)](./how_to_dev_in_docker_container_by_vscode_on_windows.md)
28+
29+
## 4.在VSCode中利用dev containers插件实现在docker容器环境下打开miniob源代码
30+
### 1)准备工作:需要有vscode和git
31+
(如果没有,请参照下面文章的第3步第1小点安装)
32+
[在windows上通过docker配置环境并利用vscode调试代码(手把手版)](./how_to_dev_in_docker_container_by_vscode_on_windows.md)
33+
34+
### 2)在应用商店中搜索以下插件并安装
35+
![dev_containers插件](./images/dev-containers-dev-containers.png)
36+
### 3)利用该插件轻松实现环境配置
37+
第一步,在vscode初始界面选择“连接到”,会看到上方搜索栏弹出列表
38+
第二步,在弹出的列表中选择“在容器中打开文件夹”
39+
第三步,选择打开你克隆得到的miniob文件夹(注意不是你自己创建的空文件夹)
40+
![vscode菜单界面](./images/dev-containers-vscode-menu.png)
41+
![选择miniob文件夹](./images/dev-containers-open-localfile.png)
42+
打开完成后进入以下界面,源代码已成功在vscode中,在docker容器的环境下打开
43+
![vscode中显示源代码](./images/dev-containers-vscode-contend.png)
44+
45+
此时docker desktop软件显示你利用dev container自动创建的容器
46+
![dockerdestop](./images/dev-containers-docker_desktop.png)
47+
48+
## 5.运行源代码并演示可以调试
49+
50+
### 1)编译源代码
51+
vscode的菜单栏中选择终端->新建终端,在终端中编译源代码,详情请见以下文件:
52+
[如何编译miniob](.././how_to_build.md)
53+
54+
编译完出现build_debug文件
55+
![build_debug文件](./images/dev-containers-build_debug.png)
56+
57+
### 2)演示使用vscode中的调试工具
58+
59+
在调试之前,需要在这个docker容器的环境下安装c/c++ extension pack拓展,点击“在开发容器中安装”:
60+
![c扩展](./images/dev-containers-c_dependence.png)
61+
62+
安装完成后,点击“运行”->“启动调试”之后就可以进行调试了,以下是个到断点处中断的事例
63+
![调试范例](./images/dev-containers-breakpoint.png)
64+
65+
到此,环境配置全部完成,利用dev-containers插件简化了整个配置环境的过程。
271 KB
Loading
24.9 KB
Loading
64.2 KB
Loading
37.1 KB
Loading
13.1 KB
Loading
64.1 KB
Loading
61.6 KB
Loading
49.3 KB
Loading
274 KB
Loading

0 commit comments

Comments
 (0)