ASP.NET Core 3.1系列（9）——Cookie的相关操作

最新推荐文章于 2024-08-10 03:03:11 发布
最新推荐文章于 2024-08-10 03:03:11 发布
阅读量3.2k 收藏 9
点赞数 1
分类专栏： ASP.NET Core C# 文章标签： ASP.NET Core
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/herrydong/article/details/124292744
版权
C# 同时被 2 个专栏收录
72 篇文章 18 订阅
订阅专栏
ASP.NET Core
32 篇文章 43 订阅
订阅专栏

1、前言

Cookie通常用来存储有关用户信息的一条数据，它可以用来标识登录用户，一般存储在客户端的浏览器上。在大多数浏览器中，每个Cookie都被存储为一个小文件，它一般采用键/值对的形式进行描述，因此可以利用键来读取、写入或删除Cookie。下面就来看看如何在ASP.NET Core中进行Cookie的设置、读取、删除操作。

2、在Controller中操作Cookie

如果是在Controller中直接操作Cookie，则直接使用如下两个组件即可：

  • HttpContext.Response.Cookies：设置、删除Cookie
  • HttpContext.Request.Cookies：获取Cookie

2.1、设置Cookie

设置Cookie的代码如下：

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using System;

namespace App.Controllers
{
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class HomeController : ControllerBase
    {
        [HttpGet]
        public ActionResult<string> SetCookie()
        {
            try
            {
                CookieOptions options = new CookieOptions
                {
                    Expires = DateTime.Now.AddDays(1)
                };
                HttpContext.Response.Cookies.Append("UserName", "admin", options);
                HttpContext.Response.Cookies.Append("Password", "12345", options);
                return Ok("添加Cookie成功");
            }
            catch
            {
                return BadRequest("添加Cookie失败");
            }
        }
    }
}

运行结果如下图所示：
在这里插入图片描述

2.2、获取Cookie

获取Cookie的代码如下：

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace App.Controllers
{
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class HomeController : ControllerBase
    {
        [HttpGet]
        public ActionResult<string> GetCookie()
        {
            try
            {
                return HttpContext.Request.Cookies["UserName"] + "\n" +
                       HttpContext.Request.Cookies["Password"];
            }
            catch
            {
                return BadRequest("获取Cookie失败");
            }
        }
    }
}

运行结果如下图所示：
在这里插入图片描述

2.3、删除Cookie

删除Cookie的代码如下：

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace App.Controllers
{
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class HomeController : ControllerBase
    {
        [HttpGet]
        public ActionResult<string> DeleteCookie()
        {
            try
            {
                HttpContext.Response.Cookies.Delete("UserName");
                HttpContext.Response.Cookies.Delete("Password");
                return Ok("删除Cookie成功");
            }
            catch
            {
                return BadRequest("删除Cookie失败");
            }
        }
    }
}

运行结果如下图所示：
在这里插入图片描述

3、封装Cookie操作类

如果我们要将Cookie的相关操作封装成类又该怎么办呢？在上面的代码中，我们主要是用HttpContext对Cookie进行操作，但HttpContext是ControllerBase的一个属性，我们定义的操作类难道要继承它吗？
在这里插入图片描述
在ASP.NET Core中，如果想使用HttpContext属性，我们可以注入IHttpContextAccessor接口，首先创建一个接口文件ICookieHelper，代码如下：

namespace App
{
    public interface ICookieHelper
    {
        /// <summary>
        /// 设置Cookie
        /// </summary>
        /// <param name="key">键</param>
        /// <param name="value">值</param>
        void SetCookie(string key, string value);

        /// <summary>
        /// 设置Cookie
        /// </summary>
        /// <param name="key">键</param>
        /// <param name="value">值</param>
        /// <param name="expires">失效时间</param>
        void SetCookie(string key, string value, int expires);

        /// <summary>
        /// 获取Cookie
        /// </summary>
        /// <param name="key">键</param>
        /// <returns>Cookie值</returns>
        string GetCookie(string key);

        /// <summary>
        /// 删除Cookie
        /// </summary>
        /// <param name="key">键</param>
        void DeleteCookie(string key);
    }
}

然后创建一个CookieHelper实现ICookieHelper，代码如下：

using Microsoft.AspNetCore.Http;
using System;

namespace App
{
    public class CookieHelper : ICookieHelper
    {
        private readonly IHttpContextAccessor httpContextAccessor;

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="httpContextAccessor"></param>
        public CookieHelper(IHttpContextAccessor httpContextAccessor)
        {
            this.httpContextAccessor = httpContextAccessor;
        }

        /// <summary>
        /// 设置Cookie
        /// </summary>
        /// <param name="key">键</param>
        /// <param name="value">值</param>
        public void SetCookie(string key, string value)
        {
            httpContextAccessor.HttpContext.Response.Cookies.Append(key, value);
        }

        /// <summary>
        /// 设置Cookie
        /// </summary>
        /// <param name="key">键</param>
        /// <param name="value">值</param>
        /// <param name="expires">失效时间</param>
        public void SetCookie(string key, string value, int expires)
        {
            CookieOptions options = new CookieOptions()
            {
                Expires = DateTime.Now.AddDays(expires)
            };
            httpContextAccessor.HttpContext.Response.Cookies.Append(key, value, options);
        }

