Flutter pub私有库搭建 & 使用

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

目标

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

步骤

部署pub_server服务端
去除发布到私有库时的google权限校验(执行pub publish命令时)
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是存放上传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

注意：
正式部署时，请将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 _publish(List 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 _publish(List 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=] --snapshot=

编译生成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目录下的同名文件即可。

如果你是直接安装的Flutter，dart-sdk在flutter/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

Flutter pub私有库搭建 & 使用

目标

步骤

方法

你可能感兴趣的:(Flutter pub私有库搭建 & 使用)