首页 >web前端 >js教程 >Astro 中的 API 密钥和环境变量:完整安全指南

Astro 中的 API 密钥和环境变量:完整安全指南

Patricia Arquette
Patricia Arquette原创
2024-12-28 08:22:09308浏览

API Keys y Variables de Entorno en Astro: Guía Completa de Seguridad

当我们使用 Astro 开发 Web 应用程序时,我们经常需要与外部 API 和服务进行交互。安全地管理凭证和 API 密钥对于保护我们的应用程序至关重要。在本指南中,我们将探索在 Astro 项目中管理 API 密钥和环境变量的最佳实践。

Astro 中的环境变量

基本配置

在 Astro 中,环境变量的处理方式与其他现代框架类似。首先,我们在项目的根目录中创建一个 .env 文件:

# .env
PUBLIC_API_URL=https://api.ejemplo.com
PRIVATE_API_KEY=tu_clave_secreta
DATABASE_URL=postgresql://usuario:password@localhost:5432/db

对于 TypeScript,建议创建一个 env.d.ts 文件来输入我们的变量:

/// <reference types="astro/client" />
interface ImportMetaEnv {
  readonly DATABASE_URL: string;
  readonly PRIVATE_API_KEY: string;
  readonly PUBLIC_API_URL: string;
}

interface ImportMeta {
  readonly env: ImportMetaEnv;
}

访问变量

在 Astro 中,我们可以根据上下文以不同的方式访问环境变量:

---
// En archivos .astro
const apiKey = import.meta.env.PRIVATE_API_KEY;
const publicUrl = import.meta.env.PUBLIC_API_URL;
---
// En archivos .ts o .js
const apiKey = import.meta.env.PRIVATE_API_KEY;

前端安全

公共变量与私有变量

Astro 遵循环境变量的重要约定:

  • PUBLIC_*:可在客户端和服务器上访问
  • 无 PUBLIC_ 前缀:只能在服务器上访问
# .env
PUBLIC_API_URL=https://api.publica.com    # ✅ Visible en el cliente
PRIVATE_API_KEY=secreto123                # ⛔ Solo servidor

保护敏感密钥

要处理需要身份验证的 API,我们必须创建无服务器端点:

// src/pages/api/data.ts
export async function GET() {
  try {
    const response = await fetch('https://api.externa.com/data', {
      headers: {
        'Authorization': `Bearer ${import.meta.env.PRIVATE_API_KEY}`
      }
    });

    const data = await response.json();
    return new Response(JSON.stringify(data), {
      status: 200,
      headers: {
        'Content-Type': 'application/json'
      }
    });
  } catch (error) {
    return new Response(JSON.stringify({ error: 'Error al obtener datos' }), {
      status: 500
    });
  }
}

最佳实践

1.环境变量的验证

在应用程序开始时实现验证功能:

// src/utils/validateEnv.ts
export function validateEnv() {
  const requiredEnvVars = [
    'DATABASE_URL',
    'PRIVATE_API_KEY',
    'PUBLIC_API_URL'
  ];

  for (const envVar of requiredEnvVars) {
    if (!import.meta.env[envVar]) {
      throw new Error(`La variable de entorno ${envVar} es requerida`);
    }
  }
}

// src/pages/index.astro
---
import { validateEnv } from '../utils/validateEnv';

if (import.meta.env.MODE === 'development') {
  validateEnv();
}
---

2. 多重环境管理

为每个环境创建不同的文件:

.env                # Variables por defecto
.env.development    # Variables de desarrollo
.env.production     # Variables de producción
.env.local          # Variables locales (ignoradas en git)

3.环境变量模板

提供.env.example文件:

# .env.example
PUBLIC_API_URL=https://api.ejemplo.com
PRIVATE_API_KEY=tu_clave_aqui
DATABASE_URL=postgresql://usuario:password@localhost:5432/db

4.Git配置

确保在 .gitignore 中包含敏感文件:

# .env
PUBLIC_API_URL=https://api.ejemplo.com
PRIVATE_API_KEY=tu_clave_secreta
DATABASE_URL=postgresql://usuario:password@localhost:5432/db

与外部服务集成

条纹示例

/// <reference types="astro/client" />
interface ImportMetaEnv {
  readonly DATABASE_URL: string;
  readonly PRIVATE_API_KEY: string;
  readonly PUBLIC_API_URL: string;
}

interface ImportMeta {
  readonly env: ImportMetaEnv;
}

Firebase 示例

---
// En archivos .astro
const apiKey = import.meta.env.PRIVATE_API_KEY;
const publicUrl = import.meta.env.PUBLIC_API_URL;
---

部署和 CI/CD

Vercel 中的配置

// En archivos .ts o .js
const apiKey = import.meta.env.PRIVATE_API_KEY;

GitHub 操作

# .env
PUBLIC_API_URL=https://api.publica.com    # ✅ Visible en el cliente
PRIVATE_API_KEY=secreto123                # ⛔ Solo servidor

额外的安全提示

  1. 密钥轮换:实现定期轮换 API 密钥的系统
// src/pages/api/data.ts
export async function GET() {
  try {
    const response = await fetch('https://api.externa.com/data', {
      headers: {
        'Authorization': `Bearer ${import.meta.env.PRIVATE_API_KEY}`
      }
    });

    const data = await response.json();
    return new Response(JSON.stringify(data), {
      status: 200,
      headers: {
        'Content-Type': 'application/json'
      }
    });
  } catch (error) {
    return new Response(JSON.stringify({ error: 'Error al obtener datos' }), {
      status: 500
    });
  }
}
  1. 使用情况监控:实施日志记录以检测误用
// src/utils/validateEnv.ts
export function validateEnv() {
  const requiredEnvVars = [
    'DATABASE_URL',
    'PRIVATE_API_KEY',
    'PUBLIC_API_URL'
  ];

  for (const envVar of requiredEnvVars) {
    if (!import.meta.env[envVar]) {
      throw new Error(`La variable de entorno ${envVar} es requerida`);
    }
  }
}

// src/pages/index.astro
---
import { validateEnv } from '../utils/validateEnv';

if (import.meta.env.MODE === 'development') {
  validateEnv();
}
---

API 密钥和环境变量的安全处理对于任何现代 Web 应用程序都至关重要。通过遵循 Astro 的这些最佳实践,我们可以:

  • 确保我们的凭证安全
  • 按环境单独配置
  • 实施稳健的验证
  • 安全地集成外部服务

以上是Astro 中的 API 密钥和环境变量:完整安全指南的详细内容。更多信息请关注PHP中文网其他相关文章!

声明:
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn