Flutter获取Git信息插件git_info_plus的使用

Flutter获取Git信息插件git_info_plus的使用

从Flutter应用程序中获取Git信息。

使用方法

Dart

final String branchName = await GitInfo.branchName;
final DateTime lastCommitDate = await GitInfo.lastCommitDate;
final String lastCommitHash = await GitInfo.lastCommitHash;
final String lastCommitHashShort = await GitInfo.lastCommitHashShort;
final String lastCommitMessage = await GitInfo.lastCommitMessage;

设置

Android

你不需要进行任何设置。

iOS

为了在iOS上使用此库，你需要进行一些设置。

1. 在info.plist文件中添加值

你可以复制并粘贴以下行：

<key>GitBranchName</key>
<string>undefined</string>
<key>GitCommitDate</key>
<string>undefined</string>
<key>GitCommitHash</key>
<string>undefined</string>
<key>GitCommitHashShort</key>
<string>undefined</string>
<key>GitCommitMessage</key>
<string>undefined</string>

2. 启用进程Info.plist文件

BuildSettings > Processes Info.plist File

改为YES

3-A. 添加运行脚本

BuildPhase >

添加一个新的运行脚本并粘贴以下内容：

plistBuddy="/usr/libexec/PlistBuddy"
infoPlistFile="${TEMP_DIR}/Preprocessed-Info.plist"

branchName=$(git branch --show-current)
commitDate=$(git --no-pager log -1 --format="%ai")
commitHash=$(git rev-parse HEAD)
commitHashShort=$(git rev-parse --short HEAD)
commitMessage=$(git log -1 --pretty=%s)

$plistBuddy -c "Set :GitBranchName $branchName" $infoPlistFile
$plistBuddy -c "Set :GitCommitDate $commitDate" $infoPlistFile
$plistBuddy -c "Set :GitCommitHash $commitHash" $infoPlistFile
$plistBuddy -c "Set :GitCommitHashShort $commitHashShort" $infoPlistFile
$plistBuddy -c "Set :GitCommitMessage $commitMessage" $infoPlistFile

3-B. 添加输入文件

${TEMP_DIR}/Preprocessed-Info.plist

完整示例Demo

import 'dart:async';

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

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _branchName = 'Unknown';
  DateTime? _lastCommitDate;
  String _lastCommitHash = 'Unknown';
  String _lastCommitHashShort = 'Unknown';
  String _lastCommitMessage = 'Unknown';

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

  Future<void> initPlatformState() async {
    String branchName;
    DateTime? lastCommitDate;
    String lastCommitHash;
    String lastCommitHashShort;
    String lastCommitMessage;

    try {
      branchName = await GitInfo.branchName ?? 'Unknown';
    } catch (_) {
      branchName = 'Error';
    }
    try {
      lastCommitDate = await GitInfo.lastCommitDate;
    } catch (_) {
      // noop
    }
    try {
      lastCommitHash = await GitInfo.lastCommitHash ?? 'Unknown';
    } catch (_) {
      lastCommitHash = 'Error';
    }
    try {
      lastCommitHashShort = await GitInfo.lastCommitHashShort ?? 'Unknown';
    } catch (_) {
      lastCommitHashShort = 'Error';
    }
    try {
      lastCommitMessage = await GitInfo.lastCommitMessage ?? 'Unknown';
    } catch (_) {
      lastCommitMessage = 'Error';
    }

    if (!mounted) return;

    setState(() {
      _branchName = branchName;
      _lastCommitDate = lastCommitDate;
      _lastCommitHash = lastCommitHash;
      _lastCommitHashShort = lastCommitHashShort;
      _lastCommitMessage = lastCommitMessage;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('git_info插件示例'),
        ),
        body: Center(
          child: Column(
            crossAxisAlignment: CrossAxisAlignment.center,
            mainAxisAlignment: MainAxisAlignment.start,
            children: [
              ListTile(
                title: const Text('分支名称'),
                subtitle: Text(_branchName),
                tileColor: Colors.white,
              ),
              const Divider(height: 1),
              ListTile(
                title: const Text('最后提交日期'),
                subtitle: Text(_lastCommitDate?.toString() ?? '未知'),
                tileColor: Colors.white,
              ),
              const Divider(height: 1),
              ListTile(
                title: const Text('最后提交哈希'),
                subtitle: Text(_lastCommitHash),
                tileColor: Colors.white,
              ),
              const Divider(height: 1),
              ListTile(
                title: const Text('最后提交哈希（短）'),
                subtitle: Text(_lastCommitHashShort),
                tileColor: Colors.white,
              ),
              const Divider(height: 1),
              ListTile(
                title: const Text('最后提交消息'),
                subtitle: Text(_lastCommitMessage),
                tileColor: Colors.white,
              ),
            ],
          ),
        ),
      ),
    );
  }
}