使用 nuget server 的 API 來實現搜索安裝 nuget 包

来源:https://www.cnblogs.com/weihanli/archive/2020/06/27/13197771.html
-Advertisement-
Play Games

使用 nuget server 的 API 來實現搜索安裝 nuget 包 ...


使用 nuget server 的 API 來實現搜索安裝 nuget 包

Intro

nuget 現在幾乎是 dotnet 開發不可缺少的一部分了，還沒有用過 nuget 的就有點落後時代了，還不快用起來

nuget 是 dotnet 里的包管理機制，類似於前端的 npm ，php 的 composer，java 里的 maven ...

nuget 定義了一套關於 nuget server 的規範，使得用戶可以自己實現一個 nuget server

也正是這些規範，使得我們可以根據這些規範來實現 nuget server 的包管理的功能，今天主要介紹一下，根據 nuget server 的 api 規範使用原始的 HTTP 請求來實現 nuget 包的搜索和使用 nuget 提供的客戶端 SDK 來實現 nuget 包的搜索和下載

Nuget Server Api

Nuget 協議介紹

nuget 的協議有好幾個版本，目前主要用的是 v3，開源的 nuget server Baget 也實現了基於 nuget protocal v3 的規範

我們添加 nuget 源的時候會指定一個 source url，類似 https://api.nuget.org/v3/index.json 這樣的，著通常被稱為 Service Index，是一個 nuget 源的入口，有點類似於 Identity Server 里的發現文檔，通過這個地址可以獲取到一系列的資源的地址

有一些資源是協議規範里定義的必須要實現的，有一些是可選的，具體參考官方文檔，以後隨著版本變化，可能會有差異，目前 nuget.org 提供的資源如下：

Nuget.org 提供了兩種搜索的方式，

一個是 SearchQuery，會根據包名稱、 tag、description 等信息去匹配關鍵詞，

一個是 SearchAutocomplete 根據包名稱的首碼去匹配包的名稱

獲取某個 nuget 包的版本信息，可以使用 PackageBaseAddress 來獲取

ServiceIndex 返回的信息示例如下：

返回的信息會有一個 resources 的數組，會包含各種不同類型的資源，對應的 @id 就是調用這種類型的API要用到的地址，下麵來看一個搜索的示例

在每個 API 的文檔頁面可以看到會使用的 @type，調用這個 API 的時候應該使用這些 @type 對應的資源

這裡的 @id 就是上面的 resource 對應的 @id，

參數說明：

q 搜索時所用的關鍵詞，

skip/take 用來分頁顯示查詢結果，

prelease 用來指定是否限制預覽版的 package，true 包含預覽版的 nuget 包，false 只包含已經正式發佈的 nuget 包

semVerLevel 是用來指定包的語義版本

The semVerLevel query parameter is used to opt-in to SemVer 2.0.0 packages. If this query parameter is excluded, only packages with SemVer 1.0.0 compatible versions will be returned (with the standard NuGet versioning caveats, such as version strings with 4 integer pieces). If semVerLevel=2.0.0 is provided, both SemVer 1.0.0 and SemVer 2.0.0 compatible packages will be returned. See the SemVer 2.0.0 support for nuget.org for more information

packageType 用來指定 nuget 包的類型，目前支持的類型包括 Dependency(預設)項目依賴項，DotnetTool(dotnetcore 2.1 引入的 dotnet cli tool)，Template (dotnet new 用) 自定義的項目模板

其他的 API 可以自行參考官方文檔：https://docs.microsoft.com/en-us/nuget/api/service-index

Packages

SearchQuery 返回的信息比較多而且可能並不准確，適用於不清楚包的名稱的時候使用，如果知道 nuget 包的名稱（PackageId） ，可以使用 SearchAutocomplete 來搜索，這樣更精準，返回的信息也更簡單，只有匹配的 package 名稱

通過原始 api 調用的方式實現 nuget 包的搜索

using var httpClient = new HttpClient(new NoProxyHttpClientHandler());
// loadServiceIndex
var serviceIndexResponse = await httpClient.GetStringAsync(NugetServiceIndex);
var serviceIndexObject = JObject.Parse(serviceIndexResponse);

var keyword = "weihanli";

//https://docs.microsoft.com/en-us/nuget/api/search-query-service-resource
var queryEndpoint = serviceIndexObject["resources"]
    .First(x => x["@type"].Value<string>() == "SearchQueryService")["@id"]
    .Value<string>();
var queryUrl = $"{queryEndpoint}?q={keyword}&skip=0&take=5&prerelease=false&semVerLevel=2.0.0";
var queryResponse = await httpClient.GetStringAsync(queryUrl);
Console.WriteLine($"formatted queryResponse:");
Console.WriteLine($"{JObject.Parse(queryResponse).ToString(Formatting.Indented)}");

// https://docs.microsoft.com/en-us/nuget/api/search-autocomplete-service-resource
var autoCompleteQueryEndpoint = serviceIndexObject["resources"]
    .First(x => x["@type"].Value<string>() == "SearchAutocompleteService")["@id"]
    .Value<string>();
var autoCompleteQueryUrl = $"{autoCompleteQueryEndpoint}?q={keyword}&skip=0&take=5&prerelease=false&semVerLevel=2.0.0";
var autoCompleteQueryResponse = await httpClient.GetStringAsync(autoCompleteQueryUrl);
Console.WriteLine($"formatted autoCompleteQueryResponse:");
Console.WriteLine($"{JObject.Parse(autoCompleteQueryResponse).ToString(Formatting.Indented)}");

output 示例：

Query 返回示例

Autocomplete 返回結果

從上面我們可以看到 Query 介面返回了很多的信息，Autocomplete 介面只返回了 package 的名稱，返回的信息更為簡潔，所以如果可以使用 Autocomplete 的方式就儘可能使用 Autocomplete 的方式

Package Versions

前面我們提到了可以使用 PackageBaseAddress 來查詢某個 nuget 包的版本信息，文檔地址：https://docs.microsoft.com/en-us/nuget/api/package-base-address-resource，來看一下示例：

using (var httpClient = new HttpClient(new NoProxyHttpClientHandler()))
{
    // loadServiceIndex
    var serviceIndexResponse = await httpClient.GetStringAsync(NugetServiceIndex);
    var serviceIndexObject = JObject.Parse(serviceIndexResponse);

    // https://docs.microsoft.com/en-us/nuget/api/package-base-address-resource
    var packageVersionsEndpoint = serviceIndexObject["resources"]
        .First(x => x["@type"].Value<string>() == "PackageBaseAddress/3.0.0")["@id"]
        .Value<string>();

    var packageVersionsQueryUrl = $"{packageVersionsEndpoint}/dbtool.core/index.json";
    var packageVersionsQueryResponse = await httpClient.GetStringAsync(packageVersionsQueryUrl);
    Console.WriteLine("DbTool.Core versions:");
    Console.WriteLine(JObject.Parse(packageVersionsQueryResponse)
                      .ToString(Formatting.Indented));
}

output 示例：

註：api 地址中的 packageId 要轉小寫

Nuget Client SDK

除了上面的根據 api 自己調用，我們還可以使用 nuget 提供的客戶端 sdk 實現上述功能，這裡就不詳細介紹了，有需要可能查閱官方文檔：https://docs.microsoft.com/en-us/nuget/reference/nuget-client-sdk

下麵給出一個使用示例：

var packageId = "WeihanLi.Common";
var packageVersion = new NuGetVersion("1.0.38");

var logger = NullLogger.Instance;
var cache = new SourceCacheContext();
// 在 SDK 的概念里，每一個 nuget 源是一個 repository
var repository = Repository.Factory.GetCoreV3("https://api.nuget.org/v3/index.json");

// SearchQuery
{
    var resource = await repository.GetResourceAsync<PackageSearchResource>();
    var searchFilter = new SearchFilter(includePrerelease: false);

    var results = await resource.SearchAsync(
        "weihanli",
        searchFilter,
        skip: 0,
        take: 20,
        logger,
        CancellationToken.None);
    foreach (var result in results)
    {
        Console.WriteLine($"Found package {result.Identity.Id} {result.Identity.Version}");
    }
}
// SearchAutoComplete
{
    var autoCompleteResource = await repository.GetResourceAsync<AutoCompleteResource>();
    var packages =
        await autoCompleteResource.IdStartsWith("WeihanLi", false, logger, CancellationToken.None);
    foreach (var package in packages)
    {
        Console.WriteLine($"Found Package {package}");
    }
}
//
{
    // get package versions
    var findPackageByIdResource = await repository.GetResourceAsync<FindPackageByIdResource>();
    var versions = await findPackageByIdResource.GetAllVersionsAsync(
        packageId,
        cache,
        logger,
        CancellationToken.None);

    foreach (var version in versions)
    {
        Console.WriteLine($"Found version {version}");
    }
}

More

你可以使用 nuget sdk 方便的實現 nuget 包的下載安裝，內部實現了簽名校驗等，這樣就可以把本地不存在的 nuget 包下載到本地了，

實現示例：

{
    var pkgDownloadContext = new PackageDownloadContext(cache);
    var downloadRes = await repository.GetResourceAsync<DownloadResource>();

    var downloadResult = await RetryHelper.TryInvokeAsync(async () =>
        await downloadRes.GetDownloadResourceResultAsync(
            new PackageIdentity(packageId, packageVersion),
            pkgDownloadContext,
            @"C:\Users\liweihan\.nuget\packages", // nuget globalPackagesFolder
            logger,
            CancellationToken.None), r => true);
    Console.WriteLine(downloadResult.Status.ToString());
}

最後提供一個解析 nuget globalPackagesFolder 的兩種思路：

一個是前面有篇文章介紹的，有個預設的配置文件，然後就是預設的配置，寫了一個解析的方法示例，支持 Windows/Linux/Mac：

{
    var packagesFolder = Environment.GetEnvironmentVariable("NUGET_PACKAGES");

    if (string.IsNullOrEmpty(packagesFolder))
    {
        // Nuget globalPackagesFolder resolve
        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
        {
            var defaultConfigFilePath =
                $@"{Environment.GetEnvironmentVariable("APPDATA")}\NuGet\NuGet.Config";
            if (File.Exists(defaultConfigFilePath))
            {
                var doc = new XmlDocument();
                doc.Load(defaultConfigFilePath);
                var node = doc.SelectSingleNode("/configuration/config/add[@key='globalPackagesFolder']");
                if (node != null)
                {
                    packagesFolder = node.Attributes["value"]?.Value;
                }
            }

            if (string.IsNullOrEmpty(packagesFolder))
            {
                packagesFolder = $@"{Environment.GetEnvironmentVariable("USERPROFILE")}\.nuget\packages";
            }
        }
        else
        {
            var defaultConfigFilePath =
                $@"{Environment.GetEnvironmentVariable("HOME")}/.config/NuGet/NuGet.Config";
            if (File.Exists(defaultConfigFilePath))
            {
                var doc = new XmlDocument();
                doc.Load(defaultConfigFilePath);
                var node = doc.SelectSingleNode("/configuration/config/add[@key='globalPackagesFolder']");
                if (node != null)
                {
                    packagesFolder = node.Attributes["value"]?.Value;
                }
            }

            if (string.IsNullOrEmpty(packagesFolder))
            {
                defaultConfigFilePath = $@"{Environment.GetEnvironmentVariable("HOME")}/.nuget/NuGet/NuGet.Config";
                if (File.Exists(defaultConfigFilePath))
                {
                    var doc = new XmlDocument();
                    doc.Load(defaultConfigFilePath);
                    var node = doc.SelectSingleNode("/configuration/config/add[@key='globalPackagesFolder']");
                    if (node != null)
                    {
                        packagesFolder = node.Value;
                    }
                }
            }

            if (string.IsNullOrEmpty(packagesFolder))
            {
                packagesFolder = $@"{Environment.GetEnvironmentVariable("HOME")}/.nuget/packages";
            }
        }
    }

    Console.WriteLine($"globalPackagesFolder: {packagesFolder}");
}

