入门

使用 Supabase 与 Vue

学习如何创建一个 Supabase 项目,向你的数据库添加一些示例数据,并从 Vue 应用查询数据。


1

创建一个 Supabase 项目

前往 database.new 并创建一个新的 Supabase 项目。

或者,您可以使用管理 API 创建项目

1
# First, get your access token from https://supabase.org.cn/dashboard/account/tokens
2
export SUPABASE_ACCESS_TOKEN="your-access-token"
3
4
# List your organizations to get the organization ID
5
curl -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
6
https://api.supabase.com/v1/organizations
7
8
# Create a new project (replace <org-id> with your organization ID)
9
curl -X POST https://api.supabase.com/v1/projects \
10
-H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
11
-H "Content-Type: application/json" \
12
-d '{
13
"organization_id": "<org-id>",
14
"name": "My Project",
15
"region": "us-east-1",
16
"db_pass": "<your-secure-password>"
17
}'

当您的项目启动并运行时,前往 表格编辑器,创建一个新表格并插入一些数据。

或者,您可以在项目的 SQL 编辑器 中运行以下代码片段。这将创建一个包含一些示例数据的 instruments 表。

1
-- Create the table
2
create table instruments (
3
id bigint primary key generated always as identity,
4
name text not null
5
);
6
-- Insert some sample data into the table
7
insert into instruments (name)
8
values
9
('violin'),
10
('viola'),
11
('cello');
12
13
alter table instruments enable row level security;

通过添加 RLS 策略使表格中的数据可公开读取

1
create policy "public can read instruments"
2
on public.instruments
3
for select to anon
4
using (true);
2

创建 Vue 应用

  • 使用 npm init 命令创建一个 Vue 应用。

终端
1
npm init vue@latest my-app
3

安装 Supabase 客户端库

最快入门的方法是使用 supabase-js 客户端库,它为从 Vue 应用使用 Supabase 提供了便捷的接口。

导航到 Vue 应用并安装 supabase-js

终端
1
cd my-app && npm install @supabase/supabase-js
4

声明 Supabase 环境变量

创建一个 .env.local 文件并填充你的 Supabase 连接变量

项目 URL
可发布密钥
匿名密钥
1
VITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
2
VITE_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>

你还可以从 项目的 连接 对话框 获取项目 URL 和密钥。

阅读 API 密钥文档 以全面了解所有密钥类型及其用途。

5

创建 Supabase 客户端

在你的 Vue 应用中创建一个 /src/lib 目录,创建一个名为 supabaseClient.js 的文件,并添加以下代码来初始化 Supabase 客户端

src/lib/supabaseClient.js
1
import { createClient } from '@supabase/supabase-js'
2
3
const supabaseUrl = import.meta.env.VITE_SUPABASE_URL
4
const supabasePublishableKey = import.meta.env.VITE_SUPABASE_PUBLISHABLE_KEY
5
6
export const supabase = createClient(supabaseUrl, supabasePublishableKey)
6

从应用查询数据

将以下代码替换到你的 App.vue 文件中的现有内容。

src/App.vue
1
<script setup>
2
import { ref, onMounted } from 'vue'
3
import { supabase } from './lib/supabaseClient'
4
5
const instruments = ref([])
6
7
async function getInstruments() {
8
const { data } = await supabase.from('instruments').select()
9
instruments.value = data
10
}
11
12
onMounted(() => {
13
getInstruments()
14
})
15
</script>
16
17
<template>
18
<ul>
19
<li v-for="instrument in instruments" :key="instrument.id">{{ instrument.name }}</li>
20
</ul>
21
</template>
7

启动应用

启动应用并在浏览器中访问 https://:5173,你应该会看到乐器列表。

终端
1
npm run dev