Flutter Package 涉及关键字的探究

一、 Package 关键字

import、as、show 、hide、part、part of、export、library、deferred as。

二、关键字探究

• import

  import 对于 iOS 开发者并不陌生，它是在 OC 头文件导入时使用的关键字。在 Flutter 中 import 的作用也是导入，导入Package的关键字。在 Flutter 中的形式:
  import 'package:xxxx.dart'; 和 import 'xxxx.dart';

  实例如下:

  import 'package:flutter/material.dart';
  import 'sign_record.dart';
  
  class TestApp extends StatelessWidget {
    @override
    Widget build(BuildContext context) {
      return Container(
        child: SignRecordRouter(),
      );
    }
  }
  

  上面是导入 material和sign_record文件引用提供下边使用。

  注意

  1. 两种导入形式的区别
     import 'package:xxxx.dart';是相对地址导入
     import 'xxxx.dart';是绝对地址导入
  2. 两种导入形式优劣
     import 'package:xxxx.dart'; 的优点是项目中使用导入文件的文件位置发生变化，不影响文件的头文件导入路径。
     import 'xxxx.dart'; 的缺点是项目中使用导入文件的文件的位置发生变化，影响文件的头文件导入，需要变更导入文件的路径。

• as

  Flutter 导入文件时的 as 的作用是给导入的 Package 进行命名。在使用时使用新命名的名进行调用属性、方法等。
  常用于:1. 简化Package的名字使用 2. 解决导入 Package 中类、属性、方法发生冲突时，使用 as 进行区分调用。

  实例代码:

  import 'package:testapp/A1/dog.dart';
  import 'package:testapp/B1/aa.dart';
  
  void main() {
    var dog = Dog();
    print(dog);
  }
  

  上面代码其中 aa.dart 和dog.dart 文件内容相同都是一个Dog 类，代码如下:

  class Dog {
  String name;
    void run() {
      print(name + "奔跑");
    }
  }
  

  所以在导入dog 和 aa 文件下，使用 Dog 类，就会报错，错误信息是:

  [class Dog, class Dog]
  'Dog' isn't a function.
  Try correcting the name to match an existing function, or define a method or function named 'Dog'.dartinvocation_of_non_function
  The name 'Dog' is defined in the libraries 'package:testapp/A1/dog.dart' and 'package:testapp/B1/aa.dart'.
  Try using 'as prefix' for one of the import directives, or hiding the name from all but one of the imports.
  

  解决方法如下:

  import 'package:testapp/A1/dog.dart' as ADog;
  import 'package:testapp/B1/aa.dart' as BDog;
  
  void main() {
    var dog = ADog.Dog();
    dog.name = "A";
    dog.run(); // A奔跑
  
    var dog1 = BDog.Dog();
    dog1.name = "B";
    dog1.run(); // B奔跑
  }
  

  注意

  在调用Package引入文件的方法、属性、类时，如果调用文件下有相同的属性、方法、类时，如果引入文件不做 as 从新命名调用，则会被本地方法、属性、类所替换。实例如下:

  // dog.dart
  void getInfo() {
    print("A 获取信息");
  }
  
  // aa.dart
  void getInfo() {
    print("B 获取信息");
  }
  
  // 使用
  import 'package:testapp/A1/dog.dart' as ADog;
  import 'package:testapp/B1/aa.dart';
  
  void main() {
    ADog.getInfo();
    getInfo();
  }
  
  void getInfo() {
    print("本地方法");
  }
  

  上面输出: A 获取信息和本地方法 而不是A 获取信息和B 获取信息, 因为 aa 中的 getInfo 方法被本地替换，而使用命名调用的则不会替换。

