API文档 - 开始使用

XFEExtension 软件包安装指南

nuget包安装教程&使用指南,本教程将指导你如何从NuGet.org官方源或GitHub安装 XFEExtension 的相关包

欢迎使用 XFEstudio 开发的开源组件!本教程将指导你如何从 NuGet.org 官方源或 GitHub Packages 安装 XFEExtension 的相关包(如 XFEstudio.XFEExtension 等)。


快速链接


目录

  1. 从 NuGet.org 安装 (推荐)
  2. 从 GitHub Packages 安装 (尝鲜/特定版本)
  3. 版本选择与依赖管理

1. 从 NuGet.org 安装 (推荐)

这是获取 XFEExtension 稳定版包的最快方式。

方法 A:使用 .NET CLI (跨平台)

打开终端,进入你的项目目录,执行:

# 以 XFEExtension.NetCore 为例
dotnet add package XFEExtension.NetCore

方法 B:使用 Visual Studio 管理器

  1. 右键点击项目 -> 管理 NuGet 程序包
  2. 在“浏览”页签搜索:XFE
  3. 从列表中选择你需要的包(例如 XFEExtension.NetCore.AutoConfig),点击安装。

方法 C:程序包管理器控制台

在 Visual Studio 的控制台中输入:

Install-Package XFEExtension.NetCore

2. 从 GitHub Packages 安装

如果你需要使用某些在 GitHub 上先行发布的预览版或特定仓库的包,可以按照以下步骤操作。

第一步:身份验证 (Required)

GitHub Packages 需要使用 GitHub 个人访问令牌 (PAT) 进行身份验证。

  1. GitHub Settings 生成一个具有 read:packages 权限的 Token。
  2. 保存该 Token,它将作为你的密码。

第二步:配置 XFEstudio 专属源

你可以通过在项目根目录下创建一个 nuget.config 文件来永久配置:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <!-- 保持官方源开启 -->
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
    <!-- 添加 XFEstudio 的 GitHub 源 -->
    <add key="XFEstudio_GitHub" value="https://nuget.pkg.github.com/XFEstudio/index.json" />
  </packageSources>
  
  <packageSourceCredentials>
    <XFEstudio_GitHub>
      <add key="Username" value="你的GITHUB用户名" />
      <add key="ClearTextPassword" value="你的PAT_TOKEN" />
    </XFEstudio_GitHub>
  </packageSourceCredentials>
</configuration>

第三步:安装 GitHub 上的包

配置完成后,你可以指定源进行安装:

dotnet add package XFEExtension.NetCore --source XFEstudio_GitHub

3. 版本选择与依赖管理

获取预发行版 (Prerelease)

XFEstudio 的新特性通常会先发布预览版。

  • CLI: dotnet add package XFEExtension.NetCore --prerelease
  • VS GUI: 勾选“包括预发行版”复选框。

常用命令

需求 命令
查看当前已安装包 dotnet list package
更新 XFEstudio 包 dotnet add package XFEExtension.NetCore (不带版本号默认最新)
移除包 dotnet remove package XFEExtension.NetCore

遇到问题?

如果你在使用 XFEExtension 的过程中遇到任何 Bug 或有功能建议:

  1. 前往相关的 GitHub Repository 提交 Issue。
  2. 在 NuGet 页面点击 "Contact Owners" 给我留言。

感谢支持 XFEExtension 的开源项目!