Dart 中的日志输出封装定义示范

import 'dart:developer' as dev;

import 'package:meta/meta.dart';

import '../constants/strings.dart';

@protected
@immutable
@internal
abstract class OpenAILogger {
  /// This represents the default value of the logger active state.
  static bool _isActive = true;

  /// Changes the logger active state.
  ///
  /// if true, the logger will log messages.
  /// If false, the logger will not log messages.
  ///
  /// The default value is [_isActive].
  static set isActive(bool newValue) {
    _isActive = newValue;
  }

  /// Logs a message, if the logger is active.
  static void log(String message) {
    if (!_isActive) {
      return;
    }

    dev.log(
      message,
      name: OpenAIStrings.openai,
    );
  }

  /// Logs that a request to an [endpoint] is being made, if the logger is active.
  static void logEndpoint(String endpoint) {
    log("accessing endpoint: $endpoint");
  }

  /// Logs that an api key is being set, if the logger is active.
  static void logAPIKey() {
    log("api key is set");
  }

  /// Logs that an baseUrl key is being set, if the logger is active.
  static void logBaseUrl() {
    log("baseUrl is set");
  }

  /// Logs that an organization id is being set, if the logger is active.
  static void logOrganization(String? organizationId) {
    log("organization id set to $organizationId");
  }
}

字符串常量定义

import 'package:meta/meta.dart';

/// This class is responsible for storing general [String] constants.
@internal
@immutable
abstract class OpenAIStrings {
  /// This is the capitalized version of "openai" used in the SDK.
  static const String openai = 'OpenAI';
}