新聞中心
Package 介紹
使用package可以創(chuàng)建可輕松共享的模塊化代碼。一個最小的package包括

成都創(chuàng)新互聯(lián)從2013年開始,先為旌德等服務建站,旌德等地企業(yè),進行企業(yè)商務咨詢服務。為旌德企業(yè)網(wǎng)站制作PC+手機+微官網(wǎng)三網(wǎng)同步一站式服務解決您的所有建站問題。
- 一個pubspec.yaml文件:聲明了package的名稱、版本、作者等的元數(shù)據(jù)文件。
- 一個 lib 文件夾:包括包中公開的(public)代碼,最少應有一個
.dart文件
Package 類型
Packages可以包含多種內(nèi)容:
- Dart包:其中一些可能包含F(xiàn)lutter的特定功能,因此對Flutter框架具有依賴性,僅將其用于Flutter,例如fluro包。
- 插件包:一種專用的Dart包,其中包含用Dart代碼編寫的API,以及針對Android(使用Java或Kotlin)和/或針對iOS(使用ObjC或Swift)平臺的特定實現(xiàn)。一個具體的例子是battery插件包。
Developing Dart packages
Step 1: 開發(fā)Dart包
要創(chuàng)建Dart包,請使用--template=package 來執(zhí)行 flutter create
$ flutter create --template=package hello這將在hello/文件夾下創(chuàng)建一個具有以下專用內(nèi)容的package工程:
- lib/hello.dart:Package的Dart代碼
- test/hello_test.dart:Package的單元測試代碼.
Step 2: 實現(xiàn)package
對于純Dart包,只需在主lib/
要測試軟件包,請在test目錄中添加unit tests。
有關(guān)如何組織包內(nèi)容的更多詳細信息,請參閱Dart library package文檔。
開發(fā)插件包
如果你想開發(fā)一個調(diào)用特定平臺API的包,你需要開發(fā)一個插件包,插件包是Dart包的專用版本。 插件包包含針對Android(Java或Kotlin代碼)或iOS(Objective-C或Swift代碼)編寫的特定于平臺的實現(xiàn)(可以同時包含Android和Ios原生的代碼)。 API使用platform channels連接到特定平臺(Android或IOS)。
Step 1: 創(chuàng)建 package
要創(chuàng)建插件包,請使用--template=plugin參數(shù)執(zhí)行flutter create
使用--org選項指定您的組織,并使用反向域名表示法。該值用于生成的Android和iOS代碼中的各種包和包標識符。
$ flutter create --org com.example --template=plugin hello這將在hello/文件夾下創(chuàng)建一個具有以下專用內(nèi)容的插件工程:
- lib/hello.dart:插件包的Dart API.
- android/src/main/java/com/yourcompany/?hello/HelloPlugin.java:插件包API的Android實現(xiàn).
- ios/Classes/HelloPlugin.m:插件包API的ios實現(xiàn).
- example/:一個依賴于該插件的Flutter應用程序,來說明如何使用它
默認情況下,插件項目針對iOS代碼使用Objective-C,Android代碼使用Java。如果您更喜歡Swift或Kotlin,則可以使用-i 或 -a 為iOS或Android指定語言。例如:
$ flutter create --template=plugin -i swift -a kotlin hello
Step 2: 實現(xiàn)包 package
由于插件包中包含用多種編程語言編寫的多個平臺的代碼,因此需要一些特定的步驟來確保順暢的體驗。
Step 2a: 定義包API(.dart)
插件包的API在Dart代碼中定義。打開主文件夾hello/ 。找到lib/hello.dart
Step 2b: 添加Android平臺代碼(.java / .kt)
我們建議您使用Android Studio編輯Android代碼。
在Android Studio中編輯Android平臺代碼之前,首先確保代碼至少已經(jīng)構(gòu)建過一次(例如,從IntelliJ運行示例應用程序或在終端執(zhí)行cd hello/example; flutter build apk)
接下來
- 啟動Android Studio
- 在’Welcome to Android Studio’對話框選擇 ‘Import project’, 或者在菜單欄 ‘File > New > Import Project…‘,然后選擇hello/example/android/build.gradle文件.
- 在’Gradle Sync’ 對話框, 選擇 ‘OK’.
- 在’Android Gradle Plugin Update’ 對話框, 選擇 ‘Don’t remind me again for this project’.
您插件的Android平臺代碼位于 hello/java/com.yourcompany.hello/?HelloPlugin.
您可以通過按下 ? 按鈕從Android Studio運行示例應用程序.
Step 2c: 添加iOS平臺代碼 (.h+.m/.swift)
我們建議您使用Xcode編輯iOS代碼 。
在編輯Xcode中的iOS平臺代碼之前,首先確保代碼至少已經(jīng)構(gòu)建過一次(例如,從Xcode中運行示例應用程序或終端執(zhí)行cd hello/example; flutter build ios --no-codesign)。
接下來
- 啟動 Xcode
- 選擇 ‘File > Open’, 然后選擇 hello/example/ios/Runner.xcworkspace 文件.
您插件的iOS平臺代碼位于Pods/DevelopmentPods/hello/Classes/中。
您可以通過按下?按鈕來運行示例應用程序
Step 2d: 連接API和平臺代碼
最后,您需要將用Dart代碼編寫的API與平臺特定的實現(xiàn)連接起來。這是通過platform channels完成的。
添加文檔
建議將以下文檔添加到所有軟件包:
- README.md:介紹包的文件
- CHANGELOG.md 記錄每個版本中的更改
- LICENSE 包含軟件包許可條款的文件
- 所有公共API的API文檔 (詳情見下文)
API documentation
在發(fā)布軟件包時,API文檔會自動生成并發(fā)布到dartdocs.org,示例請參閱device_info docs
如果您希望在本地生成API文檔,請使用以下命令:
- 將目錄更改為您的軟件包的位置:cd ~/dev/mypackage
- 告訴文檔工具Flutter SDK的位置:export FLUTTER_ROOT=~/dev/flutter (on macOS or Linux)set FLUTTER_ROOT=~/dev/flutter (on Windows)
- 運行 dartdoc 工具 (它是Flutter SDK的一部分):$FLUTTER_ROOT/bin/cache/dart-sdk/bin/dartdoc (on macOS or Linux)%FLUTTER_ROOT%\bin\cache\dart-sdk\bin\dartdoc (on Windows)
有關(guān)如何編寫API文檔的提示,請參閱Effective Dart: Documentation
發(fā)布 packages
一旦你實現(xiàn)了一個包,你可以在Pub上發(fā)布它 ,這樣其他開發(fā)人員就可以輕松使用它
在發(fā)布之前,檢查pubspec.yaml、README.md以及CHANGELOG.md文件,以確保其內(nèi)容的完整性和正確性。
然后, 運行 dry-run 命令以查看是否都準備OK了:
$ flutter packages pub publish --dry-run最后, 運行發(fā)布命令:
$ flutter packages pub publish有關(guān)發(fā)布的詳細信息,請參閱Pub publishing docs
處理包的相互依賴
如果您正在開發(fā)一個hello包,它依賴于另一個包,則需要將該依賴包添加到pubspec.yaml文件的dependencies部分。 下面的代碼使url_launcher插件的Dart API ,這在hello包中是可用的:
In hello/pubspec.yaml:
dependencies:
url_launcher: ^0.4.2
現(xiàn)在你可以在hello中import 'package:url_launcher/url_launcher.dart' 然后 launch(someUrl) 了。
這與在Flutter應用程序或任何其他Dart項目中引用軟件包沒有什么不同
但是,如果hello碰巧是一個插件包,其平臺特定的代碼需要訪問url_launcher公開的特定于平臺的API,那么您還需要為特定于平臺的構(gòu)建文件添加合適的依賴聲明,如下所示。
Android
在 hello/android/build.gradle:
android {
// lines skipped
dependencies {
provided rootProject.findProject(":url_launcher")
}
}
您現(xiàn)在可以在hello/android/src源碼中import io.flutter.plugins.urllauncher.UrlLauncherPlugin訪問UrlLauncherPlugin類
iOS
在hello/ios/hello.podspec:
Pod::Spec.new do |s|
# lines skipped
s.dependency 'url_launcher'
您現(xiàn)在可以在hello/ios/Classes源碼中 #import "UrlLauncherPlugin.h" 然后訪問 UrlLauncherPlugin 類
解決沖突
假設你想在你的hello包中使用some_package和other_package,并且這兩個包都依賴url_launcher,但是依賴的是url_launcher的不同的版本。 那我們就有潛在的沖突。避免這種情況的最好方法是在指定依賴關(guān)系時,程序包作者使用版本范圍而不是特定版本。
dependencies:
url_launcher: ^0.4.2 # Good, any 0.4.x with x >= 2 will do.
image_picker: '0.1.1' # Not so good, only 0.1.1 will do.
如果some_package聲明了上面的依賴關(guān)系,other_package聲明了url_launcher版本像’0.4.5’或’^0.4.0’,pub將能夠自動解決問題。 類似的注釋適用于插件包對Gradle模塊和Cocoa pods的平臺特定的依賴關(guān)系。
即使some_package和other_package聲明了不兼容的url_launcher版本,它仍然可能會和url_launcher以兼容的方式正常工作。 你可以通過向hello包的pubspec.yaml文件中添加依賴性覆蓋聲明來處理沖突,從而強制使用特定版本:
強制使用 0.4.3版本的url_launcher,在 hello/pubspec.yaml中:
dependencies:
some_package:
other_package:
dependency_overrides:
url_launcher: '0.4.3'
如果沖突的依賴不是一個包,而是一個特定于Android的庫,比如guava,那么必須將依賴重寫聲明添加到Gradle構(gòu)建邏輯中。
強制使用23.0版本的guava庫,在hello/android/build.gradle中:
configurations.all {
resolutionStrategy {
force 'com.google.guava:guava:23.0-android'
}
}
Cocoapods目前不提供依賴覆蓋功能。
分享題目:創(chuàng)新互聯(lián)Flutter教程:Flutter開發(fā)packages
文章轉(zhuǎn)載:http://m.5511xx.com/article/cdcphpp.html


咨詢
建站咨詢
