Dart符號(Symbol)

Dart中的符號(Symbol)是不透明的動態字串名稱，用於反映庫中的元數據。簡而言之，符號是一種存儲人類可讀字串與優化供電腦使用的字串之間關係的方法。

反射是一種在運行時獲取類型元數據的機制，如類中的方法數，它具有的構造函數數或函數中的參數數。甚至可以調用在運行時加載的類型的方法。

在Dart反射中，dart:mirrors包中提供了特定的類。此庫適用於Web應用程式和命令行應用程式。

語法

Symbol obj = new Symbol('name');
// expects a name of class or function or library to reflect

name必須是有效的公共Dart成員名稱，公共構造函數名稱或庫名稱。

示例
請考慮以下示例。代碼在庫foo_lib中聲明了一個類Foo。該類定義方法：m1，m2和m3。

檔：Foo.dart -

library foo_lib;
// libarary name can be a symbol

class Foo {
   // class name can be a symbol
   m1() {
      // method name can be a symbol
      print("Inside m1");
   }
   m2() {
      print("Inside m2");
   }
   m3() {
      print("Inside m3");
   }
}

以下代碼在Symbol類型的幫助下加載Foo.dart庫並搜索Foo類。由於需要反射上述庫中的元數據，因此這裏需要代碼導入dart:mirrors庫。

檔：FooSymbol.dart

import 'dart:core';
import 'dart:mirrors';
import 'Foo.dart';

main() {
   Symbol lib = new Symbol("foo_lib");
   //library name stored as Symbol

   Symbol clsToSearch = new Symbol("Foo");
   // class name stored as Symbol

   if(checkIf_classAvailableInlibrary(lib, clsToSearch))
   // searches Foo class in foo_lib library
      print("class found..");
}

bool checkIf_classAvailableInlibrary(Symbol libraryName, Symbol className) {
   MirrorSystem mirrorSystem = currentMirrorSystem();
   LibraryMirror libMirror = mirrorSystem.findLibrary(libraryName);

   if (libMirror != null) {
      print("Found Library");
      print("checkng...class details..");
      print("No of classes found is : ${libMirror.declarations.length}");
      libMirror.declarations.forEach((s, d) => print(s));

      if (libMirror.declarations.containsKey(className)) return true;
      return false;
   }
}

注意：代碼行 - libMirror.declarations.forEach((s, d) => print(s));將在運行時迭代庫中的每個聲明，並將聲明列印為Symbol的類型。

此代碼應產生以下輸出 -

Found Library
checkng...class details..
No of classes found is : 1
Symbol("Foo") // class name displayed as symbol
class found.

示例：顯示類的實例方法數

下麵來看看如何顯示在類實例方法的數量。可通過使用ClassMirror預定義類來實現。

import 'dart:core';
import 'dart:mirrors';
import 'Foo.dart';

main() {
   Symbol lib = new Symbol("foo_lib");
   Symbol clsToSearch = new Symbol("Foo");
   reflect_InstanceMethods(lib, clsToSearch);
}
void reflect_InstanceMethods(Symbol libraryName, Symbol className) {
   MirrorSystem mirrorSystem = currentMirrorSystem();
   LibraryMirror libMirror = mirrorSystem.findLibrary(libraryName);

   if (libMirror != null) {
      print("Found Library");
      print("checkng...class details..");
      print("No of classes found is : ${libMirror.declarations.length}");
      libMirror.declarations.forEach((s, d) => print(s));

      if (libMirror.declarations.containsKey(className)) print("found class");
      ClassMirror classMirror = libMirror.declarations[className];

      print("No of instance methods found is ${classMirror.instanceMembers.length}");
      classMirror.instanceMembers.forEach((s, v) => print(s));
   }
}

此代碼應產生以下輸出 -

Found Library
checkng...class details..
No of classes found is : 1
Symbol("Foo")
found class
No of instance methods found is 8
Symbol("==")
Symbol("hashCode")
Symbol("toString")
Symbol("noSuchMethod")
Symbol("runtimeType")
Symbol("m1")
Symbol("m2")
Symbol("m3")

將Symbol轉換為字串

可以使用MirrorSystem類將存儲在符號中的類或類的名稱轉換回字串。以下代碼顯示如何將符號轉換為字串。

import 'dart:mirrors';
void main(){
   Symbol lib = new Symbol("foo_lib");
   String name_of_lib = MirrorSystem.getName(lib);

   print(lib);
   print(name_of_lib);
}

執行上面示例代碼，得到以下結果 -

Symbol("foo_lib")

foo_lib