        /// <summary>
        /// 获取Cookie
        /// </summary>
        /// <param name="key">键</param>
        /// <returns>Cookie值</returns>
        public string GetCookie(string key)
        {
            return httpContextAccessor.HttpContext.Request.Cookies[key];
        }

        /// <summary>
        /// 删除Cookie
        /// </summary>
        /// <param name="key">键</param>
        public void DeleteCookie(string key)
        {
            httpContextAccessor.HttpContext.Response.Cookies.Delete(key);
        }
    }
}

在Controller中注入ICookieHelper，代码如下：

using Microsoft.AspNetCore.Mvc;

namespace App.Controllers
{
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class HomeController : ControllerBase
    {
        private readonly ICookieHelper cookieHelper;

        /// <summary>
        /// 构造函数
        /// </summary>
        /// <param name="cookieHelper"></param>
        public HomeController(ICookieHelper cookieHelper)
        {
            this.cookieHelper = cookieHelper;
        }

        /// <summary>
        /// 设置Cookie
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public ActionResult<string> SetCookie()
        {
            try
            {
                cookieHelper.SetCookie("UserName", "admin", 1);
                cookieHelper.SetCookie("Password", "12345", 1);
                return Ok("添加Cookie成功");
            }
            catch
            {
                return BadRequest("添加Cookie失败");
            }
        }

        /// <summary>
        /// 获取Cookie
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public ActionResult<string> GetCookie()
        {
            try
            {
                return cookieHelper.GetCookie("UserName") + "\n" +
                       cookieHelper.GetCookie("Password");
            }
            catch
            {
                return BadRequest("获取Cookie失败");
            }
        }

        /// <summary>
        /// 删除Cookie
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public ActionResult<string> DeleteCookie()
        {
            try
            {
                cookieHelper.DeleteCookie("UserName");
                cookieHelper.DeleteCookie("Password");
                return Ok("删除Cookie成功");
            }
            catch
            {
                return BadRequest("删除Cookie失败");
            }
        }
    }
}

最后在Startup.cs文件中注册IHttpContextAccessor和ICookieHelper即可，代码如下所示：

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace App
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            // 添加IHttpContextAccessor
            services.AddHttpContextAccessor();
            // 添加ICookieHelper
            services.AddSingleton<ICookieHelper, CookieHelper>();
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseHttpsRedirection();
            app.UseRouting();
            app.UseAuthorization();
            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }
    }
}

4、结语

本文主要介绍了ASP.NET Core中Cookie的使用方法。如果是在Controller中直接操作Cookie，则可以直接使用HttpContext进行操作。如果需要封装成类，则需要借助IHttpContextAccessor接口进行实现。

HerryDong
关注
专栏目录
课程3：ASP.NET Core 身份验证 - Cookie
成长的足迹
04-19 1350
身份验证在MSDN叫做Authorization，其目的就是验证Http请求，只有验证通过，才能访问特定的资源。 在Asp.Net Core提供非常多的Authorization方式。 在MSDN官方文档，我们也可以看到有以下的验证方式【截图是Asp.Net Core 7.0，各个版本有差异】：今天我们重点来，讲解Cookies验证，这是我们比较经常用到的方式之一。
c#（.net core）读取cookie
Raymon、浅忆。
10-17 2547
1.首先要到startup.cs中的ConfigureServices内添加 services.Configure<CookiePolicyOptions>(option => { option.CheckConsentNeeded = context => false; }); 2.注入cookie---因为c...
.NET CORE 使用Cookie
04-16
.Net Core 2.2使用Cookies进行一定的操作，介绍了如何在应用中完美的使用
在 ASP.NET Core 中 使用 cookies
黑夜中的潜行者
01-02 2518
  cookie 常用于保存用户相关并保存在客户端电脑上的一段数据，在大多数浏览器下，每一个cookie 都会是一个小文件的形式存在，只有 Firefox 例外，它将所有的 cookie 都保存在一个文件中，cookie 是以 key-value 的形式表现的，可以通过这个 key 去 读取，删除，写入 等操作   ASP.NET Core 中使用 cookie 机制来维护 session 状态，在客户端的每一次请求中，server 端都会将 sessionid 放在 cookie 中发送给客户端来.
