快速体验biz-demo/easy_note | 青训营笔记

192 阅读3分钟

这是我参与「第五届青训营 」笔记创作活动的第10天

只不过是字节给我的任务罢了

快速体验biz-demo/easy_note

要想运行官方的demo,首先要安装一些依赖,使用官方提供的docker-compose部署

我的环境

 Linux ubuntu 5.4.0-137-generic #154~18.04.1-Ubuntu SMP Tue Jan 10 16:58:20 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux

安装docker&docker-compose

注意不要使用sudo apt-get install dockersudo apt-get install docker-compose安装这两者,biz-demo要求的docker compose版本和apt安装的不符

安装docker

这里使用菜鸟教程的提供的快速安装

 curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun

安装docker-compose

如果能够安装可以使用官网提供的安装命令

 curl -SL https://github.com/docker/compose/releases/download/v2.15.1/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose

如果无法安装,可以使用菜鸟教程提供的快速安装(我用的这个),因为需要一些操作需要root权限,可以sudo su暂时进入root权限,安装完成后exit退出,返回到普通用户

 curl -L https://get.daocloud.io/docker/compose/releases/download/v2.4.1/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose

将可执行权限应用于二进制文件,并且创建软连接

 sudo chmod +x /usr/local/bin/docker-compose
 sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

验证安装

 docker-compose version

安装依赖

克隆biz-demo

首先要确保已经克隆了biz-demo,如果已经安装过了,请跳转到

$GOPATH/src/github.com/cloudwego/下clone项目

 cd $GOPATH/src/github.com/cloudwego/
 git clone git@github.com:cloudwego/biz-demo.git

通过docker-compose安装依赖

进入easy_note文件夹

 cd biz-demo/easy_note/
 sudo docker-compose up

如果出现错误信息:error getting credentials - err: exit status 1, out: GDBus.Error:org.freedesktop.DBus.Error.ServiceUnknown: The name org.freedesktop.secrets was not provided by any .service files

解决方法是先安装gnupg2和pass

sudo apt install gnupg2 pass

然后重新拉取

sudo docker-compose up

如果拉取的过程中卡死在pulling fs layer可以重启docker

sudo systemctl restart docker

如果出现了Pulling卡死,可以重新docker-compose up

运行项目

启动note、user、api的服务

确保当前目录位于easy_note目录下

 # 启动User RPC Server
 sh ./cmd/user/build.sh
 sh ./cmd/user/output/bootstrap.sh
 # 启动Note RPC Server
 sh ./cmd/note/build.sh
 sh ./cmd/note/output/bootstrap.sh
 # 启动API Server
 go run ./cmd/api .

向API发送请求

Create User(创建用户)

打开Postman,新建一个post请求,请求的url为服务器ip:8080/v2/user/register,切换到Body选项卡,选择form-data填入KEY-VALUE

KEY分别为usernamepassword,VALUE随意,填完后点击Send即可

image.png

发送后就可以看到响应内容了

image.png

User login(用户登录)

发送POST请求到服务器ip:8080/v2/user/login

image.png

Create Note(创建笔记)

创建Note时必须要携带登录时获得的token,在Authorization选项卡中设置

image.png

发送POST请求到服务器ip:8080/v2/note

image.png

Query Note(查询笔记)

发送GET请求,请求的url:服务器ip:8080/v2/note/query?offset=0&limit=20&search_key=test

image.png

Update Note(更新笔记)

发送PUT请求到服务器ip:8080/v2/note/上次查询获取到user_id对应的值

image.png

查看监控数据

打开服务器ip:16686

会看到Service中出现了demoapidemonotedemouser,选中一个点击Find Traces

image.png

image.png

参考

Ubuntu Docker安装-菜鸟教程

Docker Compose安装-菜鸟教程

(blog.csdn.net/RABCDXB/art…)

juejin.cn/post/719215…

github.com/cloudwego/b…