Flutter pub私有库搭建 & 使用

字节跳动的私有库公开了可以看我这篇博客部署:字节跳动flutter私有库unpub

目标

  1. 搭建私有pub服务器
  2. 发布私有库到自建服务器
  3. 引用私有pub服务器上的私有库

步骤

  1. 部署pub_server服务端
  2. 去除发布到私有库时的google权限校验(执行pub publish命令时)
  3. pubspec.yaml中引用私有库

方法

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就是pub推上来的包储存的位置

其中dart example/example.dart -d /tmp/package-db命令中的/tmp/package-db是存放上传packageplugin的地址,可以按照自己的要求确定。
当在终端中看到以下内容,说明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

注意:
正式部署时,请将localhost替换为本机真实的ip地址和可用端口。不能使用localhost字符串,使用localhost的话其他机器无法通过ip访问。

若采用修改客户端PUB_HOSTED_URL环境变量的方式引用私有仓库,则需要将example/example.dart文件中的pubDartLangOrg常量的值改为国内pub镜像地址,比如“https://pub.flutter-io.cn”。

修改localhost和8080端口号,可以在example/example.dart文件中搜索相关文字进行修改。

2.去除google权限校验
2.1. 下载pub源代码地址:https://github.com/dart-lang/pub

git clone https://github.com/dart-lang/pub
cd pub
pub get

2.2. 找到lish.dart文件(路径:pub/lib/src/command/lish.dart)


image.png

2.3. 主要是去掉外层oauth2.withClient(cache, (client)withAuthenticatedClient(cache, server, (client) 校验代码
源代码:

Future<void> _publish(List<int> packageBytes) async {
    try {
      final officialPubServers = {
        'https://pub.dartlang.org',
        'https://pub.dev',

        if (runningFromTest &&
            Platform.environment.containsKey('PUB_HOSTED_URL') &&
            Platform.environment['_PUB_TEST_AUTH_METHOD'] == 'oauth2')
          Platform.environment['PUB_HOSTED_URL'],
      };

      if (officialPubServers.contains(server.toString())) {
        // Using OAuth2 authentication client for the official pub servers
        await oauth2.withClient(cache, (client) {
          return _publishUsingClient(packageBytes, client);
        });
      } else {
        // For third party servers using bearer authentication client
        await withAuthenticatedClient(cache, server, (client) {
          return _publishUsingClient(packageBytes, client);
        });
      }
    } on PubHttpException catch (error) {
      var url = error.response.request!.url;
      if (Uri.parse(url.origin) == Uri.parse(server.origin)) {
        handleJsonError(error.response);
      } else {
        rethrow;
      }
    }
  }

修改后代码:

Future<void> _publish(List<int> packageBytes) async {
    try {
      final officialPubServers = {
        'https://pub.dartlang.org',
        'https://pub.dev',

        if (runningFromTest &&
            Platform.environment.containsKey('PUB_HOSTED_URL') &&
            Platform.environment['_PUB_TEST_AUTH_METHOD'] == 'oauth2')
          Platform.environment['PUB_HOSTED_URL'],
      };

      if (officialPubServers.contains(server.toString())) {
        // Using OAuth2 authentication client for the official pub servers
        // await oauth2.withClient(cache, (client) {
        //   return _publishUsingClient(packageBytes, client);
        // });
        await _publishUsingClient(packageBytes, http.Client());

      } else {
        // For third party servers using bearer authentication client
        // await withAuthenticatedClient(cache, server, (client) {
        //   return _publishUsingClient(packageBytes, client);
        // });
        await _publishUsingClient(packageBytes, http.Client());
      }
    } on PubHttpException catch (error) {
      var url = error.response.request!.url;
      if (Uri.parse(url.origin) == Uri.parse(server.origin)) {
        handleJsonError(error.response);
      } else {
        rethrow;
      }
    }
  }

2.4. 可以选择编译成自己的snapshot文件,命令形式如下

dart [--package_root=<path>] --snapshot=<output_file> <dart_file>

编译生成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()方法的。

2.5. 替换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目录下的同名文件即可。

如果你是直接安装的Flutterdart-sdkflutter/bin/cache目录下。

3.发布私有库到私有pub_server
主要是修改pubspec.yaml中的publish_to:到自己的私有pub_server pubspec.yaml编写规则

ps:注意每次提交version不能重复 version编写规则

name: user_info_s
description: A new Flutter project.
publish_to: http://localhost:8080 # Remove this line if you wish to publish to pub.dev

然后在package根目录下执行pub publish,此时不会再要求你做google校验,最终看到Successfully uploaded package.

4.使用私有pub库
方法1:在工程的pubspec.yaml文件中指定私有pub的引用:

user_info_s:
    hosted:
      name: user_info_s
      url: http://localhost:8080
    version: ^0.0.1

注意,name就是package的名称,如果填写的错误,pub_server服务会找不到对应的package,你会在pub_server的终端看到类似这样的日志:2022-03-01T08:49:42.888997 0:00:00.000319 GET [404] /api/packages/user_info

方法2:将环境变量设置为私有Pub服务地址export PUB_HOSTED_URL=http://localhost:8080,然后在pubspec.yaml文件中正常引用package:

dependencies:
  user_info_s: ^0.0.1

若使用该方法,则需要将example/example.dart文件中的pubDartLangOrg常量的值改为国内pub镜像地址,比如“https://pub.flutter-io.cn”。
因为当私有Pub仓库中找不到请求的package时,程序会到pubDartLangOrg指定的pub仓库中去下载用到的package到私有仓库中。
若在使用过程中出现错误,可以使用flutter pub get -v命令查看具体的明细日志。

参考链接:https://blog.csdn.net/blog_jihq/article/details/115380948

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,607评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,047评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,496评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,405评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,400评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,479评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,883评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,535评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,743评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,309评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,881评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2 342

推荐阅读更多精彩内容