Flutter Pub私有仓库搭建
目标
将自己的package/plugin推到私有pub仓库中。
关键步骤
完成该目标有两个关键步骤需要处理:
第一,部署pub_server服务端;
第二,去除pub publish命令中的google权限校验。
具体方法
1.部署pub_server
按照如下命令下载pub_server源代码,拉取依赖库后运行程序。
git clone https://github.com/dart-archive/pub_server.git
...
cd pub_server/
...
pub get
...
dart example/example.dart -d /tmp/package-db
因为pub_server是使用Dart语言编写,因此该服务的启动需要依赖dart环境,所以请先确保Dart运行环境已正确安装。
其中dart example/example.dart -d /tmp/package-db
命令中的/tmp/package-db
是存放上传package和plugin的地址,可以按照自己的要求确定。
当在终端中看到以下内容,说明pub_server运行正常:
Listening on http://localhost:8080
To make the pub client use this repository configure your shell via:
$ export PUB_HOSTED_URL=http://localhost:8080
如果想修改这里的8080端口号,可以在example/example.dart
文件中搜索8080进行修改。
2.去除google权限校验
去除google权限校验的原理请参考https://blog.csdn.net/ameryzhu/article/details/101688994。
执行步骤如下:
1、下载已修改好的代码并更新依赖:
git clone https://github.com/ameryzhu/pub
cd pub
pub get
2、编译生成snapshot文件
dart --snapshot=my.pub.snapshot ~/pub/bin/pub.dart
网络上的文章有说在bin/lib目录下执行该命令的,其实该命令的执行目录并不重要,在哪里执行都可以;重要的是命令中的~/pub/bin/pub.dart
,因为该路径指定的文件中包含main()
方法。
所以当你的Terminal中出现类似../lib/pub.dart: Warning: Interpreting this as package URI, 'package:pub/pub.dart'.
这样的错误时,你就要确认一下自己的命令中指定的目录是否正确。
在pub的源代码中,bin目录和lib目录中都有pub.dart文件,但只有bin目录中的是包含main()
方法的。
如果不想编译生成snapshot,是否可以使用别人生成好的?使用线程snapshot文件时需要确认对方的dart版本,如果对方版本和你的版本不一致,替换文件后运行命令会提示相关错误。
3、替换snapshot文件或修改配置
网络上一般的做法是将上一步生成的my.pub.snapshot
文件拷贝到dart-sdk/bin/snapshots
目录下,并且使用文本编辑工具将dart-sdk/bin
目录下pub文件中的pub.dart.snapshot
修改为my.pub.snapshot
。
其实以上做法可能只是原作者的个人习惯,实际上只要将上一步的snapshot文件命名为pub.dart.snapshot
,并替换掉dart-sdk/bin/snapshots
目录下的同名文件即可。
如果你是直接安装的Flutter,dart-sdk在
flutter/bin/cache
目录下。
3.发布pub
创建一个package:flutter create --template=package test_package
。
然后填写pubspec.yaml
中的属性值,并添加publish_to
属性:
name: test_package
description: A new Flutter package project.
version: 0.0.1
author: test
homepage: http://gitlab.com/test
publish_to: http://localhost:8080
其中publish_to
的值就是pub私有仓库的服务地址。
然后在package根目录下执行pub publish
,此时不会再要求你做google校验,最终看到Successfully uploaded package.
。
4.使用pub
在工程的pubspec.yaml
文件中增加pub的引用:
dependencies:
test_package:
hosted:
name: test_package
url: http://localhost:8080
version: ^0.0.1
注意,name就是package的名称,如果填写的错误,pub_server服务会找不到对应的package,你会在pub_server的终端看到类似这样的日志:2021-04-01T18:06:30.456418 0:00:00.000277 GET [404] /api/packages/my-package
。
若在使用过程中出现错误,可以使用flutter pub get -v
命令查看具体的明细日志。
其他
pub_server只是一个存储package的服务,并没有像pub.dev那样的前端查询页面。其实dart官方把pub.dev也开源了,地址参看https://github.com/dart-lang/pub-dev。所以理论上也可以自己部署一套查询页面。