Flutter问题详情展示插件problem_details的使用

Flutter问题详情展示插件problem_details的使用

如何使用

ProblemDetails

你可以使用未命名的工厂构造函数 ProblemDetails 来创建一个 ProblemDetails 对象。默认情况下，status 设置为 500。

void main() {
  final problemDetails = ProblemDetails();
}

如果指定了 status，ProblemDetails 构造函数将根据 status 的值填充 type 和 title 字段。但是，它只适用于某些特定的 status 值。完整的 status 值列表可以在这里查看：

void main() {
  final problemDetails = ProblemDetails(status: 403);

  // 打印: https://www.rfc-editor.org/rfc/rfc7231#section-6.5.3
  print(problemDetails.type);

  // 打印: Forbidden
  print(problemDetails.title);
}

如果 ProblemDetails 没有为某个 status 指定默认的 type 或 title，则 type 将设置为 about:blank。

void main() {
  final problemDetails = ProblemDetails(status: 1);

  // 打印: about:blank
  print(problemDetails.type);
}

ProblemDetails.raw

如果你想要手动设置所有字段的值，可以使用 ProblemDetails.raw 构造函数：

void main() {
  final problemDetails = ProblemDetails.raw(status: 403);

  // 打印: null
  print(problemDetails.type);

  // 打印: null
  print(problemDetails.title);
}

额外的字段

如果你想在 ProblemDetails 中添加新的字段，可以使用 extensions：

void extensions() {
  var problemDetails = ProblemDetails(
    extensions: {
      'key1': 'value',
      'key2': null,
      'key3': {
        'key4': [1, 2, 3],
      },
    },
  );

  // 打印:
  //  {
  //    key1: value,
  //    key2: null,
  //    key3: {
  //      key4: [1, 2, 3]
  //    }
  //  }
  print(problemDetails.extensions);
}

你可以通过使用 addOrUpdateExtension 方法来更改或添加一个字段：

void main() {
  var problemDetails = ProblemDetails(
    extensions: {
      'key1': 'value',
      'key2': null,
      'key3': {
        'key4': [1, 2, 3],
      },
    },
  );

  problemDetails = problemDetails.addOrUpdateExtension('KEY', 'VALUE');

  // 打印:
  //  {
  //    key1: value,
  //    key2: null,
  //    key3: {
  //      key4: [1, 2, 3]
  //    },
  //    'KEY': 'VALUE'
  //  }
  print(problemDetails.extensions);
}

你也可以通过使用 addOrUpdateExtensions 方法来更改或添加多个字段：

void main() {
  var problemDetails = ProblemDetails(
    extensions: {
      'key1': 'value',
      'key2': null,
      'key3': {
        'key4': [1, 2, 3],
      },
    },
  );

  problemDetails = problemDetails.addOrUpdateExtensions(
    {
      'a': 1,
      'b': 2,
    },
  );

  // 打印:
  //  {
  //    key1: value,
  //    key2: null,
  //    key3: {
  //      key4: [1, 2, 3]
  //    },
  //    'a': 1,
  //    'b': 2
  //  }
  print(problemDetails.extensions);
}

你可以通过使用 removeExtension 方法来移除一个字段：

void main() {
  var problemDetails = ProblemDetails(
    extensions: {
      'key1': 'value',
      'key2': null,
      'key3': {
        'key4': [1, 2, 3],
      },
    },
  );

  problemDetails = problemDetails.removeExtension('key1');

  // 打印:
  //  {
  //    key2: null,
  //    key3: {
  //      key4: [1, 2, 3]
  //    }
  //  }
  print(problemDetails.extensions);
}

toJson

toJson 方法将 ProblemDetails 转换为 Map。

void main() {
  final problemDetails = ProblemDetails(
    status: 403,
    extensions: {
      'key1': 'value',
      'key2': null,
      'key3': {
        'key4': [1, 2, 3],
      },
    },
  );

  final jsonData = problemDetails.toJson();

  // 打印:
  //  {
  //    status: 403,
  //    type: https://www.rfc-editor.org/rfc/rfc7231#section-6.5.3,
  //    title: Forbidden,
  //    key1: value,
  //    key2: null,
  //    key3: {
  //      key4: [1, 2, 3]
  //    }
  //  }
  print(jsonData);
}

注意: 如果某个标准字段（如 status、type、title、details、instance）为 null，则不会包含在 Map 中。extensions 的内容会放在 Map 的顶层。

fromJson

fromJson 构造函数将 Map 解析为 ProblemDetails。

void main() {
  var problemDetails = ProblemDetails(
    status: 403,
    extensions: {
      'key1': 'value',
      'key2': null,
      'key3': {
        'key4': [1, 2, 3],
      },
    },
  );

  final jsonData = problemDetails.toJson();

  problemDetails = ProblemDetails.fromJson(jsonData);

  // 打印:
  //  ProblemDetails {
  //    status: 403,
  //    type: https://www.rfc-editor.org/rfc/rfc7231#section-6.5.3,
  //    title: Forbidden,
  //    key1: value,
  //    key2: null,
  //    key3: {
  //      key4: [1, 2, 3]
  //    }
  //  }
  print(problemDetails);
}