スコープ付きパッケージレジストリ

スコープ付きレジストリは、Unity のデフォルトのレジストリに加えてレジストリを使用することを可能にし、独自のパッケージをホストできます。スコープ付きレジストリを使用すると、Package Manager は常に 1 つのパッケージを 1 つのレジストリにマップし、ネットワークの条件にかかわらず一貫した結果を保証します。

例えば、Unity のパッケージの一部をホストする独自のサーバーを設定すると、もし 1 つのレジストリが一時的に利用できなくなると、たとえ Package Manager が常に同じ順序でレジストリを検索しても、誤ったレジストリからパッケージを取得する可能性があります。ただし、独自のサーバーにスコープ付きレジストリを設定すると、 パッケージは常に 1 つのレジストリにのみマップされるため 、ネットワークの条件にかかわらず一貫した結果が保証されます。

サポートされるレジストリタイプ

Unity Package Manager は npm プロトコルに基づくレジストリをサポートします。既成の npm レジストリサーバーはなんでも使用でき、動作するはずですが、Verdaccio は素早く設定でき、多くの設定を必要としません。

これらのサーバーを設定したら、それらを スコープ付きレジストリ として加えることができます。これは npm が使用する概念と同じです。

制限

一部の npm レジストリサーバーは、/all Web API ルートですべてのパッケージの検索をサポートするわけではありません。Package Manager Search API は、設定されたスコープ付きレジストリに依存してこの古い npm API プロトコルをサポートします。公開されたすべてのパッケージのメタデータを返す HTTP エンドポイントがあります (例えば、https://registry.my-company.com/-/all)。

Package Manager API を使用して使用可能なパッケージを列挙するツールがある場合、レジストリが古いプロトコルをサポートしていないと、予期しない結果が発生する可能性があります。例えば、Package Manager ウィンドウの All packages (すべてのパッケージ) タブに、スコープ付きレジストリのパッケージは表示されません。ただし、この制限はパッケージの解決には適用されないため、スコープ付きレジストリからプロジェクトマニフェストにパッケージを手動で追加できます。

スコープ付きレジストリの設定

スコープ付きレジストリをプロジェクトマニフェストに設定するには、スコープ付きレジストリ設定オブジェクトの配列を取る scopedRegistries 属性を使用します。各オブジェクトには、スコープ付きレジストリにマップしたい各パッケージ名パターンの名前、URL の場所、スコープのリストが含まれます。Package Manager がパッケージを取得するレジストリを決定すると、パッケージの name と scopes の値を比較し、scopes が最も一致するレジストリを見つけます。

例えば、以下のプロジェクトマニフェストには、 Main と Tools の 2 つのスコープ付きレジストリがあります。

{
  "scopedRegistries": [
    {
      "name": "Main",
      "url": "https://my.company.com/registry",
      "scopes": [
        "com.my-company", "com.my-company.tools.foo"
      ]
    },
    {
      "name": "Tools",
      "url": "https://my.company.com/tools-registry",
      "scopes": [
        "com.my-company.tools"
      ]
    }
  ],
  "dependencies": {
    "com.unity.cinemachine": "1.0.0",
    "com.unity.2d.common": "1.0.0",
    "com.unity.2d.animation": "1.0.0",
    "com.my-company.bar": "1.0.0"
  }
}

ユーザーが com.my-company.bar パッケージをリクエストすると、Package Manager は com.my-company.* 名前空間がその名前に最も一致することを見つけ、Main レジストリからパッケージを取得します。

ユーザーが com.my-company.tools.foo パッケージをリクエストすると、 Main レジストリに正確に一致する名前空間を持つスコープがあります。

ユーザーが com.my-company.tools.animation パッケージをリクエストすると、Package Manager は com.my-company.tools.* 名前空間がその名前に最も近いことを見つけ、Tools レジストリからパッケージを取得します。Main スコープにも一致しますが、com.my-company.* 名前空間はそれほど近く一致しません。

ユーザーが com.other-company.bar パッケージをリクエストすると、Package Manager はスコープされたどのレジストリーでも一致するものを見つけられないため、 デフォルトのレジストリからパッケージを取得します。

設定

プロジェクトマニフェストの scopedRegistries 属性でスコープ付きレジストリを設定します。scopedRegistries 属性には、すべてのレジストリーを表すエントリー (オブジェクト) の配列が含まれます。

各レジストリオブジェクトには、一意の名前 (name)、場所 (url)、名前空間 (scopes) の配列が含まれます。Package Manager は scopes を使用して、 パッケージ名とレジストリを一致させます。