asp.net core 设置登录路径（Cookie）学习笔记
最新发布
weixin_42398843的博客
08-10 61
Cookie：　　Startup文件登录后复制 services.AddAuthentication(CookieAuthenticationDefaults.AuthenticationScheme).AddCookie(options => { options...
.NET CORE cookie
菜鸟小灰灰的博客
03-30 4801
.net core 有自己的cookie机制，不需要单独写js进行实现 statup.cs 文件中找到Configure方法 //Cookie app.UseCookieAuthentication(new CookieAuthenticationOptions { AuthenticationScheme = "Cookie",// 验证方案名 AutomaticAuthentic
【学习推荐】ASP.NET Core 3.1中文教程
05-31
ASP.NET Core 3.1是微软推出的一款高性能、开源的跨平台框架，用于构建现代云应用。本教程针对想要深入理解和掌握ASP.NET Core 3.1的开发者，提供了丰富的中文学习资源，旨在帮助读者从基础架构到实际开发，全面了解...
ASP.NET Core 3.1中文教程.rar
07-28
ASP.NET Core 3.1是微软推出的一款开源、跨平台的Web应用开发框架，它结合了.NET Core的高性能和灵活性，以及ASP.NET的功能性。这个中文教程可能是为了帮助开发者更深入地理解和掌握ASP.NET Core 3.1的核心概念、...
asp.net core3.1 实战开发（授权，鉴权的使用）
热门推荐
一点一滴
01-09 2万+
注册服务 public void ConfigureServices(IServiceCollection services) { services.AddAuthentication(CookieAuthenticationDefaults.AuthenticationScheme) .AddCookie(options => { o...
asp.net core3.1 实战开发（授权，鉴权封装详解）
一点一滴
01-10 2万+
使用方式 #region 设置自己的schema的handler services.AddAuthenticationCore(options => options.AddScheme<MyHandler>("myScheme", "demo myScheme")); #endregion #region...
ASP.NET Core3.1 Ocelot负载均衡的实现
12-16
ASP.NET Core 3.1中的Ocelot是一个强大的API Gateway，它支持多种负载均衡策略，以确保微服务架构中的高效请求处理。Ocelot通过在上游客户端与下游服务之间分配请求，增强了系统的可扩展性和可靠性。 1. **负载均衡...
ASPNETCoreCookies:有关如何在ASP.NET Core上使用cookie的视频演示的源代码（葡萄牙语）-How to use the source code
03-24
ASPNETCoreCookies 有关如何在ASP.NET Core上使用cookie的视频演示的源代码（葡萄牙语）
详解Asp.Net Core中的Cookies
weixin_34361881的博客
09-08 1122
目录 详解Asp.Net Core中的cookies 搞懂cookies Asp.Net中cookies的实现 从http中获取cookies 将cookies写入http中 总结及感想 详解Asp.Net Core中的cookies 搞懂cookies 我之前写过一篇文章来介绍cookies，如果你对cookies不是很了解请移步理解c...
ASP.NET Core Cookie 认证
dotNET跨平台
11-30 468
Cookie 认证是ASP.NET Core用来实现客户自定义认证逻辑，没有使用ASP.NET Core Identity1 ASP.NET Core Cookie 认证例子在.NET Core我们通常使用三步来配置cookie认证，第一步是使用AddAuthentication和AddCookie添加Authentication服务，第二步指定app必须使用Authentication&...
Asp.net Core的Cookie使用
飞翔的学习笔记
02-06 1680
.net core下可以使用普通的cookie也可以使用加密的cookie，普通的cookie的使用 需要继承Controller里使用 写入Cookie Response.Cookies.Append("password", "123456"); 读取Cookie string s; Request.Cookies.TryGetValue("password", out s); 删...
asp.net core中使用cookie身份验证
https://github.com/conanl5566
10-13 420
ASP.NET Core Identity 是一个完整的全功能身份验证提供程序，用于创建和维护登录名。但是， cookie 不能使用基于的身份验证提供程序 ASP.NET Core Identity 。 1、配置 在 Startup.ConfigureServices 方法中，创建具有 AddAuthentication 和 AddCookie 方法的身份验证中间件服务： services.AddAuthentication(CookieAuthenticationDefaults.Authe.
ASP.NET CORE中使用Cookie身份认证
极客神殿
03-14 1467
大家在使用ASP.NET的时候一定都用过FormsAuthentication做登录用户的身份认证，FormsAuthentication的核心就是Cookie，ASP.NET会将用户名存储在Cookie中。 现在到了ASP.NET CORE的时代，但是ASP.NET CORE中没有FormsAuthentication这个东西，那么怎么做身份认证呢？答案是ASP.NET CORE已经为我们内置了Cookie身份认证的功能，而且使用起来非常方便，注意本文是基于ASP.NET CORE 2.0版本来阐述Coo
cookie登陆_Aspnetcore权限控制设计入门---Cookie 简介
weixin_39737947的博客
11-28 186
引言Cookie是一个漂亮的设计, 是HTTP协议中的重要组成部分, 用于网站保存传送一些网站的附加信息, 随着技术的发展, localstorage, sessionstorage的出现, cookie用的越来越少, 但是因为Cookie的特点, 登陆信息,SessionKey, private consent 还是主要存在于Cookie里面. 因为最近要写一个权限部分的知识, Cookie是绕...
.NET CORE 设置cookie以及获取cookie
aex34027的博客
06-25 1787
使用我这个方式的前提是在mvc中，确认你安装了：Microsoft.AspNetCore.Mvc. 然后在继承了Controller的类型中使用我所说的方法。 直接使用即可，我是封装了方法供我自己使用，代码如下： public abstract class ControllerBase : Controller { /// <su...
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值