另一個是可以根據 nuget 提供的一個命令查詢 nuget locals global-packages -l，通過命令輸出獲取

Reference


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 第004講：改進我們的小游戲
    一 條件分支 1 python的比較操作符 2 python的條件分支語法 語法格式： if條件: 條件為（True）真執行的操作 else: 條件為假（False）執行的操作 跟其他語言的區別： if和else判斷語句後面必須要有冒號（其它語言沒有） 執行體的內容不需要用花括弧擴起來，所以必須嚴格 ...
  • PHP開發環境搭建工具有哪些？
    對於php開發小白來說搭建一個php運行環境就是一道坎！ 因為要做php開發，搭建一個能夠運行php網站的伺服器環境是第一步，傳統的php環境軟體非常複雜，好在很多公司開發了一鍵搭建php安裝環境，一鍵進行php環境配置，大大節省了搭建php mysql環境的時間！對老手來說安裝配置php環境也不再 ...
  • 在 Spring Boot 中使用 HikariCP 連接池
    上次幫小王解決瞭如何在 Spring Boot 中使用 JDBC 連接 MySQL 後，我就一直在等，等他問我第三個問題，比如說如何在 Spring Boot 中使用 HikariCP 連接池。但我等了四天也沒有等到任何音訊，似乎他從我的世界里消失了，而我卻仍然沉醉在他拍我馬屁的美妙感覺里。 突然感 ...
  • Spring Boot 使用 AOP來防止重覆提交
    思路 自定義註解 @NoRepeatSubmit 標記所有Controller中的提交請求 通過AOP 對所有標記了 @NoRepeatSubmit 的方法攔截 在業務方法執行前，獲取當前用戶的 token（或者JSessionId）+ 當前請求地址，作為一個唯一 KEY，去獲取 Redis 分散式 ...
  • ApiTemplate：.net後端項目模板完善與總結
    ApiTemplate後端項目開發模板，發佈也有一段時間了。為了補充應用場景，以及詳細說明本人總結的一些開發經驗，現已常見的《用戶/登錄許可權驗證》功能模塊來進行詳細的講解。我會以為開發此模擬的實現路徑為主線進行說明，希望能幫助到某些開發朋友。一、模塊分解模塊分析是按照《C4-架構圖》理念做的，主要分 ...
  • WindowsForm切換視窗的幾種常見實現
    在Windows Form平臺下實現視窗跳轉，常見的有以下幾種方式，比如通過Show/ShowDialog方法顯示新的視窗，通過多文檔界面(MDI)在父視窗中載入子視窗，或者是通關過在視窗中動態載入自定義控制項，比如通過將視窗中的Panel控制項作為容器，將一些自定義元素作為視圖界面控制項，動態載入到Pa ...
  • 重學ASP.NET Core 中的標記幫助程式
    標記幫助程式是什麼 標記幫助程式使伺服器端代碼可以在 Razor 文件中參與創建和呈現 HTML 元素。 例如，內置的 ImageTagHelper 可以將版本號追加到圖片名稱。 每當圖片發生變化時，伺服器都會為圖像生成一個新的唯一版本號，因此客戶端總能獲得當前圖像（而不是過時的緩存圖像）。 作者： ...
  • C# 9.0 終於來了, Top-level programs 和 Partial Methods 兩大新特性探究
    一：背景 1. 講故事 .NET 5 終於在 6月25日 發佈了第六個預覽版，隨之而來的是更多的新特性加入到了 C# 9 Preview 中，這個系列也可以繼續往下寫了，廢話不多說，今天來看一下 Top-level programs 和 Extending Partial Methods 兩大新特性 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類