欢迎加入
「易源易彩交流群」
「易源易彩交流群」
QQ扫码进群
（QQ群号：860213912）
注册得好礼
新用户微信注册享20元算力, >立即注册
关注公众号得算力
新用户关注易彩微信公众号享20元算力，
邀请有礼
邀请1人得5元算力，可累计叠加, 查看规则
本文提供了一篇关于.NET Core Web API的入门教程，重点介绍了如何使用JSON Web Tokens (JWT)进行认证。读者可以通过克隆GitHub仓库（https://github.com/GLEBR1K...）来获取示例代码，并跟随教程逐步构建和运行项目。本教程适合所有希望了解或学习.NET Core Web API与JWT认证技术的开发者。
JWT认证, .NET Core, Web API, GitHub仓库, 入门教程
JSON Web Tokens (JWT) 是一种开放标准 (RFC 7519)，用于在各方之间安全地传输信息。JWT 由三部分组成：头部 (Header)、负载 (Payload) 和签名 (Signature)。JWT 的主要特点是它是一种自包含的令牌，这意味着所有必要的信息都存储在令牌本身中，无需查询数据库即可验证和使用。这种特性使得 JWT 成为了许多现代 Web 应用程序和 API 认证的理想选择。
在.NET Core Web API 中使用 JWT 进行认证，意味着服务器会生成一个 JWT 并将其发送给客户端。客户端随后会在每个请求中携带该 JWT，通常是在 HTTP 授权头中。服务器端会验证 JWT 的有效性，如果有效，则允许访问受保护的资源。
JWT 认证相比传统的会话认证方式具有多方面的优势：
这些优势使得 JWT 成为了现代 Web 开发中非常受欢迎的认证机制之一。接下来，我们将通过实际操作来探索如何在.NET Core Web API 中实现 JWT 认证。
.NET Core 是 Microsoft 开发的一个开源、跨平台的框架，旨在为现代 Web 应用程序提供高效、灵活的基础。它支持 Windows、macOS 和 Linux 等多种操作系统，并且拥有强大的社区支持和丰富的生态系统。.NET Core 提供了高性能的运行时环境，以及广泛的类库和工具集，非常适合用于构建云原生应用、微服务架构以及高性能的 Web API。
.NET Core 的主要特点包括：
为了开始构建基于 .NET Core 的 Web API，并实现 JWT 认证功能，首先需要搭建一个合适的开发环境。以下是推荐的步骤：
dotnet --version 来确认 .NET SDK 是否成功安装。虽然不是必需的，但 Visual Studio Code 是一个非常流行的代码编辑器，提供了丰富的插件和扩展，非常适合 .NET Core 的开发工作。
本教程使用的示例代码托管在 GitHub 上，可以通过以下命令克隆到本地：
git clone https://github.com/GLEBR1K/your-repo.git
cd your-repo
dotnet build 命令来构建项目。dotnet run 命令来启动 Web API 服务。至此，您已经成功搭建了一个用于开发 .NET Core Web API 的环境，并准备好了开始实现 JWT 认证功能。接下来的部分将详细介绍如何在项目中集成 JWT 认证。
在搭建好开发环境之后，接下来的步骤是初始化一个新的 .NET Core Web API 项目，并为其添加 JWT 认证功能。本节将指导您完成项目的创建和配置过程。
如果您还没有从 GitHub 克隆示例项目，可以使用以下命令创建一个新的 .NET Core Web API 项目：
dotnet new webapi -n YourProjectName
cd YourProjectName
这里 -n 参数用于指定项目名称。创建完成后，您将看到一个基本的 Web API 项目结构。
为了实现 JWT 认证，需要添加一些必要的 NuGet 包。在项目根目录下打开命令行，运行以下命令来安装所需的包：
dotnet add package Microsoft.AspNetCore.Authentication.JwtBearer
dotnet add package Microsoft.IdentityModel.Tokens
Microsoft.AspNetCore.Authentication.JwtBearer 包提供了 JWT 身份验证的支持，而 Microsoft.IdentityModel.Tokens 包则包含了处理 JWT 的工具。
在项目中添加一个名为 AppSettings.json 的文件，用于存储 JWT 相关的配置信息。例如：
{
"JwtSettings": {
"Key": "your_secret_key_here",
"Issuer": "your_app_name",
"Audience": "your_app_audience",
"DurationInMinutes": 60
}
}
这里定义了 JWT 的密钥、颁发者、接收者以及过期时间等重要参数。请注意替换 your_secret_key_here 等占位符为实际值。
打开 Startup.cs 文件，在 ConfigureServices 方法中添加 JWT 认证服务的注册，并在 Configure 方法中启用 JWT 身份验证中间件。
public void ConfigureServices(IServiceCollection services)
{
// 添加 JWT 身份验证服务
var appSettingsSection = Configuration.GetSection("JwtSettings");
services.Configure<JwtSettings>(appSettingsSection);
var jwtSettings = appSettingsSection.Get<JwtSettings>();
services.AddAuthentication(options =>
{
options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
})
.AddJwtBearer(options =>
{
options.TokenValidationParameters = new TokenValidationParameters
{
ValidateIssuer = true,
ValidateAudience = true,
ValidateLifetime = true,
ValidateIssuerSigningKey = true,
ValidIssuer = jwtSettings.Issuer,
ValidAudience = jwtSettings.Audience,
IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(jwtSettings.Key))
};
});
// 其他服务注册
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// 启用 JWT 身份验证中间件
app.UseAuthentication();
app.UseAuthorization();
// 其他中间件配置
}
至此，您已经完成了项目的初始化，并为后续实现 JWT 认证功能打下了基础。
了解项目的结构对于后续的开发工作至关重要。下面是对项目结构的基本解析：
在 Controllers 目录下，您可以创建一个简单的控制器来测试 JWT 认证功能。例如：
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
namespace YourProjectName.Controllers
{
[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
[HttpGet]
[Authorize]
public IActionResult Get()
{
return Ok(new { message = "Hello from a protected endpoint!" });
}
}
}
这里使用 [Authorize] 属性来限制对 Get 方法的访问，只有经过 JWT 认证的请求才能访问此方法。
通过以上步骤，您已经成功初始化了一个包含 JWT 认证功能的 .NET Core Web API 项目，并对其结构有了初步的认识。接下来，您可以进一步完善 JWT 认证的实现细节，并开始开发具体的业务逻辑。
JWT (JSON Web Tokens) 是一种开放标准 (RFC 7519)，用于在各方之间安全地传输信息。JWT 由三个部分组成：头部 (Header)、负载 (Payload) 和签名 (Signature)。JWT 的主要特点是它是一种自包含的令牌，这意味着所有必要的信息都存储在令牌本身中，无需查询数据库即可验证和使用。这种特性使得 JWT 成为了许多现代 Web 应用程序和 API 认证的理想选择。
{
"typ": "JWT",
"alg": "HS256"
}
{
"sub": "1234567890",
"name": "John Doe",
"iat": 1516239022
}
HMACSHA256(
base64UrlEncode(header) + "." +
base64UrlEncode(payload),
secret
)
这些优势使得 JWT 成为了现代 Web 开发中非常受欢迎的认证机制之一。
为了在.NET Core Web API 中实现 JWT 认证，首先需要创建一个方法来生成 JWT。在项目中添加一个名为 JwtTokenGenerator.cs 的文件，并实现 JWT 生成逻辑：
using System.IdentityModel.Tokens.Jwt;
using System.Security.Claims;
using System.Text;
using Microsoft.IdentityModel.Tokens;
public class JwtTokenGenerator
{
private readonly JwtSettings _jwtSettings;
public JwtTokenGenerator(IOptions<JwtSettings> jwtSettings)
{
_jwtSettings = jwtSettings.Value;
}
public string GenerateToken(string userId)
{
var claims = new[]
{
new Claim(JwtRegisteredClaimNames.Sub, userId),
new Claim(JwtRegisteredClaimNames.Jti, Guid.NewGuid().ToString()),
new Claim(JwtRegisteredClaimNames.Iat, DateTimeOffset.UtcNow.ToUnixTimeSeconds().ToString(), ClaimValueTypes.Integer64)
};
var key = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(_jwtSettings.Key));
var creds = new SigningCredentials(key, SecurityAlgorithms.HmacSha256);
var token = new JwtSecurityToken(
issuer: _jwtSettings.Issuer,
audience: _jwtSettings.Audience,
claims: claims,
expires: DateTime.UtcNow.AddMinutes(_jwtSettings.DurationInMinutes),
signingCredentials: creds);
var tokenHandler = new JwtSecurityTokenHandler();
return tokenHandler.WriteToken(token);
}
}
在 Startup.cs 文件中，我们已经配置了 JWT 身份验证服务。接下来，需要在控制器中实现 JWT 的验证逻辑。例如，在 AccountController 中添加一个登录方法：
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;
namespace YourProjectName.Controllers
{
[ApiController]
[Route("[controller]")]
public class AccountController : ControllerBase
{
private readonly JwtTokenGenerator _tokenGenerator;
public AccountController(JwtTokenGenerator tokenGenerator)
{
_tokenGenerator = tokenGenerator;
}
[HttpPost("login")]
public async Task<IActionResult> Login([FromBody] LoginRequest request)
{
// 假设这里验证用户名和密码
if (request.Username == "admin" && request.Password == "password")
{
var token = _tokenGenerator.GenerateToken("1234567890"); // 用户ID
return Ok(new { token });
}
return Unauthorized();
}
}
public class LoginRequest
{
public string Username { get; set; }
public string Password { get; set; }
}
}
现在，客户端可以通过调用 /account/login 端点来获取 JWT。获取到 JWT 后，客户端需要在后续的每个请求中携带 JWT，以便服务器验证其有效性。例如，可以使用 Postman 或类似的工具来测试受保护的资源：
[Authorize]
[HttpGet("protected-resource")]
public IActionResult ProtectedResource()
{
return Ok(new { message = "This is a protected resource." });
}
通过以上步骤，您已经成功实现了 JWT 认证功能，并可以在.NET Core Web API 中使用 JWT 来保护资源。接下来，您可以进一步完善 JWT 认证的安全性和错误处理机制，以满足更复杂的应用场景。
为了方便快速上手并实践本教程中的内容，建议直接从 GitHub 仓库克隆示例项目。这样不仅可以节省创建新项目的时间，还能直接获得已经配置好的 JWT 认证功能。按照以下步骤操作：
cd 命令切换到您希望存放项目的文件夹。cd path/to/your/directory
git clone https://github.com/GLEBR1K/your-repo.git
your-repo 的文件夹，其中包含了完整的项目文件。cd 命令进入克隆下来的项目文件夹。cd your-repo
通过以上步骤，您已经成功地从 GitHub 仓库中克隆了示例项目。接下来，您可以开始构建并运行项目，以测试 JWT 认证功能是否正常工作。
在克隆并准备好示例项目后，接下来的步骤是构建并运行项目，以确保一切正常工作。以下是详细的步骤：
dotnet build 命令来构建项目。构建成功后，您将看到类似以下的输出：...
Build succeeded.
0 Warning(s)
0 Error(s)
Time Elapsed 00:00:01.23
dotnet run 命令来启动 Web API 服务。此时，您应该能看到类似以下的输出，表明项目正在运行：Now listening on: http://localhost:5000
Application started. Press Ctrl+C to shut down.
/account/login 端点，以测试登录功能。例如：POST http://localhost:5000/account/login
Content-Type: application/json
{
"username": "admin",
"password": "password"
}
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwianRpIjoiMmQxZDk5ZTgtNzg4Mi00ZjEwLWExMzEtZjIwMjMzZjQyZjA5IiwiaWF0IjoxNjg4OTU5NjU5LCJleHAiOjE2ODg5NjE2NTksImVtYWlsIjoibWFpbEBnbWFpbC5jb20ifQ.1aFh1b8Hf6v1s5o6p1u4q9Xl7X9jJ4z1r0j01111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111
在实现了 JWT 认证功能之后，确保系统的安全性是非常重要的一步。以下是一些推荐的最佳实践，可以帮助您增强系统的安全性：
通过遵循这些最佳实践，您可以显著提高系统的安全性，减少潜在的安全漏洞。
尽管采取了各种安全措施，但在实际应用中仍然可能会遇到一些常见的安全问题。以下是一些建议，帮助您解决这些问题：
通过采取这些措施，您可以有效地应对常见的安全挑战，确保您的 Web API 和 JWT 认证机制更加健壮和安全。
在实现了基本的 JWT 认证功能之后，您还可以利用一些高级特性来增强系统的灵活性和安全性。以下是一些值得探索的高级特性：
Startup.cs 中配置异常处理中间件，以捕获 JWT 验证失败的情况，并返回适当的错误消息。通过利用这些高级特性，您可以进一步增强 JWT 认证的功能和安全性，使其更好地适应不同的应用场景。
在.NET Core Web API 中，您还可以通过自定义 JWT 的行为来满足特定的需求。以下是一些自定义 JWT 行为的方法：
Startup.cs 中配置异常处理中间件，以捕获 JWT 验证失败的情况，并返回定制的错误消息。HttpOnly 标志来增加安全性。Startup.cs 中配置异常处理中间件，以捕获 JWT 验证失败的情况，并返回适当的错误消息。通过自定义 JWT 的行为，您可以更好地控制认证流程，以满足特定的应用需求。这些自定义选项不仅增强了系统的灵活性，还提高了系统的安全性。
本文全面介绍了如何在.NET Core Web API中使用JSON Web Tokens (JWT)进行认证。从JWT认证的基本概念出发，详细阐述了JWT的工作原理及其优势，并通过实际操作演示了如何在.NET Core环境中搭建开发环境、创建Web API项目、集成JWT认证功能以及进行安全性加固。读者不仅能够了解到JWT认证的核心机制，还能掌握具体的实现步骤和技术要点。
通过本教程的学习，开发者可以快速上手.NET Core Web API的JWT认证开发，并能够根据实际需求进行定制化的扩展。无论是初学者还是有一定经验的开发者，都能从中受益，为构建安全可靠的Web应用程序奠定坚实的基础。