• show 和 hide

  show 和 hide 是对引入库里面的内容进行选择性添加或者去除使用。首先我们给dog.dart添加类，代码如下:

  class Dog {
    String name;
    void run() {
        print(name + "奔跑1");
    }
  }
  
  class BigDog {
    String name;
    void run() {
        print(name + "奔跑2");
    }
  }
  
  class MiddleDog {
    String name;
    void run() {
        print(name + "奔跑3");
    }
  }
  
  class SmallDog {
    String name;
    void run() {
        print(name + "奔跑4");
    }
  }
  
  

  • show
    show 是对引入库内容进行选择性使用，多个选择使用逗号分隔。实例如下:

    import 'package:testapp/A1/dog.dart' show Dog, MiddleDog;
    
    void main() {
      var dog = Dog();
      print(dog);
      var middleDog = MiddleDog();
      print(middleDog);
    }
    

    上面我们使用 show 选择性的使用Dog 和 MiddleDog 两个类，dog.dart 中的其他类不能被调用。

  • hide

    hide 是对引入库内容进行选择性的剔除使用，多个选择使用逗号分隔。实例如下:

    import 'package:testapp/A1/dog.dart' hide Dog, MiddleDog;
    
    void main() {
      var dog = SmallDog();
      print(dog);
      var dog1 = BigDog();
      print(dog1);
    }
    

    上面我们使用 hide 选择性剔除Dog 和 MiddleDog 两个类，dog.dart 中的其他类能被调用。

• part 和 part of

  part 和 part of 在 Flutter 的 Package 开发中配套使用。part 是用于 Package 内模块文件路径引用的关键字; 而 part of 是用于 Package 内模块指定属于哪个Package。使用实例代码如下:

  /// part
  library idkit_toast;
  
  import 'package:flutter/material.dart';
  part 'src/toast_api.dart';
  part 'src/toast_style.dart';
  /// part of
  part of idkit_toast;
  class IDKitToast {
    Widget getChild() {
        return Containter();
    }
  }
  

  上面使用 part 引出 IDKitToast 类所在文件路径，在IDKitToast文件中使用part of 指定该类属于idkit_toast,同时，在IDKitToast 用到的其他类等的引用则将在part 所在文件内添加。

• export

  export 将一个文件中使用头文件进行整合到一个文件中，在文件在导入整合文件就可以使用全部整合文件中所有模块。在不使用 export 整合的代码如下:

  import 'package:testapp/A1/cat.dart';
  import 'package:testapp/A1/dog.dart';
  import 'package:testapp/A1/pig.dart';
  
  void main() {
    var dog = Dog();
    print(dog);
    var cat = Cat();
    print(cat);
    var pig = Pig();
    print(pig);
  }
  

  使用exprot 将 cat.dart 、dog.dart、pig.dart 整合到a1.dart 文件中，代码如下:

  export 'cat.dart';
  export 'dog.dart';
  export 'pig.dart';
  

  使用 a1.dart 文件修改不使用export的代码修改:

  import 'package:testapp/A1/a1.dart';
  
  void main() {
    var dog = Dog();
    print(dog);
    var cat = Cat();
    print(cat);
    var pig = Pig();
    print(pig);
  }
  

  注意

  exprot 也有show 和 hide ,代码如下:

  // a1.dart
  export 'cat.dart';
  export 'dog.dart' show MiddleDog;
  export 'pig.dart';
  
  // main.dart
  import 'package:testapp/A1/a1.dart';
  
  void main() {
    var dog = MiddleDog();
    print(dog);
    var cat = Cat();
    print(cat);
    var pig = Pig();
    print(pig);
  }
  

  注意: export重新导入的库相当于将库内代码复制到当前文件中，但在当前文件并不能使用。

• library

  library 将当前文件声明为一个库，形式:library xx。实例代码:

  library idkit;
  
  part 'pig.dart';
  
  class IDKit {
    void init() {
      var pig = Pig();
      print(pig);
    }
  }
  

• deferred as

  deferred as 是在应用在需要加载库时进行延迟加载，常用于减少 App 的启动时间。实例代码:

  import 'package:testapp/A1/library.dart' deferred as Id;
  
  void main() {
    getLibrary();
    getLibrary();
    print("启动完成");
  }
  
  Future getLibrary() async {
    await Id.loadLibrary();
    var id = Id.IDKit();
    id.init();
  }
  

  尽管你可能在项目中多次调用 loadLibrary()来加载一个库，但是这个库也只会被加载一次。