Flutter访问BoardGameGeek API插件bgg_api的使用

Flutter访问BoardGameGeek API插件bgg_api的使用

简介

bgg_api 是一个用于访问 Board Game Geek (BGG) XML API 第二版的 Dart 包。这个包受到 bgg.dart 包的启发，后者适用于 BGG API 的第一版本。

使用示例

以下是一个完整的 Flutter 示例，展示如何使用 bgg_api 插件来访问 Board Game Geek API 并获取游戏信息：

// 导入 bgg_api 包
import 'package:bgg_api/bgg_api.dart';

void main() async {
  // 创建 Bgg 实例
  var bgg = Bgg();

  // 获取特定游戏的信息（这里以 ID 148228 的游戏为例）
  var boardGame = await bgg.getBoardGame(148228);

  // 打印游戏名称
  print(boardGame.name); // 输出: 'Splendor'
  
  // 打印游戏发布年份
  print(boardGame.yearPublished); // 输出: 2014
  
  // 打印最小玩家数
  print(boardGame.minPlayers); // 输出: 2
  
  // 打印最大玩家数
  print(boardGame.maxPlayers); // 输出: 4

  // 搜索包含关键词 "catan" 的游戏
  var searchBoardGamesResult = await bgg.searchBoardGames('catan');
  
  // 打印搜索结果的数量
  print(searchBoardGamesResult.length);
}

示例解释

1. 导入库：

   • 首先需要导入 bgg_api 包。

2. 创建 Bgg 实例：

   • var bgg = Bgg(); 创建了一个 Bgg 实例，用于与 BGG API 进行交互。

3. 获取特定游戏信息：

   • await bgg.getBoardGame(148228) 方法通过游戏ID（例如 148228）获取特定游戏的信息。
   • boardGame.name、boardGame.yearPublished、boardGame.minPlayers 和 boardGame.maxPlayers 分别打印游戏的名称、发布年份、最小和最大玩家数。

4. 搜索游戏：

   • await bgg.searchBoardGames('catan') 方法通过关键词（例如 “catan”）搜索相关游戏，并返回搜索结果列表。
   • searchBoardGamesResult.length 打印搜索结果的数量。

完整示例代码

下面是一个完整的 Flutter 应用程序示例，展示如何在 Flutter 应用中使用 bgg_api 插件：

import 'package:flutter/material.dart';
import 'package:bgg_api/bgg_api.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'BGG API Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'BGG API Demo'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String _gameName = '';
  int _yearPublished = 0;
  int _minPlayers = 0;
  int _maxPlayers = 0;
  int _searchResultsCount = 0;

  [@override](/user/override)
  void initState() {
    super.initState();
    _fetchGameData();
  }

  Future<void> _fetchGameData() async {
    var bgg = Bgg();
    
    // 获取特定游戏信息
    var boardGame = await bgg.getBoardGame(148228);
    setState(() {
      _gameName = boardGame.name;
      _yearPublished = boardGame.yearPublished;
      _minPlayers = boardGame.minPlayers;
      _maxPlayers = boardGame.maxPlayers;
    });

    // 搜索包含关键词 "catan" 的游戏
    var searchBoardGamesResult = await bgg.searchBoardGames('catan');
    setState(() {
      _searchResultsCount = searchBoardGamesResult.length;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text('游戏名称: $_gameName'),
            Text('发布年份: $_yearPublished'),
            Text('最小玩家数: $_minPlayers'),
            Text('最大玩家数: $_maxPlayers'),
            Text('搜索结果数量: $_searchResultsCount'),
          ],
        ),
      ),
    );
  }
}