Flutter游戏数据库查询插件igdb的使用

IGDB Dart API Wrapper

On Progress

该插件是从 mitchhymel/dart-igdb_client 分支而来，用于通过 Flutter 和 Dart 访问 IGDB（Internet Games Database）API。

使用步骤

要使用 IGDB 插件，首先需要设置 Twitch 客户端 ID 和客户端密钥。以下是完整的示例代码，展示如何在 Flutter 中使用该插件来查询游戏数据。

示例代码

main.dart

import 'dart:io';
import 'package:flutter/material.dart';
import 'package:igdb/igdb.dart'; // 引入 igdb 包

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  @override
  _HomePageState createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  String _result = ''; // 存储查询结果

  Future<void> fetchGames() async {
    try {
      // 获取环境变量中的 Twitch 客户端 ID 和密钥
      final clientId = Platform.environment['TWITCH_CLIENT'];
      final clientSecret = Platform.environment['TWITCH_SECRET'];

      if (clientId == null || clientSecret == null) {
        setState(() {
          _result =
              '请确保设置了 TWITCH_CLIENT 和 TWITCH_SECRET 环境变量！';
        });
        return;
      }

      // 初始化 IGDB 客户端
      final client = IGDBClient(clientId, clientSecret);

      // 设置查询参数
      const igdbRequestParameters = IGDBRequestParameters(
        search: 'CS:GO', // 查询关键词
      );

      // 执行不同类型的查询
      final json = await client.gameJson(igdbRequestParameters);
      final countJson = await client.gameCountJson(igdbRequestParameters);
      final proto = await client.gameProto(igdbRequestParameters);
      final countProto = await client.gameCountProto(igdbRequestParameters);

      // 更新 UI
      setState(() {
        _result = '''
        JSON 游戏数据:
        $json
        
        JSON 游戏数量:
        $countJson
        
        Protocol Buffers 游戏数据:
        ${proto?.toProto3Json()}
        
        Protocol Buffers 游戏数量:
        ${countProto?.toProto3Json()}
        ''';
      });
    } catch (e) {
      setState(() {
        _result = '查询失败: $e';
      });
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('IGDB 游戏查询示例'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: fetchGames,
              child: Text('查询 CS:GO 游戏数据'),
            ),
            SizedBox(height: 20),
            Text(
              _result,
              style: TextStyle(fontSize: 14),
            ),
          ],
        ),
      ),
    );
  }
}

说明

1. 依赖安装： 在 pubspec.yaml 文件中添加 igdb 依赖：

   dependencies:
     igdb: ^0.1.0

2. 环境变量配置：

   • 在运行项目之前，请确保设置了以下环境变量：
     • TWITCH_CLIENT: Twitch 客户端 ID。
     • TWITCH_SECRET: Twitch 客户端密钥。
   • 可以在终端中设置：

     export TWITCH_CLIENT=your_client_id
     export TWITCH_SECRET=your_client_secret

3. 功能说明：

   • gameJson: 返回 JSON 格式的查询结果。
   • gameCountJson: 返回符合条件的游戏数量。
   • gameProto: 返回 Protocol Buffers 格式的查询结果。
   • gameCountProto: 返回符合条件的游戏数量（Protocol Buffers 格式）。

4. UI 界面：

   • 点击按钮后，程序会调用 IGDB API 并显示查询结果。
   • 如果查询失败，会在界面上显示错误信息。

输出示例

点击按钮后，可能的输出如下：

JSON 游戏数据:
[
  {
    "id": 10,
    "name": "Counter-Strike: Global Offensive",
    ...
  }
]

JSON 游戏数量:
1

Protocol Buffers 游戏数据:
{
  "games": [
    {
      "id": 10,
      "name": "Counter-Strike: Global Offensive",
      ...
    }
  ]
}

Protocol Buffers 游戏数量:
1